pageAction.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>Page 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 <!-- 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><a href="omnibox.html">Omnibox</a></li> 170 <li><a href="options.html">Options Pages</a></li> 171 <li><a href="override.html">Override Pages</a></li> 172 <li class="leftNavSelected">Page Actions</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">Page Actions</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="#ui">Parts of the UI</a> 259 <ol> 260 <li style="display: none; "> 261 <a>h3Name</a> 262 </li> 263 </ol> 264 </li><li> 265 <a href="#tips">Tips</a> 266 <ol> 267 <li style="display: none; "> 268 <a>h3Name</a> 269 </li> 270 </ol> 271 </li><li> 272 <a href="#examples"> Examples </a> 273 <ol> 274 <li style="display: none; "> 275 <a>h3Name</a> 276 </li> 277 </ol> 278 </li> 279 <li> 280 <a href="#apiReference">API reference: chrome.pageAction</a> 281 <ol> 282 <li style="display: none; "> 283 <a href="#properties">Properties</a> 284 <ol> 285 <li> 286 <a href="#property-anchor">propertyName</a> 287 </li> 288 </ol> 289 </li> 290 <li> 291 <a href="#methods">Methods</a> 292 <ol> 293 <li> 294 <a href="#method-hide">hide</a> 295 </li><li> 296 <a href="#method-setIcon">setIcon</a> 297 </li><li> 298 <a href="#method-setPopup">setPopup</a> 299 </li><li> 300 <a href="#method-setTitle">setTitle</a> 301 </li><li> 302 <a href="#method-show">show</a> 303 </li> 304 </ol> 305 </li> 306 <li> 307 <a href="#events">Events</a> 308 <ol> 309 <li> 310 <a href="#event-onClicked">onClicked</a> 311 </li> 312 </ol> 313 </li> 314 <li style="display: none; "> 315 <a href="#types">Types</a> 316 <ol> 317 <li> 318 <a href="#id-anchor">id</a> 319 </li> 320 </ol> 321 </li> 322 </ol> 323 </li> 324 </ol> 325 </div> 326 <!-- /TABLE OF CONTENTS --> 327 328 <!-- Standard content lead-in for experimental API pages --> 329 <p id="classSummary" style="display: none; "> 330 For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. 331 </p> 332 333 <!-- STATIC CONTENT PLACEHOLDER --> 334 <div id="static"><div id="pageData-name" class="pageData">Page Actions</div> 335 336<!-- BEGIN AUTHORED CONTENT --> 337<p> 338Use page actions to put icons inside the address bar. 339Page actions represent actions 340that can be taken on the current page, 341but that aren't applicable to all pages. 342Some examples: 343</p> 344<ul> 345 <li> Subscribe to this page's RSS feed </li> 346 <li> Make a slideshow out of this page's photos </li> 347</ul> 348 349<p> 350The RSS icon in the following screenshot 351represents a page action 352that lets you subscribe to 353the RSS feed for the current page. 354</p> 355 356<img src="images/page-action.png" width="361" height="79"> 357 358<p> 359If you want the extension's icon to always be visible, 360use a <a href="browserAction.html">browser action</a> instead. 361</p> 362 363<p class="caution"> 364<strong>Note:</strong> 365Packaged apps cannot use page actions. 366</p> 367 368 369<h2 id="manifest">Manifest</h2> 370 371<p> 372Register your page action in the 373<a href="manifest.html">extension manifest</a> 374like this: 375</p> 376 377<pre>{ 378 "name": "My extension", 379 ... 380 <b>"page_action": { 381 "default_icon": "icons/foo.png", <em>// <b>required</b></em> 382 "default_title": "Do action", <em>// optional; shown in tooltip</em> 383 "default_popup": "popup.html" <em>// optional</em> 384 }</b>, 385 ... 386}</pre> 387 388<h2 id="ui">Parts of the UI</h2> 389 390<p> 391Like browser actions, 392page actions have an icon and 393can also have a tooltip and popup; 394they can't have badges, however. 395In addition, page actions can appear and disappear. 396You can find information about icons, tooltips, and popups 397by reading about the 398<a href="browserAction.html#ui">browser action UI</a>. 399</p> 400 401<p> 402You make a page action appear and disappear using the 403<a href="#method-show">show()</a> and 404<a href="#method-hide">hide()</a> methods, respectively. 405By default, a page action is hidden. 406When you show it, you specify the tab 407in which the icon should appear. 408The icon remains visible 409until the tab is closed 410or starts displaying a different URL 411(because the user clicks a link, for example). 412</p> 413 414<!-- [PENDING: We should discuss how tabs and page actions are related. All methods take a tab ID argument. How do you get that tab ID? What's the usual way of arranging the code that monitors pages? Point to examples.] --> 415 416 417<h2 id="tips">Tips</h2> 418 419<p>For the best visual impact, 420follow these guidelines:</p> 421 422<ul> 423 <li><b>Do</b> use page actions 424 for features that make sense 425 for only a few pages. 426 </li><li><b>Don't</b> use page actions 427 for features that make sense 428 for most pages. 429 Use <a href="browserAction.html">browser actions</a> instead. 430 </li><li><b>Do</b> use icons 431 that are slightly lighter weight 432 than <a href="browserAction.html#icon">browser action icons</a>. 433 Most icons that Chrome displays 434 in the location bar 435 are smaller than 19 pixels. 436 If the edge pixels are used, 437 they are usually only used 438 for a faint shadow. 439 </li><li><b>Don't</b> constantly animate your icon. 440 That's just annoying. 441</li></ul> 442 443 444<h2 id="examples"> Examples </h2> 445 446<p> 447You can find simple examples of using page actions in the 448<a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/api/pageAction/">examples/api/pageAction</a> 449directory. 450For other examples and for help in viewing the source code, see 451<a href="samples.html">Samples</a>. 452</p> 453 454<!-- END AUTHORED CONTENT --> 455</div> 456 457 <!-- API PAGE --> 458 <div class="apiPage"> 459 <a name="apiReference"></a> 460 <h2>API reference: chrome.pageAction</h2> 461 462 <!-- PROPERTIES --> 463 <div class="apiGroup" style="display: none; "> 464 <a name="properties"></a> 465 <h3 id="properties">Properties</h3> 466 467 <div> 468 <a></a> 469 <h4>getLastError</h4> 470 <div class="summary"> 471 <!-- Note: intentionally longer 80 columns --> 472 <span>chrome.extension</span><span>lastError</span> 473 </div> 474 <div> 475 </div> 476 </div> 477 478 </div> <!-- /apiGroup --> 479 480 <!-- METHODS --> 481 <div class="apiGroup" id="methods"> 482 <a name="methods"></a> 483 <h3>Methods</h3> 484 485 <!-- iterates over all functions --> 486 <div class="apiItem"> 487 <a name="method-hide"></a> <!-- method-anchor --> 488 <h4>hide</h4> 489 490 <div class="summary"><span style="display: none; ">void</span> 491 <!-- Note: intentionally longer 80 columns --> 492 <span>chrome.pageAction.hide</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> 493 <var><span>tabId</span></var></span>)</div> 494 495 <div class="description"> 496 <p class="todo" style="display: none; ">Undocumented.</p> 497 <p>Hides the page action.</p> 498 499 <!-- PARAMETERS --> 500 <h4>Parameters</h4> 501 <dl> 502 <div> 503 <div> 504 <dt> 505 <var>tabId</var> 506 <em> 507 508 <!-- TYPE --> 509 <div style="display:inline"> 510 ( 511 <span class="optional" style="display: none; ">optional</span> 512 <span class="enum" style="display: none; ">enumerated</span> 513 <span id="typeTemplate"> 514 <span style="display: none; "> 515 <a> Type</a> 516 </span> 517 <span> 518 <span style="display: none; "> 519 array of <span><span></span></span> 520 </span> 521 <span>integer</span> 522 <span style="display: none; "></span> 523 </span> 524 </span> 525 ) 526 </div> 527 528 </em> 529 </dt> 530 <dd class="todo" style="display: none; "> 531 Undocumented. 532 </dd> 533 <dd>The id of the tab for which you want to modify the page action.</dd> 534 <dd style="display: none; "> 535 This parameter was added in version 536 <b><span></span></b>. 537 You must omit this parameter in earlier versions, 538 and you may omit it in any version. If you require this 539 parameter, the manifest key 540 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 541 can ensure that your extension won't be run in an earlier browser version. 542 </dd> 543 544 <!-- OBJECT PROPERTIES --> 545 <dd style="display: none; "> 546 <dl> 547 <div> 548 <div> 549 </div> 550 </div> 551 </dl> 552 </dd> 553 554 <!-- FUNCTION PARAMETERS --> 555 <dd style="display: none; "> 556 <div></div> 557 </dd> 558 559 </div> 560 </div> 561 </dl> 562 563 <!-- RETURNS --> 564 <h4 style="display: none; ">Returns</h4> 565 <dl> 566 <div style="display: none; "> 567 <div> 568 </div> 569 </div> 570 </dl> 571 572 <!-- CALLBACK --> 573 <div style="display: none; "> 574 <div> 575 <h4>Callback function</h4> 576 <p> 577 The callback <em>parameter</em> should specify a function 578 that looks like this: 579 </p> 580 <p> 581 If you specify the <em>callback</em> parameter, it should 582 specify a function that looks like this: 583 </p> 584 585 <!-- Note: intentionally longer 80 columns --> 586 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 587 <dl> 588 <div> 589 <div> 590 </div> 591 </div> 592 </dl> 593 </div> 594 </div> 595 596 <!-- MIN_VERSION --> 597 <p style="display: none; "> 598 This function was added in version <b><span></span></b>. 599 If you require this function, the manifest key 600 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 601 can ensure that your extension won't be run in an earlier browser version. 602 </p> 603 </div> <!-- /description --> 604 605 </div><div class="apiItem"> 606 <a name="method-setIcon"></a> <!-- method-anchor --> 607 <h4>setIcon</h4> 608 609 <div class="summary"><span style="display: none; ">void</span> 610 <!-- Note: intentionally longer 80 columns --> 611 <span>chrome.pageAction.setIcon</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 612 <var><span>details</span></var></span>)</div> 613 614 <div class="description"> 615 <p class="todo" style="display: none; ">Undocumented.</p> 616 <p>Sets the icon for the page 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> 617 618 <!-- PARAMETERS --> 619 <h4>Parameters</h4> 620 <dl> 621 <div> 622 <div> 623 <dt> 624 <var>details</var> 625 <em> 626 627 <!-- TYPE --> 628 <div style="display:inline"> 629 ( 630 <span class="optional" style="display: none; ">optional</span> 631 <span class="enum" style="display: none; ">enumerated</span> 632 <span id="typeTemplate"> 633 <span style="display: none; "> 634 <a> Type</a> 635 </span> 636 <span> 637 <span style="display: none; "> 638 array of <span><span></span></span> 639 </span> 640 <span>object</span> 641 <span style="display: none; "></span> 642 </span> 643 </span> 644 ) 645 </div> 646 647 </em> 648 </dt> 649 <dd class="todo"> 650 Undocumented. 651 </dd> 652 <dd style="display: none; "> 653 Description of this parameter from the json schema. 654 </dd> 655 <dd style="display: none; "> 656 This parameter was added in version 657 <b><span></span></b>. 658 You must omit this parameter in earlier versions, 659 and you may omit it in any version. If you require this 660 parameter, the manifest key 661 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 662 can ensure that your extension won't be run in an earlier browser version. 663 </dd> 664 665 <!-- OBJECT PROPERTIES --> 666 <dd> 667 <dl> 668 <div> 669 <div> 670 <dt> 671 <var>tabId</var> 672 <em> 673 674 <!-- TYPE --> 675 <div style="display:inline"> 676 ( 677 <span class="optional" style="display: none; ">optional</span> 678 <span class="enum" style="display: none; ">enumerated</span> 679 <span id="typeTemplate"> 680 <span style="display: none; "> 681 <a> Type</a> 682 </span> 683 <span> 684 <span style="display: none; "> 685 array of <span><span></span></span> 686 </span> 687 <span>integer</span> 688 <span style="display: none; "></span> 689 </span> 690 </span> 691 ) 692 </div> 693 694 </em> 695 </dt> 696 <dd class="todo" style="display: none; "> 697 Undocumented. 698 </dd> 699 <dd>The id of the tab for which you want to modify the page action.</dd> 700 <dd style="display: none; "> 701 This parameter was added in version 702 <b><span></span></b>. 703 You must omit this parameter in earlier versions, 704 and you may omit it in any version. If you require this 705 parameter, the manifest key 706 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 707 can ensure that your extension won't be run in an earlier browser version. 708 </dd> 709 710 <!-- OBJECT PROPERTIES --> 711 <dd style="display: none; "> 712 <dl> 713 <div> 714 <div> 715 </div> 716 </div> 717 </dl> 718 </dd> 719 720 <!-- FUNCTION PARAMETERS --> 721 <dd style="display: none; "> 722 <div></div> 723 </dd> 724 725 </div> 726 </div><div> 727 <div> 728 <dt> 729 <var>imageData</var> 730 <em> 731 732 <!-- TYPE --> 733 <div style="display:inline"> 734 ( 735 <span class="optional">optional</span> 736 <span class="enum" style="display: none; ">enumerated</span> 737 <span id="typeTemplate"> 738 <span style="display: none; "> 739 <a> Type</a> 740 </span> 741 <span> 742 <span style="display: none; "> 743 array of <span><span></span></span> 744 </span> 745 <span>ImageData</span> 746 <span style="display: none; "></span> 747 </span> 748 </span> 749 ) 750 </div> 751 752 </em> 753 </dt> 754 <dd class="todo" style="display: none; "> 755 Undocumented. 756 </dd> 757 <dd>Pixel data for an image. Must be an ImageData object (for example, from a canvas element).</dd> 758 <dd style="display: none; "> 759 This parameter was added in version 760 <b><span></span></b>. 761 You must omit this parameter in earlier versions, 762 and you may omit it in any version. If you require this 763 parameter, the manifest key 764 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 765 can ensure that your extension won't be run in an earlier browser version. 766 </dd> 767 768 <!-- OBJECT PROPERTIES --> 769 <dd> 770 <dl> 771 <div style="display: none; "> 772 <div> 773 </div> 774 </div> 775 </dl> 776 </dd> 777 778 <!-- FUNCTION PARAMETERS --> 779 <dd style="display: none; "> 780 <div></div> 781 </dd> 782 783 </div> 784 </div><div> 785 <div> 786 <dt> 787 <var>path</var> 788 <em> 789 790 <!-- TYPE --> 791 <div style="display:inline"> 792 ( 793 <span class="optional">optional</span> 794 <span class="enum" style="display: none; ">enumerated</span> 795 <span id="typeTemplate"> 796 <span style="display: none; "> 797 <a> Type</a> 798 </span> 799 <span> 800 <span style="display: none; "> 801 array of <span><span></span></span> 802 </span> 803 <span>string</span> 804 <span style="display: none; "></span> 805 </span> 806 </span> 807 ) 808 </div> 809 810 </em> 811 </dt> 812 <dd class="todo" style="display: none; "> 813 Undocumented. 814 </dd> 815 <dd>Relative path to an image in the extension to show in the browser action.</dd> 816 <dd style="display: none; "> 817 This parameter was added in version 818 <b><span></span></b>. 819 You must omit this parameter in earlier versions, 820 and you may omit it in any version. If you require this 821 parameter, the manifest key 822 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 823 can ensure that your extension won't be run in an earlier browser version. 824 </dd> 825 826 <!-- OBJECT PROPERTIES --> 827 <dd style="display: none; "> 828 <dl> 829 <div> 830 <div> 831 </div> 832 </div> 833 </dl> 834 </dd> 835 836 <!-- FUNCTION PARAMETERS --> 837 <dd style="display: none; "> 838 <div></div> 839 </dd> 840 841 </div> 842 </div><div> 843 <div> 844 <dt> 845 <var>iconIndex</var> 846 <em> 847 848 <!-- TYPE --> 849 <div style="display:inline"> 850 ( 851 <span class="optional">optional</span> 852 <span class="enum" style="display: none; ">enumerated</span> 853 <span id="typeTemplate"> 854 <span style="display: none; "> 855 <a> Type</a> 856 </span> 857 <span> 858 <span style="display: none; "> 859 array of <span><span></span></span> 860 </span> 861 <span>integer</span> 862 <span style="display: none; "></span> 863 </span> 864 </span> 865 ) 866 </div> 867 868 </em> 869 </dt> 870 <dd class="todo" style="display: none; "> 871 Undocumented. 872 </dd> 873 <dd><b>Deprecated.</b> The zero-based index into the <b>icons</b> vector specified in the manifest.</dd> 874 <dd style="display: none; "> 875 This parameter was added in version 876 <b><span></span></b>. 877 You must omit this parameter in earlier versions, 878 and you may omit it in any version. If you require this 879 parameter, the manifest key 880 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 881 can ensure that your extension won't be run in an earlier browser version. 882 </dd> 883 884 <!-- OBJECT PROPERTIES --> 885 <dd style="display: none; "> 886 <dl> 887 <div> 888 <div> 889 </div> 890 </div> 891 </dl> 892 </dd> 893 894 <!-- FUNCTION PARAMETERS --> 895 <dd style="display: none; "> 896 <div></div> 897 </dd> 898 899 </div> 900 </div> 901 </dl> 902 </dd> 903 904 <!-- FUNCTION PARAMETERS --> 905 <dd style="display: none; "> 906 <div></div> 907 </dd> 908 909 </div> 910 </div> 911 </dl> 912 913 <!-- RETURNS --> 914 <h4 style="display: none; ">Returns</h4> 915 <dl> 916 <div style="display: none; "> 917 <div> 918 </div> 919 </div> 920 </dl> 921 922 <!-- CALLBACK --> 923 <div style="display: none; "> 924 <div> 925 <h4>Callback function</h4> 926 <p> 927 The callback <em>parameter</em> should specify a function 928 that looks like this: 929 </p> 930 <p> 931 If you specify the <em>callback</em> parameter, it should 932 specify a function that looks like this: 933 </p> 934 935 <!-- Note: intentionally longer 80 columns --> 936 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 937 <dl> 938 <div> 939 <div> 940 </div> 941 </div> 942 </dl> 943 </div> 944 </div> 945 946 <!-- MIN_VERSION --> 947 <p style="display: none; "> 948 This function was added in version <b><span></span></b>. 949 If you require this function, the manifest key 950 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 951 can ensure that your extension won't be run in an earlier browser version. 952 </p> 953 </div> <!-- /description --> 954 955 </div><div class="apiItem"> 956 <a name="method-setPopup"></a> <!-- method-anchor --> 957 <h4>setPopup</h4> 958 959 <div class="summary"><span style="display: none; ">void</span> 960 <!-- Note: intentionally longer 80 columns --> 961 <span>chrome.pageAction.setPopup</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 962 <var><span>details</span></var></span>)</div> 963 964 <div class="description"> 965 <p class="todo" style="display: none; ">Undocumented.</p> 966 <p>Sets the html document to be opened as a popup when the user clicks on the page action's icon.</p> 967 968 <!-- PARAMETERS --> 969 <h4>Parameters</h4> 970 <dl> 971 <div> 972 <div> 973 <dt> 974 <var>details</var> 975 <em> 976 977 <!-- TYPE --> 978 <div style="display:inline"> 979 ( 980 <span class="optional" style="display: none; ">optional</span> 981 <span class="enum" style="display: none; ">enumerated</span> 982 <span id="typeTemplate"> 983 <span style="display: none; "> 984 <a> Type</a> 985 </span> 986 <span> 987 <span style="display: none; "> 988 array of <span><span></span></span> 989 </span> 990 <span>object</span> 991 <span style="display: none; "></span> 992 </span> 993 </span> 994 ) 995 </div> 996 997 </em> 998 </dt> 999 <dd class="todo"> 1000 Undocumented. 1001 </dd> 1002 <dd style="display: none; "> 1003 Description of this parameter from the json schema. 1004 </dd> 1005 <dd style="display: none; "> 1006 This parameter was added in version 1007 <b><span></span></b>. 1008 You must omit this parameter in earlier versions, 1009 and you may omit it in any version. If you require this 1010 parameter, the manifest key 1011 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1012 can ensure that your extension won't be run in an earlier browser version. 1013 </dd> 1014 1015 <!-- OBJECT PROPERTIES --> 1016 <dd> 1017 <dl> 1018 <div> 1019 <div> 1020 <dt> 1021 <var>tabId</var> 1022 <em> 1023 1024 <!-- TYPE --> 1025 <div style="display:inline"> 1026 ( 1027 <span class="optional" style="display: none; ">optional</span> 1028 <span class="enum" style="display: none; ">enumerated</span> 1029 <span id="typeTemplate"> 1030 <span style="display: none; "> 1031 <a> Type</a> 1032 </span> 1033 <span> 1034 <span style="display: none; "> 1035 array of <span><span></span></span> 1036 </span> 1037 <span>integer</span> 1038 <span style="display: none; "></span> 1039 </span> 1040 </span> 1041 ) 1042 </div> 1043 1044 </em> 1045 </dt> 1046 <dd class="todo" style="display: none; "> 1047 Undocumented. 1048 </dd> 1049 <dd>The id of the tab for which you want to modify the page action.</dd> 1050 <dd style="display: none; "> 1051 This parameter was added in version 1052 <b><span></span></b>. 1053 You must omit this parameter in earlier versions, 1054 and you may omit it in any version. If you require this 1055 parameter, the manifest key 1056 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1057 can ensure that your extension won't be run in an earlier browser version. 1058 </dd> 1059 1060 <!-- OBJECT PROPERTIES --> 1061 <dd style="display: none; "> 1062 <dl> 1063 <div> 1064 <div> 1065 </div> 1066 </div> 1067 </dl> 1068 </dd> 1069 1070 <!-- FUNCTION PARAMETERS --> 1071 <dd style="display: none; "> 1072 <div></div> 1073 </dd> 1074 1075 </div> 1076 </div><div> 1077 <div> 1078 <dt> 1079 <var>popup</var> 1080 <em> 1081 1082 <!-- TYPE --> 1083 <div style="display:inline"> 1084 ( 1085 <span class="optional" style="display: none; ">optional</span> 1086 <span class="enum" style="display: none; ">enumerated</span> 1087 <span id="typeTemplate"> 1088 <span style="display: none; "> 1089 <a> Type</a> 1090 </span> 1091 <span> 1092 <span style="display: none; "> 1093 array of <span><span></span></span> 1094 </span> 1095 <span>string</span> 1096 <span style="display: none; "></span> 1097 </span> 1098 </span> 1099 ) 1100 </div> 1101 1102 </em> 1103 </dt> 1104 <dd class="todo" style="display: none; "> 1105 Undocumented. 1106 </dd> 1107 <dd>The html file to show in a popup. If set to the empty string (''), no popup is shown.</dd> 1108 <dd style="display: none; "> 1109 This parameter was added in version 1110 <b><span></span></b>. 1111 You must omit this parameter in earlier versions, 1112 and you may omit it in any version. If you require this 1113 parameter, the manifest key 1114 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1115 can ensure that your extension won't be run in an earlier browser version. 1116 </dd> 1117 1118 <!-- OBJECT PROPERTIES --> 1119 <dd style="display: none; "> 1120 <dl> 1121 <div> 1122 <div> 1123 </div> 1124 </div> 1125 </dl> 1126 </dd> 1127 1128 <!-- FUNCTION PARAMETERS --> 1129 <dd style="display: none; "> 1130 <div></div> 1131 </dd> 1132 1133 </div> 1134 </div> 1135 </dl> 1136 </dd> 1137 1138 <!-- FUNCTION PARAMETERS --> 1139 <dd style="display: none; "> 1140 <div></div> 1141 </dd> 1142 1143 </div> 1144 </div> 1145 </dl> 1146 1147 <!-- RETURNS --> 1148 <h4 style="display: none; ">Returns</h4> 1149 <dl> 1150 <div style="display: none; "> 1151 <div> 1152 </div> 1153 </div> 1154 </dl> 1155 1156 <!-- CALLBACK --> 1157 <div style="display: none; "> 1158 <div> 1159 <h4>Callback function</h4> 1160 <p> 1161 The callback <em>parameter</em> should specify a function 1162 that looks like this: 1163 </p> 1164 <p> 1165 If you specify the <em>callback</em> parameter, it should 1166 specify a function that looks like this: 1167 </p> 1168 1169 <!-- Note: intentionally longer 80 columns --> 1170 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1171 <dl> 1172 <div> 1173 <div> 1174 </div> 1175 </div> 1176 </dl> 1177 </div> 1178 </div> 1179 1180 <!-- MIN_VERSION --> 1181 <p> 1182 This function was added in version <b><span>5.0.308.0</span></b>. 1183 If you require this function, the manifest key 1184 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1185 can ensure that your extension won't be run in an earlier browser version. 1186 </p> 1187 </div> <!-- /description --> 1188 1189 </div><div class="apiItem"> 1190 <a name="method-setTitle"></a> <!-- method-anchor --> 1191 <h4>setTitle</h4> 1192 1193 <div class="summary"><span style="display: none; ">void</span> 1194 <!-- Note: intentionally longer 80 columns --> 1195 <span>chrome.pageAction.setTitle</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 1196 <var><span>details</span></var></span>)</div> 1197 1198 <div class="description"> 1199 <p class="todo" style="display: none; ">Undocumented.</p> 1200 <p>Sets the title of the page action. This is displayed in a tooltip over the page action.</p> 1201 1202 <!-- PARAMETERS --> 1203 <h4>Parameters</h4> 1204 <dl> 1205 <div> 1206 <div> 1207 <dt> 1208 <var>details</var> 1209 <em> 1210 1211 <!-- TYPE --> 1212 <div style="display:inline"> 1213 ( 1214 <span class="optional" style="display: none; ">optional</span> 1215 <span class="enum" style="display: none; ">enumerated</span> 1216 <span id="typeTemplate"> 1217 <span style="display: none; "> 1218 <a> Type</a> 1219 </span> 1220 <span> 1221 <span style="display: none; "> 1222 array of <span><span></span></span> 1223 </span> 1224 <span>object</span> 1225 <span style="display: none; "></span> 1226 </span> 1227 </span> 1228 ) 1229 </div> 1230 1231 </em> 1232 </dt> 1233 <dd class="todo"> 1234 Undocumented. 1235 </dd> 1236 <dd style="display: none; "> 1237 Description of this parameter from the json schema. 1238 </dd> 1239 <dd style="display: none; "> 1240 This parameter was added in version 1241 <b><span></span></b>. 1242 You must omit this parameter in earlier versions, 1243 and you may omit it in any version. If you require this 1244 parameter, the manifest key 1245 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1246 can ensure that your extension won't be run in an earlier browser version. 1247 </dd> 1248 1249 <!-- OBJECT PROPERTIES --> 1250 <dd> 1251 <dl> 1252 <div> 1253 <div> 1254 <dt> 1255 <var>tabId</var> 1256 <em> 1257 1258 <!-- TYPE --> 1259 <div style="display:inline"> 1260 ( 1261 <span class="optional" style="display: none; ">optional</span> 1262 <span class="enum" style="display: none; ">enumerated</span> 1263 <span id="typeTemplate"> 1264 <span style="display: none; "> 1265 <a> Type</a> 1266 </span> 1267 <span> 1268 <span style="display: none; "> 1269 array of <span><span></span></span> 1270 </span> 1271 <span>integer</span> 1272 <span style="display: none; "></span> 1273 </span> 1274 </span> 1275 ) 1276 </div> 1277 1278 </em> 1279 </dt> 1280 <dd class="todo" style="display: none; "> 1281 Undocumented. 1282 </dd> 1283 <dd>The id of the tab for which you want to modify the page action.</dd> 1284 <dd style="display: none; "> 1285 This parameter was added in version 1286 <b><span></span></b>. 1287 You must omit this parameter in earlier versions, 1288 and you may omit it in any version. If you require this 1289 parameter, the manifest key 1290 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1291 can ensure that your extension won't be run in an earlier browser version. 1292 </dd> 1293 1294 <!-- OBJECT PROPERTIES --> 1295 <dd style="display: none; "> 1296 <dl> 1297 <div> 1298 <div> 1299 </div> 1300 </div> 1301 </dl> 1302 </dd> 1303 1304 <!-- FUNCTION PARAMETERS --> 1305 <dd style="display: none; "> 1306 <div></div> 1307 </dd> 1308 1309 </div> 1310 </div><div> 1311 <div> 1312 <dt> 1313 <var>title</var> 1314 <em> 1315 1316 <!-- TYPE --> 1317 <div style="display:inline"> 1318 ( 1319 <span class="optional" style="display: none; ">optional</span> 1320 <span class="enum" style="display: none; ">enumerated</span> 1321 <span id="typeTemplate"> 1322 <span style="display: none; "> 1323 <a> Type</a> 1324 </span> 1325 <span> 1326 <span style="display: none; "> 1327 array of <span><span></span></span> 1328 </span> 1329 <span>string</span> 1330 <span style="display: none; "></span> 1331 </span> 1332 </span> 1333 ) 1334 </div> 1335 1336 </em> 1337 </dt> 1338 <dd class="todo" style="display: none; "> 1339 Undocumented. 1340 </dd> 1341 <dd>The tooltip string.</dd> 1342 <dd style="display: none; "> 1343 This parameter was added in version 1344 <b><span></span></b>. 1345 You must omit this parameter in earlier versions, 1346 and you may omit it in any version. If you require this 1347 parameter, the manifest key 1348 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1349 can ensure that your extension won't be run in an earlier browser version. 1350 </dd> 1351 1352 <!-- OBJECT PROPERTIES --> 1353 <dd style="display: none; "> 1354 <dl> 1355 <div> 1356 <div> 1357 </div> 1358 </div> 1359 </dl> 1360 </dd> 1361 1362 <!-- FUNCTION PARAMETERS --> 1363 <dd style="display: none; "> 1364 <div></div> 1365 </dd> 1366 1367 </div> 1368 </div> 1369 </dl> 1370 </dd> 1371 1372 <!-- FUNCTION PARAMETERS --> 1373 <dd style="display: none; "> 1374 <div></div> 1375 </dd> 1376 1377 </div> 1378 </div> 1379 </dl> 1380 1381 <!-- RETURNS --> 1382 <h4 style="display: none; ">Returns</h4> 1383 <dl> 1384 <div style="display: none; "> 1385 <div> 1386 </div> 1387 </div> 1388 </dl> 1389 1390 <!-- CALLBACK --> 1391 <div style="display: none; "> 1392 <div> 1393 <h4>Callback function</h4> 1394 <p> 1395 The callback <em>parameter</em> should specify a function 1396 that looks like this: 1397 </p> 1398 <p> 1399 If you specify the <em>callback</em> parameter, it should 1400 specify a function that looks like this: 1401 </p> 1402 1403 <!-- Note: intentionally longer 80 columns --> 1404 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1405 <dl> 1406 <div> 1407 <div> 1408 </div> 1409 </div> 1410 </dl> 1411 </div> 1412 </div> 1413 1414 <!-- MIN_VERSION --> 1415 <p style="display: none; "> 1416 This function was added in version <b><span></span></b>. 1417 If you require this function, the manifest key 1418 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1419 can ensure that your extension won't be run in an earlier browser version. 1420 </p> 1421 </div> <!-- /description --> 1422 1423 </div><div class="apiItem"> 1424 <a name="method-show"></a> <!-- method-anchor --> 1425 <h4>show</h4> 1426 1427 <div class="summary"><span style="display: none; ">void</span> 1428 <!-- Note: intentionally longer 80 columns --> 1429 <span>chrome.pageAction.show</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> 1430 <var><span>tabId</span></var></span>)</div> 1431 1432 <div class="description"> 1433 <p class="todo" style="display: none; ">Undocumented.</p> 1434 <p>Shows the page action. The page action is shown whenever the tab is selected.</p> 1435 1436 <!-- PARAMETERS --> 1437 <h4>Parameters</h4> 1438 <dl> 1439 <div> 1440 <div> 1441 <dt> 1442 <var>tabId</var> 1443 <em> 1444 1445 <!-- TYPE --> 1446 <div style="display:inline"> 1447 ( 1448 <span class="optional" style="display: none; ">optional</span> 1449 <span class="enum" style="display: none; ">enumerated</span> 1450 <span id="typeTemplate"> 1451 <span style="display: none; "> 1452 <a> Type</a> 1453 </span> 1454 <span> 1455 <span style="display: none; "> 1456 array of <span><span></span></span> 1457 </span> 1458 <span>integer</span> 1459 <span style="display: none; "></span> 1460 </span> 1461 </span> 1462 ) 1463 </div> 1464 1465 </em> 1466 </dt> 1467 <dd class="todo" style="display: none; "> 1468 Undocumented. 1469 </dd> 1470 <dd>The id of the tab for which you want to modify the page action.</dd> 1471 <dd style="display: none; "> 1472 This parameter was added in version 1473 <b><span></span></b>. 1474 You must omit this parameter in earlier versions, 1475 and you may omit it in any version. If you require this 1476 parameter, the manifest key 1477 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1478 can ensure that your extension won't be run in an earlier browser version. 1479 </dd> 1480 1481 <!-- OBJECT PROPERTIES --> 1482 <dd style="display: none; "> 1483 <dl> 1484 <div> 1485 <div> 1486 </div> 1487 </div> 1488 </dl> 1489 </dd> 1490 1491 <!-- FUNCTION PARAMETERS --> 1492 <dd style="display: none; "> 1493 <div></div> 1494 </dd> 1495 1496 </div> 1497 </div> 1498 </dl> 1499 1500 <!-- RETURNS --> 1501 <h4 style="display: none; ">Returns</h4> 1502 <dl> 1503 <div style="display: none; "> 1504 <div> 1505 </div> 1506 </div> 1507 </dl> 1508 1509 <!-- CALLBACK --> 1510 <div style="display: none; "> 1511 <div> 1512 <h4>Callback function</h4> 1513 <p> 1514 The callback <em>parameter</em> should specify a function 1515 that looks like this: 1516 </p> 1517 <p> 1518 If you specify the <em>callback</em> parameter, it should 1519 specify a function that looks like this: 1520 </p> 1521 1522 <!-- Note: intentionally longer 80 columns --> 1523 <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> 1524 <dl> 1525 <div> 1526 <div> 1527 </div> 1528 </div> 1529 </dl> 1530 </div> 1531 </div> 1532 1533 <!-- MIN_VERSION --> 1534 <p style="display: none; "> 1535 This function was added in version <b><span></span></b>. 1536 If you require this function, the manifest key 1537 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1538 can ensure that your extension won't be run in an earlier browser version. 1539 </p> 1540 </div> <!-- /description --> 1541 1542 </div> <!-- /apiItem --> 1543 1544 </div> <!-- /apiGroup --> 1545 1546 <!-- EVENTS --> 1547 <div class="apiGroup"> 1548 <a name="events"></a> 1549 <h3 id="events">Events</h3> 1550 1551 <!-- iterates over all events --> 1552 <div class="apiItem"> 1553 <a name="event-onClicked"></a> 1554 <h4>onClicked</h4> 1555 1556 <div class="summary"> 1557 <!-- Note: intentionally longer 80 columns --> 1558 <span class="subdued">chrome.pageAction.</span><span>onClicked</span><span class="subdued">.addListener</span>(function(<span>Tab tab</span>) <span class="subdued">{...}</span>); 1559 </div> 1560 1561 <div class="description"> 1562 <p class="todo" style="display: none; ">Undocumented.</p> 1563 <p>Fired when a page action icon is clicked. This event will not fire if the page action has a popup.</p> 1564 1565 <!-- PARAMETERS --> 1566 <h4>Parameters</h4> 1567 <dl> 1568 <div> 1569 <div> 1570 <dt> 1571 <var>tab</var> 1572 <em> 1573 1574 <!-- TYPE --> 1575 <div style="display:inline"> 1576 ( 1577 <span class="optional" style="display: none; ">optional</span> 1578 <span class="enum" style="display: none; ">enumerated</span> 1579 <span id="typeTemplate"> 1580 <span> 1581 <a href="tabs.html#type-Tab">Tab</a> 1582 </span> 1583 <span style="display: none; "> 1584 <span> 1585 array of <span><span></span></span> 1586 </span> 1587 <span>paramType</span> 1588 <span></span> 1589 </span> 1590 </span> 1591 ) 1592 </div> 1593 1594 </em> 1595 </dt> 1596 <dd class="todo"> 1597 Undocumented. 1598 </dd> 1599 <dd style="display: none; "> 1600 Description of this parameter from the json schema. 1601 </dd> 1602 <dd style="display: none; "> 1603 This parameter was added in version 1604 <b><span></span></b>. 1605 You must omit this parameter in earlier versions, 1606 and you may omit it in any version. If you require this 1607 parameter, the manifest key 1608 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1609 can ensure that your extension won't be run in an earlier browser version. 1610 </dd> 1611 1612 <!-- OBJECT PROPERTIES --> 1613 <dd style="display: none; "> 1614 <dl> 1615 <div> 1616 <div> 1617 </div> 1618 </div> 1619 </dl> 1620 </dd> 1621 1622 <!-- FUNCTION PARAMETERS --> 1623 <dd style="display: none; "> 1624 <div></div> 1625 </dd> 1626 1627 </div> 1628 </div> 1629 </dl> 1630 1631 </div> <!-- /decription --> 1632 1633 </div> <!-- /apiItem --> 1634 1635 </div> <!-- /apiGroup --> 1636 1637 <!-- TYPES --> 1638 <div class="apiGroup" style="display: none; "> 1639 <a name="types"></a> 1640 <h3 id="types">Types</h3> 1641 1642 <!-- iterates over all types --> 1643 <div class="apiItem"> 1644 <a></a> 1645 <h4>type name</h4> 1646 1647 <div> 1648 </div> 1649 1650 </div> <!-- /apiItem --> 1651 1652 </div> <!-- /apiGroup --> 1653 1654 </div> <!-- /apiPage --> 1655 </div> <!-- /gc-pagecontent --> 1656 </div> <!-- /g-section --> 1657 </div> <!-- /codesiteContent --> 1658 <div id="gc-footer" --=""> 1659 <div class="text"> 1660 <p> 1661 Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>, 1662 the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons 1663 Attribution 3.0 License</a>, and code samples are licensed under the 1664 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>. 1665 </p> 1666 <p> 1667 ©2010 Google 1668 </p> 1669 1670<!-- begin analytics --> 1671<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> 1672<script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script> 1673 1674<script type="text/javascript"> 1675 // chrome doc tracking 1676 try { 1677 var engdocs = _gat._getTracker("YT-10763712-2"); 1678 engdocs._trackPageview(); 1679 } catch(err) {} 1680 1681 // code.google.com site-wide tracking 1682 try { 1683 _uacct="UA-18071-1"; 1684 _uanchor=1; 1685 _uff=0; 1686 urchinTracker(); 1687 } 1688 catch(e) {/* urchinTracker not available. */} 1689</script> 1690<!-- end analytics --> 1691 </div> 1692 </div> <!-- /gc-footer --> 1693 </div> <!-- /gc-container --> 1694</body></html> 1695
