chrome/common/extensions/docs/tutorials.html - Issue 179068: Extension Doc Changes (no building or testable changes): minor changes for tab & windows doc

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

Issue 179068: Extension Doc Changes (no building or testable changes): minor changes for tab & windows doc (Closed)

Patch Set: touch grd. rendered docs Created 11 years, 3 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:

OLD	NEW
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="getPageTitle()" jstcache="1">Tutorials</title> <link href= "css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0"> <script ty pe="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js " jstcache="0"> </script> <script type="text/javascript" src="js/api_page_genera tor.js" jstcache="0"></script> <script type="text/javascript" src="js/bootstrap. js" jstcache="0"></script> </head><!-- <body> content is completely generated. D o not edit, as it will be and rewritten. --><body jstcache="0"> <div id="contain er" jstcache="0"> <a name="top" jstcache="0"> </a> <!-- API HEADER --> <div id=" pageHeader" jstcache="0"> <div id="searchbox" jstcache="0"> <form action="http:/ /www.google.com/cse" id="cse-search-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" n ame="q" size="31" jstcache="0"> <input type="submit" name="sa" value="Search" js tcache="0"> </div> </form> <script type="text/javascript" src="http://www.google .com/jsapi" jstcache="0"></script> <script type="text/javascript" jstcache="0">g oogle.load("elements", "1", {packages: "transliteration"});</script> <script typ e="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box &t13n_langs=en" jstcache="0"></script> <script type="text/javascript" src="h ttp://www.google.com/coop/cse/brand?form=cse-search-box&lang=en" jstcache="0 "></script> </div> <div id="pageTitle" jstcache="0"> <h1 jscontent="getPageTitle ()" jstcache="1">Tutorials</h1> </div> </div> <!-- /pageHeader --> <div id="page Content" jstcache="0"> <!-- SIDENAV --> <div id="leftNav" jstcache="0"> <ul jstc ache="0"> <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li> <li jstcache="0"> <a href="getstarted.html" jstcache="0">Getting Started</a></li> <l i jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li> <li jstca che="0"> <a href="devguide.html" jstcache="0"><div jstcache="0">Developer's Guid e</div></a> <ul jstcache="0"> <li jstcache="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" jstcach e="0">Background Pages</a></li> <li jstcache="0"><a href="content_scripts.html" jstcache="0">Content Scripts</a></li> <li jstcache="0">Events</li> <li jstcache= "0"><a href="tabs.html" jstcache="0">Tabs</a></li> <li jstcache="0"><a href="win dows.html" jstcache="0">Windows</a></li> <li jstcache="0"><a href="bookmarks.htm l" jstcache="0">Bookmarks</a></li> <li jstcache="0">Themes</li> <li jstcache="0" ><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li> <li jstcache="0"><a hr ef="packaging.html" jstcache="0">Packaging</a></li> <li jstcache="0">Autoupdate< /li> </ul> </li> <li jstcache="0"><div jstcache="0" class="leftNavSelected">Tuto rials</div> <ul jstcache="0"> <li jstcache="0"><a href="tut_debugging.html" jstc ache="0">Debugging</a></li> </ul> </li> <li jstcache="0">Reference <ul jstcache= "0"> <li jstcache="0"> Formats <ul jstcache="0"> <li jstcache="0"><a href="manif est.html" jstcache="0">Manifest Files</a></li> <li jstcache="0">Match Patterns</ li> <li jstcache="0">Packages (.crx)</li> </ul> </li> <li jstcache="0"> <a href= "api_index.html" jstcache="0">chrome.* APIs</a> </li> <li jstcache="0"> <a href= "api_other.html" jstcache="0">Other APIs</a> </li> </ul> </li> <li jstcache="0"> <a href="http://dev.chromium.org/developers/design-documents/extensions/samples" jstcache="0">Samples</a></li> </ul> </div> <div id="mainColumn" jstcache="0"> < !-- TABLE OF CONTENTS --> <div id="toc" jsdisplay="showPageTOC()" jstcache="2" s tyle="display: none; "> <p jstcache="0">Contents</p> <ol jstcache="0"> <li jssel ect="getStaticTOC()" jstcache="9"> <a jscontent="name" jsvalues=".href:'#' + hre f" jstcache="14">h2Name</a> <ol jstcache="0"> <li jsselect="$this.children" jstc ache="22"> <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14">h3Name< /a> </li> </ol> </li> <div jsselect="apiDefinition" jstcache="3"> <li jstcache=" 0"> <a href="#apiReference" jscontent="'API reference: ' + getModuleName()" jstc ache="4">API reference</a> <ol jstcache="0"> <li jsdisplay="$this.properties" js tcache="5"> <a href="#properties" jstcache="0">Properties</a> <ol jstcache="0"> <li jsselect="getPropertyListFromObject($this)" jstcache="10"> <a jscontent="nam e" jsvalues=".href:'#property-' + name" href="#property-anchor" jstcache="41">pr opertyName</a> </li> </ol> </li> <li jsdisplay="functions && functions.l ength > 0" jstcache="6"> <a href="#methods" jstcache="0">Methods</a> <ol jstc ache="0"> <li jsselect="functions" jstcache="11"> <a jscontent="name" jsvalues=" .href:'#method-' + name" href="#method-anchor" jstcache="42">methodName</a> </li > </ol> </li> <li jsdisplay="events && events.length > 0" jstcache="7 "> <a href="#events" jstcache="0">Events</a> <ol jstcache="0"> <li jsselect="eve nts" jstcache="12"> <a jscontent="name" jsvalues=".href:'#event-' + name" href=" #event-anchor" jstcache="43">eventName</a> </li> </ol> </li> <li jsdisplay="type s && types.length > 0" jstcache="8"> <a href="#types" jstcache="0">Ty pes</a> <ol jstcache="0"> <li jsselect="types" jstcache="13"> <a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="44">id</a> </li> </ol > </li> </ol> </li> </div> </ol> </div> <!-- /TABLE OF CONTENTS --> <!-- STATIC CONTENT PLACEHOLDER --> <div id="static" jstcache="0"><div id="pageData-title" c lass="pageData" jstcache="0">Tutorials</div> <p jstcache="0"> Here's what we hav e, so far: </p> <ul jstcache="0"> <li jstcache="0"> <a href="getstarted.html" js tcache="0">Getting Started</a> </li> <li jstcache="0"> <a href="tut_debugging.ht ml" jstcache="0">Debugging</a> </li> </ul> </div> <!-- API PAGE --> <div class=" apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; "> <a name= "apiReference" jstcache="0"></a> <h2 jscontent="'API reference: ' + getModuleNam e()" jstcache="4">API reference: chrome.apiname </h2> <!-- PROPERTIES --> <div j sdisplay="$this.properties" class="apiGroup" jstcache="5"> <a name="properties" jstcache="0"></a> <h3 id="properties" jstcache="0">Properties</h3> <div jsselect ="getPropertyListFromObject($this)" jstcache="10"> <a jsvalues=".name:'property- ' + name" jstcache="15"></a> <h4 jscontent="name" jstcache="16">getLastError</h4 > <div class="summary" jstcache="0"> <!-- Note: intentionally longer 80 columns --> <span jscontent="getModuleName() + '.'" jstcache="23">chrome.extension</span ><span jscontent="$this.name" jstcache="24">lastError</span> </div> <div transcl ude="valueTemplate" jstcache="17"> </div> </div> </div> <!-- /apiGroup --> <!-- METHODS --> <div jsdisplay="functions && functions.length > 0" class= "apiGroup" id="methods" jstcache="6"> <a name="methods" jstcache="0"></a> <h3 js tcache="0">Methods</h3> <!-- iterates over all functions --> <div class="apiItem " jsselect="functions" jstcache="11"> <a jsvalues=".name:'method-' + name" jstca che="18"></a> <!-- method-anchor --> <h4 jscontent="name" jstcache="16">method n ame</h4> <div class="summary" jstcache="0"><span jsdisplay="returns" jscontent=" getTypeName(returns)" jstcache="25">void</span> <!-- Note: intentionally longer 80 columns --> <span jscontent="getFullyQualifiedFunctionName($this)" jstcache=" 26">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class: optional ? 'optional' : ''" jstcache="27"><span jsdisplay="$index" jstcache="33" >, </span><span jscontent="getTypeName($this)" jstcache="34"></span> <var jstcac he="0"><span jscontent="name" jstcache="16"></span></var></span>)</div> <div cla ss="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache ="28">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:descript ion" jstcache="29"> 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="35"> <!-- VALUE: This is a subtemplate th at is used elsewhere via jsTemplate transclude --> <div id="valueTemplate" jst cache="0"> <dt jstcache="0"> <var jsdisplay="$this.name" jscontent="$this.name" jstcache="45">paramName</var> <em jstcache="0"> <!-- TYPE --> <div style="displa y:inline" jstcache="0"> ( <span class="optional" jsdisplay="optional" jstcache=" 46">optional</span> <span id="typeTemplate" jstcache="0"> <span jsdisplay="getTy peRef($this)" jstcache="47"> <a jsvalues=".href: getTypeRefPage($this) + '#type- ' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="49"> Type</a> </s pan> <span jsdisplay="!getTypeRef($this)" jstcache="48"> <span jsdisplay="isArra y($this)" jstcache="50"> array of <span jsselect="items" jstcache="52"><span tra nsclude="typeTemplate" jstcache="53"></span></span> </span> <span jsdisplay="!is Array($this)" jscontent="getTypeName($this)" jstcache="51">paramType</span> </sp an> </span> ) </div> </em> </dt> <dd class="todo" jsdisplay="!$this.description" jstcache="38"> Undocumented. </dd> <dd jsdisplay="$this.description" jsvalues=" .innerHTML:$this.description" jstcache="39"> Description of this parameter from the json schema. </dd> <!-- OBJECT PROPERTIES --> <dd jsdisplay="shouldExpandObj ect($this)" jstcache="40"> <dl jstcache="0"> <div jsselect="getPropertyListFromO bject($this)" jstcache="10"> <div transclude="valueTemplate" jstcache="17"> </di v> </div> </dl> </dd> </div> <!-- /VALUE --> </div> </dl> <!-- RETURNS --> <h4 j sdisplay="returns" jstcache="30">Returns</h4> <dl jstcache="0"> <div jsselect="r eturns" jstcache="36"> <div transclude="valueTemplate" jstcache="17"> </div> </d iv> </dl> <!-- CALLBACK --> <div jsdisplay="hasCallback(parameters)" jstcac he="31"> <div jsselect="getCallbackParameters(parameters)" jstcache="37"> <h4 js tcache="0">Callback function</h4> <p jstcache="0"> If you specify the <em jstcac he="0">callback</em> parameter, it should specify a function that looks like thi s: </p> <!-- Note: intentionally longer 80 columns --> <pre jstcache="0">functio n(<span jscontent="getSignatureString(parameters)" jstcache="32">Type param1, Ty pe param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre> <dl js tcache="0"> <div jsselect="parameters" jstcache="35"> <div transclude="valueTemp late" jstcache="17"> </div> </div> </dl> </div> </div> </div> <!-- /description --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- EVENTS --> <div jsdi splay="events && events.length > 0" class="apiGroup" jstcache="7"> <a name="events" jstcache="0"></a> <h3 id="events" jstcache="0">Events</h3> <!-- i terates over all events --> <div jsselect="events" class="apiItem" jstcache="12" > <a jsvalues=".name:'event-' + name" jstcache="19"></a> <h4 jscontent="name" js tcache="16">event name</h4> <div class="summary" jstcache="0"> <!-- Note: intent ionally longer 80 columns --> <span jscontent="getModuleName() + '.'" class="sub dued" jstcache="23">chrome.bookmarks</span><span jscontent="name" jstcache="16"> onEvent</span><span class="subdued" jstcache="0">.addListener</span>(function(<s pan jscontent="getSignatureString(parameters)" jstcache="32">Type param1, Type p aram2</span>) <span class="subdued" jstcache="0">{...}</span>); </div> <div clas s="description" jstcache="0"> <p class="todo" jsdisplay="!description" jstcache= "28">Undocumented.</p> <p jsdisplay="description" jsvalues=".innerHTML:descripti on" jstcache="29"> A description from the json schema def of the event goes here . </p> <!-- PARAMETERS --> <h4 jstcache="0">Parameters</h4> <dl jstcache="0"> <d iv jsselect="parameters" jstcache="35"> <div transclude="valueTemplate" jstcache ="17"> </div> </div> </dl> </div> <!-- /decription --> </div> <!-- /apiItem --> </div> <!-- /apiGroup --> <!-- TYPES --> <div jsdisplay="types && types. length > 0" class="apiGroup" jstcache="8"> <a name="types" jstcache="0"></a> <h3 id="types" jstcache="0">Types</h3> <!-- iterates over all types --> <div jss elect="types" class="apiItem" jstcache="13"> <a jsvalues=".name:'type-' + id" js tcache="20"></a> <h4 jscontent="id" jstcache="21">type name</h4> <div transclude ="valueTemplate" jstcache="17"> </div> </div> <!-- /apiItem --> </div> <!-- /api Group --> </div> <!-- /apiPage --> </div> <!-- /mainColumn --> </div> <!-- /page Content --> <div id="pageFooter" --="" jstcache="0"> <p jstcache="0"> Except as otherwise <a href="http://code.google.com/policies.html#restrictions" jstcache=" 0">noted</a>, the content of this page is licensed under the <a rel="license" hr ef="http://creativecommons.org/licenses/by/3.0/" jstcache="0">Creative Commons A ttribution 3.0 License</a>, and code samples are licensed under the <a rel="lice nse" href="http://code.google.com/google_bsd_license.html" jstcache="0">BSD Lice nse</a>. </p> <p jstcache="0"> ©2009 Google </p> </div> <!-- /pageFooter --> </d iv> <!-- /container --> </body></html>	1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:

	2 1) The <head> information in this page is significant, should be uniform

	3 across api docs and should be edited only with knowledge of the

	4 templating mechanism.

	5 2) The <body> tag must retain id="body"

	6 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a

	7 browser, it will be re-generated from the template, json schema and

	8 authored overview content.

	9 4) The <body>.innerHTML is also generated by an offline step so that this

	10 page may easily be indexed by search engines.

	11

	12 TODO(rafaelw): Abstract this into a "pageshell" that becomes the single

	13 version of page template shell and the "instance" pages (bookmarks.html,

	14 etc...) can be generated with a build step.

	15 --><!-- <html> must retain id="template --><html xmlns="http://www.w3.org/1999/x html" jstcache="0"><!-- <head> data is significant and loads the needed librarie s and styles --><head jstcache="0">

	16 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" jstcache= "0">

	17 <title jscontent="getPageTitle()" jstcache="1">Tutorials</title>

	18 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache= "0">

	19 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js" jstcache="0">

	20 </script>

	21 <script type="text/javascript" src="js/api_page_generator.js" jstcache="0">< /script>

	22 <script type="text/javascript" src="js/bootstrap.js" jstcache="0"></script>

	23 </head><!-- <body> content is completely generated. Do not edit, as it will be

	24 and rewritten. --><body jstcache="0"> <div id="container" jstcache="0">

	25 <a name="top" jstcache="0"> </a>

	26 <!-- API HEADER -->

	27 <div id="pageHeader" jstcache="0">

	28 <div id="searchbox" jstcache="0">

	29 <form action="http://www.google.com/cse" id="cse-search-box" jstcache="0 ">

	30 <div jstcache="0">

	31 <input type="hidden" name="cx" value="002967670403910741006:61_cvzfq tno" jstcache="0">

	32 <input type="hidden" name="ie" value="UTF-8" jstcache="0">

	33 <input type="text" name="q" size="31" jstcache="0">

	34 <input type="submit" name="sa" value="Search" jstcache="0">

	35 </div>

	36 </form>

	37

	38 <script type="text/javascript" src="http://www.google.com/jsapi" jstcach e="0"></script>

	39 <script type="text/javascript" jstcache="0">google.load("elements", "1", {packages: "transliteration"});</script>

	40 <script type="text/javascript" src="http://www.google.com/coop/cse/t13n? form=cse-search-box&t13n_langs=en" jstcache="0"></script>

	41 <script type="text/javascript" src="http://www.google.com/coop/cse/brand ?form=cse-search-box&lang=en" jstcache="0"></script>

	42 </div>

	43 <div id="pageTitle" jstcache="0">

	44 <h1 jscontent="getPageTitle()" jstcache="1">Tutorials</h1>

	45 </div>

	46 </div> <!-- /pageHeader -->

	47

	48 <div id="pageContent" jstcache="0">

	49 <!-- SIDENAV -->

	50 <div id="leftNav" jstcache="0">

	51 <ul jstcache="0">

	52 <li jstcache="0"> <a href="index.html" jstcache="0">Home</a></li>

	53 <li jstcache="0"> <a href="getstarted.html" jstcache="0">Getting Start ed</a></li>

	54 <li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></l i>

	55 <li jstcache="0"> <a href="devguide.html" jstcache="0"><div jstcache=" 0">Developer's Guide</div></a>

	56 <ul jstcache="0">

	57 <li jstcache="0"><a href="toolstrip.html" jstcache="0">Toolstrips< /a></li>

	58 <li jstcache="0"><a href="pageActions.html" jstcache="0">Page Acti ons</a></li>

	59 <li jstcache="0"><a href="background_pages.html" jstcache="0">Back ground Pages</a></li>

	60 <li jstcache="0"><a href="content_scripts.html" jstcache="0">Conte nt Scripts</a></li>

	61 <li jstcache="0"><a href="events.html" jstcache="0">Events</a></li >

	62 <li jstcache="0"><a href="tabs.html" jstcache="0">Tabs</a></li>

	63 <li jstcache="0"><a href="windows.html" jstcache="0">Windows</a></ li>

	64 <li jstcache="0"><a href="bookmarks.html" jstcache="0">Bookmarks</ a></li>

	65 <li jstcache="0"><a href="themes.html" jstcache="0">Themes</a></li >

	66 <li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</ a></li>

	67 <li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</ a></li>

	68 <li jstcache="0">Autoupdate</li>

	69 </ul>

	70 </li>

	71 <li jstcache="0"><div jstcache="0" class="leftNavSelected">Tutorials</ div>

	72 <ul jstcache="0">

	73 <li jstcache="0"><a href="tut_debugging.html" jstcache="0">Debuggi ng</a></li>

	74 </ul>

	75 </li>

	76 <li jstcache="0">Reference

	77 <ul jstcache="0">

	78 <li jstcache="0"> Formats

	79 <ul jstcache="0">

	80 <li jstcache="0"><a href="manifest.html" jstcache="0">Manifest Files</a></li>

	81 <li jstcache="0"><a href="match_patterns.html" jstcache="0">Ma tch Patterns</a></li>

	82 <li jstcache="0">Packages (.crx)</li>

	83 </ul>

	84 </li>

	85 <li jstcache="0"> <a href="api_index.html" jstcache="0">chrome.* A PIs</a> </li>

	86 <li jstcache="0"> <a href="api_other.html" jstcache="0">Other APIs </a> </li>

	87 </ul>

	88 </li>

	89 <li jstcache="0"><a href="http://dev.chromium.org/developers/design-doc uments/extensions/samples" jstcache="0">Samples</a></li>

	90 </ul>

	91 </div>

	92

	93 <div id="mainColumn" jstcache="0">

	94 <!-- TABLE OF CONTENTS -->

	95 <div id="toc" jsdisplay="showPageTOC()" jstcache="2" style="display: non e; ">

	96 <p jstcache="0">Contents</p>

	97 <ol jstcache="0">

	98 <li jsselect="getStaticTOC()" jstcache="9">

	99 <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14">h2Na me</a>

	100 <ol jstcache="0">

	101 <li jsselect="$this.children" jstcache="22">

	102 <a jscontent="name" jsvalues=".href:'#' + href" jstcache="14"> h3Name</a>

	103 </li>

	104 </ol>

	105 </li>

	106 <div jsselect="apiDefinition" jstcache="3">

	107 <li jstcache="0">

	108 <a href="#apiReference" jscontent="'API reference: ' + getModule Name()" jstcache="4">API reference</a>

	109 <ol jstcache="0">

	110 <li jsdisplay="$this.properties" jstcache="5">

	111 <a href="#properties" jstcache="0">Properties</a>

	112 <ol jstcache="0">

	113 <li jsselect="getPropertyListFromObject($this)" jstcache=" 10">

	114 <a jscontent="name" jsvalues=".href:'#property-' + name" href="#property-anchor" jstcache="42">propertyName</a>

	115 </li>

	116 </ol>

	117 </li>

	118 <li jsdisplay="functions && functions.length > 0" j stcache="6">

	119 <a href="#methods" jstcache="0">Methods</a>

	120 <ol jstcache="0">

	121 <li jsselect="functions.sort(sortByName)" jstcache="11">

	122 <a jscontent="name" jsvalues=".href:'#method-' + name" h ref="#method-anchor" jstcache="43">methodName</a>

	123 </li>

	124 </ol>

	125 </li>

	126 <li jsdisplay="events && events.length > 0" jstcach e="7">

	127 <a href="#events" jstcache="0">Events</a>

	128 <ol jstcache="0">

	129 <li jsselect="events.sort(sortByName)" jstcache="12">

	130 <a jscontent="name" jsvalues=".href:'#event-' + name" hr ef="#event-anchor" jstcache="44">eventName</a>

	131 </li>

	132 </ol>

	133 </li>

	134 <li jsdisplay="types && types.length > 0" jstcache= "8">

	135 <a href="#types" jstcache="0">Types</a>

	136 <ol jstcache="0">

	137 <li jsselect="types.sort(sortByName)" jstcache="38">

	138 <a jscontent="id" jsvalues=".href:'#type-' + id" href="# id-anchor" jstcache="45">id</a>

	139 </li>

	140 </ol>

	141 </li>

	142 </ol>

	143 </li>

	144 </div>

	145 </ol>

	146 </div>

	147 <!-- /TABLE OF CONTENTS -->

	148

	149 <!-- STATIC CONTENT PLACEHOLDER -->

	150 <div id="static" jstcache="0"><div id="pageData-title" class="pageData" jstcache="0">Tutorials</div>

	151

	152 <p jstcache="0">

	153 Here's what we have, so far:

	154 </p>

	155

	156 <ul jstcache="0">

	157 <li jstcache="0"> <a href="getstarted.html" jstcache="0">Getting Started</a> < /li>

	158 <li jstcache="0"> <a href="tut_debugging.html" jstcache="0">Debugging</a> </li >

	159 </ul>

	160 </div>

	161

	162 <!-- API PAGE -->

	163 <div class="apiPage" jsselect="apiDefinition" jstcache="3" style="displa y: none; ">

	164 <a name="apiReference" jstcache="0"></a>

	165 <h2 jscontent="'API reference: ' + getModuleName()" jstcache="4">API ref erence: chrome.apiname </h2>

	166

	167 <!-- PROPERTIES -->

	168 <div jsdisplay="$this.properties" class="apiGroup" jstcache="5">

	169 <a name="properties" jstcache="0"></a>

	170 <h3 id="properties" jstcache="0">Properties</h3>

	171

	172 <div jsselect="getPropertyListFromObject($this)" jstcache="10">

	173 <a jsvalues=".name:'property-' + name" jstcache="15"></a>

	174 <h4 jscontent="name" jstcache="16">getLastError</h4>

	175 <div class="summary" jstcache="0">

	176 <!-- Note: intentionally longer 80 columns -->

	177 <span jscontent="getModuleName() + '.'" jstcache="23">chrome.ext ension</span><span jscontent="$this.name" jstcache="24">lastError</span>

	178 </div>

	179 <div transclude="valueTemplate" jstcache="17">

	180 </div>

	181 </div>

	182

	183 </div> <!-- /apiGroup -->

	184

	185 <!-- METHODS -->

	186 <div jsdisplay="functions && functions.length > 0" class="a piGroup" id="methods" jstcache="6">

	187 <a name="methods" jstcache="0"></a>

	188 <h3 jstcache="0">Methods</h3>

	189

	190 <!-- iterates over all functions -->

	191 <div class="apiItem" jsselect="functions.sort(sortByName)" jstcache= "11">

	192 <a jsvalues=".name:'method-' + name" jstcache="18"></a> <!-- metho d-anchor -->

	193 <h4 jscontent="name" jstcache="16">method name</h4>

	194

	195 <div class="summary" jstcache="0"><span jsdisplay="returns" jscont ent="getTypeName(returns)" jstcache="25">void</span>

	196 <!-- Note: intentionally longer 80 columns -->

	197 <span jscontent="getFullyQualifiedFunctionName($this)" jstcach e="26">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="cla ss:optional ? 'optional' : ''" jstcache="27"><span jsdisplay="$index" jstcache=" 33">, </span><span jscontent="getTypeName($this)" jstcache="34"></span>

	198 <var jstcache="0"><span jscontent="name" jstcache="16"></s pan></var></span>)</div>

	199

	200 <div class="description" jstcache="0">

	201 <p class="todo" jsdisplay="!description" jstcache="28">Undocumen ted.</p>

	202 <p jsdisplay="description" jsvalues=".innerHTML:description" jst cache="29">

	203 A description from the json schema def of the function goes he re.

	204 </p>

	205

	206 <!-- PARAMETERS -->

	207 <h4 jstcache="0">Parameters</h4>

	208 <dl jstcache="0">

	209 <div jsselect="parameters" jstcache="35">

	210

	211 <!-- VALUE: This is a subtemplate that is used elsewhere

	212 via jsTemplate transclude -->

	213 <div id="valueTemplate" jstcache="0">

	214 <dt jstcache="0">

	215 <var jsdisplay="$this.name" jscontent="$this.name" jstca che="46">paramName</var>

	216 <em jstcache="0">

	217

	218 <!-- TYPE -->

	219 <div style="display:inline" jstcache="0">

	220 (

	221 <span class="optional" jsdisplay="optional" jstc ache="47">optional</span>

	222 <span id="typeTemplate" jstcache="0">

	223 <span jsdisplay="getTypeRef($this)" jstcache=" 48">

	224 <a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type< /a>

	225 </span>

	226 <span jsdisplay="!getTypeRef($this)" jstcache= "49">

	227 <span jsdisplay="isArray($this)" jstcache="5 1">

	228 array of <span jsselect="items" jstcache=" 53"><span transclude="typeTemplate" jstcache="54"></span></span>

	229 </span>

	230 <span jsdisplay="!isArray($this)" jscontent= "getTypeName($this)" jstcache="52">paramType</span>

	231 </span>

	232 </span>

	233 )

	234 </div>

	235

	236 </em>

	237 </dt>

	238 <dd class="todo" jsdisplay="!$this.description" jstcache=" 39">

	239 Undocumented.

	240 </dd>

	241 <dd jsdisplay="$this.description" jsvalues=".innerHTML:$th is.description" jstcache="40">

	242 Description of this parameter from the json schema.

	243 </dd>

	244

	245 <!-- OBJECT PROPERTIES -->

	246 <dd jsdisplay="shouldExpandObject($this)" jstcache="41">

	247 <dl jstcache="0">

	248 <div jsselect="getPropertyListFromObject($this)" jstca che="10">

	249 <div transclude="valueTemplate" jstcache="17">

	250 </div>

	251 </div>

	252 </dl>

	253 </dd>

	254 </div> <!-- /VALUE -->

	255

	256 </div>

	257 </dl>

	258

	259 <!-- RETURNS -->

	260 <h4 jsdisplay="returns" jstcache="30">Returns</h4>

	261 <dl jstcache="0">

	262 <div jsselect="returns" jstcache="36">

	263 <div transclude="valueTemplate" jstcache="17">

	264 </div>

	265 </div>

	266 </dl>

	267

	268 <!-- CALLBACK -->

	269 <div jsdisplay="hasCallback(parameters)" jstcache="31">

	270 <div jsselect="getCallbackParameters(parameters)" jstcache="37 ">

	271 <h4 jstcache="0">Callback function</h4>

	272 <p jstcache="0">

	273 If you specify the <em jstcache="0">callback</em> parameter,

	274 it should specify a function that looks like this:

	275 </p>

	276

	277 <!-- Note: intentionally longer 80 columns -->

	278 <pre jstcache="0">function(<span jscontent="getSignatureString (parameters)" jstcache="32">Type param1, Type param2</span>) <span class="subdue d" jstcache="0">{...}</span>);</pre>

	279 <dl jstcache="0">

	280 <div jsselect="parameters" jstcache="35">

	281 <div transclude="valueTemplate" jstcache="17">

	282 </div>

	283 </div>

	284 </dl>

	285 </div>

	286 </div>

	287

	288 </div> <!-- /description -->

	289

	290 </div> <!-- /apiItem -->

	291

	292 </div> <!-- /apiGroup -->

	293

	294 <!-- EVENTS -->

	295 <div jsdisplay="events && events.length > 0" class="apiGrou p" jstcache="7">

	296 <a name="events" jstcache="0"></a>

	297 <h3 id="events" jstcache="0">Events</h3>

	298

	299 <!-- iterates over all events -->

	300 <div jsselect="events.sort(sortByName)" class="apiItem" jstcache="12 ">

	301 <a jsvalues=".name:'event-' + name" jstcache="19"></a>

	302 <h4 jscontent="name" jstcache="16">event name</h4>

	303

	304 <div class="summary" jstcache="0">

	305 <!-- Note: intentionally longer 80 columns -->

	306 <span jscontent="getModuleName() + '.'" class="subdued" jstcache ="23">chrome.bookmarks</span><span jscontent="name" jstcache="16">onEvent</span> <span class="subdued" jstcache="0">.addListener</span>(function(<span jscontent= "getSignatureString(parameters)" jstcache="32">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);

	307 </div>

	308

	309 <div class="description" jstcache="0">

	310 <p class="todo" jsdisplay="!description" jstcache="28">Undocumen ted.</p>

	311 <p jsdisplay="description" jsvalues=".innerHTML:description" jst cache="29">

	312 A description from the json schema def of the event goes here.

	313 </p>

	314

	315 <!-- PARAMETERS -->

	316 <h4 jstcache="0">Parameters</h4>

	317 <dl jstcache="0">

	318 <div jsselect="parameters" jstcache="35">

	319 <div transclude="valueTemplate" jstcache="17">

	320 </div>

	321 </div>

	322 </dl>

	323

	324 </div> <!-- /decription -->

	325

	326 </div> <!-- /apiItem -->

	327

	328 </div> <!-- /apiGroup -->

	329

	330 <!-- TYPES -->

	331 <div jsdisplay="types && types.length > 0" class="apiGroup" jstcache="8">

	332 <a name="types.sort(sortByName)" jstcache="0"></a>

	333 <h3 id="types" jstcache="0">Types</h3>

	334

	335 <!-- iterates over all types -->

	336 <div jsselect="types" class="apiItem" jstcache="13">

	337 <a jsvalues=".name:'type-' + id" jstcache="20"></a>

	338 <h4 jscontent="id" jstcache="21">type name</h4>

	339

	340 <div transclude="valueTemplate" jstcache="17">

	341 </div>

	342

	343 </div> <!-- /apiItem -->

	344

	345 </div> <!-- /apiGroup -->

	346

	347 </div> <!-- /apiPage -->

	348 </div> <!-- /mainColumn -->

	349 </div> <!-- /pageContent -->

	350 <div id="pageFooter" --="" jstcache="0">

	351 <p jstcache="0">

	352 Except as otherwise <a href="http://code.google.com/policies.html#restrictions " jstcache="0">noted</a>,

	353 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/" jstcache="0">Creative Commons

	354 Attribution 3.0 License</a>, and code samples are licensed under the

	355 <a rel="license" href="http://code.google.com/google_bsd_license.html" jstcach e="0">BSD License</a>.

	356 </p>

	357 <p jstcache="0">

	358 ©2009 Google

	359 </p>

	360 </div> <!-- /pageFooter -->

	361 </div> <!-- /container -->

	362 </body></html>

	363 #EOF

OLD	NEW

« chrome/common/extensions/docs/api_index.html ('K') | « chrome/common/extensions/docs/tut_debugging.html ('k') | no next file » | no next file with comments »