omnibox.html revision 201ade2fbba22bfb27ae029f4d23fca6ded109a0
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 <!-- FUNCTION PARAMETERS --> 85 <dd> 86 <div></div> 87 </dd> 88 89 </div> <!-- /VALUE --> 90 91 <div id="functionParametersTemplate"> 92 <h5>Parameters</h5> 93 <dl> 94 <div> 95 <div> 96 </div> 97 </div> 98 </dl> 99 </div> 100 </div> <!-- /SUBTEMPLATES --> 101 102 <a id="top"></a> 103 <div id="skipto"> 104 <a href="#gc-pagecontent">Skip to page content</a> 105 <a href="#gc-toc">Skip to main navigation</a> 106 </div> 107 <!-- API HEADER --> 108 <table id="header" width="100%" cellspacing="0" border="0"> 109 <tbody><tr> 110 <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> 111 <td valign="middle" width="100%" style="padding-left:0.6em;"> 112 <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em"> 113 <div id="gsc-search-box"> 114 <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno"> 115 <input type="hidden" name="ie" value="UTF-8"> 116 <input type="text" name="q" value="" size="55"> 117 <input class="gsc-search-button" type="submit" name="sa" value="Search"> 118 <br> 119 <span class="greytext">e.g. "page action" or "tabs"</span> 120 </div> 121 </form> 122 123 <script type="text/javascript" src="http://www.google.com/jsapi"></script> 124 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script> 125 <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script> 126 <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse&lang=en"></script> 127 </td> 128 </tr> 129 </tbody></table> 130 131 <div id="codesiteContent" class=""> 132 133 <a id="gc-topnav-anchor"></a> 134 <div id="gc-topnav"> 135 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1> 136 <ul id="home" class="gc-topnav-tabs"> 137 <li id="home_link"> 138 <a href="index.html" title="Google Chrome Extensions home page">Home</a> 139 </li> 140 <li id="docs_link"> 141 <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a> 142 </li> 143 <li id="faq_link"> 144 <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a> 145 </li> 146 <li id="samples_link"> 147 <a href="samples.html" title="Sample extensions (with source code)">Samples</a> 148 </li> 149 <li id="group_link"> 150 <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a> 151 </li> 152 </ul> 153 </div> <!-- end gc-topnav --> 154 155 <div class="g-section g-tpl-170"> 156 <!-- SIDENAV --> 157 <div class="g-unit g-first" id="gc-toc"> 158 <ul> 159 <li><a href="getstarted.html">Getting Started</a></li> 160 <li><a href="overview.html">Overview</a></li> 161 <li><a href="whats_new.html">What's New?</a></li> 162 <li><h2><a href="devguide.html">Developer's Guide</a></h2> 163 <ul> 164 <li>Browser UI 165 <ul> 166 <li><a href="browserAction.html">Browser Actions</a></li> 167 <li><a href="contextMenus.html">Context Menus</a></li> 168 <li><a href="notifications.html">Desktop Notifications</a></li> 169 <li class="leftNavSelected">Omnibox</li> 170 <li><a href="options.html">Options Pages</a></li> 171 <li><a href="override.html">Override Pages</a></li> 172 <li><a href="pageAction.html">Page Actions</a></li> 173 </ul> 174 </li> 175 <li>Browser Interaction 176 <ul> 177 <li><a href="bookmarks.html">Bookmarks</a></li> 178 <li><a href="cookies.html">Cookies</a></li> 179 <li><a href="events.html">Events</a></li> 180 <li><a href="history.html">History</a></li> 181 <li><a href="management.html">Management</a></li> 182 <li><a href="tabs.html">Tabs</a></li> 183 <li><a href="windows.html">Windows</a></li> 184 </ul> 185 </li> 186 <li>Implementation 187 <ul> 188 <li><a href="a11y.html">Accessibility</a></li> 189 <li><a href="background_pages.html">Background Pages</a></li> 190 <li><a href="content_scripts.html">Content Scripts</a></li> 191 <li><a href="xhr.html">Cross-Origin XHR</a></li> 192 <li><a href="idle.html">Idle</a></li> 193 <li><a href="i18n.html">Internationalization</a></li> 194 <li><a href="messaging.html">Message Passing</a></li> 195 <li><a href="npapi.html">NPAPI Plugins</a></li> 196 </ul> 197 </li> 198 <li>Finishing 199 <ul> 200 <li><a href="hosting.html">Hosting</a></li> 201 <li><a href="external_extensions.html">Other Deployment Options</a></li> 202 </ul> 203 </li> 204 </ul> 205 </li> 206 <li><h2><a href="apps.html">Packaged Apps</a></h2></li> 207 <li><h2><a href="tutorials.html">Tutorials</a></h2> 208 <ul> 209 <li><a href="tut_debugging.html">Debugging</a></li> 210 <li><a href="tut_analytics.html">Google Analytics</a></li> 211 <li><a href="tut_oauth.html">OAuth</a></li> 212 </ul> 213 </li> 214 <li><h2>Reference</h2> 215 <ul> 216 <li>Formats 217 <ul> 218 <li><a href="manifest.html">Manifest Files</a></li> 219 <li><a href="match_patterns.html">Match Patterns</a></li> 220 </ul> 221 </li> 222 <li><a href="permission_warnings.html">Permission Warnings</a></li> 223 <li><a href="api_index.html">chrome.* APIs</a></li> 224 <li><a href="api_other.html">Other APIs</a></li> 225 </ul> 226 </li> 227 <li><h2><a href="samples.html">Samples</a></h2></li> 228 <div class="line"> </div> 229 <li><h2>More</h2> 230 <ul> 231 <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li> 232 <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li> 233 <li><a href="themes.html">Themes</a></li> 234 </ul> 235 </li> 236 </ul> 237 </div> 238 <script> 239 initToggles(); 240 </script> 241 242 <div class="g-unit" id="gc-pagecontent"> 243 <div id="pageTitle"> 244 <h1 class="page_title">Omnibox</h1> 245 </div> 246 <!-- TABLE OF CONTENTS --> 247 <div id="toc"> 248 <h2>Contents</h2> 249 <ol> 250 <li> 251 <a href="#manifest">Manifest</a> 252 <ol> 253 <li style="display: none; "> 254 <a>h3Name</a> 255 </li> 256 </ol> 257 </li><li> 258 <a href="#examples">Examples</a> 259 <ol> 260 <li style="display: none; "> 261 <a>h3Name</a> 262 </li> 263 </ol> 264 </li> 265 <li> 266 <a href="#apiReference">API reference: chrome.omnibox</a> 267 <ol> 268 <li style="display: none; "> 269 <a href="#properties">Properties</a> 270 <ol> 271 <li> 272 <a href="#property-anchor">propertyName</a> 273 </li> 274 </ol> 275 </li> 276 <li> 277 <a href="#methods">Methods</a> 278 <ol> 279 <li style="display: none; "> 280 <a href="#method-anchor">methodName</a> 281 </li><li> 282 <a href="#method-setDefaultSuggestion">setDefaultSuggestion</a> 283 </li><li> 284 <a href="#method-styleDim">styleDim</a> 285 </li><li> 286 <a href="#method-styleMatch">styleMatch</a> 287 </li><li> 288 <a href="#method-styleUrl">styleUrl</a> 289 </li> 290 </ol> 291 </li> 292 <li> 293 <a href="#events">Events</a> 294 <ol> 295 <li> 296 <a href="#event-onInputCancelled">onInputCancelled</a> 297 </li><li> 298 <a href="#event-onInputChanged">onInputChanged</a> 299 </li><li> 300 <a href="#event-onInputEntered">onInputEntered</a> 301 </li><li> 302 <a href="#event-onInputStarted">onInputStarted</a> 303 </li> 304 </ol> 305 </li> 306 <li> 307 <a href="#types">Types</a> 308 <ol> 309 <li> 310 <a href="#type-SuggestResult">SuggestResult</a> 311 </li> 312 </ol> 313 </li> 314 </ol> 315 </li> 316 </ol> 317 </div> 318 <!-- /TABLE OF CONTENTS --> 319 320 <!-- Standard content lead-in for experimental API pages --> 321 <p id="classSummary" style="display: none; "> 322 For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. 323 </p> 324 325 <!-- STATIC CONTENT PLACEHOLDER --> 326 <div id="static"><div id="pageData-name" class="pageData">Omnibox</div> 327 328<!-- BEGIN AUTHORED CONTENT --> 329<p> 330The omnibox API allows you to register a 331keyword with Google Chrome's address bar, 332which is also known as the omnibox. 333</p> 334 335<p> 336<img src="images/omnibox.png" width="300" height="150" alt="A screenshot showing suggestions related to the keyword 'Chromium Search'"> 337</p> 338 339<p> 340When the user enters your extension's 341keyword, the user starts 342interacting solely with your extension. 343Each keystroke is sent to your 344extension, and you can provide suggestions 345in response. 346</p> 347 348<p> 349The suggestions can be richly formatted 350in a variety of ways. 351<!-- PENDING: for example? (include a mention of method name, maybe show a code snippet) --> 352When the user accepts 353a suggestion, your extension is notified 354and can take action. 355</p> 356 357<h2 id="manifest">Manifest</h2> 358 359<p> 360You must include an <code>omnibox</code> <code>keyword</code> field 361in the <a href="manifest.html">manifest</a> 362to use the omnibox API. 363You should also 364specify a 16x16-pixel icon, which will be 365displayed in the address bar when suggesting that users 366enter keyword mode. 367</p> 368 369<p> 370For example: 371</p> 372 373<pre>{ 374 "name": "Aaron's omnibox extension", 375 "version": "1.0", 376 <b>"omnibox": { "keyword" : "aaron" },</b> 377 <b>"icons": {</b> 378 <b>"16": "16-full-color.png"</b> 379 <b>},</b> 380 "background_page": "background.html" 381}</pre> 382 383<p class="note"> 384<strong>Note:</strong> 385Chrome automatically creates a grayscale version of 386your 16x16-pixel icon. You should provide 387a full-color version so that it can also be 388used in other situations that require color. 389For example, the <a href="contextMenus.html">context menus API</a> also uses a 16x16-pixel 390icon, but it is displayed in color. 391</p> 392 393 394<h2 id="examples">Examples</h2> 395 396<p> 397You can find samples of this API on the 398<a href="samples.html#omnibox">sample page</a>. 399 400<!-- END AUTHORED CONTENT --> 401</p></div> 402 403 <!-- API PAGE --> 404 <div class="apiPage"> 405 <a name="apiReference"></a> 406 <h2>API reference: chrome.omnibox</h2> 407 408 <!-- PROPERTIES --> 409 <div class="apiGroup" style="display: none; "> 410 <a name="properties"></a> 411 <h3 id="properties">Properties</h3> 412 413 <div> 414 <a></a> 415 <h4>getLastError</h4> 416 <div class="summary"> 417 <!-- Note: intentionally longer 80 columns --> 418 <span>chrome.extension</span><span>lastError</span> 419 </div> 420 <div> 421 </div> 422 </div> 423 424 </div> <!-- /apiGroup --> 425 426 <!-- METHODS --> 427 <div class="apiGroup" id="methods"> 428 <a name="methods"></a> 429 <h3>Methods</h3> 430 431 <!-- iterates over all functions --> 432 <div class="apiItem" style="display: none; "> 433 <a></a> <!-- method-anchor --> 434 <h4>method name</h4> 435 436 <div class="summary"><span>void</span> 437 <!-- Note: intentionally longer 80 columns --> 438 <span>chrome.module.methodName</span>(<span><span>, </span><span></span> 439 <var><span></span></var></span>)</div> 440 441 <div class="description"> 442 <p class="todo">Undocumented.</p> 443 <p> 444 A description from the json schema def of the function goes here. 445 </p> 446 447 <!-- PARAMETERS --> 448 <h4>Parameters</h4> 449 <dl> 450 <div> 451 <div> 452 </div> 453 </div> 454 </dl> 455 456 <!-- RETURNS --> 457 <h4>Returns</h4> 458 <dl> 459 <div> 460 <div> 461 </div> 462 </div> 463 </dl> 464 465 <!-- CALLBACK --> 466 <div> 467 <div> 468 <h4>Callback function</h4> 469 <p> 470 The callback <em>parameter</em> should specify a function 471 that looks like this: 472 </p> 473 <p> 474 If you specify the <em>callback</em> parameter, it should 475 specify a function that looks like this: 476 </p> 477 478 <!-- Note: intentionally longer 80 columns --> 479 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 480 <dl> 481 <div> 482 <div> 483 </div> 484 </div> 485 </dl> 486 </div> 487 </div> 488 489 <!-- MIN_VERSION --> 490 <p> 491 This function was added in version <b><span></span></b>. 492 If you require this function, the manifest key 493 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 494 can ensure that your extension won't be run in an earlier browser version. 495 </p> 496 </div> <!-- /description --> 497 498 </div><div class="apiItem"> 499 <a name="method-setDefaultSuggestion"></a> <!-- method-anchor --> 500 <h4>setDefaultSuggestion</h4> 501 502 <div class="summary"><span style="display: none; ">void</span> 503 <!-- Note: intentionally longer 80 columns --> 504 <span>chrome.omnibox.setDefaultSuggestion</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 505 <var><span>suggestion</span></var></span>)</div> 506 507 <div class="description"> 508 <p class="todo" style="display: none; ">Undocumented.</p> 509 <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> 510 511 <!-- PARAMETERS --> 512 <h4>Parameters</h4> 513 <dl> 514 <div> 515 <div> 516 <dt> 517 <var>suggestion</var> 518 <em> 519 520 <!-- TYPE --> 521 <div style="display:inline"> 522 ( 523 <span class="optional" style="display: none; ">optional</span> 524 <span class="enum" style="display: none; ">enumerated</span> 525 <span id="typeTemplate"> 526 <span style="display: none; "> 527 <a> Type</a> 528 </span> 529 <span> 530 <span style="display: none; "> 531 array of <span><span></span></span> 532 </span> 533 <span>object</span> 534 <span style="display: none; "></span> 535 </span> 536 </span> 537 ) 538 </div> 539 540 </em> 541 </dt> 542 <dd class="todo" style="display: none; "> 543 Undocumented. 544 </dd> 545 <dd>A partial SuggestResult object, without the 'content' parameter. See SuggestResult for a description of the parameters.</dd> 546 <dd style="display: none; "> 547 This parameter was added in version 548 <b><span></span></b>. 549 You must omit this parameter in earlier versions, 550 and you may omit it in any version. If you require this 551 parameter, the manifest key 552 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 553 can ensure that your extension won't be run in an earlier browser version. 554 </dd> 555 556 <!-- OBJECT PROPERTIES --> 557 <dd> 558 <dl> 559 <div> 560 <div> 561 <dt> 562 <var>description</var> 563 <em> 564 565 <!-- TYPE --> 566 <div style="display:inline"> 567 ( 568 <span class="optional" style="display: none; ">optional</span> 569 <span class="enum" style="display: none; ">enumerated</span> 570 <span id="typeTemplate"> 571 <span style="display: none; "> 572 <a> Type</a> 573 </span> 574 <span> 575 <span style="display: none; "> 576 array of <span><span></span></span> 577 </span> 578 <span>string</span> 579 <span style="display: none; "></span> 580 </span> 581 </span> 582 ) 583 </div> 584 585 </em> 586 </dt> 587 <dd class="todo" style="display: none; "> 588 Undocumented. 589 </dd> 590 <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> 591 <dd style="display: none; "> 592 This parameter was added in version 593 <b><span></span></b>. 594 You must omit this parameter in earlier versions, 595 and you may omit it in any version. If you require this 596 parameter, the manifest key 597 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 598 can ensure that your extension won't be run in an earlier browser version. 599 </dd> 600 601 <!-- OBJECT PROPERTIES --> 602 <dd style="display: none; "> 603 <dl> 604 <div> 605 <div> 606 </div> 607 </div> 608 </dl> 609 </dd> 610 611 <!-- FUNCTION PARAMETERS --> 612 <dd style="display: none; "> 613 <div></div> 614 </dd> 615 616 </div> 617 </div><div> 618 <div> 619 <dt> 620 <var>descriptionStyles</var> 621 <em> 622 623 <!-- TYPE --> 624 <div style="display:inline"> 625 ( 626 <span class="optional">optional</span> 627 <span class="enum" style="display: none; ">enumerated</span> 628 <span id="typeTemplate"> 629 <span style="display: none; "> 630 <a> Type</a> 631 </span> 632 <span> 633 <span> 634 array of <span><span> 635 <span style="display: none; "> 636 <a> Type</a> 637 </span> 638 <span> 639 <span style="display: none; "> 640 array of <span><span></span></span> 641 </span> 642 <span>object</span> 643 <span style="display: none; "></span> 644 </span> 645 </span></span> 646 </span> 647 <span style="display: none; ">paramType</span> 648 <span style="display: none; "></span> 649 </span> 650 </span> 651 ) 652 </div> 653 654 </em> 655 </dt> 656 <dd class="todo"> 657 Undocumented. 658 </dd> 659 <dd style="display: none; "> 660 Description of this parameter from the json schema. 661 </dd> 662 <dd style="display: none; "> 663 This parameter was added in version 664 <b><span></span></b>. 665 You must omit this parameter in earlier versions, 666 and you may omit it in any version. If you require this 667 parameter, the manifest key 668 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 669 can ensure that your extension won't be run in an earlier browser version. 670 </dd> 671 672 <!-- OBJECT PROPERTIES --> 673 <dd style="display: none; "> 674 <dl> 675 <div> 676 <div> 677 </div> 678 </div> 679 </dl> 680 </dd> 681 682 <!-- FUNCTION PARAMETERS --> 683 <dd style="display: none; "> 684 <div></div> 685 </dd> 686 687 </div> 688 </div> 689 </dl> 690 </dd> 691 692 <!-- FUNCTION PARAMETERS --> 693 <dd style="display: none; "> 694 <div></div> 695 </dd> 696 697 </div> 698 </div> 699 </dl> 700 701 <!-- RETURNS --> 702 <h4 style="display: none; ">Returns</h4> 703 <dl> 704 <div style="display: none; "> 705 <div> 706 </div> 707 </div> 708 </dl> 709 710 <!-- CALLBACK --> 711 <div style="display: none; "> 712 <div> 713 <h4>Callback function</h4> 714 <p> 715 The callback <em>parameter</em> should specify a function 716 that looks like this: 717 </p> 718 <p> 719 If you specify the <em>callback</em> parameter, it should 720 specify a function that looks like this: 721 </p> 722 723 <!-- Note: intentionally longer 80 columns --> 724 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 725 <dl> 726 <div> 727 <div> 728 </div> 729 </div> 730 </dl> 731 </div> 732 </div> 733 734 <!-- MIN_VERSION --> 735 <p style="display: none; "> 736 This function was added in version <b><span></span></b>. 737 If you require this function, the manifest key 738 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 739 can ensure that your extension won't be run in an earlier browser version. 740 </p> 741 </div> <!-- /description --> 742 743 </div><div class="apiItem"> 744 <a name="method-styleDim"></a> <!-- method-anchor --> 745 <h4>styleDim</h4> 746 747 <div class="summary"><span style="display: none; ">void</span> 748 <!-- Note: intentionally longer 80 columns --> 749 <span>chrome.omnibox.styleDim</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> 750 <var><span>offset</span></var></span><span class="optional"><span>, </span><span>integer</span> 751 <var><span>length</span></var></span>)</div> 752 753 <div class="description"> 754 <p class="todo" style="display: none; ">Undocumented.</p> 755 <p>Constructor for the descriptionStyles parameter of the suggest callback. This style designates a region of dim helper text. A negative offset means the region will start at that many characters from the end of the description. If length is omitted, the region will apply for the rest of the description text.</p> 756 757 <!-- PARAMETERS --> 758 <h4>Parameters</h4> 759 <dl> 760 <div> 761 <div> 762 <dt> 763 <var>offset</var> 764 <em> 765 766 <!-- TYPE --> 767 <div style="display:inline"> 768 ( 769 <span class="optional" style="display: none; ">optional</span> 770 <span class="enum" style="display: none; ">enumerated</span> 771 <span id="typeTemplate"> 772 <span style="display: none; "> 773 <a> Type</a> 774 </span> 775 <span> 776 <span style="display: none; "> 777 array of <span><span></span></span> 778 </span> 779 <span>integer</span> 780 <span style="display: none; "></span> 781 </span> 782 </span> 783 ) 784 </div> 785 786 </em> 787 </dt> 788 <dd class="todo"> 789 Undocumented. 790 </dd> 791 <dd style="display: none; "> 792 Description of this parameter from the json schema. 793 </dd> 794 <dd style="display: none; "> 795 This parameter was added in version 796 <b><span></span></b>. 797 You must omit this parameter in earlier versions, 798 and you may omit it in any version. If you require this 799 parameter, the manifest key 800 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 801 can ensure that your extension won't be run in an earlier browser version. 802 </dd> 803 804 <!-- OBJECT PROPERTIES --> 805 <dd style="display: none; "> 806 <dl> 807 <div> 808 <div> 809 </div> 810 </div> 811 </dl> 812 </dd> 813 814 <!-- FUNCTION PARAMETERS --> 815 <dd style="display: none; "> 816 <div></div> 817 </dd> 818 819 </div> 820 </div><div> 821 <div> 822 <dt> 823 <var>length</var> 824 <em> 825 826 <!-- TYPE --> 827 <div style="display:inline"> 828 ( 829 <span class="optional">optional</span> 830 <span class="enum" style="display: none; ">enumerated</span> 831 <span id="typeTemplate"> 832 <span style="display: none; "> 833 <a> Type</a> 834 </span> 835 <span> 836 <span style="display: none; "> 837 array of <span><span></span></span> 838 </span> 839 <span>integer</span> 840 <span style="display: none; "></span> 841 </span> 842 </span> 843 ) 844 </div> 845 846 </em> 847 </dt> 848 <dd class="todo"> 849 Undocumented. 850 </dd> 851 <dd style="display: none; "> 852 Description of this parameter from the json schema. 853 </dd> 854 <dd style="display: none; "> 855 This parameter was added in version 856 <b><span></span></b>. 857 You must omit this parameter in earlier versions, 858 and you may omit it in any version. If you require this 859 parameter, the manifest key 860 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 861 can ensure that your extension won't be run in an earlier browser version. 862 </dd> 863 864 <!-- OBJECT PROPERTIES --> 865 <dd style="display: none; "> 866 <dl> 867 <div> 868 <div> 869 </div> 870 </div> 871 </dl> 872 </dd> 873 874 <!-- FUNCTION PARAMETERS --> 875 <dd style="display: none; "> 876 <div></div> 877 </dd> 878 879 </div> 880 </div> 881 </dl> 882 883 <!-- RETURNS --> 884 <h4 style="display: none; ">Returns</h4> 885 <dl> 886 <div style="display: none; "> 887 <div> 888 </div> 889 </div> 890 </dl> 891 892 <!-- CALLBACK --> 893 <div style="display: none; "> 894 <div> 895 <h4>Callback function</h4> 896 <p> 897 The callback <em>parameter</em> should specify a function 898 that looks like this: 899 </p> 900 <p> 901 If you specify the <em>callback</em> parameter, it should 902 specify a function that looks like this: 903 </p> 904 905 <!-- Note: intentionally longer 80 columns --> 906 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 907 <dl> 908 <div> 909 <div> 910 </div> 911 </div> 912 </dl> 913 </div> 914 </div> 915 916 <!-- MIN_VERSION --> 917 <p style="display: none; "> 918 This function was added in version <b><span></span></b>. 919 If you require this function, the manifest key 920 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 921 can ensure that your extension won't be run in an earlier browser version. 922 </p> 923 </div> <!-- /description --> 924 925 </div><div class="apiItem"> 926 <a name="method-styleMatch"></a> <!-- method-anchor --> 927 <h4>styleMatch</h4> 928 929 <div class="summary"><span style="display: none; ">void</span> 930 <!-- Note: intentionally longer 80 columns --> 931 <span>chrome.omnibox.styleMatch</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> 932 <var><span>offset</span></var></span><span class="optional"><span>, </span><span>integer</span> 933 <var><span>length</span></var></span>)</div> 934 935 <div class="description"> 936 <p class="todo" style="display: none; ">Undocumented.</p> 937 <p>Constructor for the descriptionStyles parameter of the suggest callback. This style designates a region of text matching what the user typed. A negative offset means the region will start at that many characters from the end of the description. If length is omitted, the region will apply for the rest of the description text.</p> 938 939 <!-- PARAMETERS --> 940 <h4>Parameters</h4> 941 <dl> 942 <div> 943 <div> 944 <dt> 945 <var>offset</var> 946 <em> 947 948 <!-- TYPE --> 949 <div style="display:inline"> 950 ( 951 <span class="optional" style="display: none; ">optional</span> 952 <span class="enum" style="display: none; ">enumerated</span> 953 <span id="typeTemplate"> 954 <span style="display: none; "> 955 <a> Type</a> 956 </span> 957 <span> 958 <span style="display: none; "> 959 array of <span><span></span></span> 960 </span> 961 <span>integer</span> 962 <span style="display: none; "></span> 963 </span> 964 </span> 965 ) 966 </div> 967 968 </em> 969 </dt> 970 <dd class="todo"> 971 Undocumented. 972 </dd> 973 <dd style="display: none; "> 974 Description of this parameter from the json schema. 975 </dd> 976 <dd style="display: none; "> 977 This parameter was added in version 978 <b><span></span></b>. 979 You must omit this parameter in earlier versions, 980 and you may omit it in any version. If you require this 981 parameter, the manifest key 982 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 983 can ensure that your extension won't be run in an earlier browser version. 984 </dd> 985 986 <!-- OBJECT PROPERTIES --> 987 <dd style="display: none; "> 988 <dl> 989 <div> 990 <div> 991 </div> 992 </div> 993 </dl> 994 </dd> 995 996 <!-- FUNCTION PARAMETERS --> 997 <dd style="display: none; "> 998 <div></div> 999 </dd> 1000 1001 </div> 1002 </div><div> 1003 <div> 1004 <dt> 1005 <var>length</var> 1006 <em> 1007 1008 <!-- TYPE --> 1009 <div style="display:inline"> 1010 ( 1011 <span class="optional">optional</span> 1012 <span class="enum" style="display: none; ">enumerated</span> 1013 <span id="typeTemplate"> 1014 <span style="display: none; "> 1015 <a> Type</a> 1016 </span> 1017 <span> 1018 <span style="display: none; "> 1019 array of <span><span></span></span> 1020 </span> 1021 <span>integer</span> 1022 <span style="display: none; "></span> 1023 </span> 1024 </span> 1025 ) 1026 </div> 1027 1028 </em> 1029 </dt> 1030 <dd class="todo"> 1031 Undocumented. 1032 </dd> 1033 <dd style="display: none; "> 1034 Description of this parameter from the json schema. 1035 </dd> 1036 <dd style="display: none; "> 1037 This parameter was added in version 1038 <b><span></span></b>. 1039 You must omit this parameter in earlier versions, 1040 and you may omit it in any version. If you require this 1041 parameter, the manifest key 1042 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1043 can ensure that your extension won't be run in an earlier browser version. 1044 </dd> 1045 1046 <!-- OBJECT PROPERTIES --> 1047 <dd style="display: none; "> 1048 <dl> 1049 <div> 1050 <div> 1051 </div> 1052 </div> 1053 </dl> 1054 </dd> 1055 1056 <!-- FUNCTION PARAMETERS --> 1057 <dd style="display: none; "> 1058 <div></div> 1059 </dd> 1060 1061 </div> 1062 </div> 1063 </dl> 1064 1065 <!-- RETURNS --> 1066 <h4 style="display: none; ">Returns</h4> 1067 <dl> 1068 <div style="display: none; "> 1069 <div> 1070 </div> 1071 </div> 1072 </dl> 1073 1074 <!-- CALLBACK --> 1075 <div style="display: none; "> 1076 <div> 1077 <h4>Callback function</h4> 1078 <p> 1079 The callback <em>parameter</em> should specify a function 1080 that looks like this: 1081 </p> 1082 <p> 1083 If you specify the <em>callback</em> parameter, it should 1084 specify a function that looks like this: 1085 </p> 1086 1087 <!-- Note: intentionally longer 80 columns --> 1088 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1089 <dl> 1090 <div> 1091 <div> 1092 </div> 1093 </div> 1094 </dl> 1095 </div> 1096 </div> 1097 1098 <!-- MIN_VERSION --> 1099 <p style="display: none; "> 1100 This function was added in version <b><span></span></b>. 1101 If you require this function, the manifest key 1102 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1103 can ensure that your extension won't be run in an earlier browser version. 1104 </p> 1105 </div> <!-- /description --> 1106 1107 </div><div class="apiItem"> 1108 <a name="method-styleUrl"></a> <!-- method-anchor --> 1109 <h4>styleUrl</h4> 1110 1111 <div class="summary"><span style="display: none; ">void</span> 1112 <!-- Note: intentionally longer 80 columns --> 1113 <span>chrome.omnibox.styleUrl</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> 1114 <var><span>offset</span></var></span><span class="optional"><span>, </span><span>integer</span> 1115 <var><span>length</span></var></span>)</div> 1116 1117 <div class="description"> 1118 <p class="todo" style="display: none; ">Undocumented.</p> 1119 <p>Constructor for the descriptionStyles parameter of the suggest callback. This style designates a region of text matching a URL or filename. A negative offset means the region will start at that many characters from the end of the description. If length is omitted, the region will apply for the rest of the description text.</p> 1120 1121 <!-- PARAMETERS --> 1122 <h4>Parameters</h4> 1123 <dl> 1124 <div> 1125 <div> 1126 <dt> 1127 <var>offset</var> 1128 <em> 1129 1130 <!-- TYPE --> 1131 <div style="display:inline"> 1132 ( 1133 <span class="optional" style="display: none; ">optional</span> 1134 <span class="enum" style="display: none; ">enumerated</span> 1135 <span id="typeTemplate"> 1136 <span style="display: none; "> 1137 <a> Type</a> 1138 </span> 1139 <span> 1140 <span style="display: none; "> 1141 array of <span><span></span></span> 1142 </span> 1143 <span>integer</span> 1144 <span style="display: none; "></span> 1145 </span> 1146 </span> 1147 ) 1148 </div> 1149 1150 </em> 1151 </dt> 1152 <dd class="todo"> 1153 Undocumented. 1154 </dd> 1155 <dd style="display: none; "> 1156 Description of this parameter from the json schema. 1157 </dd> 1158 <dd style="display: none; "> 1159 This parameter was added in version 1160 <b><span></span></b>. 1161 You must omit this parameter in earlier versions, 1162 and you may omit it in any version. If you require this 1163 parameter, the manifest key 1164 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1165 can ensure that your extension won't be run in an earlier browser version. 1166 </dd> 1167 1168 <!-- OBJECT PROPERTIES --> 1169 <dd style="display: none; "> 1170 <dl> 1171 <div> 1172 <div> 1173 </div> 1174 </div> 1175 </dl> 1176 </dd> 1177 1178 <!-- FUNCTION PARAMETERS --> 1179 <dd style="display: none; "> 1180 <div></div> 1181 </dd> 1182 1183 </div> 1184 </div><div> 1185 <div> 1186 <dt> 1187 <var>length</var> 1188 <em> 1189 1190 <!-- TYPE --> 1191 <div style="display:inline"> 1192 ( 1193 <span class="optional">optional</span> 1194 <span class="enum" style="display: none; ">enumerated</span> 1195 <span id="typeTemplate"> 1196 <span style="display: none; "> 1197 <a> Type</a> 1198 </span> 1199 <span> 1200 <span style="display: none; "> 1201 array of <span><span></span></span> 1202 </span> 1203 <span>integer</span> 1204 <span style="display: none; "></span> 1205 </span> 1206 </span> 1207 ) 1208 </div> 1209 1210 </em> 1211 </dt> 1212 <dd class="todo"> 1213 Undocumented. 1214 </dd> 1215 <dd style="display: none; "> 1216 Description of this parameter from the json schema. 1217 </dd> 1218 <dd style="display: none; "> 1219 This parameter was added in version 1220 <b><span></span></b>. 1221 You must omit this parameter in earlier versions, 1222 and you may omit it in any version. If you require this 1223 parameter, the manifest key 1224 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1225 can ensure that your extension won't be run in an earlier browser version. 1226 </dd> 1227 1228 <!-- OBJECT PROPERTIES --> 1229 <dd style="display: none; "> 1230 <dl> 1231 <div> 1232 <div> 1233 </div> 1234 </div> 1235 </dl> 1236 </dd> 1237 1238 <!-- FUNCTION PARAMETERS --> 1239 <dd style="display: none; "> 1240 <div></div> 1241 </dd> 1242 1243 </div> 1244 </div> 1245 </dl> 1246 1247 <!-- RETURNS --> 1248 <h4 style="display: none; ">Returns</h4> 1249 <dl> 1250 <div style="display: none; "> 1251 <div> 1252 </div> 1253 </div> 1254 </dl> 1255 1256 <!-- CALLBACK --> 1257 <div style="display: none; "> 1258 <div> 1259 <h4>Callback function</h4> 1260 <p> 1261 The callback <em>parameter</em> should specify a function 1262 that looks like this: 1263 </p> 1264 <p> 1265 If you specify the <em>callback</em> parameter, it should 1266 specify a function that looks like this: 1267 </p> 1268 1269 <!-- Note: intentionally longer 80 columns --> 1270 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1271 <dl> 1272 <div> 1273 <div> 1274 </div> 1275 </div> 1276 </dl> 1277 </div> 1278 </div> 1279 1280 <!-- MIN_VERSION --> 1281 <p style="display: none; "> 1282 This function was added in version <b><span></span></b>. 1283 If you require this function, the manifest key 1284 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1285 can ensure that your extension won't be run in an earlier browser version. 1286 </p> 1287 </div> <!-- /description --> 1288 1289 </div> <!-- /apiItem --> 1290 1291 </div> <!-- /apiGroup --> 1292 1293 <!-- EVENTS --> 1294 <div class="apiGroup"> 1295 <a name="events"></a> 1296 <h3 id="events">Events</h3> 1297 1298 <!-- iterates over all events --> 1299 <div class="apiItem"> 1300 <a name="event-onInputCancelled"></a> 1301 <h4>onInputCancelled</h4> 1302 1303 <div class="summary"> 1304 <!-- Note: intentionally longer 80 columns --> 1305 <span class="subdued">chrome.omnibox.</span><span>onInputCancelled</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span>); 1306 </div> 1307 1308 <div class="description"> 1309 <p class="todo" style="display: none; ">Undocumented.</p> 1310 <p>User has ended the keyword input session without accepting the input.</p> 1311 1312 <!-- PARAMETERS --> 1313 <h4>Parameters</h4> 1314 <dl> 1315 <div style="display: none; "> 1316 <div> 1317 </div> 1318 </div> 1319 </dl> 1320 1321 </div> <!-- /decription --> 1322 1323 </div><div class="apiItem"> 1324 <a name="event-onInputChanged"></a> 1325 <h4>onInputChanged</h4> 1326 1327 <div class="summary"> 1328 <!-- Note: intentionally longer 80 columns --> 1329 <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>); 1330 </div> 1331 1332 <div class="description"> 1333 <p class="todo" style="display: none; ">Undocumented.</p> 1334 <p>User has changed what is typed into the omnibox.</p> 1335 1336 <!-- PARAMETERS --> 1337 <h4>Parameters</h4> 1338 <dl> 1339 <div> 1340 <div> 1341 <dt> 1342 <var>text</var> 1343 <em> 1344 1345 <!-- TYPE --> 1346 <div style="display:inline"> 1347 ( 1348 <span class="optional" style="display: none; ">optional</span> 1349 <span class="enum" style="display: none; ">enumerated</span> 1350 <span id="typeTemplate"> 1351 <span style="display: none; "> 1352 <a> Type</a> 1353 </span> 1354 <span> 1355 <span style="display: none; "> 1356 array of <span><span></span></span> 1357 </span> 1358 <span>string</span> 1359 <span style="display: none; "></span> 1360 </span> 1361 </span> 1362 ) 1363 </div> 1364 1365 </em> 1366 </dt> 1367 <dd class="todo"> 1368 Undocumented. 1369 </dd> 1370 <dd style="display: none; "> 1371 Description of this parameter from the json schema. 1372 </dd> 1373 <dd style="display: none; "> 1374 This parameter was added in version 1375 <b><span></span></b>. 1376 You must omit this parameter in earlier versions, 1377 and you may omit it in any version. If you require this 1378 parameter, the manifest key 1379 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1380 can ensure that your extension won't be run in an earlier browser version. 1381 </dd> 1382 1383 <!-- OBJECT PROPERTIES --> 1384 <dd style="display: none; "> 1385 <dl> 1386 <div> 1387 <div> 1388 </div> 1389 </div> 1390 </dl> 1391 </dd> 1392 1393 <!-- FUNCTION PARAMETERS --> 1394 <dd style="display: none; "> 1395 <div></div> 1396 </dd> 1397 1398 </div> 1399 </div><div> 1400 <div> 1401 <dt> 1402 <var>suggest</var> 1403 <em> 1404 1405 <!-- TYPE --> 1406 <div style="display:inline"> 1407 ( 1408 <span class="optional" style="display: none; ">optional</span> 1409 <span class="enum" style="display: none; ">enumerated</span> 1410 <span id="typeTemplate"> 1411 <span style="display: none; "> 1412 <a> Type</a> 1413 </span> 1414 <span> 1415 <span style="display: none; "> 1416 array of <span><span></span></span> 1417 </span> 1418 <span>function</span> 1419 <span style="display: none; "></span> 1420 </span> 1421 </span> 1422 ) 1423 </div> 1424 1425 </em> 1426 </dt> 1427 <dd class="todo" style="display: none; "> 1428 Undocumented. 1429 </dd> 1430 <dd>A callback passed to the onInputChanged event used for sending suggestions back to the browser.</dd> 1431 <dd style="display: none; "> 1432 This parameter was added in version 1433 <b><span></span></b>. 1434 You must omit this parameter in earlier versions, 1435 and you may omit it in any version. If you require this 1436 parameter, the manifest key 1437 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1438 can ensure that your extension won't be run in an earlier browser version. 1439 </dd> 1440 1441 <!-- OBJECT PROPERTIES --> 1442 <dd style="display: none; "> 1443 <dl> 1444 <div> 1445 <div> 1446 </div> 1447 </div> 1448 </dl> 1449 </dd> 1450 1451 <!-- FUNCTION PARAMETERS --> 1452 <dd> 1453 <div> 1454 <h5>Parameters</h5> 1455 <dl> 1456 <div> 1457 <div> 1458 <dt> 1459 <var style="display: none; ">paramName</var> 1460 <em> 1461 1462 <!-- TYPE --> 1463 <div style="display:inline"> 1464 ( 1465 <span class="optional" style="display: none; ">optional</span> 1466 <span class="enum" style="display: none; ">enumerated</span> 1467 <span id="typeTemplate"> 1468 <span style="display: none; "> 1469 <a> Type</a> 1470 </span> 1471 <span> 1472 <span> 1473 array of <span><span> 1474 <span> 1475 <a href="omnibox.html#type-SuggestResult">SuggestResult</a> 1476 </span> 1477 <span style="display: none; "> 1478 <span> 1479 array of <span><span></span></span> 1480 </span> 1481 <span>paramType</span> 1482 <span></span> 1483 </span> 1484 </span></span> 1485 </span> 1486 <span style="display: none; ">paramType</span> 1487 <span style="display: none; "></span> 1488 </span> 1489 </span> 1490 ) 1491 </div> 1492 1493 </em> 1494 </dt> 1495 <dd class="todo" style="display: none; "> 1496 Undocumented. 1497 </dd> 1498 <dd>Array of suggest results</dd> 1499 <dd style="display: none; "> 1500 This parameter was added in version 1501 <b><span></span></b>. 1502 You must omit this parameter in earlier versions, 1503 and you may omit it in any version. If you require this 1504 parameter, the manifest key 1505 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1506 can ensure that your extension won't be run in an earlier browser version. 1507 </dd> 1508 1509 <!-- OBJECT PROPERTIES --> 1510 <dd style="display: none; "> 1511 <dl> 1512 <div> 1513 <div> 1514 </div> 1515 </div> 1516 </dl> 1517 </dd> 1518 1519 <!-- FUNCTION PARAMETERS --> 1520 <dd style="display: none; "> 1521 <div></div> 1522 </dd> 1523 1524 </div> 1525 </div> 1526 </dl> 1527 </div> 1528 </dd> 1529 1530 </div> 1531 </div> 1532 </dl> 1533 1534 </div> <!-- /decription --> 1535 1536 </div><div class="apiItem"> 1537 <a name="event-onInputEntered"></a> 1538 <h4>onInputEntered</h4> 1539 1540 <div class="summary"> 1541 <!-- Note: intentionally longer 80 columns --> 1542 <span class="subdued">chrome.omnibox.</span><span>onInputEntered</span><span class="subdued">.addListener</span>(function(<span>string text</span>) <span class="subdued">{...}</span>); 1543 </div> 1544 1545 <div class="description"> 1546 <p class="todo" style="display: none; ">Undocumented.</p> 1547 <p>User has accepted what is typed into the omnibox.</p> 1548 1549 <!-- PARAMETERS --> 1550 <h4>Parameters</h4> 1551 <dl> 1552 <div> 1553 <div> 1554 <dt> 1555 <var>text</var> 1556 <em> 1557 1558 <!-- TYPE --> 1559 <div style="display:inline"> 1560 ( 1561 <span class="optional" style="display: none; ">optional</span> 1562 <span class="enum" style="display: none; ">enumerated</span> 1563 <span id="typeTemplate"> 1564 <span style="display: none; "> 1565 <a> Type</a> 1566 </span> 1567 <span> 1568 <span style="display: none; "> 1569 array of <span><span></span></span> 1570 </span> 1571 <span>string</span> 1572 <span style="display: none; "></span> 1573 </span> 1574 </span> 1575 ) 1576 </div> 1577 1578 </em> 1579 </dt> 1580 <dd class="todo"> 1581 Undocumented. 1582 </dd> 1583 <dd style="display: none; "> 1584 Description of this parameter from the json schema. 1585 </dd> 1586 <dd style="display: none; "> 1587 This parameter was added in version 1588 <b><span></span></b>. 1589 You must omit this parameter in earlier versions, 1590 and you may omit it in any version. If you require this 1591 parameter, the manifest key 1592 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1593 can ensure that your extension won't be run in an earlier browser version. 1594 </dd> 1595 1596 <!-- OBJECT PROPERTIES --> 1597 <dd style="display: none; "> 1598 <dl> 1599 <div> 1600 <div> 1601 </div> 1602 </div> 1603 </dl> 1604 </dd> 1605 1606 <!-- FUNCTION PARAMETERS --> 1607 <dd style="display: none; "> 1608 <div></div> 1609 </dd> 1610 1611 </div> 1612 </div> 1613 </dl> 1614 1615 </div> <!-- /decription --> 1616 1617 </div><div class="apiItem"> 1618 <a name="event-onInputStarted"></a> 1619 <h4>onInputStarted</h4> 1620 1621 <div class="summary"> 1622 <!-- Note: intentionally longer 80 columns --> 1623 <span class="subdued">chrome.omnibox.</span><span>onInputStarted</span><span class="subdued">.addListener</span>(function(<span></span>) <span class="subdued">{...}</span>); 1624 </div> 1625 1626 <div class="description"> 1627 <p class="todo" style="display: none; ">Undocumented.</p> 1628 <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> 1629 1630 <!-- PARAMETERS --> 1631 <h4>Parameters</h4> 1632 <dl> 1633 <div style="display: none; "> 1634 <div> 1635 </div> 1636 </div> 1637 </dl> 1638 1639 </div> <!-- /decription --> 1640 1641 </div> <!-- /apiItem --> 1642 1643 </div> <!-- /apiGroup --> 1644 1645 <!-- TYPES --> 1646 <div class="apiGroup"> 1647 <a name="types"></a> 1648 <h3 id="types">Types</h3> 1649 1650 <!-- iterates over all types --> 1651 <div class="apiItem"> 1652 <a name="type-SuggestResult"></a> 1653 <h4>SuggestResult</h4> 1654 1655 <div> 1656 <dt> 1657 <var style="display: none; ">paramName</var> 1658 <em> 1659 1660 <!-- TYPE --> 1661 <div style="display:inline"> 1662 ( 1663 <span class="optional" style="display: none; ">optional</span> 1664 <span class="enum" style="display: none; ">enumerated</span> 1665 <span id="typeTemplate"> 1666 <span style="display: none; "> 1667 <a> Type</a> 1668 </span> 1669 <span> 1670 <span style="display: none; "> 1671 array of <span><span></span></span> 1672 </span> 1673 <span>object</span> 1674 <span style="display: none; "></span> 1675 </span> 1676 </span> 1677 ) 1678 </div> 1679 1680 </em> 1681 </dt> 1682 <dd class="todo" style="display: none; "> 1683 Undocumented. 1684 </dd> 1685 <dd>A suggest result.</dd> 1686 <dd style="display: none; "> 1687 This parameter was added in version 1688 <b><span></span></b>. 1689 You must omit this parameter in earlier versions, 1690 and you may omit it in any version. If you require this 1691 parameter, the manifest key 1692 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1693 can ensure that your extension won't be run in an earlier browser version. 1694 </dd> 1695 1696 <!-- OBJECT PROPERTIES --> 1697 <dd> 1698 <dl> 1699 <div> 1700 <div> 1701 <dt> 1702 <var>content</var> 1703 <em> 1704 1705 <!-- TYPE --> 1706 <div style="display:inline"> 1707 ( 1708 <span class="optional" style="display: none; ">optional</span> 1709 <span class="enum" style="display: none; ">enumerated</span> 1710 <span id="typeTemplate"> 1711 <span style="display: none; "> 1712 <a> Type</a> 1713 </span> 1714 <span> 1715 <span style="display: none; "> 1716 array of <span><span></span></span> 1717 </span> 1718 <span>string</span> 1719 <span style="display: none; "></span> 1720 </span> 1721 </span> 1722 ) 1723 </div> 1724 1725 </em> 1726 </dt> 1727 <dd class="todo" style="display: none; "> 1728 Undocumented. 1729 </dd> 1730 <dd>The text that is put into the URL bar, and that is sent to the extension when the user chooses this entry.</dd> 1731 <dd style="display: none; "> 1732 This parameter was added in version 1733 <b><span></span></b>. 1734 You must omit this parameter in earlier versions, 1735 and you may omit it in any version. If you require this 1736 parameter, the manifest key 1737 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1738 can ensure that your extension won't be run in an earlier browser version. 1739 </dd> 1740 1741 <!-- OBJECT PROPERTIES --> 1742 <dd style="display: none; "> 1743 <dl> 1744 <div> 1745 <div> 1746 </div> 1747 </div> 1748 </dl> 1749 </dd> 1750 1751 <!-- FUNCTION PARAMETERS --> 1752 <dd style="display: none; "> 1753 <div></div> 1754 </dd> 1755 1756 </div> 1757 </div><div> 1758 <div> 1759 <dt> 1760 <var>description</var> 1761 <em> 1762 1763 <!-- TYPE --> 1764 <div style="display:inline"> 1765 ( 1766 <span class="optional" style="display: none; ">optional</span> 1767 <span class="enum" style="display: none; ">enumerated</span> 1768 <span id="typeTemplate"> 1769 <span style="display: none; "> 1770 <a> Type</a> 1771 </span> 1772 <span> 1773 <span style="display: none; "> 1774 array of <span><span></span></span> 1775 </span> 1776 <span>string</span> 1777 <span style="display: none; "></span> 1778 </span> 1779 </span> 1780 ) 1781 </div> 1782 1783 </em> 1784 </dt> 1785 <dd class="todo" style="display: none; "> 1786 Undocumented. 1787 </dd> 1788 <dd>The text that is displayed in the URL dropdown. Can optionally be stylized by the descriptionStyles parameter.</dd> 1789 <dd style="display: none; "> 1790 This parameter was added in version 1791 <b><span></span></b>. 1792 You must omit this parameter in earlier versions, 1793 and you may omit it in any version. If you require this 1794 parameter, the manifest key 1795 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1796 can ensure that your extension won't be run in an earlier browser version. 1797 </dd> 1798 1799 <!-- OBJECT PROPERTIES --> 1800 <dd style="display: none; "> 1801 <dl> 1802 <div> 1803 <div> 1804 </div> 1805 </div> 1806 </dl> 1807 </dd> 1808 1809 <!-- FUNCTION PARAMETERS --> 1810 <dd style="display: none; "> 1811 <div></div> 1812 </dd> 1813 1814 </div> 1815 </div><div> 1816 <div> 1817 <dt> 1818 <var>descriptionStyles</var> 1819 <em> 1820 1821 <!-- TYPE --> 1822 <div style="display:inline"> 1823 ( 1824 <span class="optional">optional</span> 1825 <span class="enum" style="display: none; ">enumerated</span> 1826 <span id="typeTemplate"> 1827 <span style="display: none; "> 1828 <a> Type</a> 1829 </span> 1830 <span> 1831 <span> 1832 array of <span><span> 1833 <span style="display: none; "> 1834 <a> Type</a> 1835 </span> 1836 <span> 1837 <span style="display: none; "> 1838 array of <span><span></span></span> 1839 </span> 1840 <span>object</span> 1841 <span style="display: none; "></span> 1842 </span> 1843 </span></span> 1844 </span> 1845 <span style="display: none; ">paramType</span> 1846 <span style="display: none; "></span> 1847 </span> 1848 </span> 1849 ) 1850 </div> 1851 1852 </em> 1853 </dt> 1854 <dd class="todo" style="display: none; "> 1855 Undocumented. 1856 </dd> 1857 <dd>An array of style objects, created using styleUrl, styleMatch, or styleDim. A style applies to the region of text specified by the style's starting offset and length. If there are any overlapping regions of text covered by multiple styles, they will be added together (e.g. 'match' + 'dim' will display a dimmed match). Not all style combinations will be visually distinct (e.g. 'url' + 'dim' may look identical to 'url').</dd> 1858 <dd style="display: none; "> 1859 This parameter was added in version 1860 <b><span></span></b>. 1861 You must omit this parameter in earlier versions, 1862 and you may omit it in any version. If you require this 1863 parameter, the manifest key 1864 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1865 can ensure that your extension won't be run in an earlier browser version. 1866 </dd> 1867 1868 <!-- OBJECT PROPERTIES --> 1869 <dd style="display: none; "> 1870 <dl> 1871 <div> 1872 <div> 1873 </div> 1874 </div> 1875 </dl> 1876 </dd> 1877 1878 <!-- FUNCTION PARAMETERS --> 1879 <dd style="display: none; "> 1880 <div></div> 1881 </dd> 1882 1883 </div> 1884 </div> 1885 </dl> 1886 </dd> 1887 1888 <!-- FUNCTION PARAMETERS --> 1889 <dd style="display: none; "> 1890 <div></div> 1891 </dd> 1892 1893 </div> 1894 1895 </div> <!-- /apiItem --> 1896 1897 </div> <!-- /apiGroup --> 1898 1899 </div> <!-- /apiPage --> 1900 </div> <!-- /gc-pagecontent --> 1901 </div> <!-- /g-section --> 1902 </div> <!-- /codesiteContent --> 1903 <div id="gc-footer" --=""> 1904 <div class="text"> 1905 <p> 1906 Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>, 1907 the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons 1908 Attribution 3.0 License</a>, and code samples are licensed under the 1909 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>. 1910 </p> 1911 <p> 1912 ©2010 Google 1913 </p> 1914 1915<!-- begin analytics --> 1916<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> 1917<script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script> 1918 1919<script type="text/javascript"> 1920 // chrome doc tracking 1921 try { 1922 var engdocs = _gat._getTracker("YT-10763712-2"); 1923 engdocs._trackPageview(); 1924 } catch(err) {} 1925 1926 // code.google.com site-wide tracking 1927 try { 1928 _uacct="UA-18071-1"; 1929 _uanchor=1; 1930 _uff=0; 1931 urchinTracker(); 1932 } 1933 catch(e) {/* urchinTracker not available. */} 1934</script> 1935<!-- end analytics --> 1936 </div> 1937 </div> <!-- /gc-footer --> 1938 </div> <!-- /gc-container --> 1939</body></html> 1940
