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