[uim-commit] r3129 - trunk/doc

[yamaken at freedesktop.org]

Author: yamaken
Date: 2006-02-19 12:20:31 -0800 (Sun, 19 Feb 2006)
New Revision: 3129

Modified:
   trunk/doc/HELPER-PROTOCOL
Log:
* doc/HELPER-PROTOCOL
  - Change field names appropriately. The message format itself is not
    changed


Modified: trunk/doc/HELPER-PROTOCOL
===================================================================
--- trunk/doc/HELPER-PROTOCOL	2006-02-19 20:13:35 UTC (rev 3128)
+++ trunk/doc/HELPER-PROTOCOL	2006-02-19 20:20:31 UTC (rev 3129)
@@ -136,20 +136,20 @@
     if the input method has 2 or more properties. One property controls one
     variable state of the input method such as 'input mode' or 'keymap'.
 
-    menucommand_name = "prop_" /^[a-z0-9_]+$/
+    action_id = identifier
 
   - prop_activate
 
-    This message notifies that a command named as menucommand_name has been
+    This message notifies that a command named as action_id has been
     activated. This message is usually sent from toolbar applets in response
     to an user selection and received by corresponding IM. Once received, the
-    prop-handler of current IM has been invoked with menucommand_name. Several
-    IMs use menucommand_name as 'input mode' such as 'hiragana', 'katakana',
+    prop-handler of current IM has been invoked with action_id. Several
+    IMs use action_id as 'input mode' such as 'hiragana', 'katakana',
     'direct' and so on, and switches to activated input mode on receiving.
 
     See also prop_list_update.
 
-    prop_activate = "prop_activate\n" menucommand_name "\n"
+    prop_activate = "prop_activate\n" action_id "\n"
 
   - prop_label_get
 
@@ -175,7 +175,7 @@
     iconic_label is a very short string typically 1 character to be used as
     icon. For example, "a" means 'direct input'.
 
-    buttontooltip_string is a string for tooltip of the button.
+    label_string is a string usually used as tooltip of the button.
 
     Invoke im-update-prop-label to send this message.
 
@@ -183,11 +183,11 @@
 
     prop_label_update = "prop_label_update\n" charset_specifier labels
     labels = labels label | label
-    label = indication_id "\t" iconic_label "\t" buttontooltip_string "\n"
+    label = indication_id "\t" iconic_label "\t" label_string "\n"
 
     indication_id = identifier
     iconic_label = str
-    buttontooltip_string = str
+    label_string = str
 
   - prop_list_get
 
@@ -220,18 +220,18 @@
     separator. But it is not necessary since the "separator" appears as dummy
     item with no action if the receiver is not aware of it.
 
-    buttontooltip_string is a string for tooltip of the button.
+    label_string is a short string to be shown in the menu, or used as tooltip
+    of the button.
 
-    menulabel_string is a short string to be shown in the menu.
+    short_desc is a short description string usually used as tooltip of the
+    menu item.
 
-    menutooltip_string is a string for tooltip of the menu.
-
-    menucommand_name is a symbolic identifier of the menu item. This will be
+    action_id is an identifier of the menu item. This will be
     notified to other processes by prop_activate when this menu item has been
     selected by user.
 
-    flag means that whether this menu item is selected. Only one menu item per
-    branch should be notified as "*" which means 'selected'.
+    activity means that whether this menu item is selected. Only one menu item
+    per branch should be notified as "*" which means 'selected'.
 
     Invoke im-update-prop-list to send this message.
 
@@ -240,16 +240,16 @@
     prop_list_update = "prop_list_update\n" charset_specifier parts
     parts = parts part | part
     part = branch leaves
-    branch = "branch\t" indication_id "\t" iconic_label "\t" buttontooltip_string "\n"
+    branch = "branch\t" indication_id "\t" iconic_label "\t" label_string "\n"
     leaves = leaves leaf | leaf
-    leaf = "leaf\t" indication_id "\t" iconic_label "\t" menulabel_string "\t" menutooltip_string "\t" menucommand_name "\t" flag "\n"
+    leaf = "leaf\t" indication_id "\t" iconic_label "\t"
+           label_string "\t" short_desc "\t" action_id "\t" activity "\n"
 
     indication_id = identifier | "separator"
     iconic_label = str
-    buttontooltip_string = str
-    menulabel_string = str
-    menutooltip_string = str
-    flag = "*" | ""
+    label_string = str
+    short_desc = str
+    activity = "*" | ""
 
 
 * IM management messages