← Back to branch summary

~ubuntu-branches/ubuntu/maverick/uim/maverick

« back to all changes in this revision

Viewing changes to doc/HELPER-CANDWIN

  • Committer: Bazaar Package Importer
  • Author(s): Masahito Omote
  • Date: 2009-03-01 12:57:00 UTC
  • mfrom: (1.1.10 upstream)
  • Revision ID: james.westby@ubuntu.com-20090301125700-0ykjdq0zgj55e3n3
Tags: 1:1.5.5-1
New upstream release and final upload by current maintainter.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/HELPER-CANDWIN
21
21
              show       |
22
22
              hide       |
23
23
              deactivate |
 
24
              set_nr_candidates |
 
25
              set_page_candidates |
 
26
              show_page  |
24
27
              show_caret_state |
25
28
              update_caret_state |
26
29
              hide_caret_state) "\n"
38
41
   activate = "activate" "\n" label
39
42
   label = charset_specifier display_limit_str "\n" candidate_strs
40
43
   display_limit_str = display_limit_label num
41
 
   display_limit_label = "display_limit"
 
44
   display_limit_label = "display_limit="
42
45
   candidate_strs = candidate_str candidate_str candidate_str ....
43
46
   candidate_str = cand_head "\t" cand_candidate "\n"
44
47
   cand_head = str
71
74
 
72
75
    deactivate = "deactivate" "\n"
73
76
 
74
 
  7. show_caret_state
 
77
  7. set_nr_candidates
 
78
    Activating the candidate window with nr_cands and display_limit
 
79
    value.  This can be used as a replacement of 'activate' message in
 
80
    combination with following 'set_page_candidates' and 'show_page'
 
81
    message for the efficient candidate page handling.
 
82
 
 
83
    activate = "set_nr_candidates" "\n" nr_cands "\n" display_limit "\n"
 
84
    nr_cands = num
 
85
    display_limit = num
 
86
 
 
87
  8. set_page_candidates
 
88
    Set heading labels and candidates to the selected page of the
 
89
    candidate window. The order of candidates must be as is.
 
90
 
 
91
    set_page_candidates = "set_page_candidates" "\n" label
 
92
    label = charset_specifier page_str "\n" candidate_strs
 
93
    page_str = page_label num
 
94
    page_label = "page="
 
95
    candidate_strs = candidate_str candidate_str candidate_str ....
 
96
    candidate_str = cand_head "\t" cand_candidate "\n"
 
97
    cand_head = str
 
98
    cand_candidate = str
 
99
 
 
100
  9. show_page
 
101
    Selecting the specified page of the candidate window.
 
102
 
 
103
    show_page = "show_page" "\n" num "\n"
 
104
 
 
105
  10. show_caret_state
75
106
    Show caret state of the input mode
76
107
 
77
108
    show_caret_state = "show_caret_state" "\n" timeout "\n" caret_state "\n"
78
109
    timeout = num
79
110
    caret_state = str
80
111
 
81
 
  8. update_caret_state
 
112
  11. update_caret_state
82
113
    Update caret state of the input mode
83
114
 
84
115
    update_caret_state = "update_caret_state" "\n"
85
116
 
86
 
  9. hide_caret_state
 
117
  12. hide_caret_state
87
118
    Hide caret state of the input mode
88
119
 
89
120
    hide_caret_state = "hide_caret_state" "\n"