-
Notifications
You must be signed in to change notification settings - Fork 37
/
Copy pathinput_ime.html
677 lines (665 loc) · 50.6 KB
/
input_ime.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<link href="stable/static/css/site.css" rel="stylesheet" type="text/css">
<link href="stable/static/css/print.css" rel="stylesheet" type="text/css" media="print">
<link href="stable/static/css/prettify.css" rel="stylesheet" type="text/css">
<link href="//www.google.com/images/icons/product/chrome-16.png" rel="icon" type="image/ico">
<link href="stable/static/css/api.css" rel="stylesheet" type="text/css">
<title>chrome.input.ime - chrome插件中文开发文档(非官方)</title>
</head>
<body>
<a id="top"></a>
<div id="header">{Header content}</div>
<a id="gc-topnav-anchor"></a>
<div id="gc-topnav">
<h1>Google Chrome Extensions</h1>
<ul id="home" class="gc-topnav-tabs">
<li id="home_link">
<a href="index.html" title="Google Chrome Extensions home page"><div>Home</div></a>
</li>
<li id="docs_link">
<a href="docs.html" title="Official Google Chrome Extensions documentation"><div>Docs</div></a>
</li>
<li id="faq_link">
<a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions"><div>FAQ</div></a>
</li>
<li id="samples_link">
<a href="samples.html" title="Sample Extensions (with source code)"><div>Samples</div></a>
</li>
<li id="group_link">
<a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum"><div>Group</div></a>
</li>
<li id="so_link">
<a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow"><div>Questions?</div></a>
</li>
</ul>
</div>
<div id="gc-container">
<div id="gc-sidebar">
<ul
class="level1 ">
<li class="level2">
<a href="getstarted.html" class="level2 ">Getting Started</a>
</li>
<li class="level2">
<a href="overview.html" class="level2 ">Overview</a>
</li>
<li class="level2">
<a href="whats_new.html" class="level2 ">What's New?</a>
</li>
<li class="level2">
<a href="devguide.html" class="level2 ">Developer's Guide</a>
<ul
class="level2 ">
<li class="level3">
<a class="button level3">
<span class="level3">Browser UI</span>
<div class="toggleIndicator level3"></div>
</a>
<ul toggleable
class="level3 hidden">
<li class="level4">
<a href="browserAction.html" class="level4 ">Browser Actions</a>
</li>
<li class="level4">
<a href="contextMenus.html" class="level4 ">Context Menus</a>
</li>
<li class="level4">
<a href="notifications.html" class="level4 ">Desktop Notifications</a>
</li>
<li class="level4">
<a href="omnibox.html" class="level4 ">Omnibox</a>
</li>
<li class="level4">
<a href="options.html" class="level4 ">Options Pages</a>
</li>
<li class="level4">
<a href="override.html" class="level4 ">Override Pages</a>
</li>
<li class="level4">
<a href="pageAction.html" class="level4 ">Page Actions</a>
</li>
</ul>
</li>
<li class="level3">
<a class="button level3">
<span class="level3">Browser Interaction</span>
<div class="toggleIndicator level3"></div>
</a>
<ul toggleable
class="level3 hidden">
<li class="level4">
<a href="bookmarks.html" class="level4 ">Bookmarks</a>
</li>
<li class="level4">
<a href="cookies.html" class="level4 ">Cookies</a>
</li>
<li class="level4">
<a href="devtools.html" class="level4 ">Developer Tools</a>
</li>
<li class="level4">
<a href="events.html" class="level4 ">Events</a>
</li>
<li class="level4">
<a href="history.html" class="level4 ">History</a>
</li>
<li class="level4">
<a href="management.html" class="level4 ">Management</a>
</li>
<li class="level4">
<a href="tabs.html" class="level4 ">Tabs</a>
</li>
<li class="level4">
<a href="windows.html" class="level4 ">Windows</a>
</li>
</ul>
</li>
<li class="level3">
<a class="button level3">
<span class="level3">Implementation</span>
<div class="toggleIndicator level3"></div>
</a>
<ul toggleable
class="level3 hidden">
<li class="level4">
<a href="a11y.html" class="level4 ">Accessibility</a>
</li>
<li class="level4">
<a href="event_pages.html" class="level4 ">Event Pages</a>
</li>
<li class="level4">
<a href="contentSecurityPolicy.html" class="level4 ">Content Security Policy</a>
</li>
<li class="level4">
<a href="content_scripts.html" class="level4 ">Content Scripts</a>
</li>
<li class="level4">
<a href="xhr.html" class="level4 ">Cross-Origin XHR</a>
</li>
<li class="level4">
<a href="i18n.html" class="level4 ">Internationalization</a>
</li>
<li class="level4">
<a href="messaging.html" class="level4 ">Message Passing</a>
</li>
<li class="level4">
<a href="permissions.html" class="level4 ">Optional Permissions</a>
</li>
<li class="level4">
<a href="npapi.html" class="level4 ">NPAPI Plugins</a>
</li>
</ul>
</li>
<li class="level3">
<a class="button level3">
<span class="level3">Finishing</span>
<div class="toggleIndicator level3"></div>
</a>
<ul toggleable
class="level3 hidden">
<li class="level4">
<a href="hosting.html" class="level4 ">Hosting</a>
</li>
<li class="level4">
<a href="external_extensions.html" class="level4 ">Other Deployment Options</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="level2">
<a href="tutorials.html" class="level2 ">Tutorials</a>
<ul
class="level2 ">
<li class="level3">
<a href="tut_migration_to_manifest_v2.html" class="level3 ">Manifest V2</a>
</li>
<li class="level3">
<a href="tut_debugging.html" class="level3 ">Debugging</a>
</li>
<li class="level3">
<a href="tut_analytics.html" class="level3 ">Google Analytics</a>
</li>
<li class="level3">
<a href="tut_oauth.html" class="level3 ">OAuth</a>
</li>
</ul>
</li>
<li class="level2">
<span class="level2">Reference</span>
<ul
class="level2 ">
<li class="level3">
<a class="button level3">
<span class="level3">Formats</span>
<div class="toggleIndicator level3"></div>
</a>
<ul toggleable
class="level3 hidden">
<li class="level4">
<a href="manifest.html" class="level4 ">Manifest Files</a>
</li>
<li class="level4">
<a href="match_patterns.html" class="level4 ">Match Patterns</a>
</li>
</ul>
</li>
<li class="level3">
<a href="permission_warnings.html" class="level3 ">Permission Warnings</a>
</li>
<li class="level3">
<a href="api_index.html" class="level3 ">chrome.* APIs</a>
</li>
<li class="level3">
<a href="api_other.html" class="level3 ">Other APIs</a>
</li>
</ul>
</li>
<li class="level2">
<span class="level2">More</span>
<ul
class="level2 ">
<li class="level3">
<a href="http://code.google.com/chrome/webstore/docs/index.html" class="level3 ">Chrome Web Store</a>
</li>
<li class="level3">
<a href="http://code.google.com/chrome/apps/docs/developers_guide.html" class="level3 ">Hosted Apps</a>
</li>
<li class="level3">
<a href="themes.html" class="level3 ">Themes</a>
</li>
</ul>
</li>
</ul>
</div>
<div id="gc-pagecontent">
<h1 class="page_title">chrome.input.ime</h1>
<div id="toc">
<h2>Contents</h2>
<ol>
<li>
<a href="#apiReference">API reference: chrome.input.ime</a>
<ol>
<li><a href="#types">Types</a><ol> <li> <a href="#type-KeyboardEvent">KeyboardEvent</a> </li> <li> <a href="#type-InputContext">InputContext</a> </li></ol></li>
<li><a href="#methods">Methods</a><ol> <li><a href="#method-setComposition">setComposition</a></li> <li><a href="#method-clearComposition">clearComposition</a></li> <li><a href="#method-commitText">commitText</a></li> <li><a href="#method-setCandidateWindowProperties">setCandidateWindowProperties</a></li> <li><a href="#method-setCandidates">setCandidates</a></li> <li><a href="#method-setCursorPosition">setCursorPosition</a></li> <li><a href="#method-setMenuItems">setMenuItems</a></li> <li><a href="#method-updateMenuItems">updateMenuItems</a></li></ol></li>
<li><a href="#events">Events</a><ol> <li><a href="#event-onActivate">onActivate</a></li> <li><a href="#event-onDeactivated">onDeactivated</a></li> <li><a href="#event-onFocus">onFocus</a></li> <li><a href="#event-onBlur">onBlur</a></li> <li><a href="#event-onInputContextUpdate">onInputContextUpdate</a></li> <li><a href="#event-onKeyEvent">onKeyEvent</a></li> <li><a href="#event-onCandidateClicked">onCandidateClicked</a></li> <li><a href="#event-onMenuItemActivated">onMenuItemActivated</a></li></ol></li>
</ol>
</li>
</ol>
</div>
<h2 id="apiReference">API Reference: chrome.input.ime</h2>
<div class="api_reference">
<h3 id="types">Types</h3>
<div>
<h3 id="type-KeyboardEvent">KeyboardEvent</h3>
<div>
<dt><span class="type_name"> ( <span id="typeTemplate">object</span> )</span></dt>
<dd>
See http://www.w3.org/TR/DOM-Level-3-Events/#events-KeyboardEvent
</dd> <h4 id="KeyboardEvent-properties">
Properties of <a href="#type-KeyboardEvent">KeyboardEvent</a>
</h4>
<dd><dl> <div>
<a name="property-KeyboardEvent-type"></a>
<dt>
<span class="variable">type</span>
<span class="property">
(
<span id="typeTemplate">enumerated string ["keyup", "keydown"]</span>
)
</span>
</dt>
<dd>
One of keyup or keydown.
</dd>
</div>
<div>
<a name="property-KeyboardEvent-requestId"></a>
<dt>
<span class="variable">requestId</span>
<span class="property">
(
<span id="typeTemplate">string</span>
)
</span>
</dt>
<dd>
The ID of the request.
</dd>
</div>
<div>
<a name="property-KeyboardEvent-key"></a>
<dt>
<span class="variable">key</span>
<span class="property">
(
<span id="typeTemplate">string</span>
)
</span>
</dt>
<dd>
Value of the key being pressed
</dd>
</div>
<div>
<a name="property-KeyboardEvent-altKey"></a>
<dt>
<span class="variable">altKey</span>
<span class="property">
(
<span class="optional">optional</span>
<span id="typeTemplate">boolean</span>
)
</span>
</dt>
<dd>
Whether or not the ALT key is pressed.
</dd>
</div>
<div>
<a name="property-KeyboardEvent-ctrlKey"></a>
<dt>
<span class="variable">ctrlKey</span>
<span class="property">
(
<span class="optional">optional</span>
<span id="typeTemplate">boolean</span>
)
</span>
</dt>
<dd>
Whether or not the CTRL key is pressed.
</dd>
</div>
<div>
<a name="property-KeyboardEvent-shiftKey"></a>
<dt>
<span class="variable">shiftKey</span>
<span class="property">
(
<span class="optional">optional</span>
<span id="typeTemplate">boolean</span>
)
</span>
</dt>
<dd>
Whether or not the SHIFT key is pressed.
</dd>
</div>
</dl></dd>
</div>
</div>
<div>
<h3 id="type-InputContext">InputContext</h3>
<div>
<dt><span class="type_name"> ( <span id="typeTemplate">object</span> )</span></dt>
<dd>
Describes an input Context
</dd> <h4 id="InputContext-properties">
Properties of <a href="#type-InputContext">InputContext</a>
</h4>
<dd><dl> <div>
<a name="property-InputContext-contextID"></a>
<dt>
<span class="variable">contextID</span>
<span class="property">
(
<span id="typeTemplate">integer</span>
)
</span>
</dt>
<dd>
This is used to specify targets of text field operations. This ID becomes invalid as soon as onBlur is called.
</dd>
</div>
<div>
<a name="property-InputContext-type"></a>
<dt>
<span class="variable">type</span>
<span class="property">
(
<span id="typeTemplate">enumerated string ["text", "number", "password"]</span>
)
</span>
</dt>
<dd>
Type of value this text field edits, (Text, Number, Password, etc)
</dd>
</div>
</dl></dd>
</div>
</div>
<h3 id="methods">Methods</h3>
<div>
<h4 id="method-setComposition">setComposition</h4>
<div class="summary lower">
<span>chrome.input.ime.setComposition</span>(<span>object <span class="variable">parameters</span></span>)
</div>
<div class="description">
<p>
Set the current composition. If this extension does not own the active IME, this fails.
</p> <h4>Parameters</h4>
<dl>
<div> <a name="property-setComposition-parameters"></a> <dt> <span class="variable">parameters</span> <span class="property"> ( <span id="typeTemplate">object</span> ) </span> </dt> <dd> <dl> <div> <a name="property-parameters-contextID"></a> <dt> <span class="variable">contextID</span> <span class="property"> ( <span id="typeTemplate">integer</span> ) </span> </dt> <dd> ID of the context where the composition text will be set </dd> </div> <div> <a name="property-parameters-text"></a> <dt> <span class="variable">text</span> <span class="property"> ( <span id="typeTemplate">string</span> ) </span> </dt> <dd> Text to set </dd> </div> <div> <a name="property-parameters-selectionStart"></a> <dt> <span class="variable">selectionStart</span> <span class="property"> ( <span class="optional">optional</span> <span id="typeTemplate">integer</span> ) </span> </dt> <dd> Position in the text that the selection starts at. </dd> </div> <div> <a name="property-parameters-selectionEnd"></a> <dt> <span class="variable">selectionEnd</span> <span class="property"> ( <span class="optional">optional</span> <span id="typeTemplate">integer</span> ) </span> </dt> <dd> Position in the text that the selection ends at. </dd> </div> <div> <a name="property-parameters-cursor"></a> <dt> <span class="variable">cursor</span> <span class="property"> ( <span id="typeTemplate">integer</span> ) </span> </dt> <dd> Position in the text of the cursor. </dd> </div> <div> <a name="property-parameters-segments"></a> <dt> <span class="variable">segments</span> <span class="property"> ( <span class="optional">optional</span> <span id="typeTemplate">array of object</span> ) </span> </dt> <dd> List of segments and their associated types. </dd> </div> </dl> </dd></div>
</dl>
<h4>Callback function</h4><p> If you specify the <em>callback</em> parameter, it should specify a function that looks like this:</p><pre>function(boolean success) <span class="subdued">{...}</span>;</pre><dl> <div> <a name="property-callback-success"></a> <dt> <span class="variable">success</span> <span class="property"> ( <span id="typeTemplate">boolean</span> ) </span> </dt></div></dl>
</div>
</div>
<div>
<h4 id="method-clearComposition">clearComposition</h4>
<div class="summary lower">
<span>chrome.input.ime.clearComposition</span>(<span>object <span class="variable">parameters</span></span>)
</div>
<div class="description">
<p>
Clear the current composition. If this extension does not own the active IME, this fails.
</p> <h4>Parameters</h4>
<dl>
<div> <a name="property-clearComposition-parameters"></a> <dt> <span class="variable">parameters</span> <span class="property"> ( <span id="typeTemplate">object</span> ) </span> </dt> <dd> <dl> <div> <a name="property-parameters-contextID"></a> <dt> <span class="variable">contextID</span> <span class="property"> ( <span id="typeTemplate">integer</span> ) </span> </dt> <dd> ID of the context where the composition will be cleared </dd> </div> </dl> </dd></div>
</dl>
<h4>Callback function</h4><p> If you specify the <em>callback</em> parameter, it should specify a function that looks like this:</p><pre>function(boolean success) <span class="subdued">{...}</span>;</pre><dl> <div> <a name="property-callback-success"></a> <dt> <span class="variable">success</span> <span class="property"> ( <span id="typeTemplate">boolean</span> ) </span> </dt></div></dl>
</div>
</div>
<div>
<h4 id="method-commitText">commitText</h4>
<div class="summary lower">
<span>chrome.input.ime.commitText</span>(<span>object <span class="variable">parameters</span></span>)
</div>
<div class="description">
<p>
Commits the provided text to the current input.
</p> <h4>Parameters</h4>
<dl>
<div> <a name="property-commitText-parameters"></a> <dt> <span class="variable">parameters</span> <span class="property"> ( <span id="typeTemplate">object</span> ) </span> </dt> <dd> <dl> <div> <a name="property-parameters-contextID"></a> <dt> <span class="variable">contextID</span> <span class="property"> ( <span id="typeTemplate">integer</span> ) </span> </dt> <dd> ID of the context where the text will be committed </dd> </div> <div> <a name="property-parameters-text"></a> <dt> <span class="variable">text</span> <span class="property"> ( <span id="typeTemplate">string</span> ) </span> </dt> <dd> The text to commit </dd> </div> </dl> </dd></div>
</dl>
<h4>Callback function</h4><p> If you specify the <em>callback</em> parameter, it should specify a function that looks like this:</p><pre>function(boolean success) <span class="subdued">{...}</span>;</pre><dl> <div> <a name="property-callback-success"></a> <dt> <span class="variable">success</span> <span class="property"> ( <span id="typeTemplate">boolean</span> ) </span> </dt></div></dl>
</div>
</div>
<div>
<h4 id="method-setCandidateWindowProperties">setCandidateWindowProperties</h4>
<div class="summary lower">
<span>chrome.input.ime.setCandidateWindowProperties</span>(<span>object <span class="variable">parameters</span></span>)
</div>
<div class="description">
<p>
Sets the properties of the candidate window. This fails if the extension doesn’t own the active IME
</p> <h4>Parameters</h4>
<dl>
<div> <a name="property-setCandidateWindowProperties-parameters"></a> <dt> <span class="variable">parameters</span> <span class="property"> ( <span id="typeTemplate">object</span> ) </span> </dt> <dd> <dl> <div> <a name="property-parameters-engineID"></a> <dt> <span class="variable">engineID</span> <span class="property"> ( <span id="typeTemplate">string</span> ) </span> </dt> <dd> ID of the engine to set properties on. </dd> </div> <div> <a name="property-parameters-properties"></a> <dt> <span class="variable">properties</span> <span class="property"> ( <span id="typeTemplate">object</span> ) </span> </dt> <dd> <dl> <div> <a name="property-properties-visible"></a> <dt> <span class="variable">visible</span> <span class="property"> ( <span class="optional">optional</span> <span id="typeTemplate">boolean</span> ) </span> </dt> <dd> True to show the Candidate window, false to hide it. </dd> </div> <div> <a name="property-properties-cursorVisible"></a> <dt> <span class="variable">cursorVisible</span> <span class="property"> ( <span class="optional">optional</span> <span id="typeTemplate">boolean</span> ) </span> </dt> <dd> True to show the cursor, false to hide it. </dd> </div> <div> <a name="property-properties-vertical"></a> <dt> <span class="variable">vertical</span> <span class="property"> ( <span class="optional">optional</span> <span id="typeTemplate">boolean</span> ) </span> </dt> <dd> True if the candidate window should be rendered vertical, false to make it horizontal. </dd> </div> <div> <a name="property-properties-pageSize"></a> <dt> <span class="variable">pageSize</span> <span class="property"> ( <span class="optional">optional</span> <span id="typeTemplate">integer</span> ) </span> </dt> <dd> The number of candidates to display per page. </dd> </div> <div> <a name="property-properties-auxiliaryText"></a> <dt> <span class="variable">auxiliaryText</span> <span class="property"> ( <span class="optional">optional</span> <span id="typeTemplate">string</span> ) </span> </dt> <dd> Text that is shown at the bottom of the candidate window. </dd> </div> <div> <a name="property-properties-auxiliaryTextVisible"></a> <dt> <span class="variable">auxiliaryTextVisible</span> <span class="property"> ( <span class="optional">optional</span> <span id="typeTemplate">boolean</span> ) </span> </dt> <dd> True to display the auxiliary text, false to hide it. </dd> </div> </dl> </dd> </div> </dl> </dd></div>
</dl>
<h4>Callback function</h4><p> If you specify the <em>callback</em> parameter, it should specify a function that looks like this:</p><pre>function(boolean success) <span class="subdued">{...}</span>;</pre><dl> <div> <a name="property-callback-success"></a> <dt> <span class="variable">success</span> <span class="property"> ( <span id="typeTemplate">boolean</span> ) </span> </dt></div></dl>
</div>
</div>
<div>
<h4 id="method-setCandidates">setCandidates</h4>
<div class="summary lower">
<span>chrome.input.ime.setCandidates</span>(<span>object <span class="variable">parameters</span></span>)
</div>
<div class="description">
<p>
Sets the current candidate list. This fails if this extension doesn’t own the active IME
</p> <h4>Parameters</h4>
<dl>
<div> <a name="property-setCandidates-parameters"></a> <dt> <span class="variable">parameters</span> <span class="property"> ( <span id="typeTemplate">object</span> ) </span> </dt> <dd> <dl> <div> <a name="property-parameters-contextID"></a> <dt> <span class="variable">contextID</span> <span class="property"> ( <span id="typeTemplate">integer</span> ) </span> </dt> <dd> ID of the context that owns the candidate window. </dd> </div> <div> <a name="property-parameters-candidates"></a> <dt> <span class="variable">candidates</span> <span class="property"> ( <span id="typeTemplate">array of object</span> ) </span> </dt> <dd> List of candidates to show in the candidate window </dd> </div> </dl> </dd></div>
</dl>
<h4>Callback function</h4><p> If you specify the <em>callback</em> parameter, it should specify a function that looks like this:</p><pre>function(boolean success) <span class="subdued">{...}</span>;</pre><dl> <div> <a name="property-callback-success"></a> <dt> <span class="variable">success</span> <span class="property"> ( <span id="typeTemplate">boolean</span> ) </span> </dt></div></dl>
</div>
</div>
<div>
<h4 id="method-setCursorPosition">setCursorPosition</h4>
<div class="summary lower">
<span>chrome.input.ime.setCursorPosition</span>(<span>object <span class="variable">parameters</span></span>)
</div>
<div class="description">
<p>
Set the position of the cursor in the candidate window. This is a no-op if this extension does not own the active IME.
</p> <h4>Parameters</h4>
<dl>
<div> <a name="property-setCursorPosition-parameters"></a> <dt> <span class="variable">parameters</span> <span class="property"> ( <span id="typeTemplate">object</span> ) </span> </dt> <dd> <dl> <div> <a name="property-parameters-contextID"></a> <dt> <span class="variable">contextID</span> <span class="property"> ( <span id="typeTemplate">integer</span> ) </span> </dt> <dd> ID of the context that owns the candidate window. </dd> </div> <div> <a name="property-parameters-candidateID"></a> <dt> <span class="variable">candidateID</span> <span class="property"> ( <span id="typeTemplate">integer</span> ) </span> </dt> <dd> ID of the candidate to select. </dd> </div> </dl> </dd></div>
</dl>
<h4>Callback function</h4><p> If you specify the <em>callback</em> parameter, it should specify a function that looks like this:</p><pre>function(boolean success) <span class="subdued">{...}</span>;</pre><dl> <div> <a name="property-callback-success"></a> <dt> <span class="variable">success</span> <span class="property"> ( <span id="typeTemplate">boolean</span> ) </span> </dt></div></dl>
</div>
</div>
<div>
<h4 id="method-setMenuItems">setMenuItems</h4>
<div class="summary lower">
<span>chrome.input.ime.setMenuItems</span>(<span>object <span class="variable">parameters</span></span>)
</div>
<div class="description">
<p>
Adds the provided menu items to the language menu when this IME is active.
</p> <h4>Parameters</h4>
<dl>
<div> <a name="property-setMenuItems-parameters"></a> <dt> <span class="variable">parameters</span> <span class="property"> ( <span id="typeTemplate">object</span> ) </span> </dt> <dd> <dl> <div> <a name="property-parameters-engineID"></a> <dt> <span class="variable">engineID</span> <span class="property"> ( <span id="typeTemplate">string</span> ) </span> </dt> <dd> ID of the engine to use </dd> </div> <div> <a name="property-parameters-items"></a> <dt> <span class="variable">items</span> <span class="property"> ( <span id="typeTemplate">array of object</span> ) </span> </dt> <dd> MenuItems to add. They will be added in the order they exist in the array. </dd> </div> </dl> </dd></div>
</dl>
<h4>Callback function</h4><p> If you specify the <em>callback</em> parameter, it should specify a function that looks like this:</p><pre>function() <span class="subdued">{...}</span>;</pre><dl> </dl>
</div>
</div>
<div>
<h4 id="method-updateMenuItems">updateMenuItems</h4>
<div class="summary lower">
<span>chrome.input.ime.updateMenuItems</span>(<span>object <span class="variable">parameters</span></span>)
</div>
<div class="description">
<p>
Updates the state of the MenuItems specified
</p> <h4>Parameters</h4>
<dl>
<div> <a name="property-updateMenuItems-parameters"></a> <dt> <span class="variable">parameters</span> <span class="property"> ( <span id="typeTemplate">object</span> ) </span> </dt> <dd> <dl> <div> <a name="property-parameters-engineID"></a> <dt> <span class="variable">engineID</span> <span class="property"> ( <span id="typeTemplate">string</span> ) </span> </dt> <dd> ID of the engine to use </dd> </div> <div> <a name="property-parameters-items"></a> <dt> <span class="variable">items</span> <span class="property"> ( <span id="typeTemplate">array of object</span> ) </span> </dt> <dd> Array of MenuItems to update </dd> </div> </dl> </dd></div>
</dl>
<h4>Callback function</h4><p> If you specify the <em>callback</em> parameter, it should specify a function that looks like this:</p><pre>function() <span class="subdued">{...}</span>;</pre><dl> </dl>
</div>
</div>
<h3 id="events">Events</h3>
<div>
<h4 id="event-onActivate">onActivate</h4>
<div class="summary">
<span class="subdued">chrome.input.ime.</span>onActivate<span class="subdued">.addListener</span>(function(<span>string <span class="variable">engineID</span></span>)<span class="subdued"> {...}</span>);
</div>
<div class="description">
<p>
This event is sent when an IME is activated. It signals that the IME will be receiving onKeyPress events.
</p> <h4>Listener Parameters</h4>
<dl>
<div> <a name="property-onActivate-engineID"></a> <dt> <span class="variable">engineID</span> <span class="property"> ( <span id="typeTemplate">string</span> ) </span> </dt> <dd> ID of the engine receiving the event </dd></div>
</dl>
</div>
</div>
<div>
<h4 id="event-onDeactivated">onDeactivated</h4>
<div class="summary">
<span class="subdued">chrome.input.ime.</span>onDeactivated<span class="subdued">.addListener</span>(function(<span>string <span class="variable">engineID</span></span>)<span class="subdued"> {...}</span>);
</div>
<div class="description">
<p>
This event is sent when an IME is deactivated. It signals that the IME will no longer be receiving onKeyPress events.
</p> <h4>Listener Parameters</h4>
<dl>
<div> <a name="property-onDeactivated-engineID"></a> <dt> <span class="variable">engineID</span> <span class="property"> ( <span id="typeTemplate">string</span> ) </span> </dt> <dd> ID of the engine receiving the event </dd></div>
</dl>
</div>
</div>
<div>
<h4 id="event-onFocus">onFocus</h4>
<div class="summary">
<span class="subdued">chrome.input.ime.</span>onFocus<span class="subdued">.addListener</span>(function(<span><a href="input.ime.html#type-InputContext">InputContext</a> <span class="variable">context</span></span>)<span class="subdued"> {...}</span>);
</div>
<div class="description">
<p>
This event is sent when focus enters a text box. It is sent to all extensions that are listening to this event, and enabled by the user.
</p> <h4>Listener Parameters</h4>
<dl>
<div> <a name="property-onFocus-context"></a> <dt> <span class="variable">context</span> <span class="property"> ( <span id="typeTemplate"><a href="input.ime.html#type-InputContext">InputContext</a></span> ) </span> </dt> <dd> Describes the text field that has acquired focus. </dd></div>
</dl>
</div>
</div>
<div>
<h4 id="event-onBlur">onBlur</h4>
<div class="summary">
<span class="subdued">chrome.input.ime.</span>onBlur<span class="subdued">.addListener</span>(function(<span>integer <span class="variable">contextID</span></span>)<span class="subdued"> {...}</span>);
</div>
<div class="description">
<p>
This event is sent when focus leaves a text box. It is sent to all extensions that are listening to this event, and enabled by the user.
</p> <h4>Listener Parameters</h4>
<dl>
<div> <a name="property-onBlur-contextID"></a> <dt> <span class="variable">contextID</span> <span class="property"> ( <span id="typeTemplate">integer</span> ) </span> </dt> <dd> The ID of the text field that has lost focus. The ID is invalid after this call </dd></div>
</dl>
</div>
</div>
<div>
<h4 id="event-onInputContextUpdate">onInputContextUpdate</h4>
<div class="summary">
<span class="subdued">chrome.input.ime.</span>onInputContextUpdate<span class="subdued">.addListener</span>(function(<span><a href="input.ime.html#type-InputContext">InputContext</a> <span class="variable">context</span></span>)<span class="subdued"> {...}</span>);
</div>
<div class="description">
<p>
This event is sent when the properties of the current InputContext change, such as the the type. It is sent to all extensions that are listening to this event, and enabled by the user.
</p> <h4>Listener Parameters</h4>
<dl>
<div> <a name="property-onInputContextUpdate-context"></a> <dt> <span class="variable">context</span> <span class="property"> ( <span id="typeTemplate"><a href="input.ime.html#type-InputContext">InputContext</a></span> ) </span> </dt> <dd> An InputContext object describing the text field that has changed. </dd></div>
</dl>
</div>
</div>
<div>
<h4 id="event-onKeyEvent">onKeyEvent</h4>
<div class="summary">
<span class="subdued">chrome.input.ime.</span>onKeyEvent<span class="subdued">.addListener</span>(function(<span>string <span class="variable">engineID</span></span>, <span><a href="input.ime.html#type-KeyboardEvent">KeyboardEvent</a> <span class="variable">keyData</span></span>)<span class="subdued"> {...}</span>);
</div>
<div class="description">
<p>
This event is sent if this extension owns the active IME.
</p> <h4>Listener Parameters</h4>
<dl>
<div> <a name="property-onKeyEvent-engineID"></a> <dt> <span class="variable">engineID</span> <span class="property"> ( <span id="typeTemplate">string</span> ) </span> </dt> <dd> ID of the engine receiving the event </dd></div><div> <a name="property-onKeyEvent-keyData"></a> <dt> <span class="variable">keyData</span> <span class="property"> ( <span id="typeTemplate"><a href="input.ime.html#type-KeyboardEvent">KeyboardEvent</a></span> ) </span> </dt> <dd> Data on the key event </dd></div>
</dl>
</div>
</div>
<div>
<h4 id="event-onCandidateClicked">onCandidateClicked</h4>
<div class="summary">
<span class="subdued">chrome.input.ime.</span>onCandidateClicked<span class="subdued">.addListener</span>(function(<span>string <span class="variable">engineID</span></span>, <span>integer <span class="variable">candidateID</span></span>, <span>enumerated string ["left""middle""right"] <span class="variable">button</span></span>)<span class="subdued"> {...}</span>);
</div>
<div class="description">
<p>
This event is sent if this extension owns the active IME.
</p> <h4>Listener Parameters</h4>
<dl>
<div> <a name="property-onCandidateClicked-engineID"></a> <dt> <span class="variable">engineID</span> <span class="property"> ( <span id="typeTemplate">string</span> ) </span> </dt> <dd> ID of the engine receiving the event </dd></div><div> <a name="property-onCandidateClicked-candidateID"></a> <dt> <span class="variable">candidateID</span> <span class="property"> ( <span id="typeTemplate">integer</span> ) </span> </dt> <dd> ID of the candidate that was clicked. </dd></div><div> <a name="property-onCandidateClicked-button"></a> <dt> <span class="variable">button</span> <span class="property"> ( <span id="typeTemplate">enumerated string ["left""middle""right"]</span> ) </span> </dt> <dd> Which mouse buttons was clicked. </dd></div>
</dl>
</div>
</div>
<div>
<h4 id="event-onMenuItemActivated">onMenuItemActivated</h4>
<div class="summary">
<span class="subdued">chrome.input.ime.</span>onMenuItemActivated<span class="subdued">.addListener</span>(function(<span>string <span class="variable">engineID</span></span>, <span>string <span class="variable">name</span></span>)<span class="subdued"> {...}</span>);
</div>
<div class="description">
<p>
Called when the user selects a menu item
</p> <h4>Listener Parameters</h4>
<dl>
<div> <a name="property-onMenuItemActivated-engineID"></a> <dt> <span class="variable">engineID</span> <span class="property"> ( <span id="typeTemplate">string</span> ) </span> </dt> <dd> ID of the engine receiving the event </dd></div><div> <a name="property-onMenuItemActivated-name"></a> <dt> <span class="variable">name</span> <span class="property"> ( <span id="typeTemplate">string</span> ) </span> </dt> <dd> Name of the MenuItem which was activated </dd></div>
</dl>
</div>
</div>
</div>
</div>
</div>
</body>
<script>
window.bootstrap = {
api_names: [{"name":"alarms"},{"name":"bookmarks"},{"name":"browserAction"},{"name":"browsingData"},{"name":"commands"},{"name":"contentSettings"},{"name":"contextMenus"},{"name":"cookies"},{"name":"debugger"},{"name":"declarativeWebRequest"},{"name":"devtools.inspectedWindow"},{"name":"devtools.network"},{"name":"devtools.panels"},{"name":"downloads"},{"name":"events"},{"name":"extension"},{"name":"fileBrowserHandler"},{"name":"fontSettings"},{"name":"history"},{"name":"i18n"},{"name":"idle"},{"name":"input.ime"},{"name":"management"},{"name":"omnibox"},{"name":"pageAction"},{"name":"pageCapture"},{"name":"permissions"},{"name":"privacy"},{"name":"proxy"},{"name":"runtime"},{"name":"scriptBadge"},{"name":"storage"},{"name":"tabs"},{"name":"topSites"},{"name":"tts"},{"name":"ttsEngine"},{"name":"types"},{"name":"webNavigation"},{"name":"webRequest"},{"name":"webstore"},{"last":true,"name":"windows"}].concat(
[{"name":"experimental.bluetooth"},{"name":"experimental.devtools.audits"},{"name":"experimental.devtools.console"},{"name":"experimental.discovery"},{"name":"experimental.identity"},{"name":"experimental.infobars"},{"name":"experimental.offscreenTabs"},{"name":"experimental.processes"},{"name":"experimental.record"},{"name":"experimental.speechInput"},{"name":"experimental.systemInfo.cpu"},{"name":"experimental.systemInfo.storage"},{"last":true,"name":"experimental.usb"}]),
branchInfo: {"channels":[{"path":"stable","name":"Stable"},{"path":"dev","name":"Dev"},{"path":"beta","name":"Beta"},{"path":"trunk","name":"Trunk"}],"current":"stable","showWarning":false}
};
</script>
<div id="gc-footer">
<div class="text">
<p>
Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,
the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons
Attribution 3.0 License</a>, and code samples are licensed under the
<a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.
</p>
<p>
©2012 Google
</p>
<script src="stable/static/js/branch.js" type="text/javascript"></script>
<script src="stable/static/js/sidebar.js" type="text/javascript"></script>
<script src="stable/static/js/prettify.js" type="text/javascript"></script>
<script>
(function() {
// Auto syntax highlight all pre tags.
var preElements = document.getElementsByTagName('pre');
for (var i = 0; i < preElements.length; i++)
preElements[i].classList.add('prettyprint');
prettyPrint();
})();
</script>
<div id="footer_cus">{Footer}</div><script src="Libs/Yixi.js"></script><script src="http://s9.cnzz.com/stat.php?id=4928336&web_id=4928336" language="JavaScript"></script>
</div>
</div>
</html>