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

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/pageActions.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/packaging.html ('k') | chrome/common/extensions/docs/self.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.pageActions API Reference</ title> <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcac he="0"> <script type="text/javascript" src="../../../third_party/jstemplate/jste mplate_compiled.js" jstcache="0"> </script> <script type="text/javascript" src=" js/api_page_generator.js" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script> </head><!-- <body> content is compl etely 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 HE ADER --> <div id="pageHeader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix t hese 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> &g t; <span jscontent="h1Header" jstcache="2">chrome.pageActions</span> </div> <div id="searchbox" jstcache="0"> <form action="http://www.google.com/cse" id="cse-s earch-box" jstcache="0"> <div jstcache="0"> <input type="hidden" name="cx" value ="002967670403910741006:61_cvzfqtno" jstcache="0"> <input type="hidden" name="ie " value="UTF-8" jstcache="0"> <input type="text" name="q" size="31" jstcache="0" > <input type="submit" name="sa" value="Search" jstcache="0"> </div> </form> <sc ript type="text/javascript" src="http://www.google.com/jsapi" jstcache="0"></scr ipt> <script type="text/javascript" jstcache="0">google.load("elements", "1", {p ackages: "transliteration"});</script> <script type="text/javascript" src="http: //www.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/ brand?form=cse-search-box&amp;lang=en" jstcache="0"></script> </div> <div id="pa geTitle" jstcache="0"> <h1 jscontent="h1Header" jstcache="2">chrome.pageActions< /h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="gets tarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overvi ew.html" 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 jstcache="0"><a href="toolstrip.html" jstcache="0">Toolstrips</a> </li><li jstc ache="0"><a href="pageActions.html" jstcache="0">Page actions</a> </li><li jstca che="0"><a href="background_pages.html" jstcache="0">Background pages</a> </li>< li jstcache="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 jstcach e="0"><a href="windows.html" jstcache="0">Windows</a> </li><li jstcache="0"><a h ref="self.html" 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" j stcache="0">Packaging</a> </li><li jstcache="0"><a href="autoupdate.html" jstcac he="0">Autoupdate</a> </li></ul> </li><li jstcache="0">Samples <ul jstcache="0"> <li jstcache="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 j stcache="0"> <li jstcache="0"> <a href="#overview" jstcache="0">Description</a> <ol jstcache="0"> <li jstcache="0"><a href="#overview-properties" jstcache="0">P roperties</a></li> <li jstcache="0"><a href="#overview-examples" jstcache="0">Ex amples</a></li> </ol> </li> <li jstcache="0"> <a href="#methods" jstcache="0">Me thods</a> <ol jstcache="0"> <li jsselect="functions" jstcache="4" jsinstance="0" > <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-enableFor Tab" jstcache="17">enableForTab</a> </li><li jsselect="functions" jstcache="4" j sinstance="*1"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#me thod-disableForTab" jstcache="17">disableForTab</a> </li> </ol> </li> <li jstcac he="0"> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect ="events" jstcache="5" jsinstance="*0" style="display: none; "> <a jscontent="na me" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="18">eventNa me</a> </li> </ol> </li> <!-- TODO: What do we do about structs/types? --> <li j stcache="0"> <a href="#structs" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li jstcache="0"><a href="#struct-BookmarkTreeNode" jstcache="0"></a></li> </ol > </li> </ol> [PENDING: links to all h2s and h3s should go here -- would it be p ossible to link to overview h3s, as well? if so, how should we create their anch or/id values?] </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDE R --> <div id="static" jstcache="0"><!-- BEGIN AUTHORED CONTENT --> <p jstcache= "0">Page actions are a simple way to represent actions that can be taken on a pa ge ("Email this page", "Share with Facebook", etc).</p> <h3 jstcache="0">Status< /h3> <p jstcache="0">First version implemented.</p> <h3 jstcache="0">User interf ace</h3> <p jstcache="0">Page actions are displayed in the right side of the Omn ibox. New actions get added to the left of the star:</p> <img src="images/pageac tion-omnibar-icons.png" jstcache="0"> <p jstcache="0">A maximum of 8 (?) actions can appear at the top level, any additional ones overflow into a drop-down menu :</p> <h3 jstcache="0">Manifest</h3> <p jstcache="0">Developers can include page actions in the manifest using the following syntax:</p> <pre jstcache="0">"page _actions": [ { "id": "myaction", // chosen by developer, and should be unique wi thin their extension "name": "Do action", "icons": ["favicon.png", "favicon2.png "] } ]</pre> <p jstcache="0">Supported icon image formats include for example pn g, bmp, ico, jpg, gif. If an image larger than 16x16 is specified, it will be re sized to fit.</p> <p jstcache="0"></p> <!-- END AUTHORED CONTENT --> </div> <!-- API PAGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3"> <!-- M ETHODS --> <div class="apiGroup" id="methods" jstcache="0"> <a name="#methods" j stcache="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <div class="apiItem" jsselect="functions" jstcache="4" jsinstance="0"> <a js values=".name:'method-' + name" jstcache="6" name="method-enableForTab"></a> <!- - method-anchor --> <h3 jscontent="name" jstcache="7">enableForTab</h3> <div cla ss="summary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstcache="9" style="display: none; ">void</span> <!-- Note: intentionally longe r 80 columns --> <span jscontent="fullName" jstcache="10">chrome.pageActions.ena bleForTab</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optiona l' : ''" jstcache="11" jsinstance="0" class="null"><span jsdisplay="$index" jstc ache="19" style="display: none; ">, </span><span jscontent="typeName" jstcache=" 20">string</span> <var jstcache="0"><span jscontent="name" jstcache="7">pageActi onId</span></var></span><span jsselect="parameters" jsvalues="class:optional ? ' optional' : ''" jstcache="11" jsinstance="*1" class=""><span jsdisplay="$index" jstcache="19">, </span><span jscontent="typeName" jstcache="20">object</span> <v ar jstcache="0"><span jscontent="name" jstcache="7">action</span></var></span>)< /div> <div class="description" jstcache="0"> <p class="todo" jsdisplay="!descrip tion" jstcache="12">Undocumented.</p> <p jsdisplay="description" jsvalues=".inne rHTML:description" jstcache="13" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcach e="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">pageActionId</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28" style="display: none; ">opti onal </span><span jscontent="typeName" jstcache="20">string</span>)</em> </dt> < dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undocumented. </dd > <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstc ache="24" style="display: none; "> Description of this parameter from the json s chema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache=" 25" style="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jst cache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <va r jscontent="name" jstcache="7">paramName</var><em jstcache="0"> (<span class="o ptional" jsdisplay="optional" jstcache="28">optional </span><span jscontent="typ eName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$ this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.descri ption" jsvalues=".innerHTML:$this.description" jstcache="24"> Description of thi s parameter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect=" parameters" jstcache="21" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentio nally longer 80 columns --> <var jscontent="name" jstcache="7">action</var><em j stcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28" style="d isplay: none; ">optional </span><span jscontent="typeName" jstcache="20">object< /span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23" > Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th is.description" jstcache="24" style="display: none; "> Description of this param eter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_prop ertyList" jstcache="25"> <dl jstcache="0"> <div jsselect="_propertyList" jstcach e="29" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 colu mns --> <var jscontent="name" jstcache="7">tabId</var><em jstcache="0"> (<span c lass="optional" jsdisplay="optional" jstcache="28" style="display: none; ">optio nal </span><span jscontent="typeName" jstcache="20">integer</span>)</em> </dt> < dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undocumented. </dd > <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstc ache="24" style="display: none; "> Description of this parameter from the json s chema. </dd> </div><div jsselect="_propertyList" jstcache="29" jsinstance="1"> < dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent=" name" jstcache="7">url</var><em jstcache="0"> (<span class="optional" jsdisplay= "optional" jstcache="28" style="display: none; ">optional </span><span jscontent ="typeName" jstcache="20">string</span>)</em> </dt> <dd class="todo" jsdisplay=" !$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.desc ription" jsvalues=".innerHTML:$this.description" jstcache="24" style="display: n one; "> Description of this parameter from the json schema. </dd> </div><div jss elect="_propertyList" jstcache="29" jsinstance="2"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">title</v ar><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28"> optional </span><span jscontent="typeName" jstcache="20">string</span>)</em> </d t> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="24" style="display: none; "> Description of this parameter from the js on schema. </dd> </div><div jsselect="_propertyList" jstcache="29" jsinstance="* 3"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscont ent="name" jstcache="7">iconId</var><em jstcache="0"> (<span class="optional" js display="optional" jstcache="28">optional </span><span jscontent="typeName" jstc ache="20">integer</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.descript ion" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalu es=".innerHTML:$this.description" jstcache="24" style="display: none; "> Descrip tion of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </d l> <!-- RETURNS --> <h4 jsdisplay="returns" jstcache="14" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="22" style="di splay: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName</var> <em jstcache="0">(<span jsco ntent="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsd isplay="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$t his.description" jsvalues=".innerHTML:$this.description" jstcache="24"> Descript ion of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="25"> <dl jstcache="0"> <div jsselect="_prop ertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 co lumns --> <var jscontent="name" jstcache="7">paramName</var><em jstcache="0"> (< span class="optional" jsdisplay="optional" jstcache="28">optional </span><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> </div> </dl> </dd> </div> < /dl> <!-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="15" style ="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a fu nction that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="26">Ty pe param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="27"> <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" jsva lues=".innerHTML:$this.description" jstcache="24"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_property List" jstcache="25"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="2 9"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscont ent="name" jstcache="7">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28">optional </span><span jscontent="typeName" j stcache="20">paramType</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"> Description of this parame ter 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" jstcache="6" name="method -disableForTab"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="7">di sableForTab</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jsc ontent="returns.typeName" jstcache="9" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="1 0">chrome.pageActions.disableForTab</span>(<span jsselect="parameters" jsvalues= "class:optional ? 'optional' : ''" jstcache="11" jsinstance="0" class="null"><sp an jsdisplay="$index" jstcache="19" style="display: none; ">, </span><span jscon tent="typeName" jstcache="20">string</span> <var jstcache="0"><span jscontent="n ame" jstcache="7">pageActionId</span></var></span><span jsselect="parameters" js values="class:optional ? 'optional' : ''" jstcache="11" jsinstance="*1" class="" ><span jsdisplay="$index" jstcache="19">, </span><span jscontent="typeName" jstc ache="20">object</span> <var jstcache="0"><span jscontent="name" jstcache="7">ac tion</span></var></span>)</div> <div class="description" jstcache="0"> <p class= "todo" jsdisplay="!description" jstcache="12">Undocumented.</p> <p jsdisplay="de scription" jsvalues=".innerHTML:description" jstcache="13" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect= "parameters" jstcache="21" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentio nally longer 80 columns --> <var jscontent="name" jstcache="7">pageActionId</var ><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28" st yle="display: none; ">optional </span><span jscontent="typeName" jstcache="20">s tring</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcach e="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHT ML:$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 jstcache="0"> <div js select="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName</var><em jst cache="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"> Undocumented. </dd> < dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcach e="24"> Description of this parameter from the json schema. </dd> </div> </dl> < /dd> </div><div jsselect="parameters" jstcache="21" jsinstance="*1"> <dt jstcach e="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstc ache="7">action</var><em jstcache="0"> (<span class="optional" jsdisplay="option al" jstcache="28" style="display: none; ">optional </span><span jscontent="typeN ame" jstcache="20">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this. description" 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 PROPERTIE S --> <dd jsdisplay="_propertyList" jstcache="25"> <dl jstcache="0"> <div jssele ct="_propertyList" jstcache="29" jsinstance="0"> <dt jstcache="0"> <!-- Note: in tentionally longer 80 columns --> <var jscontent="name" jstcache="7">tabId</var> <em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28" sty le="display: none; ">optional </span><span jscontent="typeName" jstcache="20">in teger</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcach e="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHT ML:$this.description" jstcache="24" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstca che="29" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 c olumns --> <var jscontent="name" jstcache="7">url</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28" style="display: none; ">opti onal </span><span jscontent="typeName" jstcache="20">string</span>)</em> </dt> < dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undocumented. </dd > <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstc ache="24" style="display: none; "> Description of this parameter from the json s chema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="ret urns" jstcache="14" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="22" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">pa ramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="20">paramTy pe</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 sc hema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="2 5"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache= "0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcac he="7">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optio nal" jstcache="28">optional </span><span jscontent="typeName" jstcache="20">para mType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcach e="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHT ML:$this.description" jstcache="24"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div js display="callbackParameters" jstcache="15" style="display: none; "> <h4 jstcache ="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0" >callback</em> parameter, it should specify a function that looks like this: </p > <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<spa n jscontent="callbackSignature" jstcache="26">Type param1, Type param2</span>) < span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div js select="callbackParameters" jstcache="27"> <dt jstcache="0"> <!-- Note: intentio nally 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"> Undocument ed. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.descripti on" jstcache="24"> Description of this parameter from the json schema. </dd> <!- - OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="25"> <dl jstcach e="0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramNam e</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"> Undocum ented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.descri ption" jstcache="24"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div class="apiGroup" id= "events" jstcache="0"> <a name="#events" jstcache="0"></a> <h2 id="events" jstca che="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" cla ss="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.bookmarks.</span><span js content="name" jstcache="7">onEvent</span><span class="subdued" jstcache="0">.ad dListener</span>(function(<span jscontent="callSignature" jstcache="16">Type par am1, 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="description" jsvalues=".innerHTM L:description" jstcache="13"> A description from the json schema def of the even t goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstca che="0"> <div jsselect="parameters" jstcache="21"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName </var><em jstcache="0"> (<span jscontent="typeName" jstcache="20">paramType</spa n>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23">Und ocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.des cription" jstcache="24"> Description of this parameter from the json schema. </d d> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="25"> <dl j stcache="0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">pa ramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstc ache="28">optional </span><span jscontent="typeName" jstcache="20">paramType</sp an>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> U ndocumented. </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> <!-- /decription --> </div> <!-- /a piItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainC olumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></ht ml> 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.pageActions API Reference</ title> <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcac he="0"> <script type="text/javascript" src="../../../third_party/jstemplate/jste mplate_compiled.js" jstcache="0"> </script> <script type="text/javascript" src=" js/api_page_generator.js" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script> </head><!-- <body> content is compl etely 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 HE ADER --> <div id="pageHeader" jstcache="0"> <!-- BREADCRUMB --> <!-- TODO: Fix t hese 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> &g t; <span jscontent="h1Header" jstcache="2">chrome.pageActions</span> </div> <div id="searchbox" jstcache="0"> <form action="http://www.google.com/cse" id="cse-s earch-box" jstcache="0"> <div jstcache="0"> <input type="hidden" name="cx" value ="002967670403910741006:61_cvzfqtno" jstcache="0"> <input type="hidden" name="ie " value="UTF-8" jstcache="0"> <input type="text" name="q" size="31" jstcache="0" > <input type="submit" name="sa" value="Search" jstcache="0"> </div> </form> <sc ript type="text/javascript" src="http://www.google.com/jsapi" jstcache="0"></scr ipt> <script type="text/javascript" jstcache="0">google.load("elements", "1", {p ackages: "transliteration"});</script> <script type="text/javascript" src="http: //www.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/ brand?form=cse-search-box&amp;lang=en" jstcache="0"></script> </div> <div id="pa geTitle" jstcache="0"> <h1 jscontent="h1Header" jstcache="2">chrome.pageActions< /h1> </div> </div> <!-- /pageHeader --> <div id="pageContent" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstcache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="gets tarted.html" jstcache="0">Get Started</a></li> <li jstcache="0"> <a href="overvi ew.html" 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 jstcache="0"><a href="toolstrip.html" jstcache="0">Toolstrips</a> </li><li jstc ache="0"><a href="pageActions.html" jstcache="0">Page actions</a> </li><li jstca che="0"><a href="background_pages.html" jstcache="0">Background pages</a> </li>< li jstcache="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 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-enableForTab" j stcache="17">enableForTab</a> </li><li jsselect="functions" jstcache="4" jsinsta nce="*1"> <a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-d isableForTab" jstcache="17">disableForTab</a> </li> </ol> </li> <li jstcache="0" > <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="even ts" jstcache="5" jsinstance="*0" style="display: none; "> <a jscontent="name" js values=".href:'#event-' + name" href="#event-anchor" jstcache="18">eventName</a> </li> </ol> </li> <!-- TODO: What do we do about structs/types? --> <li jstcach e="0"> <a href="#structs" jstcache="0">TODO: Structs</a> <ol jstcache="0"> <li j stcache="0"><a href="#struct-BookmarkTreeNode" jstcache="0"></a></li> </ol> </li > </ol> [PENDING: links to all h2s and h3s should go here -- would it be possibl e 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" jstcache="0"><!-- BEGIN AUTHORED CONTENT --> <p jstcache="0">Pa ge actions are a simple way to represent actions that can be taken on a page ("E mail this page", "Share with Facebook", etc).</p> <h3 jstcache="0">Status</h3> < p jstcache="0">First version implemented.</p> <h3 jstcache="0">User interface</h 3> <p jstcache="0">Page actions are displayed in the right side of the Omnibox. New actions get added to the left of the star:</p> <img src="images/pageaction-o mnibar-icons.png" jstcache="0"> <p jstcache="0">A maximum of 8 (?) actions can a ppear at the top level, any additional ones overflow into a drop-down menu:</p> <h3 jstcache="0">Manifest</h3> <p jstcache="0">Developers can include page actio ns in the manifest using the following syntax:</p> <pre jstcache="0">"page_actio ns": [ { "id": "myaction", // chosen by developer, and should be unique within t heir extension "name": "Do action", "icons": ["favicon.png", "favicon2.png"] } ] </pre> <p jstcache="0">Supported icon image formats include for example png, bmp , ico, jpg, gif. If an image larger than 16x16 is specified, it will be resized to fit.</p> <p jstcache="0"></p> <!-- END AUTHORED CONTENT --> </div> <!-- API P AGE --> <div class="apiPage" jsselect="apiDefinition" jstcache="3"> <!-- METHODS --> <div class="apiGroup" id="methods" jstcache="0"> <a name="#methods" jstcach e="0"></a> <h2 jstcache="0">Methods</h2> <!-- iterates over all functions --> <d iv class="apiItem" jsselect="functions" jstcache="4" jsinstance="0"> <a jsvalues =".name:'method-' + name" jstcache="6" name="method-enableForTab"></a> <!-- meth od-anchor --> <h3 jscontent="name" jstcache="7">enableForTab</h3> <div class="su mmary" jstcache="0"><span jsdisplay="returns" jscontent="returns.typeName" jstca che="9" style="display: none; ">void</span> <!-- Note: intentionally longer 80 c olumns --> <span jscontent="fullName" jstcache="10">chrome.pageActions.enableFor Tab</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">st ring</span> <var jstcache="0"><span jscontent="name" jstcache="7">pageActionId</ span></var></span><span jsselect="parameters" jsvalues="class:optional ? 'option al' : ''" jstcache="11" jsinstance="*1" class=""><span jsdisplay="$index" jstcac he="19">, </span><span jscontent="typeName" jstcache="20">object</span> <var jst cache="0"><span jscontent="name" jstcache="7">action</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 here. </p> <!-- PARAMETERS --> <h4 jstcache="0"> Parameters</h4> <dl jstcache="0"> <div jsselect="parameters" jstcache="21" jsins tance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">pageActionId</var><em jstcache="0"> (<span class= "optional" jsdisplay="optional" jstcache="28" style="display: none; ">optional < /span><span jscontent="typeName" jstcache="20">string</span>)</em> </dt> <dd cla ss="todo" jsdisplay="!$this.description" 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" st yle="display: none; "> <dl jstcache="0"> <div jsselect="_propertyList" jstcache= "29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jsco ntent="name" jstcache="7">paramName</var><em jstcache="0"> (<span class="optiona l" jsdisplay="optional" jstcache="28">optional </span><span jscontent="typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.d escription" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="24"> Description of this para meter from the json schema. </dd> </div> </dl> </dd> </div><div jsselect="parame ters" jstcache="21" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">action</var><em jstcach e="0"> (<span class="optional" jsdisplay="optional" jstcache="28" style="display : none; ">optional </span><span jscontent="typeName" jstcache="20">object</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" style="display: none; "> 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" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns -- > <var jscontent="name" jstcache="7">tabId</var><em jstcache="0"> (<span class=" optional" jsdisplay="optional" jstcache="28" style="display: none; ">optional </ span><span jscontent="typeName" jstcache="20">integer</span>)</em> </dt> <dd cla ss="todo" jsdisplay="!$this.description" 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> </div><div jsselect="_propertyList" jstcache="29" jsinstance="1"> <dt jst cache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">url</var><em jstcache="0"> (<span class="optional" jsdisplay="optio nal" jstcache="28" style="display: none; ">optional </span><span jscontent="type Name" jstcache="20">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this .description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.descriptio n" jsvalues=".innerHTML:$this.description" jstcache="24" style="display: none; " > Description of this parameter from the json schema. </dd> </div><div jsselect= "_propertyList" jstcache="29" jsinstance="2"> <dt jstcache="0"> <!-- Note: inten tionally longer 80 columns --> <var jscontent="name" jstcache="7">title</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28">option al </span><span jscontent="typeName" jstcache="20">string</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcac he="24" style="display: none; "> Description of this parameter from the json sch ema. </dd> </div><div jsselect="_propertyList" jstcache="29" jsinstance="*3"> <d t jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="n ame" jstcache="7">iconId</var><em jstcache="0"> (<span class="optional" jsdispla y="optional" jstcache="28">optional </span><span jscontent="typeName" jstcache=" 20">integer</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" style="display: none; "> Description o f this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!- - RETURNS --> <h4 jsdisplay="returns" jstcache="14" style="display: none; ">Retu rns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="22" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName</var> <em jstcache="0">(<span jscontent= "typeName" jstcache="20">paramType</span>)</em> </dt> <dd class="todo" jsdisplay ="!$this.description" jstcache="23"> Undocumented. </dd> <dd jsdisplay="$this.de scription" jsvalues=".innerHTML:$this.description" jstcache="24"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdis play="_propertyList" jstcache="25"> <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> < !-- CALLBACK --> <div jsdisplay="callbackParameters" jstcache="15" style ="display: none; "> <h4 jstcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0">callback</em> parameter, it should specify a fu nction that looks like this: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<span jscontent="callbackSignature" jstcache="26">Ty pe param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>); </pre> <dl jstcache="0"> <div jsselect="callbackParameters" jstcache="27"> <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" jsva lues=".innerHTML:$this.description" jstcache="24"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_property List" jstcache="25"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="2 9"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscont ent="name" jstcache="7">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28">optional </span><span jscontent="typeName" j stcache="20">paramType</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"> Description of this parame ter 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" jstcache="6" name="method -disableForTab"></a> <!-- method-anchor --> <h3 jscontent="name" jstcache="7">di sableForTab</h3> <div class="summary" jstcache="0"><span jsdisplay="returns" jsc ontent="returns.typeName" jstcache="9" style="display: none; ">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="fullName" jstcache="1 0">chrome.pageActions.disableForTab</span>(<span jsselect="parameters" jsvalues= "class:optional ? 'optional' : ''" jstcache="11" jsinstance="0" class="null"><sp an jsdisplay="$index" jstcache="19" style="display: none; ">, </span><span jscon tent="typeName" jstcache="20">string</span> <var jstcache="0"><span jscontent="n ame" jstcache="7">pageActionId</span></var></span><span jsselect="parameters" js values="class:optional ? 'optional' : ''" jstcache="11" jsinstance="*1" class="" ><span jsdisplay="$index" jstcache="19">, </span><span jscontent="typeName" jstc ache="20">object</span> <var jstcache="0"><span jscontent="name" jstcache="7">ac tion</span></var></span>)</div> <div class="description" jstcache="0"> <p class= "todo" jsdisplay="!description" jstcache="12">Undocumented.</p> <p jsdisplay="de scription" jsvalues=".innerHTML:description" jstcache="13" style="display: none; "> A description from the json schema def of the function goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <div jsselect= "parameters" jstcache="21" jsinstance="0"> <dt jstcache="0"> <!-- Note: intentio nally longer 80 columns --> <var jscontent="name" jstcache="7">pageActionId</var ><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28" st yle="display: none; ">optional </span><span jscontent="typeName" jstcache="20">s tring</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcach e="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHT ML:$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 jstcache="0"> <div js select="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName</var><em jst cache="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"> Undocumented. </dd> < dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcach e="24"> Description of this parameter from the json schema. </dd> </div> </dl> < /dd> </div><div jsselect="parameters" jstcache="21" jsinstance="*1"> <dt jstcach e="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstc ache="7">action</var><em jstcache="0"> (<span class="optional" jsdisplay="option al" jstcache="28" style="display: none; ">optional </span><span jscontent="typeN ame" jstcache="20">object</span>)</em> </dt> <dd class="todo" jsdisplay="!$this. description" 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 PROPERTIE S --> <dd jsdisplay="_propertyList" jstcache="25"> <dl jstcache="0"> <div jssele ct="_propertyList" jstcache="29" jsinstance="0"> <dt jstcache="0"> <!-- Note: in tentionally longer 80 columns --> <var jscontent="name" jstcache="7">tabId</var> <em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28" sty le="display: none; ">optional </span><span jscontent="typeName" jstcache="20">in teger</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcach e="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHT ML:$this.description" jstcache="24" style="display: none; "> Description of this parameter from the json schema. </dd> </div><div jsselect="_propertyList" jstca che="29" jsinstance="*1"> <dt jstcache="0"> <!-- Note: intentionally longer 80 c olumns --> <var jscontent="name" jstcache="7">url</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstcache="28" style="display: none; ">opti onal </span><span jscontent="typeName" jstcache="20">string</span>)</em> </dt> < dd class="todo" jsdisplay="!$this.description" jstcache="23"> Undocumented. </dd > <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstc ache="24" style="display: none; "> Description of this parameter from the json s chema. </dd> </div> </dl> </dd> </div> </dl> <!-- RETURNS --> <h4 jsdisplay="ret urns" jstcache="14" style="display: none; ">Returns</h4> <dl jstcache="0"> <div jsselect="returns" jstcache="22" style="display: none; "> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">pa ramName</var> <em jstcache="0">(<span jscontent="typeName" jstcache="20">paramTy pe</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 sc hema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="2 5"> <dl jstcache="0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache= "0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcac he="7">paramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optio nal" jstcache="28">optional </span><span jscontent="typeName" jstcache="20">para mType</span>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcach e="23"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHT ML:$this.description" jstcache="24"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> <!-- CALLBACK --> <div js display="callbackParameters" jstcache="15" style="display: none; "> <h4 jstcache ="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcache="0" >callback</em> parameter, it should specify a function that looks like this: </p > <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">function(<spa n jscontent="callbackSignature" jstcache="26">Type param1, Type param2</span>) < span class="subdued" jstcache="0">{...}</span>);</pre> <dl jstcache="0"> <div js select="callbackParameters" jstcache="27"> <dt jstcache="0"> <!-- Note: intentio nally 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"> Undocument ed. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.descripti on" jstcache="24"> Description of this parameter from the json schema. </dd> <!- - OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="25"> <dl jstcach e="0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramNam e</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"> Undocum ented. </dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.descri ption" jstcache="24"> Description of this parameter from the json schema. </dd> </div> </dl> </dd> </div> </dl> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div class="apiGroup" id= "events" jstcache="0"> <a name="#events" jstcache="0"></a> <h2 id="events" jstca che="0">Events</h2> <!-- iterates over all events --> <div jsselect="events" cla ss="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.bookmarks.</span><span js content="name" jstcache="7">onEvent</span><span class="subdued" jstcache="0">.ad dListener</span>(function(<span jscontent="callSignature" jstcache="16">Type par am1, 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="description" jsvalues=".innerHTM L:description" jstcache="13"> A description from the json schema def of the even t goes here. </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstca che="0"> <div jsselect="parameters" jstcache="21"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">paramName </var><em jstcache="0"> (<span jscontent="typeName" jstcache="20">paramType</spa n>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23">Und ocumented.</dd> <dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.des cription" jstcache="24"> Description of this parameter from the json schema. </d d> <!-- OBJECT PROPERTIES --> <dd jsdisplay="_propertyList" jstcache="25"> <dl j stcache="0"> <div jsselect="_propertyList" jstcache="29"> <dt jstcache="0"> <!-- Note: intentionally longer 80 columns --> <var jscontent="name" jstcache="7">pa ramName</var><em jstcache="0"> (<span class="optional" jsdisplay="optional" jstc ache="28">optional </span><span jscontent="typeName" jstcache="20">paramType</sp an>)</em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="23"> U ndocumented. </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> <!-- /decription --> </div> <!-- /a piItem --> </div> <!-- /apiGroup --> </div> <!-- /apiPage --> </div> <!-- /mainC olumn --> </div> <!-- /pageContent --> <div id="pageFooter" --="" jstcache="0"> Copyright 2009 <br jstcache="0"> TBD: copyright/license should be automatically included here </div> <!-- /pageFooter --> </div> <!-- /container --> </body></ht ml>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/packaging.html ('k') | chrome/common/extensions/docs/self.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698