Home | History | Annotate | Download | only in docs
      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   <title>chrome.devtools - Google Chrome Extensions - Google Code</title></head><body>  <div id="gc-container" class="labs">
     19       <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
     20       <!-- In particular, sub-templates that recurse, must be used by allowing
     21            jstemplate to make a copy of the template in this section which
     22            are not operated on by way of the jsskip="true" -->
     23       <div style="display:none">
     24 
     25         <!-- VALUE -->
     26         <div id="valueTemplate">
     27           <dt>
     28             <var>paramName</var>
     29               <em>
     30 
     31                 <!-- TYPE -->
     32                 <div style="display:inline">
     33                   (
     34                     <span class="optional">optional</span>
     35                     <span id="typeTemplate">
     36                       <span>
     37                         <a> Type</a>
     38                       </span>
     39                       <span>
     40                         <span>
     41                           array of <span><span></span></span>
     42                         </span>
     43                         <span>paramType</span>
     44                       </span>
     45                     </span>
     46                   )
     47                 </div>
     48 
     49               </em>
     50           </dt>
     51           <dd class="todo">
     52             Undocumented.
     53           </dd>
     54           <dd>
     55             Description of this parameter from the json schema.
     56           </dd>
     57 
     58           <!-- OBJECT PROPERTIES -->
     59           <dd>
     60             <dl>
     61               <div>
     62                 <div>
     63                 </div>
     64               </div>
     65             </dl>
     66           </dd>
     67         </div> <!-- /VALUE -->
     68 
     69       </div> <!-- /SUBTEMPLATES -->
     70 
     71   <a id="top"></a>
     72     <div id="skipto">
     73       <a href="#gc-pagecontent">Skip to page content</a>
     74       <a href="#gc-toc">Skip to main navigation</a>
     75     </div>
     76     <!-- API HEADER -->
     77     <table id="header" width="100%" cellspacing="0" border="0">
     78       <tbody><tr>
     79         <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>
     80         <td valign="middle" width="100%" style="padding-left:0.6em;">
     81           <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em">
     82             <div id="gsc-search-box">
     83               <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno">
     84               <input type="hidden" name="ie" value="UTF-8">
     85               <input type="text" name="q" value="" size="55">
     86               <input class="gsc-search-button" type="submit" name="sa" value="Search">
     87               <br>
     88               <span class="greytext">e.g. "page action" or "tabs"</span>
     89             </div>
     90           </form>
     91 
     92           <script type="text/javascript" src="http://www.google.com/jsapi"></script>
     93           <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
     94           <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script>
     95           <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse&lang=en"></script>
     96         </td>
     97       </tr>
     98     </tbody></table>
     99 
    100     <div id="codesiteContent" class="">
    101 
    102       <a id="gc-topnav-anchor"></a>
    103       <div id="gc-topnav">
    104         <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1>
    105         <ul id="home" class="gc-topnav-tabs">
    106           <li id="home_link">
    107             <a href="index.html" title="Google Chrome Extensions home page">Home</a>
    108           </li>
    109           <li id="docs_link">
    110             <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a>
    111           </li>
    112           <li id="faq_link">
    113             <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a>
    114           </li>
    115           <li id="samples_link">
    116             <a href="samples.html" title="Sample extensions (with source code)">Samples</a>
    117           </li>
    118           <li id="group_link">
    119             <a href="http://groups.google.com/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a>
    120           </li>
    121         </ul>
    122       </div> <!-- end gc-topnav -->
    123 
    124     <div class="g-section g-tpl-170">
    125       <!-- SIDENAV -->
    126       <div class="g-unit g-first" id="gc-toc">
    127         <ul>
    128           <li><a href="getstarted.html">Getting Started</a></li>
    129           <li><a href="overview.html">Overview</a></li>
    130           <li><h2><a href="devguide.html">Developer's Guide</a></h2>
    131             <ul>
    132               <li>Browser UI
    133                 <ul>
    134                   <li><a href="browserAction.html">Browser Actions</a></li>
    135                   <li><a href="options.html">Options Pages</a></li>
    136                   <li><a href="override.html">Override Pages</a></li>
    137                   <li><a href="pageAction.html">Page Actions</a></li>
    138                   <li><a href="themes.html">Themes</a></li>
    139                 </ul>
    140               </li>
    141               <li>Browser Interaction
    142                 <ul>
    143                   <li><a href="bookmarks.html">Bookmarks</a></li>
    144                   <li><a href="events.html">Events</a></li>
    145                   <li><a href="tabs.html">Tabs</a></li>
    146                   <li><a href="windows.html">Windows</a></li>
    147                 </ul>
    148               </li>
    149               <li>Implementation
    150                 <ul>
    151                   <li><a href="background_pages.html">Background Pages</a></li>
    152                   <li><a href="content_scripts.html">Content Scripts</a></li>
    153                   <li><a href="xhr.html">Cross-Origin XHR</a></li>
    154                   <li><a href="i18n.html">Internationalization</a></li>
    155                   <li><a href="messaging.html">Message Passing</a></li>
    156                   <li><a href="npapi.html">NPAPI Plugins</a></li>
    157                 </ul>
    158               </li>
    159               <li>Finishing
    160                 <ul>
    161                   <li><a href="autoupdate.html">Autoupdating</a></li>
    162                   <li><a href="packaging.html">Packaging</a></li>
    163                  <li><a href="external_extensions.html">External Extensions</a></li>
    164                 </ul>
    165               </li>
    166             </ul>
    167           </li>
    168           <li><h2><a href="tutorials.html">Tutorials</a></h2>
    169             <ul>
    170               <li><a href="tut_debugging.html">Debugging</a></li>
    171             </ul>
    172           </li>
    173           <li><h2>Reference</h2>
    174             <ul>
    175               <li>Formats
    176                 <ul>
    177                   <li><a href="manifest.html">Manifest Files</a></li>
    178                   <li><a href="match_patterns.html">Match Patterns</a></li>
    179                   <!-- <li>Packages (.crx)</li> -->
    180                 </ul>
    181               </li>
    182               <li><a href="api_index.html">chrome.* APIs</a></li>
    183               <li><a href="api_other.html">Other APIs</a></li>
    184             </ul>
    185           </li>
    186          <li><h2><a href="samples.html">Samples</a></h2></li>
    187         </ul>
    188       </div>
    189 
    190     <div class="g-unit" id="gc-pagecontent">
    191       <div id="pageTitle">
    192         <h1 class="page_title">chrome.devtools</h1>
    193       </div>
    194         <!-- TABLE OF CONTENTS -->
    195         <div id="toc">
    196           <h2>Contents</h2>
    197           <ol>
    198             <li style="display: none; ">
    199               <a>h2Name</a>
    200               <ol>
    201                 <li>
    202                   <a>h3Name</a>
    203                 </li>
    204               </ol>
    205             </li>
    206               <li>
    207                 <a href="#apiReference">API reference: chrome.devtools</a>
    208                 <ol>
    209                   <li style="display: none; ">
    210                     <a href="#properties">Properties</a>
    211                     <ol>
    212                       <li>
    213                         <a href="#property-anchor">propertyName</a>
    214                       </li>
    215                     </ol>
    216                   </li>
    217                   <li>
    218                     <a href="#methods">Methods</a>
    219                     <ol>
    220                       <li style="display: none; ">
    221                         <a href="#method-anchor">methodName</a>
    222                       </li>
    223                     </ol>
    224                   </li>
    225                   <li style="display: none; ">
    226                     <a href="#events">Events</a>
    227                     <ol>
    228                       <li>
    229                         <a href="#event-anchor">eventName</a>
    230                       </li>
    231                     </ol>
    232                   </li>
    233                   <li style="display: none; ">
    234                     <a href="#types">Types</a>
    235                     <ol>
    236                       <li>
    237                         <a href="#id-anchor">id</a>
    238                       </li>
    239                     </ol>
    240                   </li>
    241                 </ol>
    242               </li>
    243           </ol>
    244         </div>
    245         <!-- /TABLE OF CONTENTS -->
    246 
    247         <!-- STATIC CONTENT PLACEHOLDER -->
    248         <div id="static"></div>
    249 
    250         <!-- API PAGE -->
    251         <div class="apiPage">
    252         <a name="apiReference"></a>
    253         <h2>API reference: chrome.devtools</h2>
    254 
    255           <!-- PROPERTIES -->
    256           <div class="apiGroup" style="display: none; ">
    257             <a name="properties"></a>
    258             <h3 id="properties">Properties</h3>
    259 
    260             <div>
    261               <a></a>
    262               <h4>getLastError</h4>
    263               <div class="summary">
    264                 <!-- Note: intentionally longer 80 columns -->
    265                 <span>chrome.extension</span><span>lastError</span>
    266               </div>
    267               <div>
    268               </div>
    269             </div>
    270 
    271           </div> <!-- /apiGroup -->
    272 
    273           <!-- METHODS -->
    274           <div class="apiGroup" id="methods">
    275             <a name="methods"></a>
    276             <h3>Methods</h3>
    277 
    278             <!-- iterates over all functions -->
    279             <div class="apiItem" style="display: none; ">
    280               <a></a> <!-- method-anchor -->
    281               <h4>method name</h4>
    282 
    283               <div class="summary"><span>void</span>
    284                   <!-- Note: intentionally longer 80 columns -->
    285                   <span>chrome.module.methodName</span>(<span><span>, </span><span></span>
    286                       <var><span></span></var></span>)</div>
    287 
    288               <div class="description">
    289                 <p class="todo">Undocumented.</p>
    290                 <p>
    291                   A description from the json schema def of the function goes here.
    292                 </p>
    293 
    294                 <!-- PARAMETERS -->
    295                 <h4>Parameters</h4>
    296                 <dl>
    297                   <div>
    298                     <div>
    299                     </div>
    300                   </div>
    301                 </dl>
    302 
    303                 <!-- RETURNS -->
    304                 <h4>Returns</h4>
    305                 <dl>
    306                   <div>
    307                     <div>
    308                     </div>
    309                   </div>
    310                 </dl>
    311 
    312                 <!-- CALLBACK -->
    313                 <div>
    314                   <div>
    315                   <h4>Callback function</h4>
    316                   <p>
    317                     The callback <em>parameter</em> should specify a function
    318                     that looks like this:
    319                   </p>
    320                   <p>
    321                     If you specify the <em>callback</em> parameter, it should
    322                     specify a function that looks like this:
    323                   </p>
    324 
    325                   <!-- Note: intentionally longer 80 columns -->
    326                   <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>);</pre>
    327                   <dl>
    328                     <div>
    329                       <div>
    330                       </div>
    331                     </div>
    332                   </dl>
    333                   </div>
    334                 </div>
    335 
    336               </div> <!-- /description -->
    337 
    338             </div>  <!-- /apiItem -->
    339 
    340           </div>  <!-- /apiGroup -->
    341 
    342           <!-- EVENTS -->
    343           <div class="apiGroup" style="display: none; ">
    344             <a name="events"></a>
    345             <h3 id="events">Events</h3>
    346 
    347             <!-- iterates over all events -->
    348             <div class="apiItem">
    349               <a></a>
    350               <h4>event name</h4>
    351 
    352               <div class="summary">
    353                 <!-- Note: intentionally longer 80 columns -->
    354                 <span class="subdued">chrome.bookmarks</span><span>onEvent</span><span class="subdued">.addListener</span>(function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>);
    355               </div>
    356 
    357               <div class="description">
    358                 <p class="todo">Undocumented.</p>
    359                 <p>
    360                   A description from the json schema def of the event goes here.
    361                 </p>
    362 
    363                 <!-- PARAMETERS -->
    364                 <h4>Parameters</h4>
    365                 <dl>
    366                   <div>
    367                     <div>
    368                     </div>
    369                   </div>
    370                 </dl>
    371 
    372               </div> <!-- /decription -->
    373 
    374             </div> <!-- /apiItem -->
    375 
    376           </div> <!-- /apiGroup -->
    377 
    378           <!-- TYPES -->
    379           <div class="apiGroup" style="display: none; ">
    380             <a name="types.sort(sortByName)"></a>
    381             <h3 id="types">Types</h3>
    382 
    383             <!-- iterates over all types -->
    384             <div class="apiItem">
    385               <a></a>
    386               <h4>type name</h4>
    387 
    388               <div>
    389               </div>
    390 
    391             </div> <!-- /apiItem -->
    392 
    393           </div> <!-- /apiGroup -->
    394 
    395         </div> <!-- /apiPage -->
    396       </div> <!-- /gc-pagecontent -->
    397     </div> <!-- /g-section -->
    398   </div> <!-- /codesiteContent -->
    399     <div id="gc-footer" --="">
    400       <div class="text">
    401   <p>
    402   Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,
    403   the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons
    404   Attribution 3.0 License</a>, and code samples are licensed under the
    405   <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.
    406   </p>
    407   <p>
    408   2009 Google
    409   </p>
    410 
    411 <!-- begin analytics -->
    412 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script>
    413 <script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script>
    414 
    415 <script type="text/javascript">
    416   // chrome doc tracking
    417   try {
    418     var engdocs = _gat._getTracker("YT-10763712-2");
    419     engdocs._trackPageview();
    420   } catch(err) {}
    421 
    422   // code.google.com site-wide tracking
    423   try {
    424     _uacct="UA-18071-1";
    425     _uanchor=1;
    426     _uff=0;
    427     urchinTracker();
    428   }
    429   catch(e) {/* urchinTracker not available. */}
    430 </script>
    431 <!-- end analytics -->
    432       </div>
    433     </div> <!-- /gc-footer -->
    434   </div> <!-- /gc-container -->
    435 </body></html>
    436