[imbus commit] r41 - trunk/imbus/src

[codesite...@google.com]

Author: james.su
Date: Tue Nov 20 20:07:22 2007
New Revision: 41

Modified:
trunk/imbus/src/im_event_types.h

Log:
Update definitions of some event types.

Modified: trunk/imbus/src/im_event_types.h
==============================================================================
--- trunk/imbus/src/im_event_types.h (original)
+++ trunk/imbus/src/im_event_types.h Tue Nov 20 20:07:22 2007
@@ -1357,7 +1357,6 @@
IM_EVENT_SHOW_COMPONENTS_LIST,

-
/**
* Stores one or more arbitrary data into a storage component.
*
@@ -1563,18 +1562,94 @@
*/
IM_EVENT_STORAGE_WATCH_NOTIFY,

- IM_EVENT_STORAGE_FLUSH,
-
- IM_EVENT_STORAGE_RELOAD,
-
-

- /** Set an event which will be sent out after a certain timeout */
+ /**
+ * Calls IMBUS to hook a timeout event, that will be fired after a certain
+ * time.
+ *
+ * An event with this type shall be sent to IMBUS, if a component
wants to
+ * hook a timeout event in IMBUS.
+ * The timeout event will be fired by IMBUS after a specified time.
+ *
+ * Possible producer: any components
+ * Possible consumer: IMBUS
+ * Possible observer: any components
+ *
+ * Can broadcast: No.
+ *
+ * Source ID: ID of the component, which sends this event
+ * Dest ID: IM_EVENT_DEST_IMBUS shall be used
+ * ICID: IM_EVENT_INPUT_CONTEXT_NONE shall be used.
+ *
+ * Data:
+ * - IMUInt32
+ * A specified ID of the timeout event inside the component
scope, which
+ * can be used to cancel the timeout later.
+ * - IMUInt32
+ * A specified timeout value, in milliseconds.
+ * - IMBool
+ * Indicates if it's a periodical event. If it' a periodical
event, then
+ * IMBUS will fire it periodically in interval specified by
above timeout
+ * value. Otherwise it'll only be fired once after a specified timeout.
+ * - IMEvent
+ * The event that will be fired by IMBUS. It can be an event of
any type,
+ * but usually IM_EVENT_TIMEOUT_NOTIFY can be used for generic timeout
+ * notification.
+ *
+ * Has reply event: No
+ */
IM_EVENT_SET_TIMEOUT_EVENT,

- /** Cancel a timeout event */
+ /**
+ * Calls IMBUS to cancel a timeout event.
+ *
+ * An event with this type shall be sent to IMBUS, if a component wants
+ * IMBUS to cancel a specified timeout event hooked by previous
+ * IM_EVENT_SET_TIMEOUT_EVENT event.
+ *
+ * Possible producer: any components
+ * Possible consumer: IMBUS
+ * Possible observer: any components
+ *
+ * Can broadcast: No.
+ *
+ * Source ID: ID of the component, which sends this event
+ * Dest ID: IM_EVENT_DEST_IMBUS shall be used
+ * ICID: IM_EVENT_INPUT_CONTEXT_NONE shall be used.
+ *
+ * Data:
+ * - IMUInt32
+ * ID of the timeout event to be cancelled.
+ *
+ * Has reply event: No
+ */
IM_EVENT_CANCEL_TIMEOUT_EVENT,

+ /**
+ * An event that can be used for generic timeout notification.
+ *
+ * This event can be used in the IMEvent parameter when sending
+ * IM_EVENT_SET_TIMEOUT_EVENT to represent a generic timeout notification.
+ *
+ * Possible producer: IMBUS
+ * Possible consumer: any components
+ * Possible observer: any components
+ *
+ * Can broadcast: No.
+ *
+ * Source ID: ID of the component, which creates this event
+ * Dest ID: ID of the component, which shall consume this event, usually
+ * it should be same as the Source ID.
+ * ICID: Any valid input context ID can be used. It's up to the
+ * producer and consumer to determine the usage of this ID.
+ *
+ * Data:
+ * - IMUInt32
+ * ID of the timeout event.
+ * - Any additional data that can be interpreted by consumer.
+ *
+ * Has reply event: No
+ */
IM_EVENT_TIMEOUT_NOTIFY,

IM_EVENT_SHOW_MESSAGE_BOX,