gem::OverlayCategory Class Reference

OverlayCategory object. More...

Inheritance diagram for gem::OverlayCategory:

Collaboration diagram for gem::OverlayCategory:

Public Member Functions
	OverlayCategory (const OverlayCategory &categ)=default
	Default copy constructor noexcept is deduced.
	OverlayCategory (OverlayCategory &&categ)=default
	Default move constructor noexcept is deduced.
OverlayCategory &	operator= (const OverlayCategory &categ)=default
	Default copy assignment.
OverlayCategory &	operator= (OverlayCategory &&categ)=default
	Default move assignment noexcept is deduced.
bool	operator== (const OverlayCategory &categ)
	Comparison operator equal.
bool	operator!= (const OverlayCategory &categ)
	Comparison operator not equal.
int	getUid () const noexcept
	Get the unique ID of the category within the overlay.
int	getOverlayUid () const noexcept
	Get the parent overlay uid.
const StringRef	getName () const noexcept
	Get the category name.
const ImageRef	getImage () const noexcept
	Get the category image.
OverlayCategoryList	getSubcategories () const noexcept
	Get the category sub-categories.
bool	hasSubcategories () const noexcept
	Check if category has subcategories.

Detailed Description

OverlayCategory object.

Implements share-read / copy-on-write Api object over IOverlayCategory.

Constructor & Destructor Documentation

OverlayCategory() [1/2]

gem::OverlayCategory::OverlayCategory ( const OverlayCategory & categ )

default

Default copy constructor noexcept is deduced.

Parameters

categ

The OverlayCategory object to copy

OverlayCategory() [2/2]

gem::OverlayCategory::OverlayCategory ( OverlayCategory && categ )

default

Default move constructor noexcept is deduced.

Parameters

categ

The OverlayCategory object to move

Member Function Documentation

getImage()

const ImageRef gem::OverlayCategory::getImage ( ) const

inlinenoexcept

Get the category image.

Returns

The category image

getName()

const StringRef gem::OverlayCategory::getName ( ) const

inlinenoexcept

Get the category name.

Returns

The category name

getOverlayUid()

int gem::OverlayCategory::getOverlayUid ( ) const

inlinenoexcept

Get the parent overlay uid.

Returns

The parent overlay uid

getSubcategories()

OverlayCategoryList gem::OverlayCategory::getSubcategories ( ) const

inlinenoexcept

Get the category sub-categories.

Returns

Empty if no sub-categories are available

getUid()

int gem::OverlayCategory::getUid ( ) const

inlinenoexcept

Get the unique ID of the category within the overlay.

Returns

The category ID

hasSubcategories()

bool gem::OverlayCategory::hasSubcategories ( ) const

inlinenoexcept

Check if category has subcategories.

Returns

True if category has subcategories, false otherwise

operator!=()

bool gem::OverlayCategory::operator!= ( const OverlayCategory & categ )

inline

Comparison operator not equal.

Parameters

categ

The OverlayCategory object to compare

Returns

True if the objects are not equal, false otherwise

operator=() [1/2]

OverlayCategory & gem::OverlayCategory::operator= ( const OverlayCategory & categ )

default

Default copy assignment.

Parameters

categ

The OverlayCategory object to copy

Returns

The copied OverlayCategory object

operator=() [2/2]

OverlayCategory & gem::OverlayCategory::operator= ( OverlayCategory && categ )

default

Default move assignment noexcept is deduced.

Parameters

categ

The OverlayCategory object to move

Returns

The moved OverlayCategory object

operator==()

bool gem::OverlayCategory::operator== ( const OverlayCategory & categ )

inline

Comparison operator equal.

Parameters

categ

The OverlayCategory object to compare

Returns

True if the objects are equal, false otherwise