Input Plug-in interfaces
[Framework APIs]


Functions

void AppUIWmPluginEventNotify (AppUIWmEventID evID, AppUIWmPluginData data)
 Event notification from the input plug-in.
int AppUIWmStartEventPlugin (void)
 Request to initialise and start sending input plug-in events.
int AppUIWmStopEventPlugin (void)
 Request that input plug-in stop sending events.

Function Documentation

void AppUIWmPluginEventNotify ( AppUIWmEventID  evID,
AppUIWmPluginData  data 
)

Event notification from the input plug-in.

Each LiMo member's input plug-in uses this API to notify the window manager that an event has been received.

NOTE: The 'data' is mandatory. If an event does not include additional data, The 'length' data member shall be set to 0.

Parameters:
[in] evID Type of event.
[in] data Input plug-in additional information.

int AppUIWmStartEventPlugin ( void   ) 

Request to initialise and start sending input plug-in events.

Each LiMo input plug-in will need to implement this function.

  • Window manager will then call this API to request input plug-in to start sending events to the window manager.
  • Any input plug-in start-up logic should be included in the implementation of this function.

Message Sequence Diagram:
Input Plug-in Mechanism Start-Up:
Figure_7.bmp
Returns:
OPERATION_SUCCESS: normal end
ERR_OPERATION_FAILED: error starting input plug-in

int AppUIWmStopEventPlugin ( void   ) 

Request that input plug-in stop sending events.

Each LiMo input plug-in will need to implement this function.

  • The window manager will call this API to request input plug-in to stop sending events to the window manager
  • Any input plug-in stop logic should be included in the implementation of this function.

Returns:
OPERATION_SUCCESS: normal end
ERR_OPERATION_FAILED: error stopping input plug-in


Generated on Mon Mar 31 01:01:00 2008 by  doxygen 1.5.4