CHAI SDK  Version 1.3
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
CPNS::IIndexList_NotificationHandler Class Referenceabstract

Notification handler for Index List management. More...

Public Member Functions

virtual void OnIndexList_GetLabel (CPNS::IIndexList *const pNotifiedObject, CPNS::uint16 const wItemIndex, CPNS::UTF8String &itemLabel)=0
 Query the application for the label related to an Index List item index. More...
 

Detailed Description

Notification handler for Index List management.

Member Function Documentation

virtual void CPNS::IIndexList_NotificationHandler::OnIndexList_GetLabel ( CPNS::IIndexList *const  pNotifiedObject,
CPNS::uint16 const  wItemIndex,
CPNS::UTF8String itemLabel 
)
pure virtual

Query the application for the label related to an Index List item index.

Warning
CAUTION! the wItemIndex is the item index (0 based), not the message's Index value (1 based)!!!
Remarks
The item index value is never higher or equal to the list size given during the list creation.
Parameters
[in]pNotifiedObjectthe list
[in]wItemIndexthe item index
[out]itemLabelthe item label.