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

Notification handler for SharedDisplayLocalDevice. More...

Public Member Functions

virtual void OnSharedDisplay_Request (CPNS::ISharedDisplayLocalDevice *const pDev, CPNS::DeviceID const &clientDevID)=0
 Called on shared display request. More...
 
virtual void OnSharedDisplay_SessionClosed (CPNS::ISharedDisplayLocalDevice *const pDev)=0
 Called if shared display session closed by the client. More...
 
virtual void OnSharedDisplay_DisplayClear (CPNS::ISharedDisplayLocalDevice *const pDev)=0
 Called if the client is requesting to clear display. More...
 
virtual void OnSharedDisplay_SetText (CPNS::ISharedDisplayLocalDevice *const pDev, CPNS::uint16 const wX, CPNS::uint16 const wY, CPNS::char8 const *const utf8Text)=0
 Called if the client is requesting to display text. More...
 
virtual void OnSharedDisplay_SetCursor (CPNS::ISharedDisplayLocalDevice *const pDev, CPNS::uint16 const wX, CPNS::uint16 const wY, CPNS::Enums::SharedDisplayCursorTypes const type)=0
 Called if the client is requesting to move the cursor. More...
 

Detailed Description

Notification handler for SharedDisplayLocalDevice.

Member Function Documentation

virtual void CPNS::ISharedDisplayLocalDevice_NotificationHandler::OnSharedDisplay_DisplayClear ( CPNS::ISharedDisplayLocalDevice *const  pDev)
pure virtual

Called if the client is requesting to clear display.

Parameters
[in]pDevPointer to the local device
virtual void CPNS::ISharedDisplayLocalDevice_NotificationHandler::OnSharedDisplay_Request ( CPNS::ISharedDisplayLocalDevice *const  pDev,
CPNS::DeviceID const &  clientDevID 
)
pure virtual

Called on shared display request.

This request arrives each 500ms until it is abandoned or accepted by a shared display. At this side, a 1 second one-shot timer should be re-triggered each time this notification is called. If the timer goes to expiration before the request is accepted locally, it should be considered as abandoned.

Parameters
[in]pDevPointer to the local device
[in]clientDevIDDevice ID of the requesting device
virtual void CPNS::ISharedDisplayLocalDevice_NotificationHandler::OnSharedDisplay_SessionClosed ( CPNS::ISharedDisplayLocalDevice *const  pDev)
pure virtual

Called if shared display session closed by the client.

Parameters
[in]pDevPointer to the local device
virtual void CPNS::ISharedDisplayLocalDevice_NotificationHandler::OnSharedDisplay_SetCursor ( CPNS::ISharedDisplayLocalDevice *const  pDev,
CPNS::uint16 const  wX,
CPNS::uint16 const  wY,
CPNS::Enums::SharedDisplayCursorTypes const  type 
)
pure virtual

Called if the client is requesting to move the cursor.

Parameters
[in]pDevPointer to the local device
[in]wXX position
[in]wYY position
[in]typecursor display mode
virtual void CPNS::ISharedDisplayLocalDevice_NotificationHandler::OnSharedDisplay_SetText ( CPNS::ISharedDisplayLocalDevice *const  pDev,
CPNS::uint16 const  wX,
CPNS::uint16 const  wY,
CPNS::char8 const *const  utf8Text 
)
pure virtual

Called if the client is requesting to display text.

Parameters
[in]pDevPointer to the local device
[in]wXX position
[in]wYY position
[in]utf8Texttext to display