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/jstemplate_compiled.js"> 15 </script> 16 <script type="text/javascript" src="js/api_page_generator.js"></script> 17 <script type="text/javascript" src="js/bootstrap.js"></script> 18 <script type="text/javascript" src="js/sidebar.js"></script> 19 <title>Omnibox - Google Chrome Extensions - Google Code</title></head> 20 <body> <div id="gc-container" class="labs"> 21 <div id="devModeWarning"> 22 You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files. 23 </div> 24 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION --> 25 <!-- In particular, sub-templates that recurse, must be used by allowing 26 jstemplate to make a copy of the template in this section which 27 are not operated on by way of the jsskip="true" --> 28 <div style="display:none"> 29 30 <!-- VALUE --> 31 <div id="valueTemplate"> 32 <dt> 33 <var>paramName</var> 34 <em> 35 36 <!-- TYPE --> 37 <div style="display:inline"> 38 ( 39 <span class="optional">optional</span> 40 <span class="enum">enumerated</span> 41 <span id="typeTemplate"> 42 <span> 43 <a> Type</a> 44 </span> 45 <span> 46 <span> 47 array of <span><span></span></span> 48 </span> 49 <span>paramType</span> 50 <span></span> 51 </span> 52 </span> 53 ) 54 </div> 55 56 </em> 57 </dt> 58 <dd class="todo"> 59 Undocumented. 60 </dd> 61 <dd> 62 Description of this parameter from the json schema. 63 </dd> 64 <dd> 65 This parameter was added in version 66 <b><span></span></b>. 67 You must omit this parameter in earlier versions, 68 and you may omit it in any version. If you require this 69 parameter, the manifest key 70 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 71 can ensure that your extension won't be run in an earlier browser version. 72 </dd> 73 74 <!-- OBJECT PROPERTIES --> 75 <dd> 76 <dl> 77 <div> 78 <div> 79 </div> 80 </div> 81 </dl> 82 </dd> 83 84 <!-- OBJECT METHODS --> 85 <dd> 86 <div></div> 87 </dd> 88 89 <!-- OBJECT EVENT FIELDS --> 90 <dd> 91 <div></div> 92 </dd> 93 94 <!-- FUNCTION PARAMETERS --> 95 <dd> 96 <div></div> 97 </dd> 98 99 </div> <!-- /VALUE --> 100 101 <div id="functionParametersTemplate"> 102 <h5>Parameters</h5> 103 <dl> 104 <div> 105 <div> 106 </div> 107 </div> 108 </dl> 109 </div> 110 </div> <!-- /SUBTEMPLATES --> 111 112 <a id="top"></a> 113 <div id="skipto"> 114 <a href="#gc-pagecontent">Skip to page content</a> 115 <a href="#gc-toc">Skip to main navigation</a> 116 </div> 117 <!-- API HEADER --> 118 <table id="header" width="100%" cellspacing="0" border="0"> 119 <tbody><tr> 120 <td valign="middle"><a href="http://code.google.com/"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></a></td> 121 <td valign="middle" width="100%" style="padding-left:0.6em;"> 122 <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em"> 123 <div id="gsc-search-box"> 124 <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno"> 125 <input type="hidden" name="ie" value="UTF-8"> 126 <input type="text" name="q" value="" size="55"> 127 <input class="gsc-search-button" type="submit" name="sa" value="Search"> 128 <br> 129 <span class="greytext">e.g. "page action" or "tabs"</span> 130 </div> 131 </form> 132 133 <script type="text/javascript" src="http://www.google.com/jsapi"></script> 134 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script> 135 <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script> 136 <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse&lang=en"></script> 137 </td> 138 </tr> 139 </tbody></table> 140 141 <div id="codesiteContent" class=""> 142 143 <a id="gc-topnav-anchor"></a> 144 <div id="gc-topnav"> 145 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1> 146 <ul id="home" class="gc-topnav-tabs"> 147 <li id="home_link"> 148 <a href="index.html" title="Google Chrome Extensions home page">Home</a> 149 </li> 150 <li id="docs_link"> 151 <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a> 152 </li> 153 <li id="faq_link"> 154 <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a> 155 </li> 156 <li id="samples_link"> 157 <a href="samples.html" title="Sample extensions (with source code)">Samples</a> 158 </li> 159 <li id="group_link"> 160 <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a> 161 </li> 162 </ul> 163 </div> <!-- end gc-topnav --> 164 165 <div class="g-section g-tpl-170"> 166 <!-- SIDENAV --> 167 <div class="g-unit g-first" id="gc-toc"> 168 <ul> 169 <li><a href="getstarted.html">Getting Started</a></li> 170 <li><a href="overview.html">Overview</a></li> 171 <li><a href="whats_new.html">What's New?</a></li> 172 <li><h2><a href="devguide.html">Developer's Guide</a></h2> 173 <ul> 174 <li>Browser UI 175 <ul> 176 <li><a href="browserAction.html">Browser Actions</a></li> 177 <li><a href="contextMenus.html">Context Menus</a></li> 178 <li><a href="notifications.html">Desktop Notifications</a></li> 179 <li class="leftNavSelected">Omnibox</li> 180 <li><a href="options.html">Options Pages</a></li> 181 <li><a href="override.html">Override Pages</a></li> 182 <li><a href="pageAction.html">Page Actions</a></li> 183 </ul> 184 </li> 185 <li>Browser Interaction 186 <ul> 187 <li><a href="bookmarks.html">Bookmarks</a></li> 188 <li><a href="cookies.html">Cookies</a></li> 189 <li><a href="events.html">Events</a></li> 190 <li><a href="history.html">History</a></li> 191 <li><a href="management.html">Management</a></li> 192 <li><a href="tabs.html">Tabs</a></li> 193 <li><a href="windows.html">Windows</a></li> 194 </ul> 195 </li> 196 <li>Implementation 197 <ul> 198 <li><a href="a11y.html">Accessibility</a></li> 199 <li><a href="background_pages.html">Background Pages</a></li> 200 <li><a href="content_scripts.html">Content Scripts</a></li> 201 <li><a href="xhr.html">Cross-Origin XHR</a></li> 202 <li><a href="idle.html">Idle</a></li> 203 <li><a href="i18n.html">Internationalization</a></li> 204 <li><a href="messaging.html">Message Passing</a></li> 205 <li><a href="npapi.html">NPAPI Plugins</a></li> 206 </ul> 207 </li> 208 <li>Finishing 209 <ul> 210 <li><a href="hosting.html">Hosting</a></li> 211 <li><a href="external_extensions.html">Other Deployment Options</a></li> 212 </ul> 213 </li> 214 </ul> 215 </li> 216 <li><h2><a href="apps.html">Packaged Apps</a></h2></li> 217 <li><h2><a href="tutorials.html">Tutorials</a></h2> 218 <ul> 219 <li><a href="tut_debugging.html">Debugging</a></li> 220 <li><a href="tut_analytics.html">Google Analytics</a></li> 221 <li><a href="tut_oauth.html">OAuth</a></li> 222 </ul> 223 </li> 224 <li><h2>Reference</h2> 225 <ul> 226 <li>Formats 227 <ul> 228 <li><a href="manifest.html">Manifest Files</a></li> 229 <li><a href="match_patterns.html">Match Patterns</a></li> 230 </ul> 231 </li> 232 <li><a href="permission_warnings.html">Permission Warnings</a></li> 233 <li><a href="api_index.html">chrome.* APIs</a></li> 234 <li><a href="api_other.html">Other APIs</a></li> 235 </ul> 236 </li> 237 <li><h2><a href="samples.html">Samples</a></h2></li> 238 <div class="line"> </div> 239 <li><h2>More</h2> 240 <ul> 241 <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li> 242 <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li> 243 <li><a href="themes.html">Themes</a></li> 244 </ul> 245 </li> 246 </ul> 247 </div> 248 <script> 249 initToggles(); 250 </script> 251 252 <div class="g-unit" id="gc-pagecontent"> 253 <div id="pageTitle"> 254 <h1 class="page_title">Omnibox</h1> 255 </div> 256 <!-- TABLE OF CONTENTS --> 257 <div id="toc"> 258 <h2>Contents</h2> 259 <ol> 260 <li> 261 <a href="#manifest">Manifest</a> 262 <ol> 263 <li style="display: none; "> 264 <a>h3Name</a> 265 </li> 266 </ol> 267 </li><li> 268 <a href="#examples">Examples</a> 269 <ol> 270 <li style="display: none; "> 271 <a>h3Name</a> 272 </li> 273 </ol> 274 </li> 275 <li> 276 <a href="#apiReference">API reference: chrome.omnibox</a> 277 <ol> 278 <li style="display: none; "> 279 <a href="#properties">Properties</a> 280 <ol> 281 <li> 282 <a href="#property-anchor">propertyName</a> 283 </li> 284 </ol> 285 </li> 286 <li> 287 <a href="#global-methods">Methods</a> 288 <ol> 289 <li style="display: none; "> 290 <a href="#method-anchor">methodName</a> 291 </li><li> 292 <a href="#method-setDefaultSuggestion">setDefaultSuggestion</a> 293 </li> 294 </ol> 295 </li> 296 <li> 297 <a href="#global-events">Events</a> 298 <ol> 299 <li> 300 <a href="#event-onInputCancelled">onInputCancelled</a> 301 </li><li> 302 <a href="#event-onInputChanged">onInputChanged</a> 303 </li><li> 304 <a href="#event-onInputEntered">onInputEntered</a> 305 </li><li> 306 <a href="#event-onInputStarted">onInputStarted</a> 307 </li> 308 </ol> 309 </li> 310 <li> 311 <a href="#types">Types</a> 312 <ol> 313 <li> 314 <a href="#type-SuggestResult">SuggestResult</a> 315 </li> 316 </ol> 317 </li> 318 </ol> 319 </li> 320 </ol> 321 </div> 322 <!-- /TABLE OF CONTENTS --> 323 324 <!-- Standard content lead-in for experimental API pages --> 325 <p id="classSummary" style="display: none; "> 326 For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. 327 </p> 328 329 <!-- STATIC CONTENT PLACEHOLDER --> 330 <div id="static"><div id="pageData-name" class="pageData">Omnibox</div> 331 332 <!-- BEGIN AUTHORED CONTENT --> 333 <p> 334 The omnibox API allows you to register a 335 keyword with Google Chrome's address bar, 336 which is also known as the omnibox. 337 </p> 338 339 <p> 340 <img src="images/omnibox.png" width="300" height="150" alt="A screenshot showing suggestions related to the keyword 'Chromium Search'"> 341 </p> 342 343 <p> 344 When the user enters your extension's 345 keyword, the user starts 346 interacting solely with your extension. 347 Each keystroke is sent to your 348 extension, and you can provide suggestions 349 in response. 350 </p> 351 352 <p> 353 The suggestions can be richly formatted 354 in a variety of ways. 355 <!-- PENDING: for example? (include a mention of method name, maybe show a code snippet) --> 356 When the user accepts 357 a suggestion, your extension is notified 358 and can take action. 359 </p> 360 361 <h2 id="manifest">Manifest</h2> 362 363 <p> 364 You must include an <code>omnibox</code> <code>keyword</code> field 365 in the <a href="manifest.html">manifest</a> 366 to use the omnibox API. 367 You should also 368 specify a 16x16-pixel icon, which will be 369 displayed in the address bar when suggesting that users 370 enter keyword mode. 371 </p> 372 373 <p> 374 For example: 375 </p> 376 377 <pre>{ 378 "name": "Aaron's omnibox extension", 379 "version": "1.0", 380 <b>"omnibox": { "keyword" : "aaron" },</b> 381 <b>"icons": {</b> 382 <b>"16": "16-full-color.png"</b> 383 <b>},</b> 384 "background_page": "background.html" 385 }</pre> 386 387 <p class="note"> 388 <strong>Note:</strong> 389 Chrome automatically creates a grayscale version of 390 your 16x16-pixel icon. You should provide 391 a full-color version so that it can also be 392 used in other situations that require color. 393 For example, the <a href="contextMenus.html">context menus API</a> also uses a 16x16-pixel 394 icon, but it is displayed in color. 395 </p> 396 397 398 <h2 id="examples">Examples</h2> 399 400 <p> 401 You can find samples of this API on the 402 <a href="samples.html#omnibox">sample page</a>. 403 404 <!-- END AUTHORED CONTENT --> 405 </p></div> 406 407 <!-- API PAGE --> 408 <div class="apiPage"> 409 <a name="apiReference"></a> 410 <h2>API reference: chrome.omnibox</h2> 411 412 <!-- PROPERTIES --> 413 <div class="apiGroup" style="display: none; "> 414 <a name="properties"></a> 415 <h3 id="properties">Properties</h3> 416 417 <div> 418 <a></a> 419 <h4>getLastError</h4> 420 <div class="summary"> 421 <!-- Note: intentionally longer 80 columns --> 422 <span>chrome.extension</span><span>lastError</span> 423 </div> 424 <div> 425 </div> 426 </div> 427 428 </div> <!-- /apiGroup --> 429 430 <!-- METHODS --> 431 <div id="methodsTemplate" class="apiGroup"> 432 <a name="global-methods"></a> 433 <h3>Methods</h3> 434 435 <!-- iterates over all functions --> 436 <div class="apiItem" style="display: none; "> 437 <a></a> <!-- method-anchor --> 438 <h4>method name</h4> 439 440 <div class="summary"><span>void</span> 441 <!-- Note: intentionally longer 80 columns --> 442 <span>chrome.module.methodName</span>(<span><span>, </span><span></span> 443 <var><span></span></var></span>)</div> 444 445 <div class="description"> 446 <p class="todo">Undocumented.</p> 447 <p> 448 A description from the json schema def of the function goes here. 449 </p> 450 451 <!-- PARAMETERS --> 452 <h4>Parameters</h4> 453 <dl> 454 <div> 455 <div> 456 </div> 457 </div> 458 </dl> 459 460 <!-- RETURNS --> 461 <h4>Returns</h4> 462 <dl> 463 <div> 464 <div> 465 </div> 466 </div> 467 </dl> 468 469 <!-- CALLBACK --> 470 <div> 471 <div> 472 <h4>Callback function</h4> 473 <p> 474 The callback <em>parameter</em> should specify a function 475 that looks like this: 476 </p> 477 <p> 478 If you specify the <em>callback</em> parameter, it should 479 specify a function that looks like this: 480 </p> 481 482 <!-- Note: intentionally longer 80 columns --> 483 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 484 <dl> 485 <div> 486 <div> 487 </div> 488 </div> 489 </dl> 490 </div> 491 </div> 492 493 <!-- MIN_VERSION --> 494 <p> 495 This function was added in version <b><span></span></b>. 496 If you require this function, the manifest key 497 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 498 can ensure that your extension won't be run in an earlier browser version. 499 </p> 500 </div> <!-- /description --> 501 502 </div><div class="apiItem"> 503 <a name="method-setDefaultSuggestion"></a> <!-- method-anchor --> 504 <h4>setDefaultSuggestion</h4> 505 506 <div class="summary"><span style="display: none; ">void</span> 507 <!-- Note: intentionally longer 80 columns --> 508 <span>chrome.omnibox.setDefaultSuggestion</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 509 <var><span>suggestion</span></var></span>)</div> 510 511 <div class="description"> 512 <p class="todo" style="display: none; ">Undocumented.</p> 513 <p>Sets the description and styling for the default suggestion. The default suggestion is the text that is displayed in the first suggestion row underneath the URL bar.</p> 514 515 <!-- PARAMETERS --> 516 <h4>Parameters</h4> 517 <dl> 518 <div> 519 <div> 520 <dt> 521 <var>suggestion</var> 522 <em> 523 524 <!-- TYPE --> 525 <div style="display:inline"> 526 ( 527 <span class="optional" style="display: none; ">optional</span> 528 <span class="enum" style="display: none; ">enumerated</span> 529 <span id="typeTemplate"> 530 <span style="display: none; "> 531 <a> Type</a> 532 </span> 533 <span> 534 <span style="display: none; "> 535 array of <span><span></span></span> 536 </span> 537 <span>object</span> 538 <span style="display: none; "></span> 539 </span> 540 </span> 541 ) 542 </div> 543 544 </em> 545 </dt> 546 <dd class="todo" style="display: none; "> 547 Undocumented. 548 </dd> 549 <dd>A partial SuggestResult object, without the 'content' parameter. See SuggestResult for a description of the parameters.</dd> 550 <dd style="display: none; "> 551 This parameter was added in version 552 <b><span></span></b>. 553 You must omit this parameter in earlier versions, 554 and you may omit it in any version. If you require this 555 parameter, the manifest key 556 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 557 can ensure that your extension won't be run in an earlier browser version. 558 </dd> 559 560 <!-- OBJECT PROPERTIES --> 561 <dd> 562 <dl> 563 <div> 564 <div> 565 <dt> 566 <var>description</var> 567 <em> 568 569 <!-- TYPE --> 570 <div style="display:inline"> 571 ( 572 <span class="optional" style="display: none; ">optional</span> 573 <span class="enum" style="display: none; ">enumerated</span> 574 <span id="typeTemplate"> 575 <span style="display: none; "> 576 <a> Type</a> 577 </span> 578 <span> 579 <span style="display: none; "> 580 array of <span><span></span></span> 581 </span> 582 <span>string</span> 583 <span style="display: none; "></span> 584 </span> 585 </span> 586 ) 587 </div> 588 589 </em> 590 </dt> 591 <dd class="todo" style="display: none; "> 592 Undocumented. 593 </dd> 594 <dd>The text to display in the default suggestion. The placeholder string '%s' can be included and will be replaced with the user's input.</dd> 595 <dd style="display: none; "> 596 This parameter was added in version 597 <b><span></span></b>. 598 You must omit this parameter in earlier versions, 599 and you may omit it in any version. If you require this 600 parameter, the manifest key 601 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 602 can ensure that your extension won't be run in an earlier browser version. 603 </dd> 604 605 <!-- OBJECT PROPERTIES --> 606 <dd style="display: none; "> 607 <dl> 608 <div> 609 <div> 610 </div> 611 </div> 612 </dl> 613 </dd> 614 615 <!-- OBJECT METHODS --> 616 <dd style="display: none; "> 617 <div></div> 618 </dd> 619 620 <!-- OBJECT EVENT FIELDS --> 621 <dd style="display: none; "> 622 <div></div> 623 </dd> 624 625 <!-- FUNCTION PARAMETERS --> 626 <dd style="display: none; "> 627 <div></div> 628 </dd> 629 630 </div> 631 </div> 632 </dl> 633 </dd> 634 635 <!-- OBJECT METHODS --> 636 <dd style="display: none; "> 637 <div></div> 638 </dd> 639 640 <!-- OBJECT EVENT FIELDS --> 641 <dd style="display: none; "> 642 <div></div> 643 </dd> 644 645 <!-- FUNCTION PARAMETERS --> 646 <dd style="display: none; "> 647 <div></div> 648 </dd> 649 650 </div> 651 </div> 652 </dl> 653 654 <!-- RETURNS --> 655 <h4 style="display: none; ">Returns</h4> 656 <dl> 657 <div style="display: none; "> 658 <div> 659 </div> 660 </div> 661 </dl> 662 663 <!-- CALLBACK --> 664 <div style="display: none; "> 665 <div> 666 <h4>Callback function</h4> 667 <p> 668 The callback <em>parameter</em> should specify a function 669 that looks like this: 670 </p> 671 <p> 672 If you specify the <em>callback</em> parameter, it should 673 specify a function that looks like this: 674 </p> 675 676 <!-- Note: intentionally longer 80 columns --> 677 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 678 <dl> 679 <div> 680 <div> 681 </div> 682 </div> 683 </dl> 684 </div> 685 </div> 686 687 <!-- MIN_VERSION --> 688 <p style="display: none; "> 689 This function was added in version <b><span></span></b>. 690 If you require this function, the manifest key 691 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 692 can ensure that your extension won't be run in an earlier browser version. 693 </p> 694 </div> <!-- /description --> 695 696 </div> <!-- /apiItem --> 697 698 </div> <!-- /apiGroup --> 699 700 <!-- EVENTS --> 701 <div id="eventsTemplate" class="apiGroup"> 702 <a name="global-events"></a> 703 <h3>Events</h3> 704 <!-- iterates over all events --> 705 <div class="apiItem"> 706 <a name="event-onInputCancelled"></a> 707 <h4>onInputCancelled</h4> 708 709 <div class="summary"> 710 <!-- Note: intentionally longer 80 columns --> 711 <span class="subdued">chrome.omnibox.</span><span>onInputCancelled</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span>); 712 </div> 713 714 <div class="description"> 715 <p class="todo" style="display: none; ">Undocumented.</p> 716 <p>User has ended the keyword input session without accepting the input.</p> 717 718 <!-- PARAMETERS --> 719 <div style="display: none; "> 720 <h4>Parameters</h4> 721 <dl> 722 <div> 723 <div> 724 </div> 725 </div> 726 </dl> 727 </div> 728 </div> <!-- /decription --> 729 730 </div><div class="apiItem"> 731 <a name="event-onInputChanged"></a> 732 <h4>onInputChanged</h4> 733 734 <div class="summary"> 735 <!-- Note: intentionally longer 80 columns --> 736 <span class="subdued">chrome.omnibox.</span><span>onInputChanged</span><span class="subdued">.addListener</span>(function(<span>string text, function suggest</span>) <span class="subdued">{...}</span>); 737 </div> 738 739 <div class="description"> 740 <p class="todo" style="display: none; ">Undocumented.</p> 741 <p>User has changed what is typed into the omnibox.</p> 742 743 <!-- PARAMETERS --> 744 <div> 745 <h4>Parameters</h4> 746 <dl> 747 <div> 748 <div> 749 <dt> 750 <var>text</var> 751 <em> 752 753 <!-- TYPE --> 754 <div style="display:inline"> 755 ( 756 <span class="optional" style="display: none; ">optional</span> 757 <span class="enum" style="display: none; ">enumerated</span> 758 <span id="typeTemplate"> 759 <span style="display: none; "> 760 <a> Type</a> 761 </span> 762 <span> 763 <span style="display: none; "> 764 array of <span><span></span></span> 765 </span> 766 <span>string</span> 767 <span style="display: none; "></span> 768 </span> 769 </span> 770 ) 771 </div> 772 773 </em> 774 </dt> 775 <dd class="todo"> 776 Undocumented. 777 </dd> 778 <dd style="display: none; "> 779 Description of this parameter from the json schema. 780 </dd> 781 <dd style="display: none; "> 782 This parameter was added in version 783 <b><span></span></b>. 784 You must omit this parameter in earlier versions, 785 and you may omit it in any version. If you require this 786 parameter, the manifest key 787 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 788 can ensure that your extension won't be run in an earlier browser version. 789 </dd> 790 791 <!-- OBJECT PROPERTIES --> 792 <dd style="display: none; "> 793 <dl> 794 <div> 795 <div> 796 </div> 797 </div> 798 </dl> 799 </dd> 800 801 <!-- OBJECT METHODS --> 802 <dd style="display: none; "> 803 <div></div> 804 </dd> 805 806 <!-- OBJECT EVENT FIELDS --> 807 <dd style="display: none; "> 808 <div></div> 809 </dd> 810 811 <!-- FUNCTION PARAMETERS --> 812 <dd style="display: none; "> 813 <div></div> 814 </dd> 815 816 </div> 817 </div><div> 818 <div> 819 <dt> 820 <var>suggest</var> 821 <em> 822 823 <!-- TYPE --> 824 <div style="display:inline"> 825 ( 826 <span class="optional" style="display: none; ">optional</span> 827 <span class="enum" style="display: none; ">enumerated</span> 828 <span id="typeTemplate"> 829 <span style="display: none; "> 830 <a> Type</a> 831 </span> 832 <span> 833 <span style="display: none; "> 834 array of <span><span></span></span> 835 </span> 836 <span>function</span> 837 <span style="display: none; "></span> 838 </span> 839 </span> 840 ) 841 </div> 842 843 </em> 844 </dt> 845 <dd class="todo" style="display: none; "> 846 Undocumented. 847 </dd> 848 <dd>A callback passed to the onInputChanged event used for sending suggestions back to the browser.</dd> 849 <dd style="display: none; "> 850 This parameter was added in version 851 <b><span></span></b>. 852 You must omit this parameter in earlier versions, 853 and you may omit it in any version. If you require this 854 parameter, the manifest key 855 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 856 can ensure that your extension won't be run in an earlier browser version. 857 </dd> 858 859 <!-- OBJECT PROPERTIES --> 860 <dd style="display: none; "> 861 <dl> 862 <div> 863 <div> 864 </div> 865 </div> 866 </dl> 867 </dd> 868 869 <!-- OBJECT METHODS --> 870 <dd style="display: none; "> 871 <div></div> 872 </dd> 873 874 <!-- OBJECT EVENT FIELDS --> 875 <dd style="display: none; "> 876 <div></div> 877 </dd> 878 879 <!-- FUNCTION PARAMETERS --> 880 <dd> 881 <div> 882 <h5>Parameters</h5> 883 <dl> 884 <div> 885 <div> 886 <dt> 887 <var style="display: none; ">paramName</var> 888 <em> 889 890 <!-- TYPE --> 891 <div style="display:inline"> 892 ( 893 <span class="optional" style="display: none; ">optional</span> 894 <span class="enum" style="display: none; ">enumerated</span> 895 <span id="typeTemplate"> 896 <span style="display: none; "> 897 <a> Type</a> 898 </span> 899 <span> 900 <span> 901 array of <span><span> 902 <span> 903 <a href="omnibox.html#type-SuggestResult">SuggestResult</a> 904 </span> 905 <span style="display: none; "> 906 <span> 907 array of <span><span></span></span> 908 </span> 909 <span>paramType</span> 910 <span></span> 911 </span> 912 </span></span> 913 </span> 914 <span style="display: none; ">paramType</span> 915 <span style="display: none; "></span> 916 </span> 917 </span> 918 ) 919 </div> 920 921 </em> 922 </dt> 923 <dd class="todo" style="display: none; "> 924 Undocumented. 925 </dd> 926 <dd>Array of suggest results</dd> 927 <dd style="display: none; "> 928 This parameter was added in version 929 <b><span></span></b>. 930 You must omit this parameter in earlier versions, 931 and you may omit it in any version. If you require this 932 parameter, the manifest key 933 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 934 can ensure that your extension won't be run in an earlier browser version. 935 </dd> 936 937 <!-- OBJECT PROPERTIES --> 938 <dd style="display: none; "> 939 <dl> 940 <div> 941 <div> 942 </div> 943 </div> 944 </dl> 945 </dd> 946 947 <!-- OBJECT METHODS --> 948 <dd style="display: none; "> 949 <div></div> 950 </dd> 951 952 <!-- OBJECT EVENT FIELDS --> 953 <dd style="display: none; "> 954 <div></div> 955 </dd> 956 957 <!-- FUNCTION PARAMETERS --> 958 <dd style="display: none; "> 959 <div></div> 960 </dd> 961 962 </div> 963 </div> 964 </dl> 965 </div> 966 </dd> 967 968 </div> 969 </div> 970 </dl> 971 </div> 972 </div> <!-- /decription --> 973 974 </div><div class="apiItem"> 975 <a name="event-onInputEntered"></a> 976 <h4>onInputEntered</h4> 977 978 <div class="summary"> 979 <!-- Note: intentionally longer 80 columns --> 980 <span class="subdued">chrome.omnibox.</span><span>onInputEntered</span><span class="subdued">.addListener</span>(function(<span>string text</span>) <span class="subdued">{...}</span>); 981 </div> 982 983 <div class="description"> 984 <p class="todo" style="display: none; ">Undocumented.</p> 985 <p>User has accepted what is typed into the omnibox.</p> 986 987 <!-- PARAMETERS --> 988 <div> 989 <h4>Parameters</h4> 990 <dl> 991 <div> 992 <div> 993 <dt> 994 <var>text</var> 995 <em> 996 997 <!-- TYPE --> 998 <div style="display:inline"> 999 ( 1000 <span class="optional" style="display: none; ">optional</span> 1001 <span class="enum" style="display: none; ">enumerated</span> 1002 <span id="typeTemplate"> 1003 <span style="display: none; "> 1004 <a> Type</a> 1005 </span> 1006 <span> 1007 <span style="display: none; "> 1008 array of <span><span></span></span> 1009 </span> 1010 <span>string</span> 1011 <span style="display: none; "></span> 1012 </span> 1013 </span> 1014 ) 1015 </div> 1016 1017 </em> 1018 </dt> 1019 <dd class="todo"> 1020 Undocumented. 1021 </dd> 1022 <dd style="display: none; "> 1023 Description of this parameter from the json schema. 1024 </dd> 1025 <dd style="display: none; "> 1026 This parameter was added in version 1027 <b><span></span></b>. 1028 You must omit this parameter in earlier versions, 1029 and you may omit it in any version. If you require this 1030 parameter, the manifest key 1031 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1032 can ensure that your extension won't be run in an earlier browser version. 1033 </dd> 1034 1035 <!-- OBJECT PROPERTIES --> 1036 <dd style="display: none; "> 1037 <dl> 1038 <div> 1039 <div> 1040 </div> 1041 </div> 1042 </dl> 1043 </dd> 1044 1045 <!-- OBJECT METHODS --> 1046 <dd style="display: none; "> 1047 <div></div> 1048 </dd> 1049 1050 <!-- OBJECT EVENT FIELDS --> 1051 <dd style="display: none; "> 1052 <div></div> 1053 </dd> 1054 1055 <!-- FUNCTION PARAMETERS --> 1056 <dd style="display: none; "> 1057 <div></div> 1058 </dd> 1059 1060 </div> 1061 </div> 1062 </dl> 1063 </div> 1064 </div> <!-- /decription --> 1065 1066 </div><div class="apiItem"> 1067 <a name="event-onInputStarted"></a> 1068 <h4>onInputStarted</h4> 1069 1070 <div class="summary"> 1071 <!-- Note: intentionally longer 80 columns --> 1072 <span class="subdued">chrome.omnibox.</span><span>onInputStarted</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span>); 1073 </div> 1074 1075 <div class="description"> 1076 <p class="todo" style="display: none; ">Undocumented.</p> 1077 <p>User has started a keyword input session by typing the extension's keyword. This is guaranteed to be sent exactly once per input session, and before any onInputChanged events.</p> 1078 1079 <!-- PARAMETERS --> 1080 <div style="display: none; "> 1081 <h4>Parameters</h4> 1082 <dl> 1083 <div> 1084 <div> 1085 </div> 1086 </div> 1087 </dl> 1088 </div> 1089 </div> <!-- /decription --> 1090 1091 </div> <!-- /apiItem --> 1092 1093 </div> <!-- /apiGroup --> 1094 1095 <!-- TYPES --> 1096 <div class="apiGroup"> 1097 <a name="types"></a> 1098 <h3 id="types">Types</h3> 1099 1100 <!-- iterates over all types --> 1101 <div class="apiItem"> 1102 <a name="type-SuggestResult"></a> 1103 <h4>SuggestResult</h4> 1104 1105 <div> 1106 <dt> 1107 <var style="display: none; ">paramName</var> 1108 <em> 1109 1110 <!-- TYPE --> 1111 <div style="display:inline"> 1112 ( 1113 <span class="optional" style="display: none; ">optional</span> 1114 <span class="enum" style="display: none; ">enumerated</span> 1115 <span id="typeTemplate"> 1116 <span style="display: none; "> 1117 <a> Type</a> 1118 </span> 1119 <span> 1120 <span style="display: none; "> 1121 array of <span><span></span></span> 1122 </span> 1123 <span>object</span> 1124 <span style="display: none; "></span> 1125 </span> 1126 </span> 1127 ) 1128 </div> 1129 1130 </em> 1131 </dt> 1132 <dd class="todo" style="display: none; "> 1133 Undocumented. 1134 </dd> 1135 <dd>A suggest result.</dd> 1136 <dd style="display: none; "> 1137 This parameter was added in version 1138 <b><span></span></b>. 1139 You must omit this parameter in earlier versions, 1140 and you may omit it in any version. If you require this 1141 parameter, the manifest key 1142 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1143 can ensure that your extension won't be run in an earlier browser version. 1144 </dd> 1145 1146 <!-- OBJECT PROPERTIES --> 1147 <dd> 1148 <dl> 1149 <div> 1150 <div> 1151 <dt> 1152 <var>content</var> 1153 <em> 1154 1155 <!-- TYPE --> 1156 <div style="display:inline"> 1157 ( 1158 <span class="optional" style="display: none; ">optional</span> 1159 <span class="enum" style="display: none; ">enumerated</span> 1160 <span id="typeTemplate"> 1161 <span style="display: none; "> 1162 <a> Type</a> 1163 </span> 1164 <span> 1165 <span style="display: none; "> 1166 array of <span><span></span></span> 1167 </span> 1168 <span>string</span> 1169 <span style="display: none; "></span> 1170 </span> 1171 </span> 1172 ) 1173 </div> 1174 1175 </em> 1176 </dt> 1177 <dd class="todo" style="display: none; "> 1178 Undocumented. 1179 </dd> 1180 <dd>The text that is put into the URL bar, and that is sent to the extension when the user chooses this entry.</dd> 1181 <dd style="display: none; "> 1182 This parameter was added in version 1183 <b><span></span></b>. 1184 You must omit this parameter in earlier versions, 1185 and you may omit it in any version. If you require this 1186 parameter, the manifest key 1187 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1188 can ensure that your extension won't be run in an earlier browser version. 1189 </dd> 1190 1191 <!-- OBJECT PROPERTIES --> 1192 <dd style="display: none; "> 1193 <dl> 1194 <div> 1195 <div> 1196 </div> 1197 </div> 1198 </dl> 1199 </dd> 1200 1201 <!-- OBJECT METHODS --> 1202 <dd style="display: none; "> 1203 <div></div> 1204 </dd> 1205 1206 <!-- OBJECT EVENT FIELDS --> 1207 <dd style="display: none; "> 1208 <div></div> 1209 </dd> 1210 1211 <!-- FUNCTION PARAMETERS --> 1212 <dd style="display: none; "> 1213 <div></div> 1214 </dd> 1215 1216 </div> 1217 </div><div> 1218 <div> 1219 <dt> 1220 <var>description</var> 1221 <em> 1222 1223 <!-- TYPE --> 1224 <div style="display:inline"> 1225 ( 1226 <span class="optional" style="display: none; ">optional</span> 1227 <span class="enum" style="display: none; ">enumerated</span> 1228 <span id="typeTemplate"> 1229 <span style="display: none; "> 1230 <a> Type</a> 1231 </span> 1232 <span> 1233 <span style="display: none; "> 1234 array of <span><span></span></span> 1235 </span> 1236 <span>string</span> 1237 <span style="display: none; "></span> 1238 </span> 1239 </span> 1240 ) 1241 </div> 1242 1243 </em> 1244 </dt> 1245 <dd class="todo" style="display: none; "> 1246 Undocumented. 1247 </dd> 1248 <dd>The text that is displayed in the URL dropdown. Can contain XML-style markup for styling. The supported tags are 'url' (for a literal URL), 'match' (for highlighting text that matched what the user's query), and 'dim' (for dim helper text). The styles can be nested, eg. <dim><match>dimmed match</match></dim>.</dd> 1249 <dd style="display: none; "> 1250 This parameter was added in version 1251 <b><span></span></b>. 1252 You must omit this parameter in earlier versions, 1253 and you may omit it in any version. If you require this 1254 parameter, the manifest key 1255 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1256 can ensure that your extension won't be run in an earlier browser version. 1257 </dd> 1258 1259 <!-- OBJECT PROPERTIES --> 1260 <dd style="display: none; "> 1261 <dl> 1262 <div> 1263 <div> 1264 </div> 1265 </div> 1266 </dl> 1267 </dd> 1268 1269 <!-- OBJECT METHODS --> 1270 <dd style="display: none; "> 1271 <div></div> 1272 </dd> 1273 1274 <!-- OBJECT EVENT FIELDS --> 1275 <dd style="display: none; "> 1276 <div></div> 1277 </dd> 1278 1279 <!-- FUNCTION PARAMETERS --> 1280 <dd style="display: none; "> 1281 <div></div> 1282 </dd> 1283 1284 </div> 1285 </div> 1286 </dl> 1287 </dd> 1288 1289 <!-- OBJECT METHODS --> 1290 <dd style="display: none; "> 1291 <div></div> 1292 </dd> 1293 1294 <!-- OBJECT EVENT FIELDS --> 1295 <dd style="display: none; "> 1296 <div></div> 1297 </dd> 1298 1299 <!-- FUNCTION PARAMETERS --> 1300 <dd style="display: none; "> 1301 <div></div> 1302 </dd> 1303 1304 </div> 1305 1306 </div> <!-- /apiItem --> 1307 1308 </div> <!-- /apiGroup --> 1309 1310 </div> <!-- /apiPage --> 1311 </div> <!-- /gc-pagecontent --> 1312 </div> <!-- /g-section --> 1313 </div> <!-- /codesiteContent --> 1314 <div id="gc-footer" --=""> 1315 <div class="text"> 1316 <p> 1317 Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>, 1318 the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons 1319 Attribution 3.0 License</a>, and code samples are licensed under the 1320 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>. 1321 </p> 1322 <p> 1323 2011 Google 1324 </p> 1325 1326 <!-- begin analytics --> 1327 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> 1328 <script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script> 1329 1330 <script type="text/javascript"> 1331 // chrome doc tracking 1332 try { 1333 var engdocs = _gat._getTracker("YT-10763712-2"); 1334 engdocs._trackPageview(); 1335 } catch(err) {} 1336 1337 // code.google.com site-wide tracking 1338 try { 1339 _uacct="UA-18071-1"; 1340 _uanchor=1; 1341 _uff=0; 1342 urchinTracker(); 1343 } 1344 catch(e) {/* urchinTracker not available. */} 1345 </script> 1346 <!-- end analytics --> 1347 </div> 1348 </div> <!-- /gc-footer --> 1349 </div> <!-- /gc-container --> 1350 </body></html> 1351
