blob: f48b0fe6ba2571f9602f8eb549b577c07a7ca1ae (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
|
<div id="container">
<a name="top"> </a>
<!-- API HEADER -->
<div id="pageHeader">
<div id="searchbox">
<form action="http://www.google.com/cse" id="cse-search-box">
<div>
<input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" size="31" />
<input type="submit" name="sa" value="Search" />
</div>
</form>
<script type="text/javascript" src="http://www.google.com/jsapi"></script>
<script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
<script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse-search-box&t13n_langs=en"></script>
<script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en"></script>
</div>
<div id="pageTitle">
<h1 jscontent="getPageTitle()">chrome.apiname</h1>
</div>
</div> <!-- /pageHeader -->
<div id="pageContent">
<!-- SIDENAV -->
<div id="leftNav">
<ul>
<li> <a href="index.html">Home</a></li>
<li> <a href="getstarted.html">Get Started</a></li>
<li> <a href="overview.html">Overview</a></li>
<li>Reference
<ul>
<li><a href="manifest.html">Manifest</a></li>
<li><a href="toolstrip.html">Toolstrips</a></li>
<li><a href="pageActions.html">Page actions</a></li>
<li><a href="background_pages.html">Background pages</a></li>
<li><a href="content_scripts.html">Content scripts</a></li>
<li><a href="extension.html">Extension</a></li>
<li><a href="tabs.html">Tabs</a></li>
<li><a href="windows.html">Windows</a></li>
<li><a href="self.html">Self</a></li>
<li><a href="npapi.html">NPAPI Plugins</a></li>
<li><a href="packaging.html">Packaging</a></li>
<li><a href="autoupdate.html">Autoupdate</a></li>
</ul>
</li>
<li>Samples
<ul>
<li>[sample 1]</li>
<li>[sample 2]</li>
</ul>
</li>
</ul>
</div>
<div id="mainColumn">
<!-- TABLE OF CONTENTS -->
<div id="toc" jsselect="apiDefinition">
<p>Contents</p>
<ol>
<li>
<a href="#overview">Description</a>
<ol>
<li><a href="#overview-properties">Properties</a></li>
<li><a href="#overview-examples">Examples</a></li>
</ol>
</li>
<li jsdisplay="functions && functions.length > 0">
<a href="#methods">Methods</a>
<ol>
<li jsselect="functions">
<a jscontent="name"
jsvalues=".href:'#method-' + name"
href="#method-anchor">methodName</a>
</li>
</ol>
</li>
<li jsdisplay="events && events.length > 0">
<a href="#events">Events</a>
<ol>
<li jsselect="events">
<a jscontent="name"
jsvalues=".href:'#event-' + name"
href="#event-anchor">eventName</a>
</li>
</ol>
</li>
<li jsdisplay="types && types.length > 0">
<a href="#types">Types</a>
<ol>
<li jsselect="types">
<a jscontent="id"
jsvalues=".href:'#type-' + id"
href="#id-anchor">id</a>
</li>
</ol>
</li>
</ol>
[PENDING: links 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"></div>
<!-- API PAGE -->
<div class="apiPage" jsselect="apiDefinition">
<!-- METHODS -->
<div jsdisplay="functions && functions.length > 0" class="apiGroup" id="methods">
<a name="#methods"></a>
<h2>Methods</h2>
<!-- iterates over all functions -->
<div class="apiItem" jsselect="functions">
<a jsvalues=".name:'method-' + name"></a> <!-- method-anchor -->
<h3 jscontent="name">method name</h3>
<div class="summary"><span jsdisplay="returns" jscontent="getTypeName(returns)">void</span>
<!-- Note: intentionally longer 80 columns -->
<span jscontent="getFullyQualifiedFunctionName($this)">chrome.module.methodName</span>(<span jsselect="parameters" jsvalues="class:optional ? 'optional' : ''"><span jsdisplay="$index">, </span><span jscontent="getTypeName($this)"></span>
<var><span jscontent="name"></span></var></span>)</div>
<div class="description">
<p class="todo" jsdisplay="!description">Undocumented.</p>
<p jsdisplay="description" jsvalues=".innerHTML:description">
A description from the json schema def of the function goes here.
</p>
<!-- PARAMETERS -->
<h4>Parameters</h4>
<dl>
<div jsselect="parameters">
<!-- VALUE: This is a subtemplate that is used elsewhere
via jsTemplate *transclude* -->
<div id="valueTemplate">
<dt>
<var jsdisplay="$this.name" jscontent="$this.name">paramName</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional" jsdisplay="optional">optional</span>
<span id="typeTemplate">
<span jsdisplay="getTypeRef($this)">
<a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)"> Type</a>
</span>
<span jsdisplay="!getTypeRef($this)">
<span jsdisplay="isArray($this)">
array of <span jsselect="items"><span transclude="typeTemplate"></span></span>
</span>
<span jsdisplay="!isArray($this)" jscontent="getTypeName($this)">paramType</span>
</span>
</span>
)
</div>
</em>
</dt>
<dd class="todo" jsdisplay="!$this.description">
Undocumented.
</dd>
<dd jsdisplay="$this.description"
jsvalues=".innerHTML:$this.description">
Description of this parameter from the json schema.
</dd>
<!-- OBJECT PROPERTIES -->
<dd jsdisplay="shouldExpandObject($this)">
<dl>
<div jsselect="getPropertyListFromObject($this)">
<div transclude="valueTemplate">
</div>
</div>
</dl>
</dd>
</div> <!-- /VALUE -->
</div>
</dl>
<!-- RETURNS -->
<h4 jsdisplay="returns">Returns</h4>
<dl>
<div jsselect="returns">
<div transclude="valueTemplate">
</div>
</div>
</dl>
<!-- CALLBACK -->
<div jsdisplay="hasCallback(parameters)">
<div jsselect="getCallbackParameters(parameters)">
<h4>Callback function</h4>
<p>
If you specify the <em>callback</em> parameter,
it should specify a function that looks like this:
</p>
<!-- Note: intentionally longer 80 columns -->
<pre>function(<span jscontent="getSignatureString(parameters)">Type param1, Type param2</span>) <span class="subdued">{...}</span>);</pre>
<dl>
<div jsselect="parameters">
<div transclude="valueTemplate">
</div>
</div>
</dl>
</div>
</div>
</div> <!-- /description -->
</div> <!-- /apiItem -->
</div> <!-- /apiGroup -->
<!-- EVENTS -->
<div jsdisplay="events && events.length > 0" class="apiGroup">
<a name="#events"></a>
<h2 id="events">Events</h2>
<!-- iterates over all events -->
<div jsselect="events" class="apiItem">
<a jsvalues=".name:'event-' + name"></a>
<h3 jscontent="name">event name</h3>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
<span class="subdued">chrome.bookmarks.</span><span jscontent="name">onEvent</span><span class="subdued">.addListener</span>(function(<span jscontent="getSignatureString(parameters)">Type param1, Type param2</span>) <span class="subdued">{...}</span>);
</div>
<div class="description">
<p class="todo" jsdisplay="!description">Undocumented.</p>
<p jsdisplay="description" jsvalues=".innerHTML:description">
A description from the json schema def of the event goes here.
</p>
<!-- PARAMETERS -->
<h4>Parameters</h4>
<dl>
<div jsselect="parameters">
<div transclude="valueTemplate">
</div>
</div>
</dl>
</div> <!-- /decription -->
</div> <!-- /apiItem -->
</div> <!-- /apiGroup -->
<!-- TYPES -->
<div jsdisplay="types && types.length > 0" class="apiGroup">
<a name="#types"></a>
<h2 id="types">Types</h2>
<!-- iterates over all types -->
<div jsselect="types" class="apiItem">
<a jsvalues=".name:'type-' + id"></a>
<h3 jscontent="id">type name</h3>
<div transclude="valueTemplate">
</div>
</div> <!-- /apiItem -->
</div> <!-- /apiGroup -->
</div> <!-- /apiPage -->
</div> <!-- /mainColumn -->
</div> <!-- /pageContent -->
<div id="pageFooter" -->
Copyright 2009
<br />
TBD: copyright/license should be automatically included here
</div> <!-- /pageFooter -->
</div> <!-- /container -->
|
