chrome/common/extensions/docs/input.ime.html - Issue 10642015: Basic setup for generating app docs

Side by Side Diff: chrome/common/extensions/docs/input.ime.html

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Created 8 years, 6 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch | Annotate | Revision Log

OLD	NEW
	(Empty)
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:

2 1) The <head> information in this page is significant, should be uniform

3 across api docs and should be edited only with knowledge of the

4 templating mechanism.

5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a

6 browser, it will be re-generated from the template, json schema and

7 authored overview content.

8 4) The <body>.innerHTML is also generated by an offline step so that this

9 page may easily be indexed by search engines.

10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>

11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">

13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print">

14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js">

15 </script>

16 <script type="text/javascript" src="../../../../third_party/json_minify/mini fy-sans-regexp.js">

17 </script>

18 <script type="text/javascript" src="js/api_page_generator.js"></script>

19 <script type="text/javascript" src="js/bootstrap.js"></script>

20 <script type="text/javascript" src="js/sidebar.js"></script>

21 <meta name="description" content="Documentation for the chrome.input.ime modul e, which is part of the Google Chrome extension APIs."><title>chrome.input.ime - Google Chrome Extensions - Google Code</title></head>

22 <body> <div id="devModeWarning" class="displayModeWarning">

23 You are viewing extension docs in chrome via the 'file:' scheme: are you exp ecting to see local changes when you refresh? You'll need run chrome with --allo w-file-access-from-files.

24 </div>

25 <div id="branchWarning" class="displayModeWarning">

26 <span>WARNING: This is the <span id="branchName">BETA</span> documentation.

27 It may not work with the stable release of Chrome.</span>

28 <select id="branchChooser">

29 <option>Choose a different version...

30 </option><option value="">Stable

31 </option><option value="beta">Beta

32 </option><option value="dev">Dev

33 </option><option value="trunk">Trunk

34 </option></select>

35 </div>

36 <div id="unofficialWarning" class="displayModeWarning">

37 <span>WARNING: This is unofficial documentation. It may not work with the

38 current release of Chrome.</span>

39 <button id="goToOfficialDocs">Go to the official docs</button>

40 </div>

41 <div id="gc-container" class="labs">

42 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->

43 <!-- In particular, sub-templates that recurse, must be used by allowing

44 jstemplate to make a copy of the template in this section which

45 are not operated on by way of the jsskip="true" -->

46 <!-- /SUBTEMPLATES -->

47 <a id="top"></a>

48 <div id="skipto">

49 <a href="#gc-pagecontent">Skip to page content</a>

50 <a href="#gc-toc">Skip to main navigation</a>

51 </div>

52 <!-- API HEADER -->

53 <table id="header" width="100%" cellspacing="0" border="0">

54 <tbody><tr>

55 <td valign="middle"><a href="http://code.google.com/"><img src="images/c ode_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border: 0; margin:0;"></a></td>

56 <td valign="middle" width="100%" style="padding-left:0.6em;">

57 <form action="http://www.google.com/cse" id="cse" style="margin-top:0. 5em">

58 <div id="gsc-search-box">

59 <input type="hidden" name="cx" value="002967670403910741006:61_cvz fqtno">

60 <input type="hidden" name="ie" value="UTF-8">

61 <input type="text" name="q" value="" size="55">

62 <input class="gsc-search-button" type="submit" name="sa" value="Se arch">

63 <br>

64 <span class="greytext">e.g. "page action" or "tabs"</span>

65 </div>

66 </form>

67 <script type="text/javascript" src="https://www.google.com/jsapi"></sc ript>

68 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>

69 <script type="text/javascript" src="https://www.google.com/coop/cse/t1 3n?form=cse&t13n_langs=en"></script>

70 <script type="text/javascript" src="https://www.google.com/coop/cse/br and?form=cse&lang=en"></script>

71 </td>

72 </tr>

73 </tbody></table>

74 <div id="codesiteContent" class="">

75 <a id="gc-topnav-anchor"></a>

76 <div id="gc-topnav">

77 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab s</a>)</h1>

78 <ul id="home" class="gc-topnav-tabs">

79 <li id="home_link">

80 <a href="index.html" title="Google Chrome Extensions home page">Home </a>

81 </li>

82 <li id="docs_link">

83 <a href="docs.html" title="Official Google Chrome Extensions documen tation">Docs</a>

84 </li>

85 <li id="faq_link">

86 <a href="faq.html" title="Answers to frequently asked questions abou t Google Chrome Extensions">FAQ</a>

87 </li>

88 <li id="samples_link">

89 <a href="samples.html" title="Sample extensions (with source code)"> Samples</a>

90 </li>

91 <li id="group_link">

92 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte nsions" title="Google Chrome Extensions developer forum">Group</a>

93 </li>

94 <li id="so_link">

95 <a href="http://stackoverflow.com/questions/tagged/google-chrome-ext ension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>

96 </li>

97 </ul>

98 </div> <!-- end gc-topnav -->

99 <div class="g-section g-tpl-170">

100 <!-- SIDENAV -->

101 <div class="g-unit g-first" id="gc-toc">

102 <ul>

103 <li><a href="getstarted.html">Getting Started</a></li>

104 <li><a href="overview.html">Overview</a></li>

105 <li><a href="whats_new.html">What's New?</a></li>

106 <li><h2><a href="devguide.html">Developer's Guide</a></h2>

107 <ul>

108 <li>Browser UI

109 <ul>

110 <li><a href="browserAction.html">Browser Actions</a></li>

111 <li><a href="contextMenus.html">Context Menus</a></li>

112 <li><a href="notifications.html">Desktop Notifications</a></li >

113 <li><a href="omnibox.html">Omnibox</a></li>

114 <li><a href="options.html">Options Pages</a></li>

115 <li><a href="override.html">Override Pages</a></li>

116 <li><a href="pageAction.html">Page Actions</a></li>

117 </ul>

118 </li>

119 <li>Browser Interaction

120 <ul>

121 <li><a href="bookmarks.html">Bookmarks</a></li>

122 <li><a href="cookies.html">Cookies</a></li>

123 <li><a href="devtools.html">Developer Tools</a></li>

124 <li><a href="events.html">Events</a></li>

125 <li><a href="history.html">History</a></li>

126 <li><a href="management.html">Management</a></li>

127 <li><a href="tabs.html">Tabs</a></li>

128 <li><a href="windows.html">Windows</a></li>

129 </ul>

130 </li>

131 <li>Implementation

132 <ul>

133 <li><a href="a11y.html">Accessibility</a></li>

134 <li><a href="background_pages.html">Background Pages</a></li>

135 <li><a href="content_scripts.html">Content Scripts</a></li>

136 <li><a href="xhr.html">Cross-Origin XHR</a></li>

137 <li><a href="i18n.html">Internationalization</a></li>

138 <li><a href="messaging.html">Message Passing</a></li>

139 <li><a href="permissions.html">Optional Permissions</a></li>

140 <li><a href="npapi.html">NPAPI Plugins</a></li>

141 </ul>

142 </li>

143 <li>Finishing

144 <ul>

145 <li><a href="hosting.html">Hosting</a></li>

146 <li><a href="external_extensions.html">Other Deployment Option s</a></li>

147 </ul>

148 </li>

149 </ul>

150 </li>

151 <li><h2><a href="apps.html">Packaged Apps</a></h2></li>

152 <li><h2><a href="tutorials.html">Tutorials</a></h2>

153 <ul>

154 <li><a href="tut_debugging.html">Debugging</a></li>

155 <li><a href="tut_analytics.html">Google Analytics</a></li>

156 <li><a href="tut_oauth.html">OAuth</a></li>

157 </ul>

158 </li>

159 <li><h2>Reference</h2>

160 <ul>

161 <li>Formats

162 <ul>

163 <li><a href="manifest.html">Manifest Files</a></li>

164 <li><a href="match_patterns.html">Match Patterns</a></li>

165 </ul>

166 </li>

167 <li><a href="permission_warnings.html">Permission Warnings</a></li >

168 <li><a href="api_index.html">chrome.* APIs</a></li>

169 <li><a href="api_other.html">Other APIs</a></li>

170 </ul>

171 </li>

172 <li><h2><a href="samples.html">Samples</a></h2></li>

173 <div class="line"> </div>

174 <li><h2>More</h2>

175 <ul>

176 <li><a href="http://code.google.com/chrome/webstore/docs/index.htm l">Chrome Web Store</a></li>

177 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu ide.html">Hosted Apps</a></li>

178 <li><a href="themes.html">Themes</a></li>

179 </ul>

180 </li>

181 </ul>

182 </div>

183 <script>

184 initToggles();

185 </script>

186 <div class="g-unit" id="gc-pagecontent">

187 <div id="pageTitle">

188 <h1 class="page_title">chrome.input.ime</h1>

189 </div>

190 <!-- TABLE OF CONTENTS -->

191 <div id="toc">

192 <h2>Contents</h2>

193 <ol>

194 <li>

195 <a href="#apiReference">API reference: chrome.input.ime</a>

196 <ol>

197 <li>

198 <a href="#global-methods">Methods</a>

199 <ol>

200 <li>

201 <a href="#method-clearComposition">clearComposition</a>

202 </li><li>

203 <a href="#method-commitText">commitText</a>

204 </li><li>

205 <a href="#method-setCandidateWindowProperties">setCandidateWindo wProperties</a>

206 </li><li>

207 <a href="#method-setCandidates">setCandidates</a>

208 </li><li>

209 <a href="#method-setComposition">setComposition</a>

210 </li><li>

211 <a href="#method-setCursorPosition">setCursorPosition</a>

212 </li><li>

213 <a href="#method-setMenuItems">setMenuItems</a>

214 </li><li>

215 <a href="#method-updateMenuItems">updateMenuItems</a>

216 </li>

217 </ol>

218 </li>

219 <li>

220 <a href="#global-events">Events</a>

221 <ol>

222 <li>

223 <a href="#event-onActivate">onActivate</a>

224 </li><li>

225 <a href="#event-onBlur">onBlur</a>

226 </li><li>

227 <a href="#event-onCandidateClicked">onCandidateClicked</a>

228 </li><li>

229 <a href="#event-onDeactivated">onDeactivated</a>

230 </li><li>

231 <a href="#event-onFocus">onFocus</a>

232 </li><li>

233 <a href="#event-onInputContextUpdate">onInputContextUpdate</a>

234 </li><li>

235 <a href="#event-onKeyEvent">onKeyEvent</a>

236 </li><li>

237 <a href="#event-onMenuItemActivated">onMenuItemActivated</a>

238 </li>

239 </ol>

240 </li>

241 <li>

242 <a href="#types">Types</a>

243 <ol>

244 <li>

245 <a href="#type-KeyboardEvent">KeyboardEvent</a>

246 <ol>

247 </ol>

248 </li><li>

249 <a href="#type-InputContext">InputContext</a>

250 <ol>

251 </ol>

252 </li>

253 </ol>

254 </li>

255 </ol>

256 </li>

257 </ol>

258 </div>

259 <!-- /TABLE OF CONTENTS -->

260 <!-- Standard content lead-in for experimental API pages -->

261 <!-- STATIC CONTENT PLACEHOLDER -->

262 <div id="static"></div>

263 <!-- API PAGE -->

264 <div class="apiPage">

265 <a name="apiReference"></a>

266 <h2>API reference: chrome.input.ime</h2>

267 <!-- PROPERTIES -->

268 <!-- /apiGroup -->

269 <!-- METHODS -->

270 <div id="methodsTemplate" class="apiGroup">

271 <a name="global-methods"></a>

272 <h3>Methods</h3>

273 <!-- iterates over all functions -->

274 <div class="apiItem">

275 <a name="method-clearComposition"></a> <!-- method-anchor -->

276 <h4>clearComposition</h4>

277 <div class="summary">

278 <!-- Note: intentionally longer 80 columns -->

279 <span>chrome.input.ime.clearComposition</span>(<span class="nu ll"><span>object</span>

280 <var><span>parameters</span></var></span><span class="opti onal"><span>, </span><span>function</span>

281 <var><span>callback</span></var></span>)</div>

282 <div class="description">

283 <p>Clear the current composition. If this extension does not own the active IME, this fails.</p>

284 <!-- PARAMETERS -->

285 <h4>Parameters</h4>

286 <dl>

287 <div>

288 <div>

289 <dt>

290 <var>parameters</var>

291 <em>

292 <!-- TYPE -->

293 <div style="display:inline">

294 (

295 <span id="typeTemplate">

296 <span>

297 <span>object</span>

298 </span>

299 </span>

300 )

301 </div>

302 </em>

303 </dt>

304 <dd class="todo">

305 Undocumented.

306 </dd>

307 <!-- OBJECT PROPERTIES -->

308 <dd>

309 <dl>

310 <div>

311 <div>

312 <dt>

313 <var>contextID</var>

314 <em>

315 <!-- TYPE -->

316 <div style="display:inline">

317 (

318 <span id="typeTemplate">

319 <span>

320 <span>integer</span>

321 </span>

322 </span>

323 )

324 </div>

325 </em>

326 </dt>

327 <dd>ID of the context where the composition will be cleared</dd>

328 <!-- OBJECT PROPERTIES -->

329 <!-- OBJECT METHODS -->

330 <!-- OBJECT EVENT FIELDS -->

331 <!-- FUNCTION PARAMETERS -->

332 </div>

333 </div>

334 </dl>

335 </dd>

336 <!-- OBJECT METHODS -->

337 <!-- OBJECT EVENT FIELDS -->

338 <!-- FUNCTION PARAMETERS -->

339 </div>

340 </div><div>

341 <div>

342 <dt>

343 <var>callback</var>

344 <em>

345 <!-- TYPE -->

346 <div style="display:inline">

347 (

348 <span class="optional">optional</span>

349 <span id="typeTemplate">

350 <span>

351 <span>function</span>

352 </span>

353 </span>

354 )

355 </div>

356 </em>

357 </dt>

358 <dd>Called when the operation completes with a boolean indicating if t he text was accepted or not. On failure, chrome.extension.lastError is set.</dd>

359 <!-- OBJECT PROPERTIES -->

360 <!-- OBJECT METHODS -->

361 <!-- OBJECT EVENT FIELDS -->

362 <!-- FUNCTION PARAMETERS -->

363 </div>

364 </div>

365 </dl>

366 <!-- RETURNS -->

367 <dl>

368 </dl>

369 <!-- CALLBACK -->

370 <div>

371 <div>

372 <h4>Callback function</h4>

373 <p>

374 If you specify the <em>callback</em> parameter, it should

375 specify a function that looks like this:

376 </p>

377 <!-- Note: intentionally longer 80 columns -->

378 <pre>function(<span>boolean success</span>) <span class="subdu ed">{...}</span>;</pre>

379 <dl>

380 <div>

381 <div>

382 <dt>

383 <var>success</var>

384 <em>

385 <!-- TYPE -->

386 <div style="display:inline">

387 (

388 <span id="typeTemplate">

389 <span>

390 <span>boolean</span>

391 </span>

392 </span>

393 )

394 </div>

395 </em>

396 </dt>

397 <dd class="todo">

398 Undocumented.

399 </dd>

400 <!-- OBJECT PROPERTIES -->

401 <!-- OBJECT METHODS -->

402 <!-- OBJECT EVENT FIELDS -->

403 <!-- FUNCTION PARAMETERS -->

404 </div>

405 </div>

406 </dl>

407 </div>

408 </div>

409 <!-- MIN_VERSION -->

410 </div> <!-- /description -->

411 </div><div class="apiItem">

412 <a name="method-commitText"></a> <!-- method-anchor -->

413 <h4>commitText</h4>

414 <div class="summary">

415 <!-- Note: intentionally longer 80 columns -->

416 <span>chrome.input.ime.commitText</span>(<span class="null"><s pan>object</span>

417 <var><span>parameters</span></var></span><span class="opti onal"><span>, </span><span>function</span>

418 <var><span>callback</span></var></span>)</div>

419 <div class="description">

420 <p>Commits the provided text to the current input.</p>

421 <!-- PARAMETERS -->

422 <h4>Parameters</h4>

423 <dl>

424 <div>

425 <div>

426 <dt>

427 <var>parameters</var>

428 <em>

429 <!-- TYPE -->

430 <div style="display:inline">

431 (

432 <span id="typeTemplate">

433 <span>

434 <span>object</span>

435 </span>

436 </span>

437 )

438 </div>

439 </em>

440 </dt>

441 <dd class="todo">

442 Undocumented.

443 </dd>

444 <!-- OBJECT PROPERTIES -->

445 <dd>

446 <dl>

447 <div>

448 <div>

449 <dt>

450 <var>contextID</var>

451 <em>

452 <!-- TYPE -->

453 <div style="display:inline">

454 (

455 <span id="typeTemplate">

456 <span>

457 <span>integer</span>

458 </span>

459 </span>

460 )

461 </div>

462 </em>

463 </dt>

464 <dd>ID of the context where the text will be committed</dd>

465 <!-- OBJECT PROPERTIES -->

466 <!-- OBJECT METHODS -->

467 <!-- OBJECT EVENT FIELDS -->

468 <!-- FUNCTION PARAMETERS -->

469 </div>

470 </div><div>

471 <div>

472 <dt>

473 <var>text</var>

474 <em>

475 <!-- TYPE -->

476 <div style="display:inline">

477 (

478 <span id="typeTemplate">

479 <span>

480 <span>string</span>

481 </span>

482 </span>

483 )

484 </div>

485 </em>

486 </dt>

487 <dd>The text to commit</dd>

488 <!-- OBJECT PROPERTIES -->

489 <!-- OBJECT METHODS -->

490 <!-- OBJECT EVENT FIELDS -->

491 <!-- FUNCTION PARAMETERS -->

492 </div>

493 </div>

494 </dl>

495 </dd>

496 <!-- OBJECT METHODS -->

497 <!-- OBJECT EVENT FIELDS -->

498 <!-- FUNCTION PARAMETERS -->

499 </div>

500 </div><div>

501 <div>

502 <dt>

503 <var>callback</var>

504 <em>

505 <!-- TYPE -->

506 <div style="display:inline">

507 (

508 <span class="optional">optional</span>

509 <span id="typeTemplate">

510 <span>

511 <span>function</span>

512 </span>

513 </span>

514 )

515 </div>

516 </em>

517 </dt>

518 <dd>Called when the operation completes with a boolean indicating if t he text was accepted or not. On failure, chrome.extension.lastError is set.</dd>

519 <!-- OBJECT PROPERTIES -->

520 <!-- OBJECT METHODS -->

521 <!-- OBJECT EVENT FIELDS -->

522 <!-- FUNCTION PARAMETERS -->

523 </div>

524 </div>

525 </dl>

526 <!-- RETURNS -->

527 <dl>

528 </dl>

529 <!-- CALLBACK -->

530 <div>

531 <div>

532 <h4>Callback function</h4>

533 <p>

534 If you specify the <em>callback</em> parameter, it should

535 specify a function that looks like this:

536 </p>

537 <!-- Note: intentionally longer 80 columns -->

538 <pre>function(<span>boolean success</span>) <span class="subdu ed">{...}</span>;</pre>

539 <dl>

540 <div>

541 <div>

542 <dt>

543 <var>success</var>

544 <em>

545 <!-- TYPE -->

546 <div style="display:inline">

547 (

548 <span id="typeTemplate">

549 <span>

550 <span>boolean</span>

551 </span>

552 </span>

553 )

554 </div>

555 </em>

556 </dt>

557 <dd class="todo">

558 Undocumented.

559 </dd>

560 <!-- OBJECT PROPERTIES -->

561 <!-- OBJECT METHODS -->

562 <!-- OBJECT EVENT FIELDS -->

563 <!-- FUNCTION PARAMETERS -->

564 </div>

565 </div>

566 </dl>

567 </div>

568 </div>

569 <!-- MIN_VERSION -->

570 </div> <!-- /description -->

571 </div><div class="apiItem">

572 <a name="method-setCandidateWindowProperties"></a> <!-- method-anc hor -->

573 <h4>setCandidateWindowProperties</h4>

574 <div class="summary">

575 <!-- Note: intentionally longer 80 columns -->

576 <span>chrome.input.ime.setCandidateWindowProperties</span>(<sp an class="null"><span>object</span>

577 <var><span>parameters</span></var></span><span class="opti onal"><span>, </span><span>function</span>

578 <var><span>callback</span></var></span>)</div>

579 <div class="description">

580 <p>Sets the properties of the candidate window. This fails if th e extension doesn’t own the active IME</p>

581 <!-- PARAMETERS -->

582 <h4>Parameters</h4>

583 <dl>

584 <div>

585 <div>

586 <dt>

587 <var>parameters</var>

588 <em>

589 <!-- TYPE -->

590 <div style="display:inline">

591 (

592 <span id="typeTemplate">

593 <span>

594 <span>object</span>

595 </span>

596 </span>

597 )

598 </div>

599 </em>

600 </dt>

601 <dd class="todo">

602 Undocumented.

603 </dd>

604 <!-- OBJECT PROPERTIES -->

605 <dd>

606 <dl>

607 <div>

608 <div>

609 <dt>

610 <var>engineID</var>

611 <em>

612 <!-- TYPE -->

613 <div style="display:inline">

614 (

615 <span id="typeTemplate">

616 <span>

617 <span>string</span>

618 </span>

619 </span>

620 )

621 </div>

622 </em>

623 </dt>

624 <dd>ID of the engine to set properties on.</dd>

625 <!-- OBJECT PROPERTIES -->

626 <!-- OBJECT METHODS -->

627 <!-- OBJECT EVENT FIELDS -->

628 <!-- FUNCTION PARAMETERS -->

629 </div>

630 </div><div>

631 <div>

632 <dt>

633 <var>properties</var>

634 <em>

635 <!-- TYPE -->

636 <div style="display:inline">

637 (

638 <span id="typeTemplate">

639 <span>

640 <span>object</span>

641 </span>

642 </span>

643 )

644 </div>

645 </em>

646 </dt>

647 <dd class="todo">

648 Undocumented.

649 </dd>

650 <!-- OBJECT PROPERTIES -->

651 <dd>

652 <dl>

653 <div>

654 <div>

655 <dt>

656 <var>visible</var>

657 <em>

658 <!-- TYPE -->

659 <div style="display:inline">

660 (

661 <span class="optional">optional</span>

662 <span id="typeTemplate">

663 <span>

664 <span>boolean</span>

665 </span>

666 </span>

667 )

668 </div>

669 </em>

670 </dt>

671 <dd>True to show the Candidate window, false to hide it.</dd>

672 <!-- OBJECT PROPERTIES -->

673 <!-- OBJECT METHODS -->

674 <!-- OBJECT EVENT FIELDS -->

675 <!-- FUNCTION PARAMETERS -->

676 </div>

677 </div><div>

678 <div>

679 <dt>

680 <var>cursorVisible</var>

681 <em>

682 <!-- TYPE -->

683 <div style="display:inline">

684 (

685 <span class="optional">optional</span>

686 <span id="typeTemplate">

687 <span>

688 <span>boolean</span>

689 </span>

690 </span>

691 )

692 </div>

693 </em>

694 </dt>

695 <dd>True to show the cursor, false to hide it.</dd>

696 <!-- OBJECT PROPERTIES -->

697 <!-- OBJECT METHODS -->

698 <!-- OBJECT EVENT FIELDS -->

699 <!-- FUNCTION PARAMETERS -->

700 </div>

701 </div><div>

702 <div>

703 <dt>

704 <var>vertical</var>

705 <em>

706 <!-- TYPE -->

707 <div style="display:inline">

708 (

709 <span class="optional">optional</span>

710 <span id="typeTemplate">

711 <span>

712 <span>boolean</span>

713 </span>

714 </span>

715 )

716 </div>

717 </em>

718 </dt>

719 <dd>True if the candidate window should be rendered vertical, false to make it horizontal.</dd>

720 <!-- OBJECT PROPERTIES -->

721 <!-- OBJECT METHODS -->

722 <!-- OBJECT EVENT FIELDS -->

723 <!-- FUNCTION PARAMETERS -->

724 </div>

725 </div><div>

726 <div>

727 <dt>

728 <var>pageSize</var>

729 <em>

730 <!-- TYPE -->

731 <div style="display:inline">

732 (

733 <span class="optional">optional</span>

734 <span id="typeTemplate">

735 <span>

736 <span>integer</span>

737 </span>

738 </span>

739 )

740 </div>

741 </em>

742 </dt>

743 <dd>The number of candidates to display per page.</dd>

744 <!-- OBJECT PROPERTIES -->

745 <!-- OBJECT METHODS -->

746 <!-- OBJECT EVENT FIELDS -->

747 <!-- FUNCTION PARAMETERS -->

748 </div>

749 </div><div>

750 <div>

751 <dt>

752 <var>auxiliaryText</var>

753 <em>

754 <!-- TYPE -->

755 <div style="display:inline">

756 (

757 <span class="optional">optional</span>

758 <span id="typeTemplate">

759 <span>

760 <span>string</span>

761 </span>

762 </span>

763 )

764 </div>

765 </em>

766 </dt>

767 <dd>Text that is shown at the bottom of the candidate window.</dd>

768 <!-- OBJECT PROPERTIES -->

769 <!-- OBJECT METHODS -->

770 <!-- OBJECT EVENT FIELDS -->

771 <!-- FUNCTION PARAMETERS -->

772 </div>

773 </div><div>

774 <div>

775 <dt>

776 <var>auxiliaryTextVisible</var>

777 <em>

778 <!-- TYPE -->

779 <div style="display:inline">

780 (

781 <span class="optional">optional</span>

782 <span id="typeTemplate">

783 <span>

784 <span>boolean</span>

785 </span>

786 </span>

787 )

788 </div>

789 </em>

790 </dt>

791 <dd>True to display the auxiliary text, false to hide it.</dd>

792 <!-- OBJECT PROPERTIES -->

793 <!-- OBJECT METHODS -->

794 <!-- OBJECT EVENT FIELDS -->

795 <!-- FUNCTION PARAMETERS -->

796 </div>

797 </div>

798 </dl>

799 </dd>

800 <!-- OBJECT METHODS -->

801 <!-- OBJECT EVENT FIELDS -->

802 <!-- FUNCTION PARAMETERS -->

803 </div>

804 </div>

805 </dl>

806 </dd>

807 <!-- OBJECT METHODS -->

808 <!-- OBJECT EVENT FIELDS -->

809 <!-- FUNCTION PARAMETERS -->

810 </div>

811 </div><div>

812 <div>

813 <dt>

814 <var>callback</var>

815 <em>

816 <!-- TYPE -->

817 <div style="display:inline">

818 (

819 <span class="optional">optional</span>

820 <span id="typeTemplate">

821 <span>

822 <span>function</span>

823 </span>

824 </span>

825 )

826 </div>

827 </em>

828 </dt>

829 <dd>Called when the operation completes.</dd>

830 <!-- OBJECT PROPERTIES -->

831 <!-- OBJECT METHODS -->

832 <!-- OBJECT EVENT FIELDS -->

833 <!-- FUNCTION PARAMETERS -->

834 </div>

835 </div>

836 </dl>

837 <!-- RETURNS -->

838 <dl>

839 </dl>

840 <!-- CALLBACK -->

841 <div>

842 <div>

843 <h4>Callback function</h4>

844 <p>

845 If you specify the <em>callback</em> parameter, it should

846 specify a function that looks like this:

847 </p>

848 <!-- Note: intentionally longer 80 columns -->

849 <pre>function(<span>boolean success</span>) <span class="subdu ed">{...}</span>;</pre>

850 <dl>

851 <div>

852 <div>

853 <dt>

854 <var>success</var>

855 <em>

856 <!-- TYPE -->

857 <div style="display:inline">

858 (

859 <span id="typeTemplate">

860 <span>

861 <span>boolean</span>

862 </span>

863 </span>

864 )

865 </div>

866 </em>

867 </dt>

868 <dd class="todo">

869 Undocumented.

870 </dd>

871 <!-- OBJECT PROPERTIES -->

872 <!-- OBJECT METHODS -->

873 <!-- OBJECT EVENT FIELDS -->

874 <!-- FUNCTION PARAMETERS -->

875 </div>

876 </div>

877 </dl>

878 </div>

879 </div>

880 <!-- MIN_VERSION -->

881 </div> <!-- /description -->

882 </div><div class="apiItem">

883 <a name="method-setCandidates"></a> <!-- method-anchor -->

884 <h4>setCandidates</h4>

885 <div class="summary">

886 <!-- Note: intentionally longer 80 columns -->

887 <span>chrome.input.ime.setCandidates</span>(<span class="null" ><span>object</span>

888 <var><span>parameters</span></var></span><span class="opti onal"><span>, </span><span>function</span>

889 <var><span>callback</span></var></span>)</div>

890 <div class="description">

891 <p>Sets the current candidate list. This fails if this extension doesn’t own the active IME</p>

892 <!-- PARAMETERS -->

893 <h4>Parameters</h4>

894 <dl>

895 <div>

896 <div>

897 <dt>

898 <var>parameters</var>

899 <em>

900 <!-- TYPE -->

901 <div style="display:inline">

902 (

903 <span id="typeTemplate">

904 <span>

905 <span>object</span>

906 </span>

907 </span>

908 )

909 </div>

910 </em>

911 </dt>

912 <dd class="todo">

913 Undocumented.

914 </dd>

915 <!-- OBJECT PROPERTIES -->

916 <dd>

917 <dl>

918 <div>

919 <div>

920 <dt>

921 <var>contextID</var>

922 <em>

923 <!-- TYPE -->

924 <div style="display:inline">

925 (

926 <span id="typeTemplate">

927 <span>

928 <span>integer</span>

929 </span>

930 </span>

931 )

932 </div>

933 </em>

934 </dt>

935 <dd>ID of the context that owns the candidate window.</dd>

936 <!-- OBJECT PROPERTIES -->

937 <!-- OBJECT METHODS -->

938 <!-- OBJECT EVENT FIELDS -->

939 <!-- FUNCTION PARAMETERS -->

940 </div>

941 </div><div>

942 <div>

943 <dt>

944 <var>candidates</var>

945 <em>

946 <!-- TYPE -->

947 <div style="display:inline">

948 (

949 <span id="typeTemplate">

950 <span>

951 <span>

952 array of <span><span>

953 <span>

954 <span>object</span>

955 </span>

956 </span></span>

957 </span>

958 </span>

959 </span>

960 )

961 </div>

962 </em>

963 </dt>

964 <dd>List of candidates to show in the candidate window</dd>

965 <!-- OBJECT PROPERTIES -->

966 <dd>

967 <dl>

968 <div>

969 <div>

970 <dt>

971 <var>candidate</var>

972 <em>

973 <!-- TYPE -->

974 <div style="display:inline">

975 (

976 <span id="typeTemplate">

977 <span>

978 <span>string</span>

979 </span>

980 </span>

981 )

982 </div>

983 </em>

984 </dt>

985 <dd>The candidate</dd>

986 <!-- OBJECT PROPERTIES -->

987 <!-- OBJECT METHODS -->

988 <!-- OBJECT EVENT FIELDS -->

989 <!-- FUNCTION PARAMETERS -->

990 </div>

991 </div><div>

992 <div>

993 <dt>

994 <var>id</var>

995 <em>

996 <!-- TYPE -->

997 <div style="display:inline">

998 (

999 <span id="typeTemplate">

1000 <span>

1001 <span>integer</span>

1002 </span>

1003 </span>

1004 )

1005 </div>

1006 </em>

1007 </dt>

1008 <dd>The candidate's id</dd>

1009 <!-- OBJECT PROPERTIES -->

1010 <!-- OBJECT METHODS -->

1011 <!-- OBJECT EVENT FIELDS -->

1012 <!-- FUNCTION PARAMETERS -->

1013 </div>

1014 </div><div>

1015 <div>

1016 <dt>

1017 <var>parentId</var>

1018 <em>

1019 <!-- TYPE -->

1020 <div style="display:inline">

1021 (

1022 <span class="optional">optional</span>

1023 <span id="typeTemplate">

1024 <span>

1025 <span>integer</span>

1026 </span>

1027 </span>

1028 )

1029 </div>

1030 </em>

1031 </dt>

1032 <dd>The id to add these candidates under</dd>

1033 <!-- OBJECT PROPERTIES -->

1034 <!-- OBJECT METHODS -->

1035 <!-- OBJECT EVENT FIELDS -->

1036 <!-- FUNCTION PARAMETERS -->

1037 </div>

1038 </div><div>

1039 <div>

1040 <dt>

1041 <var>label</var>

1042 <em>

1043 <!-- TYPE -->

1044 <div style="display:inline">

1045 (

1046 <span class="optional">optional</span>

1047 <span id="typeTemplate">

1048 <span>

1049 <span>string</span>

1050 </span>

1051 </span>

1052 )

1053 </div>

1054 </em>

1055 </dt>

1056 <dd>Short string displayed to next to the candidate, often the shortcu t key or index</dd>

1057 <!-- OBJECT PROPERTIES -->

1058 <!-- OBJECT METHODS -->

1059 <!-- OBJECT EVENT FIELDS -->

1060 <!-- FUNCTION PARAMETERS -->

1061 </div>

1062 </div><div>

1063 <div>

1064 <dt>

1065 <var>annotation</var>

1066 <em>

1067 <!-- TYPE -->

1068 <div style="display:inline">

1069 (

1070 <span class="optional">optional</span>

1071 <span id="typeTemplate">

1072 <span>

1073 <span>string</span>

1074 </span>

1075 </span>

1076 )

1077 </div>

1078 </em>

1079 </dt>

1080 <dd>Additional text describing the candidate</dd>

1081 <!-- OBJECT PROPERTIES -->

1082 <!-- OBJECT METHODS -->

1083 <!-- OBJECT EVENT FIELDS -->

1084 <!-- FUNCTION PARAMETERS -->

1085 </div>

1086 </div>

1087 </dl>

1088 </dd>

1089 <!-- OBJECT METHODS -->

1090 <!-- OBJECT EVENT FIELDS -->

1091 <!-- FUNCTION PARAMETERS -->

1092 </div>

1093 </div>

1094 </dl>

1095 </dd>

1096 <!-- OBJECT METHODS -->

1097 <!-- OBJECT EVENT FIELDS -->

1098 <!-- FUNCTION PARAMETERS -->

1099 </div>

1100 </div><div>

1101 <div>

1102 <dt>

1103 <var>callback</var>

1104 <em>

1105 <!-- TYPE -->

1106 <div style="display:inline">

1107 (

1108 <span class="optional">optional</span>

1109 <span id="typeTemplate">

1110 <span>

1111 <span>function</span>

1112 </span>

1113 </span>

1114 )

1115 </div>

1116 </em>

1117 </dt>

1118 <dd>Called when the operation completes.</dd>

1119 <!-- OBJECT PROPERTIES -->

1120 <!-- OBJECT METHODS -->

1121 <!-- OBJECT EVENT FIELDS -->

1122 <!-- FUNCTION PARAMETERS -->

1123 </div>

1124 </div>

1125 </dl>

1126 <!-- RETURNS -->

1127 <dl>

1128 </dl>

1129 <!-- CALLBACK -->

1130 <div>

1131 <div>

1132 <h4>Callback function</h4>

1133 <p>

1134 If you specify the <em>callback</em> parameter, it should

1135 specify a function that looks like this:

1136 </p>

1137 <!-- Note: intentionally longer 80 columns -->

1138 <pre>function(<span>boolean success</span>) <span class="subdu ed">{...}</span>;</pre>

1139 <dl>

1140 <div>

1141 <div>

1142 <dt>

1143 <var>success</var>

1144 <em>

1145 <!-- TYPE -->

1146 <div style="display:inline">

1147 (

1148 <span id="typeTemplate">

1149 <span>

1150 <span>boolean</span>

1151 </span>

1152 </span>

1153 )

1154 </div>

1155 </em>

1156 </dt>

1157 <dd class="todo">

1158 Undocumented.

1159 </dd>

1160 <!-- OBJECT PROPERTIES -->

1161 <!-- OBJECT METHODS -->

1162 <!-- OBJECT EVENT FIELDS -->

1163 <!-- FUNCTION PARAMETERS -->

1164 </div>

1165 </div>

1166 </dl>

1167 </div>

1168 </div>

1169 <!-- MIN_VERSION -->

1170 </div> <!-- /description -->

1171 </div><div class="apiItem">

1172 <a name="method-setComposition"></a> <!-- method-anchor -->

1173 <h4>setComposition</h4>

1174 <div class="summary">

1175 <!-- Note: intentionally longer 80 columns -->

1176 <span>chrome.input.ime.setComposition</span>(<span class="null "><span>object</span>

1177 <var><span>parameters</span></var></span><span class="opti onal"><span>, </span><span>function</span>

1178 <var><span>callback</span></var></span>)</div>

1179 <div class="description">

1180 <p>Set the current composition. If this extension does not own t he active IME, this fails.</p>

1181 <!-- PARAMETERS -->

1182 <h4>Parameters</h4>

1183 <dl>

1184 <div>

1185 <div>

1186 <dt>

1187 <var>parameters</var>

1188 <em>

1189 <!-- TYPE -->

1190 <div style="display:inline">

1191 (

1192 <span id="typeTemplate">

1193 <span>

1194 <span>object</span>

1195 </span>

1196 </span>

1197 )

1198 </div>

1199 </em>

1200 </dt>

1201 <dd class="todo">

1202 Undocumented.

1203 </dd>

1204 <!-- OBJECT PROPERTIES -->

1205 <dd>

1206 <dl>

1207 <div>

1208 <div>

1209 <dt>

1210 <var>contextID</var>

1211 <em>

1212 <!-- TYPE -->

1213 <div style="display:inline">

1214 (

1215 <span id="typeTemplate">

1216 <span>

1217 <span>integer</span>

1218 </span>

1219 </span>

1220 )

1221 </div>

1222 </em>

1223 </dt>

1224 <dd>ID of the context where the composition text will be set</dd>

1225 <!-- OBJECT PROPERTIES -->

1226 <!-- OBJECT METHODS -->

1227 <!-- OBJECT EVENT FIELDS -->

1228 <!-- FUNCTION PARAMETERS -->

1229 </div>

1230 </div><div>

1231 <div>

1232 <dt>

1233 <var>text</var>

1234 <em>

1235 <!-- TYPE -->

1236 <div style="display:inline">

1237 (

1238 <span id="typeTemplate">

1239 <span>

1240 <span>string</span>

1241 </span>

1242 </span>

1243 )

1244 </div>

1245 </em>

1246 </dt>

1247 <dd>Text to set</dd>

1248 <!-- OBJECT PROPERTIES -->

1249 <!-- OBJECT METHODS -->

1250 <!-- OBJECT EVENT FIELDS -->

1251 <!-- FUNCTION PARAMETERS -->

1252 </div>

1253 </div><div>

1254 <div>

1255 <dt>

1256 <var>selectionStart</var>

1257 <em>

1258 <!-- TYPE -->

1259 <div style="display:inline">

1260 (

1261 <span class="optional">optional</span>

1262 <span id="typeTemplate">

1263 <span>

1264 <span>integer</span>

1265 </span>

1266 </span>

1267 )

1268 </div>

1269 </em>

1270 </dt>

1271 <dd>Position in the text that the selection starts at.</dd>

1272 <!-- OBJECT PROPERTIES -->

1273 <!-- OBJECT METHODS -->

1274 <!-- OBJECT EVENT FIELDS -->

1275 <!-- FUNCTION PARAMETERS -->

1276 </div>

1277 </div><div>

1278 <div>

1279 <dt>

1280 <var>selectionEnd</var>

1281 <em>

1282 <!-- TYPE -->

1283 <div style="display:inline">

1284 (

1285 <span class="optional">optional</span>

1286 <span id="typeTemplate">

1287 <span>

1288 <span>integer</span>

1289 </span>

1290 </span>

1291 )

1292 </div>

1293 </em>

1294 </dt>

1295 <dd>Position in the text that the selection ends at.</dd>

1296 <!-- OBJECT PROPERTIES -->

1297 <!-- OBJECT METHODS -->

1298 <!-- OBJECT EVENT FIELDS -->

1299 <!-- FUNCTION PARAMETERS -->

1300 </div>

1301 </div><div>

1302 <div>

1303 <dt>

1304 <var>cursor</var>

1305 <em>

1306 <!-- TYPE -->

1307 <div style="display:inline">

1308 (

1309 <span id="typeTemplate">

1310 <span>

1311 <span>integer</span>

1312 </span>

1313 </span>

1314 )

1315 </div>

1316 </em>

1317 </dt>

1318 <dd>Position in the text of the cursor.</dd>

1319 <!-- OBJECT PROPERTIES -->

1320 <!-- OBJECT METHODS -->

1321 <!-- OBJECT EVENT FIELDS -->

1322 <!-- FUNCTION PARAMETERS -->

1323 </div>

1324 </div><div>

1325 <div>

1326 <dt>

1327 <var>segments</var>

1328 <em>

1329 <!-- TYPE -->

1330 <div style="display:inline">

1331 (

1332 <span class="optional">optional</span>

1333 <span id="typeTemplate">

1334 <span>

1335 <span>

1336 array of <span><span>

1337 <span>

1338 <span>object</span>

1339 </span>

1340 </span></span>

1341 </span>

1342 </span>

1343 </span>

1344 )

1345 </div>

1346 </em>

1347 </dt>

1348 <dd>List of segments and their associated types.</dd>

1349 <!-- OBJECT PROPERTIES -->

1350 <dd>

1351 <dl>

1352 <div>

1353 <div>

1354 <dt>

1355 <var>start</var>

1356 <em>

1357 <!-- TYPE -->

1358 <div style="display:inline">

1359 (

1360 <span id="typeTemplate">

1361 <span>

1362 <span>integer</span>

1363 </span>

1364 </span>

1365 )

1366 </div>

1367 </em>

1368 </dt>

1369 <dd>Index of the character to start this segment at</dd>

1370 <!-- OBJECT PROPERTIES -->

1371 <!-- OBJECT METHODS -->

1372 <!-- OBJECT EVENT FIELDS -->

1373 <!-- FUNCTION PARAMETERS -->

1374 </div>

1375 </div><div>

1376 <div>

1377 <dt>

1378 <var>end</var>

1379 <em>

1380 <!-- TYPE -->

1381 <div style="display:inline">

1382 (

1383 <span id="typeTemplate">

1384 <span>

1385 <span>integer</span>

1386 </span>

1387 </span>

1388 )

1389 </div>

1390 </em>

1391 </dt>

1392 <dd>Index of the character to end this segment after.</dd>

1393 <!-- OBJECT PROPERTIES -->

1394 <!-- OBJECT METHODS -->

1395 <!-- OBJECT EVENT FIELDS -->

1396 <!-- FUNCTION PARAMETERS -->

1397 </div>

1398 </div><div>

1399 <div>

1400 <dt>

1401 <var>style</var>

1402 <em>

1403 <!-- TYPE -->

1404 <div style="display:inline">

1405 (

1406 <span class="enum">enumerated</span>

1407 <span id="typeTemplate">

1408 <span>

1409 <span>string</span>

1410 <span>["underline", "doubleUnderline"]</span>

1411 </span>

1412 </span>

1413 )

1414 </div>

1415 </em>

1416 </dt>

1417 <dd>How to render this segment</dd>

1418 <!-- OBJECT PROPERTIES -->

1419 <!-- OBJECT METHODS -->

1420 <!-- OBJECT EVENT FIELDS -->

1421 <!-- FUNCTION PARAMETERS -->

1422 </div>

1423 </div>

1424 </dl>

1425 </dd>

1426 <!-- OBJECT METHODS -->

1427 <!-- OBJECT EVENT FIELDS -->

1428 <!-- FUNCTION PARAMETERS -->

1429 </div>

1430 </div>

1431 </dl>

1432 </dd>

1433 <!-- OBJECT METHODS -->

1434 <!-- OBJECT EVENT FIELDS -->

1435 <!-- FUNCTION PARAMETERS -->

1436 </div>

1437 </div><div>

1438 <div>

1439 <dt>

1440 <var>callback</var>

1441 <em>

1442 <!-- TYPE -->

1443 <div style="display:inline">

1444 (

1445 <span class="optional">optional</span>

1446 <span id="typeTemplate">

1447 <span>

1448 <span>function</span>

1449 </span>

1450 </span>

1451 )

1452 </div>

1453 </em>

1454 </dt>

1455 <dd>Called when the operation completes with a boolean indicating if t he text was accepted or not. On failure, chrome.extension.lastError is set.</dd>

1456 <!-- OBJECT PROPERTIES -->

1457 <!-- OBJECT METHODS -->

1458 <!-- OBJECT EVENT FIELDS -->

1459 <!-- FUNCTION PARAMETERS -->

1460 </div>

1461 </div>

1462 </dl>

1463 <!-- RETURNS -->

1464 <dl>

1465 </dl>

1466 <!-- CALLBACK -->

1467 <div>

1468 <div>

1469 <h4>Callback function</h4>

1470 <p>

1471 If you specify the <em>callback</em> parameter, it should

1472 specify a function that looks like this:

1473 </p>

1474 <!-- Note: intentionally longer 80 columns -->

1475 <pre>function(<span>boolean success</span>) <span class="subdu ed">{...}</span>;</pre>

1476 <dl>

1477 <div>

1478 <div>

1479 <dt>

1480 <var>success</var>

1481 <em>

1482 <!-- TYPE -->

1483 <div style="display:inline">

1484 (

1485 <span id="typeTemplate">

1486 <span>

1487 <span>boolean</span>

1488 </span>

1489 </span>

1490 )

1491 </div>

1492 </em>

1493 </dt>

1494 <dd class="todo">

1495 Undocumented.

1496 </dd>

1497 <!-- OBJECT PROPERTIES -->

1498 <!-- OBJECT METHODS -->

1499 <!-- OBJECT EVENT FIELDS -->

1500 <!-- FUNCTION PARAMETERS -->

1501 </div>

1502 </div>

1503 </dl>

1504 </div>

1505 </div>

1506 <!-- MIN_VERSION -->

1507 </div> <!-- /description -->

1508 </div><div class="apiItem">

1509 <a name="method-setCursorPosition"></a> <!-- method-anchor -->

1510 <h4>setCursorPosition</h4>

1511 <div class="summary">

1512 <!-- Note: intentionally longer 80 columns -->

1513 <span>chrome.input.ime.setCursorPosition</span>(<span class="n ull"><span>object</span>

1514 <var><span>parameters</span></var></span><span class="opti onal"><span>, </span><span>function</span>

1515 <var><span>callback</span></var></span>)</div>

1516 <div class="description">

1517 <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>

1518 <!-- PARAMETERS -->

1519 <h4>Parameters</h4>

1520 <dl>

1521 <div>

1522 <div>

1523 <dt>

1524 <var>parameters</var>

1525 <em>

1526 <!-- TYPE -->

1527 <div style="display:inline">

1528 (

1529 <span id="typeTemplate">

1530 <span>

1531 <span>object</span>

1532 </span>

1533 </span>

1534 )

1535 </div>

1536 </em>

1537 </dt>

1538 <dd class="todo">

1539 Undocumented.

1540 </dd>

1541 <!-- OBJECT PROPERTIES -->

1542 <dd>

1543 <dl>

1544 <div>

1545 <div>

1546 <dt>

1547 <var>contextID</var>

1548 <em>

1549 <!-- TYPE -->

1550 <div style="display:inline">

1551 (

1552 <span id="typeTemplate">

1553 <span>

1554 <span>integer</span>

1555 </span>

1556 </span>

1557 )

1558 </div>

1559 </em>

1560 </dt>

1561 <dd>ID of the context that owns the candidate window.</dd>

1562 <!-- OBJECT PROPERTIES -->

1563 <!-- OBJECT METHODS -->

1564 <!-- OBJECT EVENT FIELDS -->

1565 <!-- FUNCTION PARAMETERS -->

1566 </div>

1567 </div><div>

1568 <div>

1569 <dt>

1570 <var>candidateID</var>

1571 <em>

1572 <!-- TYPE -->

1573 <div style="display:inline">

1574 (

1575 <span id="typeTemplate">

1576 <span>

1577 <span>integer</span>

1578 </span>

1579 </span>

1580 )

1581 </div>

1582 </em>

1583 </dt>

1584 <dd>ID of the candidate to select.</dd>

1585 <!-- OBJECT PROPERTIES -->

1586 <!-- OBJECT METHODS -->

1587 <!-- OBJECT EVENT FIELDS -->

1588 <!-- FUNCTION PARAMETERS -->

1589 </div>

1590 </div>

1591 </dl>

1592 </dd>

1593 <!-- OBJECT METHODS -->

1594 <!-- OBJECT EVENT FIELDS -->

1595 <!-- FUNCTION PARAMETERS -->

1596 </div>

1597 </div><div>

1598 <div>

1599 <dt>

1600 <var>callback</var>

1601 <em>

1602 <!-- TYPE -->

1603 <div style="display:inline">

1604 (

1605 <span class="optional">optional</span>

1606 <span id="typeTemplate">

1607 <span>

1608 <span>function</span>

1609 </span>

1610 </span>

1611 )

1612 </div>

1613 </em>

1614 </dt>

1615 <dd>Called when the operation completes</dd>

1616 <!-- OBJECT PROPERTIES -->

1617 <!-- OBJECT METHODS -->

1618 <!-- OBJECT EVENT FIELDS -->

1619 <!-- FUNCTION PARAMETERS -->

1620 </div>

1621 </div>

1622 </dl>

1623 <!-- RETURNS -->

1624 <dl>

1625 </dl>

1626 <!-- CALLBACK -->

1627 <div>

1628 <div>

1629 <h4>Callback function</h4>

1630 <p>

1631 If you specify the <em>callback</em> parameter, it should

1632 specify a function that looks like this:

1633 </p>

1634 <!-- Note: intentionally longer 80 columns -->

1635 <pre>function(<span>boolean success</span>) <span class="subdu ed">{...}</span>;</pre>

1636 <dl>

1637 <div>

1638 <div>

1639 <dt>

1640 <var>success</var>

1641 <em>

1642 <!-- TYPE -->

1643 <div style="display:inline">

1644 (

1645 <span id="typeTemplate">

1646 <span>

1647 <span>boolean</span>

1648 </span>

1649 </span>

1650 )

1651 </div>

1652 </em>

1653 </dt>

1654 <dd class="todo">

1655 Undocumented.

1656 </dd>

1657 <!-- OBJECT PROPERTIES -->

1658 <!-- OBJECT METHODS -->

1659 <!-- OBJECT EVENT FIELDS -->

1660 <!-- FUNCTION PARAMETERS -->

1661 </div>

1662 </div>

1663 </dl>

1664 </div>

1665 </div>

1666 <!-- MIN_VERSION -->

1667 </div> <!-- /description -->

1668 </div><div class="apiItem">

1669 <a name="method-setMenuItems"></a> <!-- method-anchor -->

1670 <h4>setMenuItems</h4>

1671 <div class="summary">

1672 <!-- Note: intentionally longer 80 columns -->

1673 <span>chrome.input.ime.setMenuItems</span>(<span class="null"> <span>object</span>

1674 <var><span>parameters</span></var></span><span class="opti onal"><span>, </span><span>function</span>

1675 <var><span>callback</span></var></span>)</div>

1676 <div class="description">

1677 <p>Adds the provided menu items to the language menu when this I ME is active.</p>

1678 <!-- PARAMETERS -->

1679 <h4>Parameters</h4>

1680 <dl>

1681 <div>

1682 <div>

1683 <dt>

1684 <var>parameters</var>

1685 <em>

1686 <!-- TYPE -->

1687 <div style="display:inline">

1688 (

1689 <span id="typeTemplate">

1690 <span>

1691 <span>object</span>

1692 </span>

1693 </span>

1694 )

1695 </div>

1696 </em>

1697 </dt>

1698 <dd class="todo">

1699 Undocumented.

1700 </dd>

1701 <!-- OBJECT PROPERTIES -->

1702 <dd>

1703 <dl>

1704 <div>

1705 <div>

1706 <dt>

1707 <var>engineID</var>

1708 <em>

1709 <!-- TYPE -->

1710 <div style="display:inline">

1711 (

1712 <span id="typeTemplate">

1713 <span>

1714 <span>string</span>

1715 </span>

1716 </span>

1717 )

1718 </div>

1719 </em>

1720 </dt>

1721 <dd>ID of the engine to use</dd>

1722 <!-- OBJECT PROPERTIES -->

1723 <!-- OBJECT METHODS -->

1724 <!-- OBJECT EVENT FIELDS -->

1725 <!-- FUNCTION PARAMETERS -->

1726 </div>

1727 </div><div>

1728 <div>

1729 <dt>

1730 <var>items</var>

1731 <em>

1732 <!-- TYPE -->

1733 <div style="display:inline">

1734 (

1735 <span id="typeTemplate">

1736 <span>

1737 <span>

1738 array of <span><span>

1739 <span>

1740 <span>object</span>

1741 </span>

1742 </span></span>

1743 </span>

1744 </span>

1745 </span>

1746 )

1747 </div>

1748 </em>

1749 </dt>

1750 <dd>MenuItems to add. They will be added in the order they exist in th e array.</dd>

1751 <!-- OBJECT PROPERTIES -->

1752 <dd>

1753 <dl>

1754 <div>

1755 <div>

1756 <dt>

1757 <var>id</var>

1758 <em>

1759 <!-- TYPE -->

1760 <div style="display:inline">

1761 (

1762 <span id="typeTemplate">

1763 <span>

1764 <span>string</span>

1765 </span>

1766 </span>

1767 )

1768 </div>

1769 </em>

1770 </dt>

1771 <dd>String that will be passed to callbacks referencing this MenuItem. </dd>

1772 <!-- OBJECT PROPERTIES -->

1773 <!-- OBJECT METHODS -->

1774 <!-- OBJECT EVENT FIELDS -->

1775 <!-- FUNCTION PARAMETERS -->

1776 </div>

1777 </div><div>

1778 <div>

1779 <dt>

1780 <var>label</var>

1781 <em>

1782 <!-- TYPE -->

1783 <div style="display:inline">

1784 (

1785 <span class="optional">optional</span>

1786 <span id="typeTemplate">

1787 <span>

1788 <span>string</span>

1789 </span>

1790 </span>

1791 )

1792 </div>

1793 </em>

1794 </dt>

1795 <dd>Text displayed in the menu for this item.</dd>

1796 <!-- OBJECT PROPERTIES -->

1797 <!-- OBJECT METHODS -->

1798 <!-- OBJECT EVENT FIELDS -->

1799 <!-- FUNCTION PARAMETERS -->

1800 </div>

1801 </div><div>

1802 <div>

1803 <dt>

1804 <var>style</var>

1805 <em>

1806 <!-- TYPE -->

1807 <div style="display:inline">

1808 (

1809 <span class="optional">optional</span>

1810 <span class="enum">enumerated</span>

1811 <span id="typeTemplate">

1812 <span>

1813 <span>string</span>

1814 <span>["none", "check", "radio", "separator"]</span>

1815 </span>

1816 </span>

1817 )

1818 </div>

1819 </em>

1820 </dt>

1821 <dd>Enum representing if this item is: none, check, radio, or a separa tor. Radio buttons between separators are considered grouped.</dd>

1822 <!-- OBJECT PROPERTIES -->

1823 <!-- OBJECT METHODS -->

1824 <!-- OBJECT EVENT FIELDS -->

1825 <!-- FUNCTION PARAMETERS -->

1826 </div>

1827 </div><div>

1828 <div>

1829 <dt>

1830 <var>visible</var>

1831 <em>

1832 <!-- TYPE -->

1833 <div style="display:inline">

1834 (

1835 <span class="optional">optional</span>

1836 <span id="typeTemplate">

1837 <span>

1838 <span>boolean</span>

1839 </span>

1840 </span>

1841 )

1842 </div>

1843 </em>

1844 </dt>

1845 <dd>Indicates this item is visible.</dd>

1846 <!-- OBJECT PROPERTIES -->

1847 <!-- OBJECT METHODS -->

1848 <!-- OBJECT EVENT FIELDS -->

1849 <!-- FUNCTION PARAMETERS -->

1850 </div>

1851 </div><div>

1852 <div>

1853 <dt>

1854 <var>checked</var>

1855 <em>

1856 <!-- TYPE -->

1857 <div style="display:inline">

1858 (

1859 <span class="optional">optional</span>

1860 <span id="typeTemplate">

1861 <span>

1862 <span>boolean</span>

1863 </span>

1864 </span>

1865 )

1866 </div>

1867 </em>

1868 </dt>

1869 <dd>Indicates this item should be drawn with a check.</dd>

1870 <!-- OBJECT PROPERTIES -->

1871 <!-- OBJECT METHODS -->

1872 <!-- OBJECT EVENT FIELDS -->

1873 <!-- FUNCTION PARAMETERS -->

1874 </div>

1875 </div><div>

1876 <div>

1877 <dt>

1878 <var>enabled</var>

1879 <em>

1880 <!-- TYPE -->

1881 <div style="display:inline">

1882 (

1883 <span class="optional">optional</span>

1884 <span id="typeTemplate">

1885 <span>

1886 <span>boolean</span>

1887 </span>

1888 </span>

1889 )

1890 </div>

1891 </em>

1892 </dt>

1893 <dd>Indicates this item is enabled.</dd>

1894 <!-- OBJECT PROPERTIES -->

1895 <!-- OBJECT METHODS -->

1896 <!-- OBJECT EVENT FIELDS -->

1897 <!-- FUNCTION PARAMETERS -->

1898 </div>

1899 </div>

1900 </dl>

1901 </dd>

1902 <!-- OBJECT METHODS -->

1903 <!-- OBJECT EVENT FIELDS -->

1904 <!-- FUNCTION PARAMETERS -->

1905 </div>

1906 </div>

1907 </dl>

1908 </dd>

1909 <!-- OBJECT METHODS -->

1910 <!-- OBJECT EVENT FIELDS -->

1911 <!-- FUNCTION PARAMETERS -->

1912 </div>

1913 </div><div>

1914 <div>

1915 <dt>

1916 <var>callback</var>

1917 <em>

1918 <!-- TYPE -->

1919 <div style="display:inline">

1920 (

1921 <span class="optional">optional</span>

1922 <span id="typeTemplate">

1923 <span>

1924 <span>function</span>

1925 </span>

1926 </span>

1927 )

1928 </div>

1929 </em>

1930 </dt>

1931 <dd class="todo">

1932 Undocumented.

1933 </dd>

1934 <!-- OBJECT PROPERTIES -->

1935 <!-- OBJECT METHODS -->

1936 <!-- OBJECT EVENT FIELDS -->

1937 <!-- FUNCTION PARAMETERS -->

1938 </div>

1939 </div>

1940 </dl>

1941 <!-- RETURNS -->

1942 <dl>

1943 </dl>

1944 <!-- CALLBACK -->

1945 <div>

1946 <div>

1947 <h4>Callback function</h4>

1948 <p>

1949 If you specify the <em>callback</em> parameter, it should

1950 specify a function that looks like this:

1951 </p>

1952 <!-- Note: intentionally longer 80 columns -->

1953 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>

1954 <dl>

1955 </dl>

1956 </div>

1957 </div>

1958 <!-- MIN_VERSION -->

1959 </div> <!-- /description -->

1960 </div><div class="apiItem">

1961 <a name="method-updateMenuItems"></a> <!-- method-anchor -->

1962 <h4>updateMenuItems</h4>

1963 <div class="summary">

1964 <!-- Note: intentionally longer 80 columns -->

1965 <span>chrome.input.ime.updateMenuItems</span>(<span class="nul l"><span>object</span>

1966 <var><span>parameters</span></var></span><span class="opti onal"><span>, </span><span>function</span>

1967 <var><span>callback</span></var></span>)</div>

1968 <div class="description">

1969 <p>Updates the state of the MenuItems specified</p>

1970 <!-- PARAMETERS -->

1971 <h4>Parameters</h4>

1972 <dl>

1973 <div>

1974 <div>

1975 <dt>

1976 <var>parameters</var>

1977 <em>

1978 <!-- TYPE -->

1979 <div style="display:inline">

1980 (

1981 <span id="typeTemplate">

1982 <span>

1983 <span>object</span>

1984 </span>

1985 </span>

1986 )

1987 </div>

1988 </em>

1989 </dt>

1990 <dd class="todo">

1991 Undocumented.

1992 </dd>

1993 <!-- OBJECT PROPERTIES -->

1994 <dd>

1995 <dl>

1996 <div>

1997 <div>

1998 <dt>

1999 <var>engineID</var>

2000 <em>

2001 <!-- TYPE -->

2002 <div style="display:inline">

2003 (

2004 <span id="typeTemplate">

2005 <span>

2006 <span>string</span>

2007 </span>

2008 </span>

2009 )

2010 </div>

2011 </em>

2012 </dt>

2013 <dd>ID of the engine to use</dd>

2014 <!-- OBJECT PROPERTIES -->

2015 <!-- OBJECT METHODS -->

2016 <!-- OBJECT EVENT FIELDS -->

2017 <!-- FUNCTION PARAMETERS -->

2018 </div>

2019 </div><div>

2020 <div>

2021 <dt>

2022 <var>items</var>

2023 <em>

2024 <!-- TYPE -->

2025 <div style="display:inline">

2026 (

2027 <span id="typeTemplate">

2028 <span>

2029 <span>

2030 array of <span><span>

2031 <span>

2032 <span>object</span>

2033 </span>

2034 </span></span>

2035 </span>

2036 </span>

2037 </span>

2038 )

2039 </div>

2040 </em>

2041 </dt>

2042 <dd>Array of MenuItems to update</dd>

2043 <!-- OBJECT PROPERTIES -->

2044 <dd>

2045 <dl>

2046 <div>

2047 <div>

2048 <dt>

2049 <var>id</var>

2050 <em>

2051 <!-- TYPE -->

2052 <div style="display:inline">

2053 (

2054 <span id="typeTemplate">

2055 <span>

2056 <span>string</span>

2057 </span>

2058 </span>

2059 )

2060 </div>

2061 </em>

2062 </dt>

2063 <dd>String that will be passed to callbacks referencing this MenuItem. </dd>

2064 <!-- OBJECT PROPERTIES -->

2065 <!-- OBJECT METHODS -->

2066 <!-- OBJECT EVENT FIELDS -->

2067 <!-- FUNCTION PARAMETERS -->

2068 </div>

2069 </div><div>

2070 <div>

2071 <dt>

2072 <var>label</var>

2073 <em>

2074 <!-- TYPE -->

2075 <div style="display:inline">

2076 (

2077 <span class="optional">optional</span>

2078 <span id="typeTemplate">

2079 <span>

2080 <span>string</span>

2081 </span>

2082 </span>

2083 )

2084 </div>

2085 </em>

2086 </dt>

2087 <dd>Text displayed in the menu for this item.</dd>

2088 <!-- OBJECT PROPERTIES -->

2089 <!-- OBJECT METHODS -->

2090 <!-- OBJECT EVENT FIELDS -->

2091 <!-- FUNCTION PARAMETERS -->

2092 </div>

2093 </div><div>

2094 <div>

2095 <dt>

2096 <var>style</var>

2097 <em>

2098 <!-- TYPE -->

2099 <div style="display:inline">

2100 (

2101 <span class="optional">optional</span>

2102 <span class="enum">enumerated</span>

2103 <span id="typeTemplate">

2104 <span>

2105 <span>string</span>

2106 <span>["none", "check", "radio", "separator"]</span>

2107 </span>

2108 </span>

2109 )

2110 </div>

2111 </em>

2112 </dt>

2113 <dd>Enum representing if this item is: none, check, radio, or a separa tor. Radio buttons between separators are considered grouped.</dd>

2114 <!-- OBJECT PROPERTIES -->

2115 <!-- OBJECT METHODS -->

2116 <!-- OBJECT EVENT FIELDS -->

2117 <!-- FUNCTION PARAMETERS -->

2118 </div>

2119 </div><div>

2120 <div>

2121 <dt>

2122 <var>visible</var>

2123 <em>

2124 <!-- TYPE -->

2125 <div style="display:inline">

2126 (

2127 <span class="optional">optional</span>

2128 <span id="typeTemplate">

2129 <span>

2130 <span>boolean</span>

2131 </span>

2132 </span>

2133 )

2134 </div>

2135 </em>

2136 </dt>

2137 <dd>Indicates this item is visible.</dd>

2138 <!-- OBJECT PROPERTIES -->

2139 <!-- OBJECT METHODS -->

2140 <!-- OBJECT EVENT FIELDS -->

2141 <!-- FUNCTION PARAMETERS -->

2142 </div>

2143 </div><div>

2144 <div>

2145 <dt>

2146 <var>checked</var>

2147 <em>

2148 <!-- TYPE -->

2149 <div style="display:inline">

2150 (

2151 <span class="optional">optional</span>

2152 <span id="typeTemplate">

2153 <span>

2154 <span>boolean</span>

2155 </span>

2156 </span>

2157 )

2158 </div>

2159 </em>

2160 </dt>

2161 <dd>Indicates this item should be drawn with a check.</dd>

2162 <!-- OBJECT PROPERTIES -->

2163 <!-- OBJECT METHODS -->

2164 <!-- OBJECT EVENT FIELDS -->

2165 <!-- FUNCTION PARAMETERS -->

2166 </div>

2167 </div><div>

2168 <div>

2169 <dt>

2170 <var>enabled</var>

2171 <em>

2172 <!-- TYPE -->

2173 <div style="display:inline">

2174 (

2175 <span class="optional">optional</span>

2176 <span id="typeTemplate">

2177 <span>

2178 <span>boolean</span>

2179 </span>

2180 </span>

2181 )

2182 </div>

2183 </em>

2184 </dt>

2185 <dd>Indicates this item is enabled.</dd>

2186 <!-- OBJECT PROPERTIES -->

2187 <!-- OBJECT METHODS -->

2188 <!-- OBJECT EVENT FIELDS -->

2189 <!-- FUNCTION PARAMETERS -->

2190 </div>

2191 </div>

2192 </dl>

2193 </dd>

2194 <!-- OBJECT METHODS -->

2195 <!-- OBJECT EVENT FIELDS -->

2196 <!-- FUNCTION PARAMETERS -->

2197 </div>

2198 </div>

2199 </dl>

2200 </dd>

2201 <!-- OBJECT METHODS -->

2202 <!-- OBJECT EVENT FIELDS -->

2203 <!-- FUNCTION PARAMETERS -->

2204 </div>

2205 </div><div>

2206 <div>

2207 <dt>

2208 <var>callback</var>

2209 <em>

2210 <!-- TYPE -->

2211 <div style="display:inline">

2212 (

2213 <span class="optional">optional</span>

2214 <span id="typeTemplate">

2215 <span>

2216 <span>function</span>

2217 </span>

2218 </span>

2219 )

2220 </div>

2221 </em>

2222 </dt>

2223 <dd>Called when the operation completes</dd>

2224 <!-- OBJECT PROPERTIES -->

2225 <!-- OBJECT METHODS -->

2226 <!-- OBJECT EVENT FIELDS -->

2227 <!-- FUNCTION PARAMETERS -->

2228 </div>

2229 </div>

2230 </dl>

2231 <!-- RETURNS -->

2232 <dl>

2233 </dl>

2234 <!-- CALLBACK -->

2235 <div>

2236 <div>

2237 <h4>Callback function</h4>

2238 <p>

2239 If you specify the <em>callback</em> parameter, it should

2240 specify a function that looks like this:

2241 </p>

2242 <!-- Note: intentionally longer 80 columns -->

2243 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>

2244 <dl>

2245 </dl>

2246 </div>

2247 </div>

2248 <!-- MIN_VERSION -->

2249 </div> <!-- /description -->

2250 </div> <!-- /apiItem -->

2251 </div> <!-- /apiGroup -->

2252 <!-- EVENTS -->

2253 <div id="eventsTemplate" class="apiGroup">

2254 <a name="global-events"></a>

2255 <h3>Events</h3>

2256 <!-- iterates over all events -->

2257 <div class="apiItem">

2258 <a name="event-onActivate"></a>

2259 <h4>onActivate</h4>

2260 <div class="summary">

2261 <!-- Note: intentionally longer 80 columns -->

2262 <span class="subdued">chrome.input.ime.</span><span>onActivate</ span><span class="subdued">.addListener</span>(function(<span>string engineID</s pan>) <span class="subdued">{...}</span><span></span>);

2263 </div>

2264 <div class="description">

2265 <p>This event is sent when an IME is activated. It signals that the IME will be receiving onKeyPress events.</p>

2266 <!-- LISTENER PARAMETERS -->

2267 <div>

2268 <h4>Listener parameters</h4>

2269 <dl>

2270 <div>

2271 <div>

2272 <dt>

2273 <var>engineID</var>

2274 <em>

2275 <!-- TYPE -->

2276 <div style="display:inline">

2277 (

2278 <span id="typeTemplate">

2279 <span>

2280 <span>string</span>

2281 </span>

2282 </span>

2283 )

2284 </div>

2285 </em>

2286 </dt>

2287 <dd>ID of the engine receiving the event</dd>

2288 <!-- OBJECT PROPERTIES -->

2289 <!-- OBJECT METHODS -->

2290 <!-- OBJECT EVENT FIELDS -->

2291 <!-- FUNCTION PARAMETERS -->

2292 </div>

2293 </div>

2294 </dl>

2295 </div>

2296 <!-- EXTRA PARAMETERS -->

2297 <!-- LISTENER RETURN VALUE -->

2298 <dl>

2299 </dl>

2300 </div> <!-- /description -->

2301 <!-- /description -->

2302 </div><div class="apiItem">

2303 <a name="event-onBlur"></a>

2304 <h4>onBlur</h4>

2305 <div class="summary">

2306 <!-- Note: intentionally longer 80 columns -->

2307 <span class="subdued">chrome.input.ime.</span><span>onBlur</span ><span class="subdued">.addListener</span>(function(<span>integer contextID</spa n>) <span class="subdued">{...}</span><span></span>);

2308 </div>

2309 <div class="description">

2310 <p>This event is sent when focus leaves a text box. It is sent t o all extensions that are listening to this event, and enabled by the user.</p>

2311 <!-- LISTENER PARAMETERS -->

2312 <div>

2313 <h4>Listener parameters</h4>

2314 <dl>

2315 <div>

2316 <div>

2317 <dt>

2318 <var>contextID</var>

2319 <em>

2320 <!-- TYPE -->

2321 <div style="display:inline">

2322 (

2323 <span id="typeTemplate">

2324 <span>

2325 <span>integer</span>

2326 </span>

2327 </span>

2328 )

2329 </div>

2330 </em>

2331 </dt>

2332 <dd>The ID of the text field that has lost focus. The ID is invalid af ter this call</dd>

2333 <!-- OBJECT PROPERTIES -->

2334 <!-- OBJECT METHODS -->

2335 <!-- OBJECT EVENT FIELDS -->

2336 <!-- FUNCTION PARAMETERS -->

2337 </div>

2338 </div>

2339 </dl>

2340 </div>

2341 <!-- EXTRA PARAMETERS -->

2342 <!-- LISTENER RETURN VALUE -->

2343 <dl>

2344 </dl>

2345 </div> <!-- /description -->

2346 <!-- /description -->

2347 </div><div class="apiItem">

2348 <a name="event-onCandidateClicked"></a>

2349 <h4>onCandidateClicked</h4>

2350 <div class="summary">

2351 <!-- Note: intentionally longer 80 columns -->

2352 <span class="subdued">chrome.input.ime.</span><span>onCandidateC licked</span><span class="subdued">.addListener</span>(function(<span>string eng ineID, integer candidateID, string button</span>) <span class="subdued">{...}</s pan><span></span>);

2353 </div>

2354 <div class="description">

2355 <p>This event is sent if this extension owns the active IME.</p>

2356 <!-- LISTENER PARAMETERS -->

2357 <div>

2358 <h4>Listener parameters</h4>

2359 <dl>

2360 <div>

2361 <div>

2362 <dt>

2363 <var>engineID</var>

2364 <em>

2365 <!-- TYPE -->

2366 <div style="display:inline">

2367 (

2368 <span id="typeTemplate">

2369 <span>

2370 <span>string</span>

2371 </span>

2372 </span>

2373 )

2374 </div>

2375 </em>

2376 </dt>

2377 <dd>ID of the engine receiving the event</dd>

2378 <!-- OBJECT PROPERTIES -->

2379 <!-- OBJECT METHODS -->

2380 <!-- OBJECT EVENT FIELDS -->

2381 <!-- FUNCTION PARAMETERS -->

2382 </div>

2383 </div><div>

2384 <div>

2385 <dt>

2386 <var>candidateID</var>

2387 <em>

2388 <!-- TYPE -->

2389 <div style="display:inline">

2390 (

2391 <span id="typeTemplate">

2392 <span>

2393 <span>integer</span>

2394 </span>

2395 </span>

2396 )

2397 </div>

2398 </em>

2399 </dt>

2400 <dd>ID of the candidate that was clicked.</dd>

2401 <!-- OBJECT PROPERTIES -->

2402 <!-- OBJECT METHODS -->

2403 <!-- OBJECT EVENT FIELDS -->

2404 <!-- FUNCTION PARAMETERS -->

2405 </div>

2406 </div><div>

2407 <div>

2408 <dt>

2409 <var>button</var>

2410 <em>

2411 <!-- TYPE -->

2412 <div style="display:inline">

2413 (

2414 <span class="enum">enumerated</span>

2415 <span id="typeTemplate">

2416 <span>

2417 <span>string</span>

2418 <span>["left", "middle", "right"]</span>

2419 </span>

2420 </span>

2421 )

2422 </div>

2423 </em>

2424 </dt>

2425 <dd>Which mouse buttons was clicked.</dd>

2426 <!-- OBJECT PROPERTIES -->

2427 <!-- OBJECT METHODS -->

2428 <!-- OBJECT EVENT FIELDS -->

2429 <!-- FUNCTION PARAMETERS -->

2430 </div>

2431 </div>

2432 </dl>

2433 </div>

2434 <!-- EXTRA PARAMETERS -->

2435 <!-- LISTENER RETURN VALUE -->

2436 <dl>

2437 </dl>

2438 </div> <!-- /description -->

2439 <!-- /description -->

2440 </div><div class="apiItem">

2441 <a name="event-onDeactivated"></a>

2442 <h4>onDeactivated</h4>

2443 <div class="summary">

2444 <!-- Note: intentionally longer 80 columns -->

2445 <span class="subdued">chrome.input.ime.</span><span>onDeactivate d</span><span class="subdued">.addListener</span>(function(<span>string engineID </span>) <span class="subdued">{...}</span><span></span>);

2446 </div>

2447 <div class="description">

2448 <p>This event is sent when an IME is deactivated. It signals tha t the IME will no longer be receiving onKeyPress events.</p>

2449 <!-- LISTENER PARAMETERS -->

2450 <div>

2451 <h4>Listener parameters</h4>

2452 <dl>

2453 <div>

2454 <div>

2455 <dt>

2456 <var>engineID</var>

2457 <em>

2458 <!-- TYPE -->

2459 <div style="display:inline">

2460 (

2461 <span id="typeTemplate">

2462 <span>

2463 <span>string</span>

2464 </span>

2465 </span>

2466 )

2467 </div>

2468 </em>

2469 </dt>

2470 <dd>ID of the engine receiving the event</dd>

2471 <!-- OBJECT PROPERTIES -->

2472 <!-- OBJECT METHODS -->

2473 <!-- OBJECT EVENT FIELDS -->

2474 <!-- FUNCTION PARAMETERS -->

2475 </div>

2476 </div>

2477 </dl>

2478 </div>

2479 <!-- EXTRA PARAMETERS -->

2480 <!-- LISTENER RETURN VALUE -->

2481 <dl>

2482 </dl>

2483 </div> <!-- /description -->

2484 <!-- /description -->

2485 </div><div class="apiItem">

2486 <a name="event-onFocus"></a>

2487 <h4>onFocus</h4>

2488 <div class="summary">

2489 <!-- Note: intentionally longer 80 columns -->

2490 <span class="subdued">chrome.input.ime.</span><span>onFocus</spa n><span class="subdued">.addListener</span>(function(<span>InputContext context< /span>) <span class="subdued">{...}</span><span></span>);

2491 </div>

2492 <div class="description">

2493 <p>This event is sent when focus enters a text box. It is sent t o all extensions that are listening to this event, and enabled by the user.</p>

2494 <!-- LISTENER PARAMETERS -->

2495 <div>

2496 <h4>Listener parameters</h4>

2497 <dl>

2498 <div>

2499 <div>

2500 <dt>

2501 <var>context</var>

2502 <em>

2503 <!-- TYPE -->

2504 <div style="display:inline">

2505 (

2506 <span id="typeTemplate">

2507 <span>

2508 <span>InputContext</span>

2509 </span>

2510 </span>

2511 )

2512 </div>

2513 </em>

2514 </dt>

2515 <dd>Describes the text field that has acquired focus.</dd>

2516 <!-- OBJECT PROPERTIES -->

2517 <!-- OBJECT METHODS -->

2518 <!-- OBJECT EVENT FIELDS -->

2519 <!-- FUNCTION PARAMETERS -->

2520 </div>

2521 </div>

2522 </dl>

2523 </div>

2524 <!-- EXTRA PARAMETERS -->

2525 <!-- LISTENER RETURN VALUE -->

2526 <dl>

2527 </dl>

2528 </div> <!-- /description -->

2529 <!-- /description -->

2530 </div><div class="apiItem">

2531 <a name="event-onInputContextUpdate"></a>

2532 <h4>onInputContextUpdate</h4>

2533 <div class="summary">

2534 <!-- Note: intentionally longer 80 columns -->

2535 <span class="subdued">chrome.input.ime.</span><span>onInputConte xtUpdate</span><span class="subdued">.addListener</span>(function(<span>InputCon text context</span>) <span class="subdued">{...}</span><span></span>);

2536 </div>

2537 <div class="description">

2538 <p>This event is sent when the properties of the current InputCo ntext change, such as the the type. It is sent to all extensions that are listen ing to this event, and enabled by the user.</p>

2539 <!-- LISTENER PARAMETERS -->

2540 <div>

2541 <h4>Listener parameters</h4>

2542 <dl>

2543 <div>

2544 <div>

2545 <dt>

2546 <var>context</var>

2547 <em>

2548 <!-- TYPE -->

2549 <div style="display:inline">

2550 (

2551 <span id="typeTemplate">

2552 <span>

2553 <span>InputContext</span>

2554 </span>

2555 </span>

2556 )

2557 </div>

2558 </em>

2559 </dt>

2560 <dd>An InputContext object describing the text field that has changed. </dd>

2561 <!-- OBJECT PROPERTIES -->

2562 <!-- OBJECT METHODS -->

2563 <!-- OBJECT EVENT FIELDS -->

2564 <!-- FUNCTION PARAMETERS -->

2565 </div>

2566 </div>

2567 </dl>

2568 </div>

2569 <!-- EXTRA PARAMETERS -->

2570 <!-- LISTENER RETURN VALUE -->

2571 <dl>

2572 </dl>

2573 </div> <!-- /description -->

2574 <!-- /description -->

2575 </div><div class="apiItem">

2576 <a name="event-onKeyEvent"></a>

2577 <h4>onKeyEvent</h4>

2578 <div class="summary">

2579 <!-- Note: intentionally longer 80 columns -->

2580 <span class="subdued">chrome.input.ime.</span><span>onKeyEvent</ span><span class="subdued">.addListener</span>(function(<span>string engineID, K eyboardEvent keyData</span>) <span class="subdued">{...}</span><span></span>);

2581 </div>

2582 <div class="description">

2583 <p>This event is sent if this extension owns the active IME.</p>

2584 <!-- LISTENER PARAMETERS -->

2585 <div>

2586 <h4>Listener parameters</h4>

2587 <dl>

2588 <div>

2589 <div>

2590 <dt>

2591 <var>engineID</var>

2592 <em>

2593 <!-- TYPE -->

2594 <div style="display:inline">

2595 (

2596 <span id="typeTemplate">

2597 <span>

2598 <span>string</span>

2599 </span>

2600 </span>

2601 )

2602 </div>

2603 </em>

2604 </dt>

2605 <dd>ID of the engine receiving the event</dd>

2606 <!-- OBJECT PROPERTIES -->

2607 <!-- OBJECT METHODS -->

2608 <!-- OBJECT EVENT FIELDS -->

2609 <!-- FUNCTION PARAMETERS -->

2610 </div>

2611 </div><div>

2612 <div>

2613 <dt>

2614 <var>keyData</var>

2615 <em>

2616 <!-- TYPE -->

2617 <div style="display:inline">

2618 (

2619 <span id="typeTemplate">

2620 <span>

2621 <span>KeyboardEvent</span>

2622 </span>

2623 </span>

2624 )

2625 </div>

2626 </em>

2627 </dt>

2628 <dd>Data on the key event</dd>

2629 <!-- OBJECT PROPERTIES -->

2630 <!-- OBJECT METHODS -->

2631 <!-- OBJECT EVENT FIELDS -->

2632 <!-- FUNCTION PARAMETERS -->

2633 </div>

2634 </div>

2635 </dl>

2636 </div>

2637 <!-- EXTRA PARAMETERS -->

2638 <!-- LISTENER RETURN VALUE -->

2639 <h4>Listener returns</h4>

2640 <dl>

2641 <div>

2642 <div>

2643 <dt>

2644 <em>

2645 <!-- TYPE -->

2646 <div style="display:inline">

2647 (

2648 <span id="typeTemplate">

2649 <span>

2650 <span>boolean</span>

2651 </span>

2652 </span>

2653 )

2654 </div>

2655 </em>

2656 </dt>

2657 <dd>True if the keystroke was handled, false if not</dd>

2658 <!-- OBJECT PROPERTIES -->

2659 <!-- OBJECT METHODS -->

2660 <!-- OBJECT EVENT FIELDS -->

2661 <!-- FUNCTION PARAMETERS -->

2662 </div>

2663 </div>

2664 </dl>

2665 </div> <!-- /description -->

2666 <!-- /description -->

2667 </div><div class="apiItem">

2668 <a name="event-onMenuItemActivated"></a>

2669 <h4>onMenuItemActivated</h4>

2670 <div class="summary">

2671 <!-- Note: intentionally longer 80 columns -->

2672 <span class="subdued">chrome.input.ime.</span><span>onMenuItemAc tivated</span><span class="subdued">.addListener</span>(function(<span>string en gineID, string name</span>) <span class="subdued">{...}</span><span></span>);

2673 </div>

2674 <div class="description">

2675 <p>Called when the user selects a menu item</p>

2676 <!-- LISTENER PARAMETERS -->

2677 <div>

2678 <h4>Listener parameters</h4>

2679 <dl>

2680 <div>

2681 <div>

2682 <dt>

2683 <var>engineID</var>

2684 <em>

2685 <!-- TYPE -->

2686 <div style="display:inline">

2687 (

2688 <span id="typeTemplate">

2689 <span>

2690 <span>string</span>

2691 </span>

2692 </span>

2693 )

2694 </div>

2695 </em>

2696 </dt>

2697 <dd>ID of the engine receiving the event</dd>

2698 <!-- OBJECT PROPERTIES -->

2699 <!-- OBJECT METHODS -->

2700 <!-- OBJECT EVENT FIELDS -->

2701 <!-- FUNCTION PARAMETERS -->

2702 </div>

2703 </div><div>

2704 <div>

2705 <dt>

2706 <var>name</var>

2707 <em>

2708 <!-- TYPE -->

2709 <div style="display:inline">

2710 (

2711 <span id="typeTemplate">

2712 <span>

2713 <span>string</span>

2714 </span>

2715 </span>

2716 )

2717 </div>

2718 </em>

2719 </dt>

2720 <dd>Name of the MenuItem which was activated</dd>

2721 <!-- OBJECT PROPERTIES -->

2722 <!-- OBJECT METHODS -->

2723 <!-- OBJECT EVENT FIELDS -->

2724 <!-- FUNCTION PARAMETERS -->

2725 </div>

2726 </div>

2727 </dl>

2728 </div>

2729 <!-- EXTRA PARAMETERS -->

2730 <!-- LISTENER RETURN VALUE -->

2731 <dl>

2732 </dl>

2733 </div> <!-- /description -->

2734 <!-- /description -->

2735 </div> <!-- /apiItem -->

2736 </div> <!-- /apiGroup -->

2737 <!-- TYPES -->

2738 <div class="apiGroup">

2739 <a name="types"></a>

2740 <h3 id="types">Types</h3>

2741 <!-- iterates over all types -->

2742 <div class="apiItem">

2743 <a name="type-KeyboardEvent"></a>

2744 <h4>KeyboardEvent</h4>

2745 <div>

2746 <dt>

2747 <em>

2748 <!-- TYPE -->

2749 <div style="display:inline">

2750 (

2751 <span id="typeTemplate">

2752 <span>

2753 <span>object</span>

2754 </span>

2755 </span>

2756 )

2757 </div>

2758 </em>

2759 </dt>

2760 <dd>See http://www.w3.org/TR/DOM-Level-3-Events/#events-KeyboardEvent< /dd>

2761 <!-- OBJECT PROPERTIES -->

2762 <dd>

2763 <dl>

2764 <div>

2765 <div>

2766 <dt>

2767 <var>type</var>

2768 <em>

2769 <!-- TYPE -->

2770 <div style="display:inline">

2771 (

2772 <span class="enum">enumerated</span>

2773 <span id="typeTemplate">

2774 <span>

2775 <span>string</span>

2776 <span>["keyup", "keydown"]</span>

2777 </span>

2778 </span>

2779 )

2780 </div>

2781 </em>

2782 </dt>

2783 <dd>One of keyup or keydown.</dd>

2784 <!-- OBJECT PROPERTIES -->

2785 <!-- OBJECT METHODS -->

2786 <!-- OBJECT EVENT FIELDS -->

2787 <!-- FUNCTION PARAMETERS -->

2788 </div>

2789 </div><div>

2790 <div>

2791 <dt>

2792 <var>requestId</var>

2793 <em>

2794 <!-- TYPE -->

2795 <div style="display:inline">

2796 (

2797 <span id="typeTemplate">

2798 <span>

2799 <span>string</span>

2800 </span>

2801 </span>

2802 )

2803 </div>

2804 </em>

2805 </dt>

2806 <dd>The ID of the request.</dd>

2807 <!-- OBJECT PROPERTIES -->

2808 <!-- OBJECT METHODS -->

2809 <!-- OBJECT EVENT FIELDS -->

2810 <!-- FUNCTION PARAMETERS -->

2811 </div>

2812 </div><div>

2813 <div>

2814 <dt>

2815 <var>key</var>

2816 <em>

2817 <!-- TYPE -->

2818 <div style="display:inline">

2819 (

2820 <span id="typeTemplate">

2821 <span>

2822 <span>string</span>

2823 </span>

2824 </span>

2825 )

2826 </div>

2827 </em>

2828 </dt>

2829 <dd>Value of the key being pressed</dd>

2830 <!-- OBJECT PROPERTIES -->

2831 <!-- OBJECT METHODS -->

2832 <!-- OBJECT EVENT FIELDS -->

2833 <!-- FUNCTION PARAMETERS -->

2834 </div>

2835 </div><div>

2836 <div>

2837 <dt>

2838 <var>altKey</var>

2839 <em>

2840 <!-- TYPE -->

2841 <div style="display:inline">

2842 (

2843 <span class="optional">optional</span>

2844 <span id="typeTemplate">

2845 <span>

2846 <span>boolean</span>

2847 </span>

2848 </span>

2849 )

2850 </div>

2851 </em>

2852 </dt>

2853 <dd>Whether or not the ALT key is pressed.</dd>

2854 <!-- OBJECT PROPERTIES -->

2855 <!-- OBJECT METHODS -->

2856 <!-- OBJECT EVENT FIELDS -->

2857 <!-- FUNCTION PARAMETERS -->

2858 </div>

2859 </div><div>

2860 <div>

2861 <dt>

2862 <var>ctrlKey</var>

2863 <em>

2864 <!-- TYPE -->

2865 <div style="display:inline">

2866 (

2867 <span class="optional">optional</span>

2868 <span id="typeTemplate">

2869 <span>

2870 <span>boolean</span>

2871 </span>

2872 </span>

2873 )

2874 </div>

2875 </em>

2876 </dt>

2877 <dd>Whether or not the CTRL key is pressed.</dd>

2878 <!-- OBJECT PROPERTIES -->

2879 <!-- OBJECT METHODS -->

2880 <!-- OBJECT EVENT FIELDS -->

2881 <!-- FUNCTION PARAMETERS -->

2882 </div>

2883 </div><div>

2884 <div>

2885 <dt>

2886 <var>shiftKey</var>

2887 <em>

2888 <!-- TYPE -->

2889 <div style="display:inline">

2890 (

2891 <span class="optional">optional</span>

2892 <span id="typeTemplate">

2893 <span>

2894 <span>boolean</span>

2895 </span>

2896 </span>

2897 )

2898 </div>

2899 </em>

2900 </dt>

2901 <dd>Whether or not the SHIFT key is pressed.</dd>

2902 <!-- OBJECT PROPERTIES -->

2903 <!-- OBJECT METHODS -->

2904 <!-- OBJECT EVENT FIELDS -->

2905 <!-- FUNCTION PARAMETERS -->

2906 </div>

2907 </div>

2908 </dl>

2909 </dd>

2910 <!-- OBJECT METHODS -->

2911 <!-- OBJECT EVENT FIELDS -->

2912 <!-- FUNCTION PARAMETERS -->

2913 </div>

2914 </div><div class="apiItem">

2915 <a name="type-InputContext"></a>

2916 <h4>InputContext</h4>

2917 <div>

2918 <dt>

2919 <em>

2920 <!-- TYPE -->

2921 <div style="display:inline">

2922 (

2923 <span id="typeTemplate">

2924 <span>

2925 <span>object</span>

2926 </span>

2927 </span>

2928 )

2929 </div>

2930 </em>

2931 </dt>

2932 <dd>Describes an input Context</dd>

2933 <!-- OBJECT PROPERTIES -->

2934 <dd>

2935 <dl>

2936 <div>

2937 <div>

2938 <dt>

2939 <var>contextID</var>

2940 <em>

2941 <!-- TYPE -->

2942 <div style="display:inline">

2943 (

2944 <span id="typeTemplate">

2945 <span>

2946 <span>integer</span>

2947 </span>

2948 </span>

2949 )

2950 </div>

2951 </em>

2952 </dt>

2953 <dd>This is used to specify targets of text field operations. This ID becomes invalid as soon as onBlur is called.</dd>

2954 <!-- OBJECT PROPERTIES -->

2955 <!-- OBJECT METHODS -->

2956 <!-- OBJECT EVENT FIELDS -->

2957 <!-- FUNCTION PARAMETERS -->

2958 </div>

2959 </div><div>

2960 <div>

2961 <dt>

2962 <var>type</var>

2963 <em>

2964 <!-- TYPE -->

2965 <div style="display:inline">

2966 (

2967 <span class="enum">enumerated</span>

2968 <span id="typeTemplate">

2969 <span>

2970 <span>string</span>

2971 <span>["text", "number", "password"]</span>

2972 </span>

2973 </span>

2974 )

2975 </div>

2976 </em>

2977 </dt>

2978 <dd>Type of value this text field edits, (Text, Number, Password, etc) </dd>

2979 <!-- OBJECT PROPERTIES -->

2980 <!-- OBJECT METHODS -->

2981 <!-- OBJECT EVENT FIELDS -->

2982 <!-- FUNCTION PARAMETERS -->

2983 </div>

2984 </div>

2985 </dl>

2986 </dd>

2987 <!-- OBJECT METHODS -->

2988 <!-- OBJECT EVENT FIELDS -->

2989 <!-- FUNCTION PARAMETERS -->

2990 </div>

2991 </div> <!-- /apiItem -->

2992 </div> <!-- /apiGroup -->

2993 </div> <!-- /apiPage -->

2994 </div> <!-- /gc-pagecontent -->

2995 </div> <!-- /g-section -->

2996 </div> <!-- /codesiteContent -->

2997 <div id="gc-footer" --="">

2998 <div class="text">

2999 <p>

3000 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,

3001 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons

3002 Attribution 3.0 License</a>, and code samples are licensed under the

3003 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.

3004 </p>

3005 <p>

3006 ©2011 Google

3007 </p>

3008 <!-- begin analytics -->

3009 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>

3010 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>

3011 <script type="text/javascript">

3012 // chrome doc tracking

3013 try {

3014 var engdocs = _gat._getTracker("YT-10763712-2");

3015 engdocs._trackPageview();

3016 } catch(err) {}

3017 // code.google.com site-wide tracking

3018 try {

3019 _uacct="UA-18071-1";

3020 _uanchor=1;

3021 _uff=0;

3022 urchinTracker();

3023 }

3024 catch(e) {/* urchinTracker not available. */}

3025 </script>

3026 <!-- end analytics -->

3027 </div>

3028 </div> <!-- /gc-footer -->

3029 </div> <!-- /gc-container -->

3030 </body></html>

OLD	NEW

« no previous file with comments | « chrome/common/extensions/docs/index.html ('k') | chrome/common/extensions/docs/js/api_page_generator.js » ('j') | no next file with comments »