Inheritance diagram for gem::OverlayItem:

Collaboration diagram for gem::OverlayItem:

Public Member Functions
	OverlayItem (const OverlayItem &item)=default
	Default copy constructor.
	OverlayItem (OverlayItem &&item)=default
	Default move constructor noexcept is deduced.
OverlayItem &	operator= (const OverlayItem &item)=default
	Default copy assignment.
OverlayItem &	operator= (OverlayItem &&item)=default
	Default move assignment noexcept is deduced.
bool	operator== (const OverlayItem &overlayItem)
	Comparison operator equal.
bool	operator!= (const OverlayItem &overlayItem)
	Comparison operator not equal.
LargeInteger	getUid () const noexcept
	Get the unique ID of the item within the overlay.
const OverlayInfoRef	getOverlayInfo () const noexcept
	Get the parent overlay info.
int	getOverlayUid () const noexcept
	Get the parent overlay UID.
const CoordinatesRef	getCoordinates () const noexcept
	Get the OverlayItem coordinates.
const StringRef	getName () const noexcept
	Get the name of the item.
const ImageRef	getImage () const noexcept
	Get the image of the item.
const StringRef	getPreviewUrl (Size webViewSize=Size()) const noexcept
	Get the preview URL for the item (if any).
String	getPreviewData (EPreviewDataType type) const noexcept
	Get OverlayItem preview data.
SearchableParameterList	getPreviewData () const noexcept
	Get OverlayItem preview data as parameters list.
bool	hasPreviewExtendedData () const noexcept
	Check if this type of OverlayItem has preview EXTENDED data (dynamic data that needs to be downloaded).
int	getPreviewExtendedData (SearchableParameterList &list, ProgressListener listener) const noexcept
	Asynchronous get OverlayItem preview EXTENDED data (dynamic data that needs to be downloaded) as parameters list.
void	cancelGetPreviewExtendedData (ProgressListener listener) const noexcept
	Cancel an asynchronous get OverlayItem preview EXTENDED data.
int	getCategoryId () const noexcept
	Get OverlayItem category id.

Detailed Description

OverlayItem object.

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

Constructor & Destructor Documentation

◆ OverlayItem() [1/2]

gem::OverlayItem::OverlayItem ( const OverlayItem & item )

default

Default copy constructor.

Parameters

item	The OverlayItem object to copy

◆ OverlayItem() [2/2]

gem::OverlayItem::OverlayItem ( OverlayItem && item )

default

Default move constructor noexcept is deduced.

Parameters

item	The OverlayItem object to move

Member Function Documentation

◆ cancelGetPreviewExtendedData()

void gem::OverlayItem::cancelGetPreviewExtendedData ( ProgressListener listener ) const

inlinenoexcept

Cancel an asynchronous get OverlayItem preview EXTENDED data.

Parameters

[in] listener The Progress listener used to identify the operation.

◆ getCategoryId()

int gem::OverlayItem::getCategoryId ( ) const

inlinenoexcept

Get OverlayItem category id.

Returns: The overlay category id if it exists, otherwise 0

◆ getCoordinates()

const CoordinatesRef gem::OverlayItem::getCoordinates ( ) const

inlinenoexcept

Get the OverlayItem coordinates.

Returns: Empty if coordinates are not available

◆ getImage()

const ImageRef gem::OverlayItem::getImage ( ) const

inlinenoexcept

Get the image of the item.

Returns: Empty if image is not available

◆ getName()

const StringRef gem::OverlayItem::getName ( ) const

inlinenoexcept

Get the name of the item.

Returns: Empty if name is not available

◆ getOverlayInfo()

const OverlayInfoRef gem::OverlayItem::getOverlayInfo ( ) const

inlinenoexcept

Get the parent overlay info.

Returns: Empty if OverlayItem is empty

◆ getOverlayUid()

int gem::OverlayItem::getOverlayUid ( ) const

inlinenoexcept

Get the parent overlay UID.

Returns: The parent overlay UID

◆ getPreviewData() [1/2]

SearchableParameterList gem::OverlayItem::getPreviewData ( ) const

inlinenoexcept

Get OverlayItem preview data as parameters list.

Returns: The preview data as a list of parameters

◆ getPreviewData() [2/2]

String gem::OverlayItem::getPreviewData ( EPreviewDataType type ) const

inlinenoexcept

Get OverlayItem preview data.

Parameters

[in] type The OverlayItem preview data format

Returns: The preview data in the given type format

◆ getPreviewExtendedData()

int gem::OverlayItem::getPreviewExtendedData	(	SearchableParameterList &	list,
		ProgressListener	listener ) const

inlinenoexcept

Asynchronous get OverlayItem preview EXTENDED data (dynamic data that needs to be downloaded) as parameters list.

Parameters

[in]	list	The list that will be populated with the preview extended data once it is downloaded.
[in]	listener	Progress listener which is MANDATORY.

Returns: KNoError on success, error::KInvalidInput if no listener specified, error::KCouldNotStart if the request couldn't be started, error::KNotSupported if called even though hasPreviewExtendedData() returned false, error::KGeneral in any other error case.

◆ getPreviewUrl()

const StringRef gem::OverlayItem::getPreviewUrl ( Size webViewSize = Size() ) const

inlinenoexcept

Get the preview URL for the item (if any).

The preview URL may be opened by the UI into a web browser window to present more details to the user about this item.

Parameters

webViewSize is the size of the web view window.

Returns: Empty if the item has no preview URL.

◆ getUid()

LargeInteger gem::OverlayItem::getUid ( ) const

inlinenoexcept

Get the unique ID of the item within the overlay.

Returns: The item ID

◆ hasPreviewExtendedData()

bool gem::OverlayItem::hasPreviewExtendedData ( ) const

inlinenoexcept

Check if this type of OverlayItem has preview EXTENDED data (dynamic data that needs to be downloaded).

Returns: True if the item has preview extended data, false otherwise

◆ operator!=()

bool gem::OverlayItem::operator!= ( const OverlayItem & overlayItem )

inline

Comparison operator not equal.

Parameters

overlayItem The OverlayItem object to compare

Returns: True if the objects are not equal, false otherwise

◆ operator=() [1/2]

OverlayItem & gem::OverlayItem::operator= ( const OverlayItem & item )

default

Default copy assignment.

Parameters

item	The OverlayItem object to copy

Returns: The copied OverlayItem object

◆ operator=() [2/2]

OverlayItem & gem::OverlayItem::operator= ( OverlayItem && item )

default

Default move assignment noexcept is deduced.

Parameters

item	The OverlayItem object to move

Returns: The moved OverlayItem object

◆ operator==()

bool gem::OverlayItem::operator== ( const OverlayItem & overlayItem )

inline

Comparison operator equal.

Parameters

overlayItem The OverlayItem object to compare

Returns: True if the objects are equal, false otherwise

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ OverlayItem() [1/2]

◆ OverlayItem() [2/2]

Member Function Documentation

◆ cancelGetPreviewExtendedData()

◆ getCategoryId()

◆ getCoordinates()

◆ getImage()

◆ getName()

◆ getOverlayInfo()

◆ getOverlayUid()

◆ getPreviewData() [1/2]

◆ getPreviewData() [2/2]

◆ getPreviewExtendedData()

◆ getPreviewUrl()

◆ getUid()

◆ hasPreviewExtendedData()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()