Author: ek.kato
Date: Tue Oct 7 04:37:15 2008
New Revision: 5586
Modified:
trunk/doc/COMPATIBILITY
trunk/doc/HELPER-CANDWIN
Log:
* doc/HELPER-CANDWIN
* doc/COMPATIBILITY
- Update changes in uim-xim with r5584.
Modified: trunk/doc/COMPATIBILITY
==============================================================================
--- trunk/doc/COMPATIBILITY (original)
+++ trunk/doc/COMPATIBILITY Tue Oct 7 04:37:15 2008
@@ -57,6 +57,23 @@
The changes are described below in most recently updated order.
------------------------------------------------------------------------------
+Summary: New helper-candwin protocol about setting the candidates
+Affects: Helper program developers
+Updates: Helper-candwin protocol
+Version: 1.6.0
+Revision: ac5584
+Date: 2008-10-07
+Modifier: Etsushi Kato
+Related:
+URL:
+Changes:
+ (new) "set_nr_candidates"
+ (new) "set_page_candidates"
+ (new) "show_page"
+Description:
+ New helper-candwin message from uim-xim to uim-candwin-{gtk,qt} for
+ the light weight page handling.
+------------------------------------------------------------------------------
Summary: Plugin loding and unloading schemes are changed
Affects: uim developers, IM developers
Updates: libuim ABI, Scheme API
Modified: trunk/doc/HELPER-CANDWIN
==============================================================================
--- trunk/doc/HELPER-CANDWIN (original)
+++ trunk/doc/HELPER-CANDWIN Tue Oct 7 04:37:15 2008
@@ -21,6 +21,9 @@
show |
hide |
deactivate |
+ set_nr_candidates |
+ set_page_candidates |
+ show_page |
show_caret_state |
update_caret_state |
hide_caret_state) "\n"
@@ -38,7 +41,7 @@
activate = "activate" "\n" label
label = charset_specifier display_limit_str "\n" candidate_strs
display_limit_str = display_limit_label num
- display_limit_label = "display_limit"
+ display_limit_label = "display_limit="
candidate_strs = candidate_str candidate_str candidate_str ....
candidate_str = cand_head "\t" cand_candidate "\n"
cand_head = str
@@ -71,19 +74,47 @@
deactivate = "deactivate" "\n"
- 7. show_caret_state
+ 7. set_nr_candidates
+ Activating the candidate window with nr_cands and display_limit
+ value. This can be used as a replacement of 'activate' message in
+ combination with following 'set_page_candidates' and 'show_page'
+ message for the efficient candidate page handling.
+
+ activate = "set_nr_candidates" "\n" nr_cands "\n" display_limit "\n"
+ nr_cands = num
+ display_limit = num
+
+ 8. set_page_candidates
+ Set heading labels and candidates to the selected page of the
+ candidate window. The order of candidates must be as is.
+
+ set_page_candidates = "set_page_candidates" "\n" label
+ label = charset_specifier page_str "\n" candidate_strs
+ page_str = page_label num
+ page_label = "page="
+ candidate_strs = candidate_str candidate_str candidate_str ....
+ candidate_str = cand_head "\t" cand_candidate "\n"
+ cand_head = str
+ cand_candidate = str
+
+ 9. show_page
+ Selecting the specified page of the candidate window.
+
+ show_page = "show_page" "\n" num "\n"
+
+ 10. show_caret_state
Show caret state of the input mode
show_caret_state = "show_caret_state" "\n" timeout "\n"
caret_state "\n"
timeout = num
caret_state = str
- 8. update_caret_state
+ 11. update_caret_state
Update caret state of the input mode
update_caret_state = "update_caret_state" "\n"
- 9. hide_caret_state
+ 12. hide_caret_state
Hide caret state of the input mode
hide_caret_state = "hide_caret_state" "\n"
