This list is providing the items for Selector parameters. More...

Inheritance diagram for CPNS::ISelectorItemList:

Collaboration diagram for CPNS::ISelectorItemList:

Public Member Functions
virtual CPNS::uint16	GetSize ()=0
	Get the number of items in the list. More...

virtual CPNS::boolean	GetLabelFromValue (CPNS::uint16 const wItemValue, CPNS::UTF8String &itemLabel)=0
	Get the label related to an item value. More...

virtual CPNS::boolean	GetValueFromLabel (CPNS::char8 const *const utf8Label, CPNS::uint16 &wItemValue)=0
	Get the value related to an item label. More...

virtual CPNS::boolean	GetItemFromIndex (CPNS::uint16 const wItemIndex, CPNS::UTF8String &itemLabel, CPNS::uint16 &wItemValue)=0
	Get the label related to an item index. More...

virtual CPNS::Enums::Errors	UpdateDynamicContent (CPNS::uint16 const wNewSize)=0
	Send a notification to all Outputs handling a parameter using this list telling that the list content changed. More...

Public Member Functions inherited from CPNS::IObject
virtual CPNS::ICHAI *	GetCHAI ()=0
	Get a pointer to the CHAI hosting this object. More...

virtual void	RegisterObjectNotificationHandler (CPNS::IObject_NotificationHandler *const pHandler)=0
	Register an Object's notification handler. More...

virtual void	UnregisterObjectNotificationHandler (CPNS::IObject_NotificationHandler *const pHandler)=0
	Unregister an Object's notification handler. More...

virtual CPNS::Enums::ObjectTypes	GetObjectType () const =0
	Get the object type. More...

virtual CPNS::uint32	GetHandle () const =0
	Get a unique handle to the object if this object is handled by the trashcan. More...

virtual void	SetUserDataPtr (void const *const pData)=0
	Set a custom user ptr data. More...

virtual void *	GetUserDataPtr () const =0
	Get custom user ptr data. More...

virtual void	SetUserDataUInt32 (const CPNS::uint32 dwData)=0
	Set a custom user uint32 data. More...

virtual CPNS::uint32	GetUserDataUInt32 () const =0
	Get custom user uint32 data. More...

Detailed Description

This list is providing the items for Selector parameters.

Member Function Documentation

virtual CPNS::boolean CPNS::ISelectorItemList::GetItemFromIndex	(	CPNS::uint16 const	wItemIndex,
		CPNS::UTF8String &	itemLabel,
		CPNS::uint16 &	wItemValue
	)

pure virtual

Get the label related to an item index.

Parameters

[in]	wItemIndex	the item index
[out]	itemLabel	the item label
[out]	wItemValue	the item value

Returns: TRUE on success

virtual CPNS::boolean CPNS::ISelectorItemList::GetLabelFromValue	(	CPNS::uint16 const	wItemValue,
		CPNS::UTF8String &	itemLabel
	)

pure virtual

Get the label related to an item value.

Parameters

[in]	wItemValue	the item value
[out]	itemLabel	the item label

Returns: TRUE on success

virtual CPNS::uint16 CPNS::ISelectorItemList::GetSize ( )

pure virtual

Get the number of items in the list.

virtual CPNS::boolean CPNS::ISelectorItemList::GetValueFromLabel	(	CPNS::char8 const *const	utf8Label,
		CPNS::uint16 &	wItemValue
	)

pure virtual

Get the value related to an item label.

Parameters

[in]	itemLabel	the item label
[out]	wItemValue	the item value

Returns: TRUE on success

virtual CPNS::Enums::Errors CPNS::ISelectorItemList::UpdateDynamicContent ( CPNS::uint16 const wNewSize )

pure virtual

Send a notification to all Outputs handling a parameter using this list telling that the list content changed.

Calling this makes IOutput_NotificationHandler::OnOutput_RefreshSelectorItemList to be called on connected outputs.

Parameters

[in] wNewSize new number of items in the list

Public Member Functions

Detailed Description

Member Function Documentation