← Back to branch summary

~ubuntu-branches/ubuntu/precise/uim/precise

« back to all changes in this revision

Viewing changes to doc/HELPER-CANDWIN

  • Committer: Package Import Robot
  • Author(s): Ilya Barygin
  • Date: 2011-12-18 16:35:38 UTC
  • mfrom: (1.1.13) (15.1.7 sid)
  • Revision ID: package-import@ubuntu.com-20111218163538-8ktir39z2mjpii8z
Tags: 1:1.7.1-3ubuntu1
https://launchpad.net/bugs/818199
* Merge from Debian testing (LP: #818199).
* Remaining changes:
  - debian/uim-qt.install: Fix plugin path for multiarch location.
* Dropped changes:
  - uim-applet-gnome removal (GNOME 3 applet is available)
  - 19_as-needed_compile_fix.dpatch (accepted into Debian package)
* translations.patch: add several files to POTFILE.in to prevent
  intltool-update failure.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/HELPER-CANDWIN
26
26
              show_page  |
27
27
              show_caret_state |
28
28
              update_caret_state |
29
 
              hide_caret_state) "\n"
30
 
  charset_specifier = "charset=" charset "\n"
 
29
              hide_caret_state) "\f"
 
30
  charset_specifier = "charset=" charset "\f"
31
31
  charset = "UTF-8" | "EUC-JP" | "GB18030" |
32
32
            <or any name that can be specified as iconv_open(3) argument>
33
 
  str = str <any characters except for '\0', '\t', or '\n'> | ""
 
33
  str = str <any characters except for '\0', '\a', or '\f'> | ""
34
34
  num = /[0-9]+/
35
35
 
36
36
  1. activate
38
38
   and add heading labels and candidates to it. The order of
39
39
   candidates must be as is.
40
40
 
41
 
   activate = "activate" "\n" label
42
 
   label = charset_specifier display_limit_str "\n" candidate_strs
 
41
   activate = "activate" "\f" label
 
42
   label = charset_specifier display_limit_str "\f" candidate_strs
43
43
   display_limit_str = display_limit_label num
44
44
   display_limit_label = "display_limit="
45
45
   candidate_strs = candidate_str candidate_str candidate_str ....
46
 
   candidate_str = cand_head "\t" cand_candidate "\n"
 
46
   candidate_str = cand_head "\a" cand_candidate "\a" cand_annotation "\f"
47
47
   cand_head = str
48
48
   cand_candidate = str
 
49
   cand_annotation = str
49
50
 
50
51
  2. select
51
52
    Selecting the specified candidate in helper-candwin window.
52
53
 
53
 
    select = "select" "\n" num "\n"
 
54
    select = "select" "\f" num "\f"
54
55
 
55
56
  3. move
56
57
    Moving the helper-candwin window.
57
58
 
58
 
    move = "move" "\n" XPos "\n" YPos "\n"
 
59
    move = "move" "\f" XPos "\f" YPos "\f"
59
60
    XPos = num
60
61
    YPos = num
61
62
 
62
63
  4. show
63
64
    Showing the candidate window
64
65
 
65
 
    show = "show" "\n"
 
66
    show = "show" "\f"
66
67
 
67
68
  5. hide
68
69
    Hide the candidate window
69
70
 
70
 
    hide = "hide" "\n"
 
71
    hide = "hide" "\f"
71
72
 
72
73
  6. deactivate
73
74
    Deactivating the candidate window
74
75
 
75
 
    deactivate = "deactivate" "\n"
 
76
    deactivate = "deactivate" "\f"
76
77
 
77
78
  7. set_nr_candidates
78
79
    Activating the candidate window with nr_cands and display_limit
80
81
    combination with following 'set_page_candidates' and 'show_page'
81
82
    message for the efficient candidate page handling.
82
83
 
83
 
    activate = "set_nr_candidates" "\n" nr_cands "\n" display_limit "\n"
 
84
    activate = "set_nr_candidates" "\f" nr_cands "\f" display_limit "\f"
84
85
    nr_cands = num
85
86
    display_limit = num
86
87
 
88
89
    Set heading labels and candidates to the selected page of the
89
90
    candidate window. The order of candidates must be as is.
90
91
 
91
 
    set_page_candidates = "set_page_candidates" "\n" label
92
 
    label = charset_specifier page_str "\n" candidate_strs
 
92
    set_page_candidates = "set_page_candidates" "\f" label
 
93
    label = charset_specifier page_str "\f" candidate_strs
93
94
    page_str = page_label num
94
95
    page_label = "page="
95
96
    candidate_strs = candidate_str candidate_str candidate_str ....
96
 
    candidate_str = cand_head "\t" cand_candidate "\n"
 
97
    candidate_str = cand_head "\a" cand_candidate "\a" cand_annotation "\f"
97
98
    cand_head = str
98
99
    cand_candidate = str
 
100
    cand_annotation = str
99
101
 
100
102
  9. show_page
101
103
    Selecting the specified page of the candidate window.
102
104
 
103
 
    show_page = "show_page" "\n" num "\n"
 
105
    show_page = "show_page" "\f" num "\f"
104
106
 
105
107
  10. show_caret_state
106
108
    Show caret state of the input mode
107
109
 
108
 
    show_caret_state = "show_caret_state" "\n" timeout "\n" caret_state "\n"
 
110
    show_caret_state = "show_caret_state" "\f" timeout "\f" caret_state "\f"
109
111
    timeout = num
110
112
    caret_state = str
111
113
 
112
114
  11. update_caret_state
113
115
    Update caret state of the input mode
114
116
 
115
 
    update_caret_state = "update_caret_state" "\n"
 
117
    update_caret_state = "update_caret_state" "\f"
116
118
 
117
119
  12. hide_caret_state
118
120
    Hide caret state of the input mode
119
121
 
120
 
    hide_caret_state = "hide_caret_state" "\n"
 
122
    hide_caret_state = "hide_caret_state" "\f"
121
123
 
122
124
Sending Message format BNF
123
125
  session  = messages