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>Browser Actions - 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 class="leftNavSelected">Browser Actions</li> 177 <li><a href="contextMenus.html">Context Menus</a></li> 178 <li><a href="notifications.html">Desktop Notifications</a></li> 179 <li><a href="omnibox.html">Omnibox</a></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">Browser Actions</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="#ui">Parts of the UI</a> 269 <ol> 270 <li> 271 <a href="#icon">Icon</a> 272 </li><li> 273 <a href="#tooltip">Tooltip</a> 274 </li><li> 275 <a href="#badge">Badge</a> 276 </li><li> 277 <a href="#popups">Popup</a> 278 </li> 279 </ol> 280 </li><li> 281 <a href="#H2-6">Tips</a> 282 <ol> 283 <li style="display: none; "> 284 <a>h3Name</a> 285 </li> 286 </ol> 287 </li><li> 288 <a href="#examples"> Examples </a> 289 <ol> 290 <li style="display: none; "> 291 <a>h3Name</a> 292 </li> 293 </ol> 294 </li> 295 <li> 296 <a href="#apiReference">API reference: chrome.browserAction</a> 297 <ol> 298 <li style="display: none; "> 299 <a href="#properties">Properties</a> 300 <ol> 301 <li> 302 <a href="#property-anchor">propertyName</a> 303 </li> 304 </ol> 305 </li> 306 <li> 307 <a href="#global-methods">Methods</a> 308 <ol> 309 <li> 310 <a href="#method-setBadgeBackgroundColor">setBadgeBackgroundColor</a> 311 </li><li> 312 <a href="#method-setBadgeText">setBadgeText</a> 313 </li><li> 314 <a href="#method-setIcon">setIcon</a> 315 </li><li> 316 <a href="#method-setPopup">setPopup</a> 317 </li><li> 318 <a href="#method-setTitle">setTitle</a> 319 </li> 320 </ol> 321 </li> 322 <li> 323 <a href="#global-events">Events</a> 324 <ol> 325 <li> 326 <a href="#event-onClicked">onClicked</a> 327 </li> 328 </ol> 329 </li> 330 <li style="display: none; "> 331 <a href="#types">Types</a> 332 <ol> 333 <li> 334 <a href="#id-anchor">id</a> 335 </li> 336 </ol> 337 </li> 338 </ol> 339 </li> 340 </ol> 341 </div> 342 <!-- /TABLE OF CONTENTS --> 343 344 <!-- Standard content lead-in for experimental API pages --> 345 <p id="classSummary" style="display: none; "> 346 For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. 347 </p> 348 349 <!-- STATIC CONTENT PLACEHOLDER --> 350 <div id="static"><div id="pageData-name" class="pageData">Browser Actions</div> 351 352<!-- BEGIN AUTHORED CONTENT --> 353<p>Use browser actions to put icons 354 in the main Google Chrome toolbar, 355 to the right of the address bar. 356 In addition to its <a href="#icon">icon</a>, 357 a browser action can also have 358 a <a href="#tooltip">tooltip</a>, 359 a <a href="#badge">badge</a>, 360 and a <a href="#popups">popup</a>. 361 </p> 362 363<p> 364In the following figure, 365the multicolored square 366to the right of the address bar 367is the icon for a browser action. 368A popup is below the icon. 369</p> 370 371<img src="images/browser-action.png" width="363" height="226"> 372 373<p> 374If you want to create an icon that isn't always visible, 375use a <a href="pageAction.html">page action</a> 376instead of a browser action. 377</p> 378 379<p class="caution"> 380<strong>Note:</strong> 381Packaged apps cannot use browser actions. 382</p> 383 384<!-- [PENDING: We should show tooltips and badges, as well.] --> 385 386<h2 id="manifest">Manifest</h2> 387 388<p> 389Register your browser action in the 390<a href="manifest.html">extension manifest</a> 391like this: 392</p> 393 394<pre>{ 395 "name": "My extension", 396 ... 397 <b>"browser_action": { 398 "default_icon": "images/icon19.png", <em>// optional</em> 399 "default_title": "Google Mail", <em>// optional; shown in tooltip</em> 400 "default_popup": "popup.html" <em>// optional</em> 401 }</b>, 402 ... 403}</pre> 404 405<h2 id="ui">Parts of the UI</h2> 406 407<p> 408A browser action can have an <a href="#icon">icon</a>, 409a <a href="#tooltip">tooltip</a>, 410a <a href="#badge">badge</a>, 411and a <a href="#popups">popup</a>. 412</p> 413 414<h3 id="icon">Icon</h3> 415 416<p>Browser action icons can be up to 19 pixels wide and high. 417 Larger icons are resized to fit, but for best results, 418 use a 19-pixel square icon.</p> 419 420<p>You can set the icon in two ways: 421 using a static image or using the 422 HTML5 <a href="http://www.whatwg.org/specs/web-apps/current-work/multipage/the-canvas-element.html">canvas element</a>. 423 Using static images is easier for simple applications, 424 but you can create more dynamic UIs â 425 such as smooth animation â 426 using the canvas element. 427 </p> 428 429<p>Static images can be in any format WebKit can display, 430 including BMP, GIF, ICO, JPEG, or PNG. 431 </p> 432 433<p>To set the icon, 434use the <b>default_icon</b> field of <b>browser_action</b> 435in the <a href="#manifest">manifest</a>, 436or call the <a href="#method-setIcon">setIcon()</a> method. 437 438 439</p><h3 id="tooltip">Tooltip</h3> 440 441<p> 442To set the tooltip, 443use the <b>default_title</b> field of <b>browser_action</b> 444in the <a href="#manifest">manifest</a>, 445or call the <a href="#method-setTitle">setTitle()</a> method. 446You can specify locale-specific strings for the <b>default_title</b> field; 447see <a href="i18n.html">Internationalization</a> for details. 448</p> 449 450<h3 id="badge">Badge</h3> 451 452<p>Browser actions can optionally display a <em>badge</em> â 453 a bit of text that is layered over the icon. 454 Badges make it easy to update the browser action 455 to display a small amount of information 456 about the state of the extension.</p> 457 458<p>Because the badge has limited space, 459 it should have 4 characters or less. 460 </p> 461 462<p> 463Set the text and color of the badge using 464<a href="#method-setBadgeText">setBadgeText()</a> and 465<a href="#method-setBadgeBackgroundColor">setBadgeBackgroundColor()</a>, 466respectively. 467<!-- [PENDING: if you have a color but no text, will anything display?] --> 468</p> 469 470 471<h3 id="popups">Popup</h3> 472 473<p>If a browser action has a popup, 474 the popup appears when the user clicks the icon. 475 The popup can contain any HTML contents that you like, 476 and it's automatically sized to fit its contents. 477 </p> 478 479<p> 480To add a popup to your browser action, 481create an HTML file with the popup's contents. 482Specify the HTML file in the <b>default_popup</b> field of <b>browser_action</b> 483in the <a href="#manifest">manifest</a>, or call the 484<a href="#method-setPopup">setPopup()</a> method. 485</p> 486 487<a name="H2-6"></a><h2>Tips</h2> 488 489<p>For the best visual impact, 490 follow these guidelines:</p> 491 492<ul> 493 <li><b>Do</b> use browser actions for features 494 that make sense on most pages. 495 </li><li><b>Don't</b> use browser actions for features 496 that make sense for only a few pages. 497 Use <a href="pageAction.html">page actions</a> instead. 498 </li><li><b>Do</b> use big, colorful icons that make the most of 499 the 19x19-pixel space. 500 Browser action icons should seem a little bigger 501 and heavier than page action icons. 502 </li><li><b>Don't</b> attempt to mimic 503 Google Chrome's monochrome "wrench" icon. 504 That doesn't work well with themes, and anyway, 505 extensions should stand out a little. 506 </li><li><b>Do</b> use alpha transparency 507 to add soft edges to your icon. 508 Because many people use themes, 509 your icon should look nice 510 on a variety of background colors. 511 </li><li><b>Don't</b> constantly animate your icon. 512 That's just annoying. 513</li></ul> 514 515<h2 id="examples"> Examples </h2> 516 517<p> 518You can find simple examples of using browser actions in the 519<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/api/browserAction/">examples/api/browserAction</a> 520directory. 521For other examples and for help in viewing the source code, see 522<a href="samples.html">Samples</a>. 523</p> 524 525<!-- END AUTHORED CONTENT --> 526</div> 527 528 <!-- API PAGE --> 529 <div class="apiPage"> 530 <a name="apiReference"></a> 531 <h2>API reference: chrome.browserAction</h2> 532 533 <!-- PROPERTIES --> 534 <div class="apiGroup" style="display: none; "> 535 <a name="properties"></a> 536 <h3 id="properties">Properties</h3> 537 538 <div> 539 <a></a> 540 <h4>getLastError</h4> 541 <div class="summary"> 542 <!-- Note: intentionally longer 80 columns --> 543 <span>chrome.extension</span><span>lastError</span> 544 </div> 545 <div> 546 </div> 547 </div> 548 549 </div> <!-- /apiGroup --> 550 551 <!-- METHODS --> 552 <div id="methodsTemplate" class="apiGroup"> 553 <a name="global-methods"></a> 554 <h3>Methods</h3> 555 556 <!-- iterates over all functions --> 557 <div class="apiItem"> 558 <a name="method-setBadgeBackgroundColor"></a> <!-- method-anchor --> 559 <h4>setBadgeBackgroundColor</h4> 560 561 <div class="summary"><span style="display: none; ">void</span> 562 <!-- Note: intentionally longer 80 columns --> 563 <span>chrome.browserAction.setBadgeBackgroundColor</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 564 <var><span>details</span></var></span>)</div> 565 566 <div class="description"> 567 <p class="todo" style="display: none; ">Undocumented.</p> 568 <p>Sets the background color for the badge.</p> 569 570 <!-- PARAMETERS --> 571 <h4>Parameters</h4> 572 <dl> 573 <div> 574 <div> 575 <dt> 576 <var>details</var> 577 <em> 578 579 <!-- TYPE --> 580 <div style="display:inline"> 581 ( 582 <span class="optional" style="display: none; ">optional</span> 583 <span class="enum" style="display: none; ">enumerated</span> 584 <span id="typeTemplate"> 585 <span style="display: none; "> 586 <a> Type</a> 587 </span> 588 <span> 589 <span style="display: none; "> 590 array of <span><span></span></span> 591 </span> 592 <span>object</span> 593 <span style="display: none; "></span> 594 </span> 595 </span> 596 ) 597 </div> 598 599 </em> 600 </dt> 601 <dd class="todo"> 602 Undocumented. 603 </dd> 604 <dd style="display: none; "> 605 Description of this parameter from the json schema. 606 </dd> 607 <dd style="display: none; "> 608 This parameter was added in version 609 <b><span></span></b>. 610 You must omit this parameter in earlier versions, 611 and you may omit it in any version. If you require this 612 parameter, the manifest key 613 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 614 can ensure that your extension won't be run in an earlier browser version. 615 </dd> 616 617 <!-- OBJECT PROPERTIES --> 618 <dd> 619 <dl> 620 <div> 621 <div> 622 <dt> 623 <var>color</var> 624 <em> 625 626 <!-- TYPE --> 627 <div style="display:inline"> 628 ( 629 <span class="optional" style="display: none; ">optional</span> 630 <span class="enum" style="display: none; ">enumerated</span> 631 <span id="typeTemplate"> 632 <span style="display: none; "> 633 <a> Type</a> 634 </span> 635 <span> 636 <span> 637 array of <span><span> 638 <span style="display: none; "> 639 <a> Type</a> 640 </span> 641 <span> 642 <span style="display: none; "> 643 array of <span><span></span></span> 644 </span> 645 <span>integer</span> 646 <span style="display: none; "></span> 647 </span> 648 </span></span> 649 </span> 650 <span style="display: none; ">paramType</span> 651 <span style="display: none; "></span> 652 </span> 653 </span> 654 ) 655 </div> 656 657 </em> 658 </dt> 659 <dd class="todo" style="display: none; "> 660 Undocumented. 661 </dd> 662 <dd>An array of four integers in the range [0,255] that make up the RGBA color of the badge. For example, opaque red is <code>[255, 0, 0, 255]</code>.</dd> 663 <dd style="display: none; "> 664 This parameter was added in version 665 <b><span></span></b>. 666 You must omit this parameter in earlier versions, 667 and you may omit it in any version. If you require this 668 parameter, the manifest key 669 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 670 can ensure that your extension won't be run in an earlier browser version. 671 </dd> 672 673 <!-- OBJECT PROPERTIES --> 674 <dd style="display: none; "> 675 <dl> 676 <div> 677 <div> 678 </div> 679 </div> 680 </dl> 681 </dd> 682 683 <!-- OBJECT METHODS --> 684 <dd style="display: none; "> 685 <div></div> 686 </dd> 687 688 <!-- OBJECT EVENT FIELDS --> 689 <dd style="display: none; "> 690 <div></div> 691 </dd> 692 693 <!-- FUNCTION PARAMETERS --> 694 <dd style="display: none; "> 695 <div></div> 696 </dd> 697 698 </div> 699 </div><div> 700 <div> 701 <dt> 702 <var>tabId</var> 703 <em> 704 705 <!-- TYPE --> 706 <div style="display:inline"> 707 ( 708 <span class="optional">optional</span> 709 <span class="enum" style="display: none; ">enumerated</span> 710 <span id="typeTemplate"> 711 <span style="display: none; "> 712 <a> Type</a> 713 </span> 714 <span> 715 <span style="display: none; "> 716 array of <span><span></span></span> 717 </span> 718 <span>integer</span> 719 <span style="display: none; "></span> 720 </span> 721 </span> 722 ) 723 </div> 724 725 </em> 726 </dt> 727 <dd class="todo" style="display: none; "> 728 Undocumented. 729 </dd> 730 <dd>Limits the change to when a particular tab is selected. Automatically resets when the tab is closed.</dd> 731 <dd style="display: none; "> 732 This parameter was added in version 733 <b><span></span></b>. 734 You must omit this parameter in earlier versions, 735 and you may omit it in any version. If you require this 736 parameter, the manifest key 737 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 738 can ensure that your extension won't be run in an earlier browser version. 739 </dd> 740 741 <!-- OBJECT PROPERTIES --> 742 <dd style="display: none; "> 743 <dl> 744 <div> 745 <div> 746 </div> 747 </div> 748 </dl> 749 </dd> 750 751 <!-- OBJECT METHODS --> 752 <dd style="display: none; "> 753 <div></div> 754 </dd> 755 756 <!-- OBJECT EVENT FIELDS --> 757 <dd style="display: none; "> 758 <div></div> 759 </dd> 760 761 <!-- FUNCTION PARAMETERS --> 762 <dd style="display: none; "> 763 <div></div> 764 </dd> 765 766 </div> 767 </div> 768 </dl> 769 </dd> 770 771 <!-- OBJECT METHODS --> 772 <dd style="display: none; "> 773 <div></div> 774 </dd> 775 776 <!-- OBJECT EVENT FIELDS --> 777 <dd style="display: none; "> 778 <div></div> 779 </dd> 780 781 <!-- FUNCTION PARAMETERS --> 782 <dd style="display: none; "> 783 <div></div> 784 </dd> 785 786 </div> 787 </div> 788 </dl> 789 790 <!-- RETURNS --> 791 <h4 style="display: none; ">Returns</h4> 792 <dl> 793 <div style="display: none; "> 794 <div> 795 </div> 796 </div> 797 </dl> 798 799 <!-- CALLBACK --> 800 <div style="display: none; "> 801 <div> 802 <h4>Callback function</h4> 803 <p> 804 The callback <em>parameter</em> should specify a function 805 that looks like this: 806 </p> 807 <p> 808 If you specify the <em>callback</em> parameter, it should 809 specify a function that looks like this: 810 </p> 811 812 <!-- Note: intentionally longer 80 columns --> 813 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 814 <dl> 815 <div> 816 <div> 817 </div> 818 </div> 819 </dl> 820 </div> 821 </div> 822 823 <!-- MIN_VERSION --> 824 <p style="display: none; "> 825 This function was added in version <b><span></span></b>. 826 If you require this function, the manifest key 827 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 828 can ensure that your extension won't be run in an earlier browser version. 829 </p> 830 </div> <!-- /description --> 831 832 </div><div class="apiItem"> 833 <a name="method-setBadgeText"></a> <!-- method-anchor --> 834 <h4>setBadgeText</h4> 835 836 <div class="summary"><span style="display: none; ">void</span> 837 <!-- Note: intentionally longer 80 columns --> 838 <span>chrome.browserAction.setBadgeText</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 839 <var><span>details</span></var></span>)</div> 840 841 <div class="description"> 842 <p class="todo" style="display: none; ">Undocumented.</p> 843 <p>Sets the badge text for the browser action. The badge is displayed on top of the icon.</p> 844 845 <!-- PARAMETERS --> 846 <h4>Parameters</h4> 847 <dl> 848 <div> 849 <div> 850 <dt> 851 <var>details</var> 852 <em> 853 854 <!-- TYPE --> 855 <div style="display:inline"> 856 ( 857 <span class="optional" style="display: none; ">optional</span> 858 <span class="enum" style="display: none; ">enumerated</span> 859 <span id="typeTemplate"> 860 <span style="display: none; "> 861 <a> Type</a> 862 </span> 863 <span> 864 <span style="display: none; "> 865 array of <span><span></span></span> 866 </span> 867 <span>object</span> 868 <span style="display: none; "></span> 869 </span> 870 </span> 871 ) 872 </div> 873 874 </em> 875 </dt> 876 <dd class="todo"> 877 Undocumented. 878 </dd> 879 <dd style="display: none; "> 880 Description of this parameter from the json schema. 881 </dd> 882 <dd style="display: none; "> 883 This parameter was added in version 884 <b><span></span></b>. 885 You must omit this parameter in earlier versions, 886 and you may omit it in any version. If you require this 887 parameter, the manifest key 888 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 889 can ensure that your extension won't be run in an earlier browser version. 890 </dd> 891 892 <!-- OBJECT PROPERTIES --> 893 <dd> 894 <dl> 895 <div> 896 <div> 897 <dt> 898 <var>text</var> 899 <em> 900 901 <!-- TYPE --> 902 <div style="display:inline"> 903 ( 904 <span class="optional" style="display: none; ">optional</span> 905 <span class="enum" style="display: none; ">enumerated</span> 906 <span id="typeTemplate"> 907 <span style="display: none; "> 908 <a> Type</a> 909 </span> 910 <span> 911 <span style="display: none; "> 912 array of <span><span></span></span> 913 </span> 914 <span>string</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>Any number of characters can be passed, but only about four can fit in the space.</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><div> 964 <div> 965 <dt> 966 <var>tabId</var> 967 <em> 968 969 <!-- TYPE --> 970 <div style="display:inline"> 971 ( 972 <span class="optional">optional</span> 973 <span class="enum" style="display: none; ">enumerated</span> 974 <span id="typeTemplate"> 975 <span style="display: none; "> 976 <a> Type</a> 977 </span> 978 <span> 979 <span style="display: none; "> 980 array of <span><span></span></span> 981 </span> 982 <span>integer</span> 983 <span style="display: none; "></span> 984 </span> 985 </span> 986 ) 987 </div> 988 989 </em> 990 </dt> 991 <dd class="todo" style="display: none; "> 992 Undocumented. 993 </dd> 994 <dd>Limits the change to when a particular tab is selected. Automatically resets when the tab is closed.</dd> 995 <dd style="display: none; "> 996 This parameter was added in version 997 <b><span></span></b>. 998 You must omit this parameter in earlier versions, 999 and you may omit it in any version. If you require this 1000 parameter, the manifest key 1001 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1002 can ensure that your extension won't be run in an earlier browser version. 1003 </dd> 1004 1005 <!-- OBJECT PROPERTIES --> 1006 <dd style="display: none; "> 1007 <dl> 1008 <div> 1009 <div> 1010 </div> 1011 </div> 1012 </dl> 1013 </dd> 1014 1015 <!-- OBJECT METHODS --> 1016 <dd style="display: none; "> 1017 <div></div> 1018 </dd> 1019 1020 <!-- OBJECT EVENT FIELDS --> 1021 <dd style="display: none; "> 1022 <div></div> 1023 </dd> 1024 1025 <!-- FUNCTION PARAMETERS --> 1026 <dd style="display: none; "> 1027 <div></div> 1028 </dd> 1029 1030 </div> 1031 </div> 1032 </dl> 1033 </dd> 1034 1035 <!-- OBJECT METHODS --> 1036 <dd style="display: none; "> 1037 <div></div> 1038 </dd> 1039 1040 <!-- OBJECT EVENT FIELDS --> 1041 <dd style="display: none; "> 1042 <div></div> 1043 </dd> 1044 1045 <!-- FUNCTION PARAMETERS --> 1046 <dd style="display: none; "> 1047 <div></div> 1048 </dd> 1049 1050 </div> 1051 </div> 1052 </dl> 1053 1054 <!-- RETURNS --> 1055 <h4 style="display: none; ">Returns</h4> 1056 <dl> 1057 <div style="display: none; "> 1058 <div> 1059 </div> 1060 </div> 1061 </dl> 1062 1063 <!-- CALLBACK --> 1064 <div style="display: none; "> 1065 <div> 1066 <h4>Callback function</h4> 1067 <p> 1068 The callback <em>parameter</em> should specify a function 1069 that looks like this: 1070 </p> 1071 <p> 1072 If you specify the <em>callback</em> parameter, it should 1073 specify a function that looks like this: 1074 </p> 1075 1076 <!-- Note: intentionally longer 80 columns --> 1077 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1078 <dl> 1079 <div> 1080 <div> 1081 </div> 1082 </div> 1083 </dl> 1084 </div> 1085 </div> 1086 1087 <!-- MIN_VERSION --> 1088 <p style="display: none; "> 1089 This function was added in version <b><span></span></b>. 1090 If you require this function, the manifest key 1091 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1092 can ensure that your extension won't be run in an earlier browser version. 1093 </p> 1094 </div> <!-- /description --> 1095 1096 </div><div class="apiItem"> 1097 <a name="method-setIcon"></a> <!-- method-anchor --> 1098 <h4>setIcon</h4> 1099 1100 <div class="summary"><span style="display: none; ">void</span> 1101 <!-- Note: intentionally longer 80 columns --> 1102 <span>chrome.browserAction.setIcon</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 1103 <var><span>details</span></var></span>)</div> 1104 1105 <div class="description"> 1106 <p class="todo" style="display: none; ">Undocumented.</p> 1107 <p>Sets the icon for the browser action. The icon can be specified either as the path to an image file or as the pixel data from a canvas element. Either the <b>path</b> or the <b>imageData</b> property must be specified.</p> 1108 1109 <!-- PARAMETERS --> 1110 <h4>Parameters</h4> 1111 <dl> 1112 <div> 1113 <div> 1114 <dt> 1115 <var>details</var> 1116 <em> 1117 1118 <!-- TYPE --> 1119 <div style="display:inline"> 1120 ( 1121 <span class="optional" style="display: none; ">optional</span> 1122 <span class="enum" style="display: none; ">enumerated</span> 1123 <span id="typeTemplate"> 1124 <span style="display: none; "> 1125 <a> Type</a> 1126 </span> 1127 <span> 1128 <span style="display: none; "> 1129 array of <span><span></span></span> 1130 </span> 1131 <span>object</span> 1132 <span style="display: none; "></span> 1133 </span> 1134 </span> 1135 ) 1136 </div> 1137 1138 </em> 1139 </dt> 1140 <dd class="todo"> 1141 Undocumented. 1142 </dd> 1143 <dd style="display: none; "> 1144 Description of this parameter from the json schema. 1145 </dd> 1146 <dd style="display: none; "> 1147 This parameter was added in version 1148 <b><span></span></b>. 1149 You must omit this parameter in earlier versions, 1150 and you may omit it in any version. If you require this 1151 parameter, the manifest key 1152 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1153 can ensure that your extension won't be run in an earlier browser version. 1154 </dd> 1155 1156 <!-- OBJECT PROPERTIES --> 1157 <dd> 1158 <dl> 1159 <div> 1160 <div> 1161 <dt> 1162 <var>imageData</var> 1163 <em> 1164 1165 <!-- TYPE --> 1166 <div style="display:inline"> 1167 ( 1168 <span class="optional">optional</span> 1169 <span class="enum" style="display: none; ">enumerated</span> 1170 <span id="typeTemplate"> 1171 <span style="display: none; "> 1172 <a> Type</a> 1173 </span> 1174 <span> 1175 <span style="display: none; "> 1176 array of <span><span></span></span> 1177 </span> 1178 <span>ImageData</span> 1179 <span style="display: none; "></span> 1180 </span> 1181 </span> 1182 ) 1183 </div> 1184 1185 </em> 1186 </dt> 1187 <dd class="todo" style="display: none; "> 1188 Undocumented. 1189 </dd> 1190 <dd>Pixel data for an image. Must be an ImageData object (for example, from a <code>canvas</code> element).</dd> 1191 <dd style="display: none; "> 1192 This parameter was added in version 1193 <b><span></span></b>. 1194 You must omit this parameter in earlier versions, 1195 and you may omit it in any version. If you require this 1196 parameter, the manifest key 1197 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1198 can ensure that your extension won't be run in an earlier browser version. 1199 </dd> 1200 1201 <!-- OBJECT PROPERTIES --> 1202 <dd> 1203 <dl> 1204 <div style="display: none; "> 1205 <div> 1206 </div> 1207 </div> 1208 </dl> 1209 </dd> 1210 1211 <!-- OBJECT METHODS --> 1212 <dd style="display: none; "> 1213 <div></div> 1214 </dd> 1215 1216 <!-- OBJECT EVENT FIELDS --> 1217 <dd style="display: none; "> 1218 <div></div> 1219 </dd> 1220 1221 <!-- FUNCTION PARAMETERS --> 1222 <dd style="display: none; "> 1223 <div></div> 1224 </dd> 1225 1226 </div> 1227 </div><div> 1228 <div> 1229 <dt> 1230 <var>path</var> 1231 <em> 1232 1233 <!-- TYPE --> 1234 <div style="display:inline"> 1235 ( 1236 <span class="optional">optional</span> 1237 <span class="enum" style="display: none; ">enumerated</span> 1238 <span id="typeTemplate"> 1239 <span style="display: none; "> 1240 <a> Type</a> 1241 </span> 1242 <span> 1243 <span style="display: none; "> 1244 array of <span><span></span></span> 1245 </span> 1246 <span>string</span> 1247 <span style="display: none; "></span> 1248 </span> 1249 </span> 1250 ) 1251 </div> 1252 1253 </em> 1254 </dt> 1255 <dd class="todo" style="display: none; "> 1256 Undocumented. 1257 </dd> 1258 <dd>Relative path to an image in the extension to show in the browser action.</dd> 1259 <dd style="display: none; "> 1260 This parameter was added in version 1261 <b><span></span></b>. 1262 You must omit this parameter in earlier versions, 1263 and you may omit it in any version. If you require this 1264 parameter, the manifest key 1265 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1266 can ensure that your extension won't be run in an earlier browser version. 1267 </dd> 1268 1269 <!-- OBJECT PROPERTIES --> 1270 <dd style="display: none; "> 1271 <dl> 1272 <div> 1273 <div> 1274 </div> 1275 </div> 1276 </dl> 1277 </dd> 1278 1279 <!-- OBJECT METHODS --> 1280 <dd style="display: none; "> 1281 <div></div> 1282 </dd> 1283 1284 <!-- OBJECT EVENT FIELDS --> 1285 <dd style="display: none; "> 1286 <div></div> 1287 </dd> 1288 1289 <!-- FUNCTION PARAMETERS --> 1290 <dd style="display: none; "> 1291 <div></div> 1292 </dd> 1293 1294 </div> 1295 </div><div> 1296 <div> 1297 <dt> 1298 <var>tabId</var> 1299 <em> 1300 1301 <!-- TYPE --> 1302 <div style="display:inline"> 1303 ( 1304 <span class="optional">optional</span> 1305 <span class="enum" style="display: none; ">enumerated</span> 1306 <span id="typeTemplate"> 1307 <span style="display: none; "> 1308 <a> Type</a> 1309 </span> 1310 <span> 1311 <span style="display: none; "> 1312 array of <span><span></span></span> 1313 </span> 1314 <span>integer</span> 1315 <span style="display: none; "></span> 1316 </span> 1317 </span> 1318 ) 1319 </div> 1320 1321 </em> 1322 </dt> 1323 <dd class="todo" style="display: none; "> 1324 Undocumented. 1325 </dd> 1326 <dd>Limits the change to when a particular tab is selected. Automatically resets when the tab is closed.</dd> 1327 <dd style="display: none; "> 1328 This parameter was added in version 1329 <b><span></span></b>. 1330 You must omit this parameter in earlier versions, 1331 and you may omit it in any version. If you require this 1332 parameter, the manifest key 1333 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1334 can ensure that your extension won't be run in an earlier browser version. 1335 </dd> 1336 1337 <!-- OBJECT PROPERTIES --> 1338 <dd style="display: none; "> 1339 <dl> 1340 <div> 1341 <div> 1342 </div> 1343 </div> 1344 </dl> 1345 </dd> 1346 1347 <!-- OBJECT METHODS --> 1348 <dd style="display: none; "> 1349 <div></div> 1350 </dd> 1351 1352 <!-- OBJECT EVENT FIELDS --> 1353 <dd style="display: none; "> 1354 <div></div> 1355 </dd> 1356 1357 <!-- FUNCTION PARAMETERS --> 1358 <dd style="display: none; "> 1359 <div></div> 1360 </dd> 1361 1362 </div> 1363 </div> 1364 </dl> 1365 </dd> 1366 1367 <!-- OBJECT METHODS --> 1368 <dd style="display: none; "> 1369 <div></div> 1370 </dd> 1371 1372 <!-- OBJECT EVENT FIELDS --> 1373 <dd style="display: none; "> 1374 <div></div> 1375 </dd> 1376 1377 <!-- FUNCTION PARAMETERS --> 1378 <dd style="display: none; "> 1379 <div></div> 1380 </dd> 1381 1382 </div> 1383 </div> 1384 </dl> 1385 1386 <!-- RETURNS --> 1387 <h4 style="display: none; ">Returns</h4> 1388 <dl> 1389 <div style="display: none; "> 1390 <div> 1391 </div> 1392 </div> 1393 </dl> 1394 1395 <!-- CALLBACK --> 1396 <div style="display: none; "> 1397 <div> 1398 <h4>Callback function</h4> 1399 <p> 1400 The callback <em>parameter</em> should specify a function 1401 that looks like this: 1402 </p> 1403 <p> 1404 If you specify the <em>callback</em> parameter, it should 1405 specify a function that looks like this: 1406 </p> 1407 1408 <!-- Note: intentionally longer 80 columns --> 1409 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1410 <dl> 1411 <div> 1412 <div> 1413 </div> 1414 </div> 1415 </dl> 1416 </div> 1417 </div> 1418 1419 <!-- MIN_VERSION --> 1420 <p style="display: none; "> 1421 This function was added in version <b><span></span></b>. 1422 If you require this function, the manifest key 1423 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1424 can ensure that your extension won't be run in an earlier browser version. 1425 </p> 1426 </div> <!-- /description --> 1427 1428 </div><div class="apiItem"> 1429 <a name="method-setPopup"></a> <!-- method-anchor --> 1430 <h4>setPopup</h4> 1431 1432 <div class="summary"><span style="display: none; ">void</span> 1433 <!-- Note: intentionally longer 80 columns --> 1434 <span>chrome.browserAction.setPopup</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 1435 <var><span>details</span></var></span>)</div> 1436 1437 <div class="description"> 1438 <p class="todo" style="display: none; ">Undocumented.</p> 1439 <p>Sets the html document to be opened as a popup when the user clicks on the browser action's icon.</p> 1440 1441 <!-- PARAMETERS --> 1442 <h4>Parameters</h4> 1443 <dl> 1444 <div> 1445 <div> 1446 <dt> 1447 <var>details</var> 1448 <em> 1449 1450 <!-- TYPE --> 1451 <div style="display:inline"> 1452 ( 1453 <span class="optional" style="display: none; ">optional</span> 1454 <span class="enum" style="display: none; ">enumerated</span> 1455 <span id="typeTemplate"> 1456 <span style="display: none; "> 1457 <a> Type</a> 1458 </span> 1459 <span> 1460 <span style="display: none; "> 1461 array of <span><span></span></span> 1462 </span> 1463 <span>object</span> 1464 <span style="display: none; "></span> 1465 </span> 1466 </span> 1467 ) 1468 </div> 1469 1470 </em> 1471 </dt> 1472 <dd class="todo"> 1473 Undocumented. 1474 </dd> 1475 <dd style="display: none; "> 1476 Description of this parameter from the json schema. 1477 </dd> 1478 <dd style="display: none; "> 1479 This parameter was added in version 1480 <b><span></span></b>. 1481 You must omit this parameter in earlier versions, 1482 and you may omit it in any version. If you require this 1483 parameter, the manifest key 1484 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1485 can ensure that your extension won't be run in an earlier browser version. 1486 </dd> 1487 1488 <!-- OBJECT PROPERTIES --> 1489 <dd> 1490 <dl> 1491 <div> 1492 <div> 1493 <dt> 1494 <var>tabId</var> 1495 <em> 1496 1497 <!-- TYPE --> 1498 <div style="display:inline"> 1499 ( 1500 <span class="optional">optional</span> 1501 <span class="enum" style="display: none; ">enumerated</span> 1502 <span id="typeTemplate"> 1503 <span style="display: none; "> 1504 <a> Type</a> 1505 </span> 1506 <span> 1507 <span style="display: none; "> 1508 array of <span><span></span></span> 1509 </span> 1510 <span>integer</span> 1511 <span style="display: none; "></span> 1512 </span> 1513 </span> 1514 ) 1515 </div> 1516 1517 </em> 1518 </dt> 1519 <dd class="todo" style="display: none; "> 1520 Undocumented. 1521 </dd> 1522 <dd>Limits the change to when a particular tab is selected. Automatically resets when the tab is closed.</dd> 1523 <dd style="display: none; "> 1524 This parameter was added in version 1525 <b><span></span></b>. 1526 You must omit this parameter in earlier versions, 1527 and you may omit it in any version. If you require this 1528 parameter, the manifest key 1529 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1530 can ensure that your extension won't be run in an earlier browser version. 1531 </dd> 1532 1533 <!-- OBJECT PROPERTIES --> 1534 <dd style="display: none; "> 1535 <dl> 1536 <div> 1537 <div> 1538 </div> 1539 </div> 1540 </dl> 1541 </dd> 1542 1543 <!-- OBJECT METHODS --> 1544 <dd style="display: none; "> 1545 <div></div> 1546 </dd> 1547 1548 <!-- OBJECT EVENT FIELDS --> 1549 <dd style="display: none; "> 1550 <div></div> 1551 </dd> 1552 1553 <!-- FUNCTION PARAMETERS --> 1554 <dd style="display: none; "> 1555 <div></div> 1556 </dd> 1557 1558 </div> 1559 </div><div> 1560 <div> 1561 <dt> 1562 <var>popup</var> 1563 <em> 1564 1565 <!-- TYPE --> 1566 <div style="display:inline"> 1567 ( 1568 <span class="optional" style="display: none; ">optional</span> 1569 <span class="enum" style="display: none; ">enumerated</span> 1570 <span id="typeTemplate"> 1571 <span style="display: none; "> 1572 <a> Type</a> 1573 </span> 1574 <span> 1575 <span style="display: none; "> 1576 array of <span><span></span></span> 1577 </span> 1578 <span>string</span> 1579 <span style="display: none; "></span> 1580 </span> 1581 </span> 1582 ) 1583 </div> 1584 1585 </em> 1586 </dt> 1587 <dd class="todo" style="display: none; "> 1588 Undocumented. 1589 </dd> 1590 <dd>The html file to show in a popup. If set to the empty string (''), no popup is shown.</dd> 1591 <dd style="display: none; "> 1592 This parameter was added in version 1593 <b><span></span></b>. 1594 You must omit this parameter in earlier versions, 1595 and you may omit it in any version. If you require this 1596 parameter, the manifest key 1597 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1598 can ensure that your extension won't be run in an earlier browser version. 1599 </dd> 1600 1601 <!-- OBJECT PROPERTIES --> 1602 <dd style="display: none; "> 1603 <dl> 1604 <div> 1605 <div> 1606 </div> 1607 </div> 1608 </dl> 1609 </dd> 1610 1611 <!-- OBJECT METHODS --> 1612 <dd style="display: none; "> 1613 <div></div> 1614 </dd> 1615 1616 <!-- OBJECT EVENT FIELDS --> 1617 <dd style="display: none; "> 1618 <div></div> 1619 </dd> 1620 1621 <!-- FUNCTION PARAMETERS --> 1622 <dd style="display: none; "> 1623 <div></div> 1624 </dd> 1625 1626 </div> 1627 </div> 1628 </dl> 1629 </dd> 1630 1631 <!-- OBJECT METHODS --> 1632 <dd style="display: none; "> 1633 <div></div> 1634 </dd> 1635 1636 <!-- OBJECT EVENT FIELDS --> 1637 <dd style="display: none; "> 1638 <div></div> 1639 </dd> 1640 1641 <!-- FUNCTION PARAMETERS --> 1642 <dd style="display: none; "> 1643 <div></div> 1644 </dd> 1645 1646 </div> 1647 </div> 1648 </dl> 1649 1650 <!-- RETURNS --> 1651 <h4 style="display: none; ">Returns</h4> 1652 <dl> 1653 <div style="display: none; "> 1654 <div> 1655 </div> 1656 </div> 1657 </dl> 1658 1659 <!-- CALLBACK --> 1660 <div style="display: none; "> 1661 <div> 1662 <h4>Callback function</h4> 1663 <p> 1664 The callback <em>parameter</em> should specify a function 1665 that looks like this: 1666 </p> 1667 <p> 1668 If you specify the <em>callback</em> parameter, it should 1669 specify a function that looks like this: 1670 </p> 1671 1672 <!-- Note: intentionally longer 80 columns --> 1673 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1674 <dl> 1675 <div> 1676 <div> 1677 </div> 1678 </div> 1679 </dl> 1680 </div> 1681 </div> 1682 1683 <!-- MIN_VERSION --> 1684 <p> 1685 This function was added in version <b><span>5.0.316.0</span></b>. 1686 If you require this function, the manifest key 1687 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1688 can ensure that your extension won't be run in an earlier browser version. 1689 </p> 1690 </div> <!-- /description --> 1691 1692 </div><div class="apiItem"> 1693 <a name="method-setTitle"></a> <!-- method-anchor --> 1694 <h4>setTitle</h4> 1695 1696 <div class="summary"><span style="display: none; ">void</span> 1697 <!-- Note: intentionally longer 80 columns --> 1698 <span>chrome.browserAction.setTitle</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 1699 <var><span>details</span></var></span>)</div> 1700 1701 <div class="description"> 1702 <p class="todo" style="display: none; ">Undocumented.</p> 1703 <p>Sets the title of the browser action. This shows up in the tooltip.</p> 1704 1705 <!-- PARAMETERS --> 1706 <h4>Parameters</h4> 1707 <dl> 1708 <div> 1709 <div> 1710 <dt> 1711 <var>details</var> 1712 <em> 1713 1714 <!-- TYPE --> 1715 <div style="display:inline"> 1716 ( 1717 <span class="optional" style="display: none; ">optional</span> 1718 <span class="enum" style="display: none; ">enumerated</span> 1719 <span id="typeTemplate"> 1720 <span style="display: none; "> 1721 <a> Type</a> 1722 </span> 1723 <span> 1724 <span style="display: none; "> 1725 array of <span><span></span></span> 1726 </span> 1727 <span>object</span> 1728 <span style="display: none; "></span> 1729 </span> 1730 </span> 1731 ) 1732 </div> 1733 1734 </em> 1735 </dt> 1736 <dd class="todo"> 1737 Undocumented. 1738 </dd> 1739 <dd style="display: none; "> 1740 Description of this parameter from the json schema. 1741 </dd> 1742 <dd style="display: none; "> 1743 This parameter was added in version 1744 <b><span></span></b>. 1745 You must omit this parameter in earlier versions, 1746 and you may omit it in any version. If you require this 1747 parameter, the manifest key 1748 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1749 can ensure that your extension won't be run in an earlier browser version. 1750 </dd> 1751 1752 <!-- OBJECT PROPERTIES --> 1753 <dd> 1754 <dl> 1755 <div> 1756 <div> 1757 <dt> 1758 <var>title</var> 1759 <em> 1760 1761 <!-- TYPE --> 1762 <div style="display:inline"> 1763 ( 1764 <span class="optional" style="display: none; ">optional</span> 1765 <span class="enum" style="display: none; ">enumerated</span> 1766 <span id="typeTemplate"> 1767 <span style="display: none; "> 1768 <a> Type</a> 1769 </span> 1770 <span> 1771 <span style="display: none; "> 1772 array of <span><span></span></span> 1773 </span> 1774 <span>string</span> 1775 <span style="display: none; "></span> 1776 </span> 1777 </span> 1778 ) 1779 </div> 1780 1781 </em> 1782 </dt> 1783 <dd class="todo" style="display: none; "> 1784 Undocumented. 1785 </dd> 1786 <dd>The string the browser action should display when moused over.</dd> 1787 <dd style="display: none; "> 1788 This parameter was added in version 1789 <b><span></span></b>. 1790 You must omit this parameter in earlier versions, 1791 and you may omit it in any version. If you require this 1792 parameter, the manifest key 1793 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1794 can ensure that your extension won't be run in an earlier browser version. 1795 </dd> 1796 1797 <!-- OBJECT PROPERTIES --> 1798 <dd style="display: none; "> 1799 <dl> 1800 <div> 1801 <div> 1802 </div> 1803 </div> 1804 </dl> 1805 </dd> 1806 1807 <!-- OBJECT METHODS --> 1808 <dd style="display: none; "> 1809 <div></div> 1810 </dd> 1811 1812 <!-- OBJECT EVENT FIELDS --> 1813 <dd style="display: none; "> 1814 <div></div> 1815 </dd> 1816 1817 <!-- FUNCTION PARAMETERS --> 1818 <dd style="display: none; "> 1819 <div></div> 1820 </dd> 1821 1822 </div> 1823 </div><div> 1824 <div> 1825 <dt> 1826 <var>tabId</var> 1827 <em> 1828 1829 <!-- TYPE --> 1830 <div style="display:inline"> 1831 ( 1832 <span class="optional">optional</span> 1833 <span class="enum" style="display: none; ">enumerated</span> 1834 <span id="typeTemplate"> 1835 <span style="display: none; "> 1836 <a> Type</a> 1837 </span> 1838 <span> 1839 <span style="display: none; "> 1840 array of <span><span></span></span> 1841 </span> 1842 <span>integer</span> 1843 <span style="display: none; "></span> 1844 </span> 1845 </span> 1846 ) 1847 </div> 1848 1849 </em> 1850 </dt> 1851 <dd class="todo" style="display: none; "> 1852 Undocumented. 1853 </dd> 1854 <dd>Limits the change to when a particular tab is selected. Automatically resets when the tab is closed.</dd> 1855 <dd style="display: none; "> 1856 This parameter was added in version 1857 <b><span></span></b>. 1858 You must omit this parameter in earlier versions, 1859 and you may omit it in any version. If you require this 1860 parameter, the manifest key 1861 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1862 can ensure that your extension won't be run in an earlier browser version. 1863 </dd> 1864 1865 <!-- OBJECT PROPERTIES --> 1866 <dd style="display: none; "> 1867 <dl> 1868 <div> 1869 <div> 1870 </div> 1871 </div> 1872 </dl> 1873 </dd> 1874 1875 <!-- OBJECT METHODS --> 1876 <dd style="display: none; "> 1877 <div></div> 1878 </dd> 1879 1880 <!-- OBJECT EVENT FIELDS --> 1881 <dd style="display: none; "> 1882 <div></div> 1883 </dd> 1884 1885 <!-- FUNCTION PARAMETERS --> 1886 <dd style="display: none; "> 1887 <div></div> 1888 </dd> 1889 1890 </div> 1891 </div> 1892 </dl> 1893 </dd> 1894 1895 <!-- OBJECT METHODS --> 1896 <dd style="display: none; "> 1897 <div></div> 1898 </dd> 1899 1900 <!-- OBJECT EVENT FIELDS --> 1901 <dd style="display: none; "> 1902 <div></div> 1903 </dd> 1904 1905 <!-- FUNCTION PARAMETERS --> 1906 <dd style="display: none; "> 1907 <div></div> 1908 </dd> 1909 1910 </div> 1911 </div> 1912 </dl> 1913 1914 <!-- RETURNS --> 1915 <h4 style="display: none; ">Returns</h4> 1916 <dl> 1917 <div style="display: none; "> 1918 <div> 1919 </div> 1920 </div> 1921 </dl> 1922 1923 <!-- CALLBACK --> 1924 <div style="display: none; "> 1925 <div> 1926 <h4>Callback function</h4> 1927 <p> 1928 The callback <em>parameter</em> should specify a function 1929 that looks like this: 1930 </p> 1931 <p> 1932 If you specify the <em>callback</em> parameter, it should 1933 specify a function that looks like this: 1934 </p> 1935 1936 <!-- Note: intentionally longer 80 columns --> 1937 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1938 <dl> 1939 <div> 1940 <div> 1941 </div> 1942 </div> 1943 </dl> 1944 </div> 1945 </div> 1946 1947 <!-- MIN_VERSION --> 1948 <p style="display: none; "> 1949 This function was added in version <b><span></span></b>. 1950 If you require this function, the manifest key 1951 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1952 can ensure that your extension won't be run in an earlier browser version. 1953 </p> 1954 </div> <!-- /description --> 1955 1956 </div> <!-- /apiItem --> 1957 1958 </div> <!-- /apiGroup --> 1959 1960 <!-- EVENTS --> 1961 <div id="eventsTemplate" class="apiGroup"> 1962 <a name="global-events"></a> 1963 <h3>Events</h3> 1964 <!-- iterates over all events --> 1965 <div class="apiItem"> 1966 <a name="event-onClicked"></a> 1967 <h4>onClicked</h4> 1968 1969 <div class="summary"> 1970 <!-- Note: intentionally longer 80 columns --> 1971 <span class="subdued">chrome.browserAction.</span><span>onClicked</span><span class="subdued">.addListener</span>(function(<span>Tab tab</span>) <span class="subdued">{...}</span>); 1972 </div> 1973 1974 <div class="description"> 1975 <p class="todo" style="display: none; ">Undocumented.</p> 1976 <p>Fired when a browser action icon is clicked. This event will not fire if the browser action has a popup.</p> 1977 1978 <!-- PARAMETERS --> 1979 <div> 1980 <h4>Parameters</h4> 1981 <dl> 1982 <div> 1983 <div> 1984 <dt> 1985 <var>tab</var> 1986 <em> 1987 1988 <!-- TYPE --> 1989 <div style="display:inline"> 1990 ( 1991 <span class="optional" style="display: none; ">optional</span> 1992 <span class="enum" style="display: none; ">enumerated</span> 1993 <span id="typeTemplate"> 1994 <span> 1995 <a href="tabs.html#type-Tab">Tab</a> 1996 </span> 1997 <span style="display: none; "> 1998 <span> 1999 array of <span><span></span></span> 2000 </span> 2001 <span>paramType</span> 2002 <span></span> 2003 </span> 2004 </span> 2005 ) 2006 </div> 2007 2008 </em> 2009 </dt> 2010 <dd class="todo"> 2011 Undocumented. 2012 </dd> 2013 <dd style="display: none; "> 2014 Description of this parameter from the json schema. 2015 </dd> 2016 <dd style="display: none; "> 2017 This parameter was added in version 2018 <b><span></span></b>. 2019 You must omit this parameter in earlier versions, 2020 and you may omit it in any version. If you require this 2021 parameter, the manifest key 2022 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2023 can ensure that your extension won't be run in an earlier browser version. 2024 </dd> 2025 2026 <!-- OBJECT PROPERTIES --> 2027 <dd style="display: none; "> 2028 <dl> 2029 <div> 2030 <div> 2031 </div> 2032 </div> 2033 </dl> 2034 </dd> 2035 2036 <!-- OBJECT METHODS --> 2037 <dd style="display: none; "> 2038 <div></div> 2039 </dd> 2040 2041 <!-- OBJECT EVENT FIELDS --> 2042 <dd style="display: none; "> 2043 <div></div> 2044 </dd> 2045 2046 <!-- FUNCTION PARAMETERS --> 2047 <dd style="display: none; "> 2048 <div></div> 2049 </dd> 2050 2051 </div> 2052 </div> 2053 </dl> 2054 </div> 2055 </div> <!-- /decription --> 2056 2057 </div> <!-- /apiItem --> 2058 2059 </div> <!-- /apiGroup --> 2060 2061 <!-- TYPES --> 2062 <div class="apiGroup" style="display: none; "> 2063 <a name="types"></a> 2064 <h3 id="types">Types</h3> 2065 2066 <!-- iterates over all types --> 2067 <div class="apiItem"> 2068 <a></a> 2069 <h4>type name</h4> 2070 2071 <div> 2072 </div> 2073 2074 </div> <!-- /apiItem --> 2075 2076 </div> <!-- /apiGroup --> 2077 2078 </div> <!-- /apiPage --> 2079 </div> <!-- /gc-pagecontent --> 2080 </div> <!-- /g-section --> 2081 </div> <!-- /codesiteContent --> 2082 <div id="gc-footer" --=""> 2083 <div class="text"> 2084 <p> 2085 Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>, 2086 the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons 2087 Attribution 3.0 License</a>, and code samples are licensed under the 2088 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>. 2089 </p> 2090 <p> 2091 ©2011 Google 2092 </p> 2093 2094<!-- begin analytics --> 2095<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> 2096<script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script> 2097 2098<script type="text/javascript"> 2099 // chrome doc tracking 2100 try { 2101 var engdocs = _gat._getTracker("YT-10763712-2"); 2102 engdocs._trackPageview(); 2103 } catch(err) {} 2104 2105 // code.google.com site-wide tracking 2106 try { 2107 _uacct="UA-18071-1"; 2108 _uanchor=1; 2109 _uff=0; 2110 urchinTracker(); 2111 } 2112 catch(e) {/* urchinTracker not available. */} 2113</script> 2114<!-- end analytics --> 2115 </div> 2116 </div> <!-- /gc-footer --> 2117 </div> <!-- /gc-container --> 2118</body></html> 2119
