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
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
|
<!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 mechanism.
2) The <body> tag *must* retain id="body"
3) All <body>.innerHTML is genereated 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>.innerHTML is also generated by an offline step so that this
page may easily be indexed by search engines.
TODO(rafaelw): Abstract this into a "pageshell" that becomes the single
version of page template shell and the "instance" pages (bookmarks.html,
etc...) can be generated with a build step.
--><!-- <html> must retain id="template --><html xmlns="http://www.w3.org/1999/xhtml" jstcache="0"><!-- <head> data 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">Google Chrome Extensions: Developer Documentation</title>
<link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css" jstcache="0">
<script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_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 completely 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 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" name="q" size="31" jstcache="0">
<input type="submit" name="sa" value="Search" jstcache="0">
</div>
</form>
<script type="text/javascript" src="http://www.google.com/jsapi" jstcache="0"></script>
<script type="text/javascript" jstcache="0">google.load("elements", "1", {packages: "transliteration"});</script>
<script type="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="http://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">Google Chrome Extensions: Developer Documentation</h1>
</div>
</div> <!-- /pageHeader -->
<div id="pageContent" jstcache="0">
<!-- SIDENAV -->
<div id="leftNav" jstcache="0">
<ul jstcache="0">
<li jstcache="0" class="leftNavSelected">Home </li>
<li jstcache="0"> <a href="getstarted.html" jstcache="0">Getting Started</a></li>
<li jstcache="0"> <a href="overview.html" jstcache="0">Overview</a></li>
<li jstcache="0"> <a href="devguide.html" jstcache="0"><div jstcache="0">Developer's Guide</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" 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="events.html" jstcache="0">Events</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="bookmarks.html" jstcache="0">Bookmarks</a></li>
<li jstcache="0"><a href="themes.html" jstcache="0">Themes</a></li>
<li jstcache="0"><a href="npapi.html" jstcache="0">NPAPI Plugins</a></li>
<li jstcache="0"><a href="packaging.html" jstcache="0">Packaging</a></li>
<li jstcache="0">Autoupdate</li>
</ul>
</li>
<li jstcache="0"><a href="tutorials.html" jstcache="0"><div jstcache="0">Tutorials</div></a>
<ul jstcache="0">
<li jstcache="0"><a href="tut_debugging.html" jstcache="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="manifest.html" jstcache="0">Manifest Files</a></li>
<li jstcache="0"><a href="match_patterns.html" jstcache="0">Match Patterns</a></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" style="display: none; ">
<p jstcache="0">Contents</p>
<ol jstcache="0">
<li jsselect="getStaticTOC()" jstcache="9">
<a jscontent="name" jsvalues=".href:'#' + href" jstcache="14">h2Name</a>
<ol jstcache="0">
<li jsselect="$this.children" jstcache="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()" jstcache="4">API reference</a>
<ol jstcache="0">
<li jsdisplay="$this.properties" jstcache="5">
<a href="#properties" jstcache="0">Properties</a>
<ol jstcache="0">
<li jsselect="getPropertyListFromObject($this)" jstcache="10">
<a jscontent="name" jsvalues=".href:'#property-' + name" href="#property-anchor" jstcache="42">propertyName</a>
</li>
</ol>
</li>
<li jsdisplay="functions && functions.length > 0" jstcache="6">
<a href="#methods" jstcache="0">Methods</a>
<ol jstcache="0">
<li jsselect="functions.sort(sortByName)" jstcache="11">
<a jscontent="name" jsvalues=".href:'#method-' + name" href="#method-anchor" jstcache="43">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="events.sort(sortByName)" jstcache="12">
<a jscontent="name" jsvalues=".href:'#event-' + name" href="#event-anchor" jstcache="44">eventName</a>
</li>
</ol>
</li>
<li jsdisplay="types && types.length > 0" jstcache="8">
<a href="#types" jstcache="0">Types</a>
<ol jstcache="0">
<li jsselect="types.sort(sortByName)" jstcache="38">
<a jscontent="id" jsvalues=".href:'#type-' + id" href="#id-anchor" jstcache="45">id</a>
</li>
</ol>
</li>
</ol>
</li>
</div>
</ol>
</div>
<!-- /TABLE OF CONTENTS -->
<!-- STATIC CONTENT PLACEHOLDER -->
<div id="static" jstcache="0"><style jstcache="0">
#pics {
margin:2em 1em 1.5em;
}
#pics td {
text-align:center;
width:33%!important;
border:none;
padding:1em;
font-size:90%;
}
#pics img {
width:180px;
height:85px;
border:1px solid black;
}
</style>
<div id="pageData-title" class="pageData" jstcache="0">Google Chrome Extensions: Developer Documentation</div>
<h3 jstcache="0">Hello There!</h3>
<p jstcache="0">
<em jstcache="0">Extensions</em> are small software programs
that can modify and enhance the functionality of Google Chrome.
</p>
<p jstcache="0">
You write them using web technologies like
HTML, JavaScript, and CSS.
So if you know how to write web pages,
you already know most of what
you need to know to write extensions.
</p>
<p jstcache="0">
Here are some examples of what you can build with extensions:
</p>
<table id="pics" jstcache="0">
<tbody jstcache="0"><tr jstcache="0">
<td valign="top" jstcache="0">
<b jstcache="0">Toolstrips</b><br jstcache="0">
<a href="toolstrip.html" jstcache="0"><img src="images/index/toolstrip.png" jstcache="0"></a>
<br jstcache="0">
Display small toolbars in Google Chrome's chrome
</td>
<td valign="top" jstcache="0">
<b jstcache="0">Page actions</b><br jstcache="0">
<a href="pageActions.html" jstcache="0"><img src="images/index/page_action.png" jstcache="0"></a>
<br jstcache="0">
Add buttons to the Omnibox that get displayed for specific pages
</td>
<td valign="top" jstcache="0">
<b jstcache="0">Content scripts</b><br jstcache="0">
<a href="content_scripts.html" jstcache="0"><img src="images/index/content_script.png" jstcache="0"></a>
<br jstcache="0">
Modify the look and behavior of web pages
</td>
</tr>
</tbody></table>
<p jstcache="0">
This website contains all the information
you need to build extensions.
Start with one of these sections:
</p>
<ul jstcache="0">
<li jstcache="0">
<a href="getstarted.html" jstcache="0">Getting Started</a>:
Build a simple "Hello, World" extension in about 5 minutes
</li>
<li jstcache="0">
<a href="overview.html" jstcache="0">Overview</a>:
Learn about the fundamental design points of
Google Chrome's extension system
</li>
<li jstcache="0">
<a href="devguide.html" jstcache="0">Developer's Guide</a>:
Get detailed information on using each feature and API
</li>
</ul>
<p jstcache="0">
Also check out the discussion group:
<a href="http://groups.google.com/group/chromium-extensions" jstcache="0">chromium-extensions</a>
</p></div>
<!-- API PAGE -->
<div class="apiPage" jsselect="apiDefinition" jstcache="3" style="display: none; ">
<a name="apiReference" jstcache="0"></a>
<h2 jscontent="'API reference: ' + getModuleName()" jstcache="4">API reference: chrome.apiname </h2>
<!-- PROPERTIES -->
<div jsdisplay="$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 transclude="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 jstcache="0">Methods</h3>
<!-- iterates over all functions -->
<div class="apiItem" jsselect="functions.sort(sortByName)" jstcache="11">
<a jsvalues=".name:'method-' + name" jstcache="18"></a> <!-- method-anchor -->
<h4 jscontent="name" jstcache="16">method name</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 jstcache="0"><span jscontent="name" jstcache="16"></span></var></span>)</div>
<div class="description" jstcache="0">
<p class="todo" jsdisplay="!description" jstcache="28">Undocumented.</p>
<p jsdisplay="description" jsvalues=".innerHTML:description" 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 that is used elsewhere
via jsTemplate *transclude* -->
<div id="valueTemplate" jstcache="0">
<dt jstcache="0">
<var jsdisplay="$this.name" jscontent="$this.name" jstcache="46">paramName</var>
<em jstcache="0">
<!-- TYPE -->
<div style="display:inline" jstcache="0">
(
<span class="optional" jsdisplay="optional" jstcache="47">optional</span>
<span id="typeTemplate" jstcache="0">
<span jsdisplay="getTypeRef($this)" jstcache="48">
<a jsvalues=".href: getTypeRefPage($this) + '#type-' + getTypeRef($this)" jscontent="getTypeRef($this)" jstcache="50"> Type</a>
</span>
<span jsdisplay="!getTypeRef($this)" jstcache="49">
<span jsdisplay="isArray($this)" jstcache="51">
array of <span jsselect="items" jstcache="53"><span transclude="typeTemplate" jstcache="54"></span></span>
</span>
<span jsdisplay="!isArray($this)" jscontent="getTypeName($this)" jstcache="52">paramType</span>
</span>
</span>
)
</div>
</em>
</dt>
<dd class="todo" jsdisplay="!$this.description" jstcache="39">
Undocumented.
</dd>
<dd jsdisplay="$this.description" jsvalues=".innerHTML:$this.description" jstcache="40">
Description of this parameter from the json schema.
</dd>
<!-- OBJECT PROPERTIES -->
<dd jsdisplay="shouldExpandObject($this)" jstcache="41">
<dl jstcache="0">
<div jsselect="getPropertyListFromObject($this)" jstcache="10">
<div transclude="valueTemplate" jstcache="17">
</div>
</div>
</dl>
</dd>
</div> <!-- /VALUE -->
</div>
</dl>
<!-- RETURNS -->
<h4 jsdisplay="returns" jstcache="30">Returns</h4>
<dl jstcache="0">
<div jsselect="returns" jstcache="36">
<div transclude="valueTemplate" jstcache="17">
</div>
</div>
</dl>
<!-- CALLBACK -->
<div jsdisplay="hasCallback(parameters)" jstcache="31">
<div jsselect="getCallbackParameters(parameters)" jstcache="37">
<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(<span jscontent="getSignatureString(parameters)" jstcache="32">Type param1, Type param2</span>) <span class="subdued" jstcache="0">{...}</span>);</pre>
<dl jstcache="0">
<div jsselect="parameters" jstcache="35">
<div transclude="valueTemplate" jstcache="17">
</div>
</div>
</dl>
</div>
</div>
</div> <!-- /description -->
</div> <!-- /apiItem -->
</div> <!-- /apiGroup -->
<!-- EVENTS -->
<div jsdisplay="events && events.length > 0" class="apiGroup" jstcache="7">
<a name="events" jstcache="0"></a>
<h3 id="events" jstcache="0">Events</h3>
<!-- iterates over all events -->
<div jsselect="events.sort(sortByName)" class="apiItem" jstcache="12">
<a jsvalues=".name:'event-' + name" jstcache="19"></a>
<h4 jscontent="name" jstcache="16">event name</h4>
<div class="summary" jstcache="0">
<!-- Note: intentionally longer 80 columns -->
<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>);
</div>
<div class="description" jstcache="0">
<p class="todo" jsdisplay="!description" jstcache="28">Undocumented.</p>
<p jsdisplay="description" jsvalues=".innerHTML:description" jstcache="29">
A description from the json schema def of the event goes here.
</p>
<!-- PARAMETERS -->
<h4 jstcache="0">Parameters</h4>
<dl jstcache="0">
<div 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.sort(sortByName)" jstcache="0"></a>
<h3 id="types" jstcache="0">Types</h3>
<!-- iterates over all types -->
<div jsselect="types" class="apiItem" jstcache="13">
<a jsvalues=".name:'type-' + id" jstcache="20"></a>
<h4 jscontent="id" jstcache="21">type name</h4>
<div transclude="valueTemplate" jstcache="17">
</div>
</div> <!-- /apiItem -->
</div> <!-- /apiGroup -->
</div> <!-- /apiPage -->
</div> <!-- /mainColumn -->
</div> <!-- /pageContent -->
<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" href="http://creativecommons.org/licenses/by/3.0/" jstcache="0">Creative Commons
Attribution 3.0 License</a>, and code samples are licensed under the
<a rel="license" href="http://code.google.com/google_bsd_license.html" jstcache="0">BSD License</a>.
</p>
<p jstcache="0">
©2009 Google
</p>
</div> <!-- /pageFooter -->
</div> <!-- /container -->
</body></html>
#EOF
|
