Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(258)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/toolstrip.html

Issue 165323: Add chrome.extension to extension_api.json and docs (Closed)
Patch Set: precommit Created 11 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « chrome/common/extensions/docs/template/api_template.html ('k') | chrome/common/extensions/docs/windows.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating mecha nism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is gener eated as an rendering step. If viewed in a browser, it will be re-generated from the template, json schema and authored overview content. 4) The <body>.innerHTM L is also generated by an offline step so that this page may easily be indexed b y search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes t he single version of page template shell and the "instance" pages (bookmarks.htm l, etc...) can be generated with a build step. --><!-- <html> must retain id="te mplate --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> da ta is significant and loads the needed libraries and styles --><head jstcache="0 "> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache=" 0"> <title jscontent="pageTitle" jstcache="1">chrome.toolstrip API Reference</ti tle> <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache ="0"> <script type="text/javascript" src="../../../third_party/jstemplate/jstemp late_compiled.js" jstcache="0"> </script> <script type="text/javascript" src="js /api_page_generator.js" jstcache="0"></script> <script type="text/javascript" sr c="js/bootstrap.js" jstcache="0"></script> </head><!-- <body> content is complet ely generated. Do not edit, as it will be and rewritten. --><body jstcache="0"> <div id="container" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEAD ER --> <div id="pageHeader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix the se hrefs --> <div id="breadcrumbs" jstcache="0"> <a href="index.html" jstcache=" 0">Google Chrome Extensions</a> &gt; <a href="reference_index.html" jstcache="0" >Reference</a> &gt; <a href="api_index.html" jstcache="0">chrome.* APIs</a> &gt; <span jscontent="h1Header" jstcache="2">chrome.toolstrip</span> </div> <div id= "searchbox" jstcache="0"> <form action="http://www.google.com/cse" id="cse-searc h-box" jstcache="0"> <div jstcache="0"> <input type="hidden" name="cx" value="00 2967670403910741006:61_cvzfqtno" jstcache="0"> <input type="hidden" name="ie" va lue="UTF-8" jstcache="0"> <input type="text" name="q" size="31" jstcache="0"> <i nput type="submit" name="sa" value="Search" jstcache="0"> </div> </form> <script type="text/javascript" src="http://www.google.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstcache="0">google.load("elements", "1", {packa ges: "transliteration"});</script> <script type="text/javascript" src="http://ww w.google.com/coop/cse/t13n?form=cse-search-box&amp;t13n_langs=en" jstcache="0">< /script> <script type="text/javascript" src="http://www.google.com/coop/cse/bran d?form=cse-search-box&amp;lang=en" jstcache="0"></script> </div> <div id="pageTi tle" jstcache="0"> <h1 jscontent="h1Header" jstcache="2">chrome.toolstrip</h1> < /div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDEN AV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a hr ef="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted .html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.htm l" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> < li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a> </li><li jstca che="0"><a href="toolstrip.html" jstcache="0">Toolstrips</a> </li><li jstcache=" 0"><a href="pageActions.html" jstcache="0">Page actions</a> </li><li jstcache="0 "><a href="background_pages.html" jstcache="0">Background pages</a> </li><li jst cache="0"><a href="content_scripts.html" jstcache="0">Content scripts</a> </li>< li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a> </li><li jstcache="0"> <a href="windows.html" jstcache="0">Windows</a> </li><li jstcache="0"><a href="s elf.html" jstcache="0">Self</a> </li><li jstcache="0"><a href="npapi.html" jstca che="0">NPAPI Plugins</a> </li><li jstcache="0"><a href="packaging.html" jstcach e="0">Packaging</a> </li><li jstcache="0"><a href="autoupdate.html" jstcache="0" >Autoupdate</a> </li></ul> </li><li jstcache="0">Samples <ul jstcache="0"> <li j stcache="0">[sample 1] </li><li jstcache="0">[sample 2] </li></ul> </li></ul> </ div> <div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jsselect="apiDefinition" jstcache="3"> <p jstcache="0">Contents</p> <ol jstcach e="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol js tcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Propert ies</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples </a></li> </ol> </li> <li jstcache="0"> <a href="#methods" jstcache="0">Methods< /a> <ol jstcache="0"> <li jsselect="functions" jstcache="4" jsinstance="0"> <a j scontent="name" jsvalues=".href:'#method-' + name" href="#method-expand" jstcach e="17">expand</a> </li><li jsselect="functions" jstcache="4" jsinstance="*1"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-collapse" jst cache="17">collapse</a> </li> </ol> </li> <li jstcache="0"> <a href="#events" js tcache="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="5" jsins tance="*0" style="display: none; "> <a jscontent="name" jsvalues=".href:'#event- ' + name" href="#event-anchor" jstcache="18">eventName</a> </li> </ol> </li> <!- - TODO: What do we do about structs/types? --> <li jstcache="0"> <a href="#struc ts" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><a href="# struct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PENDING: link s to all h2s and h3s should go here -- would it be possible to link to overview h3s, as well? if so, how should we create their anchor/id values?] </div> <!-- / TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstca che="0"><!-- BEGIN AUTHORED CONTENT --> <p jstcache="0">Toolstrips allow you to add UI to Chrome's toolbar area. Toolstrips are nothing more than (very small) H TML pages, so anything you can do with HTML/CSS/JavaScript, you can do with tool strips.</p><p jstcache="0"> </p><h3 jstcache="0">Status</h3> <p jstcache="0">Imp lementation in progress.</p> <h3 jstcache="0">Details</h3> <p jstcache="0">Regis ter your toolstrips in the extension manifest, like this:</p> <pre jstcache="0"> { "name": "My First Extension", "version": "1.0", "description": "The first exte nsion that I made.", "toolstrips": [ "one_toolstrip.html", "two_toolstrip.html" ] }</pre> <p jstcache="0">You can create buttons that look like the bookmark bar buttons using this template:</p> <pre jstcache="0">&lt;div class="toolstrip-but ton"&gt; &lt;!-- Image is optional and should be a 16x16 icon. --&gt; &lt;img sr c="path/to/some_icon.png"&gt; &lt;span&gt;My Button&lt;/span&gt; &lt;/div&gt;</p re> <h3 jstcache="0">Debugging Tips</h3> <ul jstcache="0"> <li jstcache="0">You can right click on a toolstrip to get a web inspector.</li> <li jstcache="0">ale rt(), prompt(), and confirm() don't work yet. Sorry about that.</li> <li jstcach e="0">You can run toolstrips in the main content area by loading their URL, whic h would be something like chrome-extension://00000000000000000000000000000000000 00000/my_toolstrip.html</li> </ul> <h3 jstcache="0">Design Tips</h3> <ul jstcach e="0"> <li jstcache="0">Try not to use too much space. Toolbar real estate is pr ecious and users tend to prefer extensions to use as little of it as possible.</ li> <li jstcache="0">The toolbar automatically detects how much space a toolstri p needs and reflows. So you can resize your toolstrip dynamically if you need a little more room temporarily.</li> <li jstcache="0">If you need to do more exten sive UI, use the tab contents area or a pop up window.</li> <li jstcache="0">Rem ember that there can be multiple instances of a given toolstrip page running at one time. Each browser window has its own toolstrip. If you need long-running ap plication logic, try Background Pages.</li> </ul> <!-- END AUTHORED CONTENT --> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache= "3"> <!-- METHODS --> <div class="apiGroup" id="methods" jstcache="0"> <a name=" #methods" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="4" jsinstance ="0"> <a jsvalues=".name:'method-' + name" jstcache="6" name="method-expand"></a > <!-- method-anchor --> <h3 jscontent="name" jstcache="7">expand</h3> <div clas s="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="9" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="10">chrome.toolstrip.expand </span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="11" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="19" style="display: none; ">, </span><span jscontent="typeName" jstcache="20">integ er</span> <var jstcache="0"><span jscontent="name" jstcache="7">height</span></v ar></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : '' " jstcache="11" jsinstance="1" class="optional"><span jsdisplay="$index" jstcach e="19">, </span><span jscontent="typeName" jstcache="20">string</span> <var jstc ache="0"><span jscontent="name" jstcache="7">url</span></var></span><span jssele ct="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="11" jsinst ance="*2" class="optional"><span jsdisplay="$index" jstcache="19">, </span><span jscontent="typeName" jstcache="20">function</span> <var jstcache="0"><span jsco ntent="name" jstcache="7">callback</span></var></span>)</div> <div class="descri ption" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="12">Undo cumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstca che="13" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <d l jstcache="0"> <div jsselect="parameters" jstcache="21" jsinstance="0"> <dt jst cache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">height</var><em jstcache="0"> (<span class="optional" jsdisplay="op tional" jstcache="28" style="display: none; ">optional </span><span jscontent="t ypeName" jstcache="20">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$ this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.descri ption" jsvalues=".innerHTML:$this.description" jstcache="24" style="display: non e; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROP ERTIES --> <dd jsdisplay="_propertyList" jstcache="25" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache=" 7">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28">optional </span><span jscontent="typeName" jstcache="20">paramTyp e</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="2 3"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$ this.description" jstcache="24"> Description of this parameter from the json sch ema. </dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="21" jsi nstance="1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <v ar jscontent="name" jstcache="7">url</var><em jstcache="0"> (<span class="option al" jsdisplay="optional" jstcache="28">optional </span><span jscontent="typeName " jstcache="20">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.des cription" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" j svalues=".innerHTML:$this.description" jstcache="24" style="display: none; "> De scription of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES - -> <dd jsdisplay="_propertyList" jstcache="25" style="display: none; "> <dl jstc ache="0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- No te: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">param Name</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcach e="28">optional </span><span jscontent="typeName" jstcache="20">paramType</span> )</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undo cumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.des cription" jstcache="24"> Description of this parameter from the json schema. </d d> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="21" jsinstance= "*2"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jsco ntent="name" jstcache="7">callback</var><em jstcache="0"> (<span class="optional " jsdisplay="optional" jstcache="28">optional </span><span jscontent="typeName" jstcache="20">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.des cription" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" j svalues=".innerHTML:$this.description" jstcache="24" style="display: none; "> De scription of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES - -> <dd jsdisplay="_propertyList" jstcache="25" style="display: none; "> <dl jstc ache="0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- No te: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">param Name</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcach e="28">optional </span><span jscontent="typeName" jstcache="20">paramType</span> )</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undo cumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.des cription" jstcache="24"> Description of this parameter from the json schema. </d d> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstc ache="14" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect=" returns" jstcache="22" style="display: none; "> <dt jstcache="0"> <!-- Note: int entionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName</v ar> <em jstcache="0">(<span jscontent="typeName" jstcache="20">paramType</span>) </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undoc umented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.desc ription" jstcache="24"> Description of this parameter from the json schema. </dd > <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="25"> <dl js tcache="0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">par amName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstca che="28">optional </span><span jscontent="typeName" jstcache="20">paramType</spa n>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> Un documented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.d escription" jstcache="24"> Description of this parameter from the json schema. < /dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbac kParameters" jstcache="15"> <h4 jstcache="0">Callback function</h4> <p jstcache= "0"> If you specify the <em jstcache="0">callback</em> parameter, it should spec ify a function that looks like this: </p> <!-- Note: intentionally longer 80 col umns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache ="26"></span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstca che="0"> <div jsselect="callbackParameters" jstcache="27" jsinstance="*0" style= "display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName</var><em jstcache="0"> (<span j scontent="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay= "$this.description" jsvalues=".innerHTML:$this.description" jstcache="24"> Descr iption of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="25"> <dl jstcache="0"> <div jsselect="_p ropertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28">optional </span><spa n jscontent="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="tod o" jsdisplay="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdispl ay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="24"> De scription of this parameter from the json schema. </dd> </div> </dl> </dd> </div > </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect= "functions" jstcache="4" jsinstance="*1"> <a jsvalues=".name:'method-' + name" j stcache="6" name="method-collapse"></a> <!-- method-anchor --> <h3 jscontent="na me" jstcache="7">collapse</h3> <div class="summary" jstcache="0"><span jsdisplay ="returns" jscontent="returns.typeName" jstcache="9" style="display: none; ">voi d</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullNam e" jstcache="10">chrome.toolstrip.collapse</span>(<span jsselect="parameters" js values="class:optional ? 'optional' : ''" jstcache="11" jsinstance="0" class="op tional"><span jsdisplay="$index" jstcache="19" style="display: none; ">, </span> <span jscontent="typeName" jstcache="20">string</span> <var jstcache="0"><span j scontent="name" jstcache="7">url</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="11" jsinstance="*1" class= "optional"><span jsdisplay="$index" jstcache="19">, </span><span jscontent="type Name" jstcache="20">function</span> <var jstcache="0"><span jscontent="name" jst cache="7">callback</span></var></span>)</div> <div class="description" jstcache= "0"> <p class="todo" jsdisplay="!description" jstcache="12">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="13" style=" display: none; "> A description from the json schema def of the function goes he re. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="21" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">url </var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="2 8">optional </span><span jscontent="typeName" jstcache="20">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undocumente d. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.descriptio n" jstcache="24" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jst cache="25" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyLi st" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName</var><em jstcache="0"> (<span c lass="optional" jsdisplay="optional" jstcache="28">optional </span><span jsconte nt="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisp lay="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this .description" jsvalues=".innerHTML:$this.description" jstcache="24"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jss elect="parameters" jstcache="21" jsinstance="*1"> <dt jstcache="0"> <!-- Note: i ntentionally longer 80 columns --> <var jscontent="name" jstcache="7">callback</ var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28" >optional </span><span jscontent="typeName" jstcache="20">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undocumente d. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.descriptio n" jstcache="24" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jst cache="25" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyLi st" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName</var><em jstcache="0"> (<span c lass="optional" jsdisplay="optional" jstcache="28">optional </span><span jsconte nt="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisp lay="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this .description" jsvalues=".innerHTML:$this.description" jstcache="24"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> < !-- RETURNS --> <h4 jsdisplay="returns" jstcache="14" style="display: none; ">Re turns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="22" style="displa y: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <va r jscontent="name" jstcache="7">paramName</var> <em jstcache="0">(<span jsconten t="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdispl ay="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this. description" jsvalues=".innerHTML:$this.description" jstcache="24"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsd isplay="_propertyList" jstcache="25"> <dl jstcache="0"> <div jsselect="_property List" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 column s --> <var jscontent="name" jstcache="7">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28">optional </span><span jscon tent="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdi splay="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$th is.description" jsvalues=".innerHTML:$this.description" jstcache="24"> Descripti on of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="15"> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstc ache="0">callback</em> parameter, it should specify a function that looks like t his: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">funct ion(<span jscontent="callbackSignature" jstcache="26"></span>) <span class="subd ued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callback Parameters" jstcache="27" jsinstance="*0" style="display: none; "> <dt jstcache= "0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcac he="7">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="20 ">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" j stcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".i nnerHTML:$this.description" jstcache="24"> Description of this parameter from th e json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" js tcache="25"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="nam e" jstcache="7">paramName</var><em jstcache="0"> (<span class="optional" jsdispl ay="optional" jstcache="28">optional </span><span jscontent="typeName" jstcache= "20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description " jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues= ".innerHTML:$this.description" jstcache="24"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /desc ription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> < div class="apiGroup" id="events" jstcache="0"> <a name="#events" jstcache="0"></ a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <d iv jsselect="events" class="apiItem" jstcache="5" jsinstance="*0" style="display : none; "> <a jsvalues=".name:'event-' + name" jstcache="8"></a> <h3 jscontent=" name" jstcache="7">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.b ookmarks.</span><span jscontent="name" jstcache="7">onEvent</span><span class="s ubdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature " jstcache="16">Type param1, Type param2</span>) <span class="subdued" jstcache= "0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="12">Undocumented.</p> <p jsdisplay="descript ion" jsvalues=".innerHTML:description" jstcache="13"> A description from the jso n schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">P arameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="21"> <dt j stcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name " jstcache="7">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstc ache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.descri ption" jstcache="23">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalu es=".innerHTML:$this.description" jstcache="24"> Description of this parameter f rom the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyLi st" jstcache="25"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="29" > <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jsconten t="name" jstcache="7">paramName</var><em jstcache="0"> (<span class="optional" j sdisplay="optional" jstcache="28">optional </span><span jscontent="typeName" jst cache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.descr iption" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsv alues=".innerHTML:$this.description" jstcache="24"> Description of this paramete r from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decri ption --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPag e --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFoot er" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /c ontainer --> </body></html> 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 1) The <head> information in this page is significant, should be uniform across api docs and should be edited only with knowledge of the templating mecha nism. 2) The <body> tag *must* retain id="body" 3) All <body>.innerHTML is gener eated as an rendering step. If viewed in a browser, it will be re-generated from the template, json schema and authored overview content. 4) The <body>.innerHTM L is also generated by an offline step so that this page may easily be indexed b y search engines. TODO(rafaelw): Abstract this into a "pageshell" that becomes t he single version of page template shell and the "instance" pages (bookmarks.htm l, etc...) can be generated with a build step. --><!-- <html> must retain id="te mplate --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> da ta is significant and loads the needed libraries and styles --><head jstcache="0 "> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache=" 0"> <title jscontent="pageTitle" jstcache="1">chrome.toolstrip API Reference</ti tle> <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache ="0"> <script type="text/javascript" src="../../../third_party/jstemplate/jstemp late_compiled.js" jstcache="0"> </script> <script type="text/javascript" src="js /api_page_generator.js" jstcache="0"></script> <script type="text/javascript" sr c="js/bootstrap.js" jstcache="0"></script> </head><!-- <body> content is complet ely generated. Do not edit, as it will be and rewritten. --><body jstcache="0"> <div id="container" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEAD ER --> <div id="pageHeader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix the se hrefs --> <div id="breadcrumbs" jstcache="0"> <a href="index.html" jstcache=" 0">Google Chrome Extensions</a> &gt; <a href="reference_index.html" jstcache="0" >Reference</a> &gt; <a href="api_index.html" jstcache="0">chrome.* APIs</a> &gt; <span jscontent="h1Header" jstcache="2">chrome.toolstrip</span> </div> <div id= "searchbox" jstcache="0"> <form action="http://www.google.com/cse" id="cse-searc h-box" jstcache="0"> <div jstcache="0"> <input type="hidden" name="cx" value="00 2967670403910741006:61_cvzfqtno" jstcache="0"> <input type="hidden" name="ie" va lue="UTF-8" jstcache="0"> <input type="text" name="q" size="31" jstcache="0"> <i nput type="submit" name="sa" value="Search" jstcache="0"> </div> </form> <script type="text/javascript" src="http://www.google.com/jsapi" jstcache="0"></script> <script type="text/javascript" jstcache="0">google.load("elements", "1", {packa ges: "transliteration"});</script> <script type="text/javascript" src="http://ww w.google.com/coop/cse/t13n?form=cse-search-box&amp;t13n_langs=en" jstcache="0">< /script> <script type="text/javascript" src="http://www.google.com/coop/cse/bran d?form=cse-search-box&amp;lang=en" jstcache="0"></script> </div> <div id="pageTi tle" jstcache="0"> <h1 jscontent="h1Header" jstcache="2">chrome.toolstrip</h1> < /div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDEN AV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a hr ef="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted .html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overview.htm l" jstcache="0">Overview</a></li> <li jstcache="0">Reference <ul jstcache="0"> < li jstcache="0"><a href="manifest.html" jstcache="0">Manifest</a> </li><li jstca che="0"><a href="toolstrip.html" jstcache="0">Toolstrips</a> </li><li jstcache=" 0"><a href="pageActions.html" jstcache="0">Page actions</a> </li><li jstcache="0 "><a href="background_pages.html" jstcache="0">Background pages</a> </li><li jst cache="0"><a href="content_scripts.html" jstcache="0">Content scripts</a> </li>< li jstcache="0"><a href="extension.html" jstcache="0">Extension</a> </li><li jst cache="0"><a href="tabs.html" jstcache="0">Tabs</a> </li><li jstcache="0"><a hre f="windows.html" jstcache="0">Windows</a> </li><li jstcache="0"><a href="self.ht ml" jstcache="0">Self</a> </li><li jstcache="0"><a href="npapi.html" jstcache="0 ">NPAPI Plugins</a> </li><li jstcache="0"><a href="packaging.html" jstcache="0"> Packaging</a> </li><li jstcache="0"><a href="autoupdate.html" jstcache="0">Autou pdate</a> </li></ul> </li><li jstcache="0">Samples <ul jstcache="0"> <li jstcach e="0">[sample 1] </li><li jstcache="0">[sample 2] </li></ul> </li></ul> </div> < div id="mainColumn" jstcache="0"> <!-- TABLE OF CONTENTS --> <div id="toc" jssel ect="apiDefinition" jstcache="3"> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache ="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">Properties</a ></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Examples</a></ li> </ol> </li> <li jstcache="0"> <a href="#methods" jstcache="0">Methods</a> <o l jstcache="0"> <li jsselect="functions" jstcache="4" jsinstance="0"> <a jsconte nt="name" jsvalues=".href:'#method-' + name" href="#method-expand" jstcache="17" >expand</a> </li><li jsselect="functions" jstcache="4" jsinstance="*1"> <a jscon tent="name" jsvalues=".href:'#method-' + name" href="#method-collapse" jstcache= "17">collapse</a> </li> </ol> </li> <li jstcache="0"> <a href="#events" jstcache ="0">Events</a> <ol jstcache="0"> <li jsselect="events" jstcache="5" jsinstance= "*0" style="display: none; "> <a jscontent="name" jsvalues=".href:'#event-' + na me" href="#event-anchor" jstcache="18">eventName</a> </li> </ol> </li> <!-- TODO : What do we do about structs/types? --> <li jstcache="0"> <a href="#structs" js tcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><a href="#struct -BookmarkTreeNode" jstcache="0"></a></li> </ol> </li> </ol> [PENDING: links to a ll h2s and h3s should go here -- would it be possible to link to overview h3s, a s well? if so, how should we create their anchor/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0 "><!-- BEGIN AUTHORED CONTENT --> <p jstcache="0">Toolstrips allow you to add UI to Chrome's toolbar area. Toolstrips are nothing more than (very small) HTML pa ges, so anything you can do with HTML/CSS/JavaScript, you can do with toolstrips .</p><p jstcache="0"> </p><h3 jstcache="0">Status</h3> <p jstcache="0">Implement ation in progress.</p> <h3 jstcache="0">Details</h3> <p jstcache="0">Register yo ur toolstrips in the extension manifest, like this:</p> <pre jstcache="0">{ "nam e": "My First Extension", "version": "1.0", "description": "The first extension that I made.", "toolstrips": [ "one_toolstrip.html", "two_toolstrip.html" ] }</p re> <p jstcache="0">You can create buttons that look like the bookmark bar butto ns using this template:</p> <pre jstcache="0">&lt;div class="toolstrip-button"&g t; &lt;!-- Image is optional and should be a 16x16 icon. --&gt; &lt;img src="pat h/to/some_icon.png"&gt; &lt;span&gt;My Button&lt;/span&gt; &lt;/div&gt;</pre> <h 3 jstcache="0">Debugging Tips</h3> <ul jstcache="0"> <li jstcache="0">You can ri ght click on a toolstrip to get a web inspector.</li> <li jstcache="0">alert(), prompt(), and confirm() don't work yet. Sorry about that.</li> <li jstcache="0"> You can run toolstrips in the main content area by loading their URL, which woul d be something like chrome-extension://0000000000000000000000000000000000000000/ my_toolstrip.html</li> </ul> <h3 jstcache="0">Design Tips</h3> <ul jstcache="0"> <li jstcache="0">Try not to use too much space. Toolbar real estate is precious and users tend to prefer extensions to use as little of it as possible.</li> <l i jstcache="0">The toolbar automatically detects how much space a toolstrip need s and reflows. So you can resize your toolstrip dynamically if you need a little more room temporarily.</li> <li jstcache="0">If you need to do more extensive U I, use the tab contents area or a pop up window.</li> <li jstcache="0">Remember that there can be multiple instances of a given toolstrip page running at one ti me. Each browser window has its own toolstrip. If you need long-running applicat ion logic, try Background Pages.</li> </ul> <!-- END AUTHORED CONTENT --> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3"> < !-- METHODS --> <div class="apiGroup" id="methods" jstcache="0"> <a name="#metho ds" jstcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all funct ions --> <div class="apiItem" jsselect="functions" jstcache="4" jsinstance="0"> <a jsvalues=".name:'method-' + name" jstcache="6" name="method-expand"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="7">expand</h3> <div class="sum mary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcac he="9" style="display: none; ">void</span> <!-- Note: intentionally longer 80 co lumns --> <span jscontent="fullName" jstcache="10">chrome.toolstrip.expand</span >(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcac he="11" jsinstance="0" class="null"><span jsdisplay="$index" jstcache="19" style ="display: none; ">, </span><span jscontent="typeName" jstcache="20">integer</sp an> <var jstcache="0"><span jscontent="name" jstcache="7">height</span></var></s pan><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstc ache="11" jsinstance="1" class="optional"><span jsdisplay="$index" jstcache="19" >, </span><span jscontent="typeName" jstcache="20">string</span> <var jstcache=" 0"><span jscontent="name" jstcache="7">url</span></var></span><span jsselect="pa rameters" jsvalues="class:optional ? 'optional' : ''" jstcache="11" jsinstance=" *2" class="optional"><span jsdisplay="$index" jstcache="19">, </span><span jscon tent="typeName" jstcache="20">function</span> <var jstcache="0"><span jscontent= "name" jstcache="7">callback</span></var></span>)</div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="12">Undocument ed.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="1 3" style="display: none; "> A description from the json schema def of the functi on goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstc ache="0"> <div jsselect="parameters" jstcache="21" jsinstance="0"> <dt jstcache= "0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcac he="7">height</var><em jstcache="0"> (<span class="optional" jsdisplay="optional " jstcache="28" style="display: none; ">optional </span><span jscontent="typeNam e" jstcache="20">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.d escription" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="24" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="25" style="display: none; "> <dl js tcache="0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">par amName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstca che="28">optional </span><span jscontent="typeName" jstcache="20">paramType</spa n>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> Un documented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.d escription" jstcache="24"> Description of this parameter from the json schema. < /dd> </div> </dl> </dd> </div><div jsselect="parameters" jstcache="21" jsinstanc e="1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jsc ontent="name" jstcache="7">url</var><em jstcache="0"> (<span class="optional" js display="optional" jstcache="28">optional </span><span jscontent="typeName" jstc ache="20">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.descripti on" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalue s=".innerHTML:$this.description" jstcache="24" style="display: none; "> Descript ion of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="25" style="display: none; "> <dl jstcache=" 0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: in tentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName</ var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28" >optional </span><span jscontent="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undocument ed. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.descripti on" jstcache="24"> Description of this parameter from the json schema. </dd> </d iv> </dl> </dd> </div><div jsselect="parameters" jstcache="21" jsinstance="*2"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent= "name" jstcache="7">callback</var><em jstcache="0"> (<span class="optional" jsdi splay="optional" jstcache="28">optional </span><span jscontent="typeName" jstcac he="20">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.descripti on" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalue s=".innerHTML:$this.description" jstcache="24" style="display: none; "> Descript ion of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="25" style="display: none; "> <dl jstcache=" 0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: in tentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName</ var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28" >optional </span><span jscontent="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undocument ed. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.descripti on" jstcache="24"> Description of this parameter from the json schema. </dd> </d iv> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache=" 14" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="return s" jstcache="22" style="display: none; "> <dt jstcache="0"> <!-- Note: intention ally longer 80 columns --> <var jscontent="name" jstcache="7">paramName</var> <e m jstcache="0">(<span jscontent="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undocumente d. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.descriptio n" jstcache="24"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="25"> <dl jstcache ="0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName </var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="2 8">optional </span><span jscontent="typeName" jstcache="20">paramType</span>)</e m> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undocume nted. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.descrip tion" jstcache="24"> Description of this parameter from the json schema. </dd> < /div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbac kParameters" jstcache="15"> <h4 jstcache="0">Callback function</h4> <p jstcache= "0"> If you specify the <em jstcache="0">callback</em> parameter, it should spec ify a function that looks like this: </p> <!-- Note: intentionally longer 80 col umns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache ="26"></span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstca che="0"> <div jsselect="callbackParameters" jstcache="27" jsinstance="*0" style= "display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName</var><em jstcache="0"> (<span j scontent="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay= "$this.description" jsvalues=".innerHTML:$this.description" jstcache="24"> Descr iption of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="25"> <dl jstcache="0"> <div jsselect="_p ropertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28">optional </span><spa n jscontent="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="tod o" jsdisplay="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdispl ay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="24"> De scription of this parameter from the json schema. </dd> </div> </dl> </dd> </div > </dl> </div> </div> <!-- /description --> </div><div class="apiItem" jsselect= "functions" jstcache="4" jsinstance="*1"> <a jsvalues=".name:'method-' + name" j stcache="6" name="method-collapse"></a> <!-- method-anchor --> <h3 jscontent="na me" jstcache="7">collapse</h3> <div class="summary" jstcache="0"><span jsdisplay ="returns" jscontent="returns.typeName" jstcache="9" style="display: none; ">voi d</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullNam e" jstcache="10">chrome.toolstrip.collapse</span>(<span jsselect="parameters" js values="class:optional ? 'optional' : ''" jstcache="11" jsinstance="0" class="op tional"><span jsdisplay="$index" jstcache="19" style="display: none; ">, </span> <span jscontent="typeName" jstcache="20">string</span> <var jstcache="0"><span j scontent="name" jstcache="7">url</span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''" jstcache="11" jsinstance="*1" class= "optional"><span jsdisplay="$index" jstcache="19">, </span><span jscontent="type Name" jstcache="20">function</span> <var jstcache="0"><span jscontent="name" jst cache="7">callback</span></var></span>)</div> <div class="description" jstcache= "0"> <p class="todo" jsdisplay="!description" jstcache="12">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="13" style=" display: none; "> A description from the json schema def of the function goes he re. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="21" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">url </var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="2 8">optional </span><span jscontent="typeName" jstcache="20">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undocumente d. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.descriptio n" jstcache="24" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jst cache="25" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyLi st" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName</var><em jstcache="0"> (<span c lass="optional" jsdisplay="optional" jstcache="28">optional </span><span jsconte nt="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisp lay="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this .description" jsvalues=".innerHTML:$this.description" jstcache="24"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div><div jss elect="parameters" jstcache="21" jsinstance="*1"> <dt jstcache="0"> <!-- Note: i ntentionally longer 80 columns --> <var jscontent="name" jstcache="7">callback</ var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28" >optional </span><span jscontent="typeName" jstcache="20">function</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undocumente d. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.descriptio n" jstcache="24" style="display: none; "> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jst cache="25" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyLi st" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName</var><em jstcache="0"> (<span c lass="optional" jsdisplay="optional" jstcache="28">optional </span><span jsconte nt="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisp lay="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this .description" jsvalues=".innerHTML:$this.description" jstcache="24"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> < !-- RETURNS --> <h4 jsdisplay="returns" jstcache="14" style="display: none; ">Re turns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="22" style="displa y: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <va r jscontent="name" jstcache="7">paramName</var> <em jstcache="0">(<span jsconten t="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdispl ay="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this. description" jsvalues=".innerHTML:$this.description" jstcache="24"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsd isplay="_propertyList" jstcache="25"> <dl jstcache="0"> <div jsselect="_property List" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 column s --> <var jscontent="name" jstcache="7">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28">optional </span><span jscon tent="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdi splay="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$th is.description" jsvalues=".innerHTML:$this.description" jstcache="24"> Descripti on of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="15"> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstc ache="0">callback</em> parameter, it should specify a function that looks like t his: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">funct ion(<span jscontent="callbackSignature" jstcache="26"></span>) <span class="subd ued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div jsselect="callback Parameters" jstcache="27" jsinstance="*0" style="display: none; "> <dt jstcache= "0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcac he="7">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstcache="20 ">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" j stcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".i nnerHTML:$this.description" jstcache="24"> Description of this parameter from th e json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" js tcache="25"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="nam e" jstcache="7">paramName</var><em jstcache="0"> (<span class="optional" jsdispl ay="optional" jstcache="28">optional </span><span jscontent="typeName" jstcache= "20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description " jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues= ".innerHTML:$this.description" jstcache="24"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /desc ription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> < div class="apiGroup" id="events" jstcache="0"> <a name="#events" jstcache="0"></ a> <h2 id="events" jstcache="0">Events</h2> <!-- iterates over all events --> <d iv jsselect="events" class="apiItem" jstcache="5" jsinstance="*0" style="display : none; "> <a jsvalues=".name:'event-' + name" jstcache="8"></a> <h3 jscontent=" name" jstcache="7">event name</h3> <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span class="subdued" jstcache="0">chrome.b ookmarks.</span><span jscontent="name" jstcache="7">onEvent</span><span class="s ubdued" jstcache="0">.addListener</span>(function(<span jscontent="callSignature " jstcache="16">Type param1, Type param2</span>) <span class="subdued" jstcache= "0">{...}</span>); </div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache="12">Undocumented.</p> <p jsdisplay="descript ion" jsvalues=".innerHTML:description" jstcache="13"> A description from the jso n schema def of the event goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">P arameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="21"> <dt j stcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name " jstcache="7">paramName</var><em jstcache="0"> (<span jscontent="typeName" jstc ache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.descri ption" jstcache="23">Undocumented.</dd> <dd jsdisplay="$this.description" jsvalu es=".innerHTML:$this.description" jstcache="24"> Description of this parameter f rom the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyLi st" jstcache="25"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="29" > <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jsconten t="name" jstcache="7">paramName</var><em jstcache="0"> (<span class="optional" j sdisplay="optional" jstcache="28">optional </span><span jscontent="typeName" jst cache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.descr iption" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsv alues=".innerHTML:$this.description" jstcache="24"> Description of this paramete r from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> <!-- /decri ption --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPag e --> </div> <!-- /mainColumn --> </div> <!-- /pageContent --> <div id="pageFoot er" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /c ontainer --> </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/template/api_template.html ('k') | chrome/common/extensions/docs/windows.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698