[imbus commit] r49 - trunk/imbus/src

[codesite...@google.com]

Author: james.su
Date: Wed Jan 16 23:41:02 2008
New Revision: 49

Modified:
trunk/imbus/src/im_event_types.h

Log:
Updated comments.

Modified: trunk/imbus/src/im_event_types.h
==============================================================================
--- trunk/imbus/src/im_event_types.h (original)
+++ trunk/imbus/src/im_event_types.h Wed Jan 16 23:41:02 2008
@@ -1652,8 +1652,28 @@
*/
IM_EVENT_TIMEOUT_NOTIFY,

- IM_EVENT_SHOW_MESSAGE_BOX,
-
+ /**
+ * Notifies an UI component to show a notification.
+ *
+ * Possible producer: any components
+ * Possible consumer: UI components
+ * Possible observer: any components
+ *
+ * Can broadcast: No.
+ *
+ * Source ID: ID of the component, which creates this event
+ * Dest ID: ID of the UI component, which shall consume this event,
+ * Can be IM_EVENT_DEST_DEFAULT.
+ * ICID: IM_EVENT_INPUT_CONTEXT_NONE shall be used.
+ *
+ * Data:
+ * - IMText
+ * Text of the notification to be shown.
+ * - IMBool
+ * If true then audio or visual notification shall be used.
+ *
+ * Has reply event: No
+ */
IM_EVENT_SHOW_NOTIFICATION,

IM_EVENT_USER_DEFINED_START = 32768,

[codesite...@google.com]