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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: fix Created 8 years, 6 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 | Annotate | Revision Log
« chrome/common/extensions/docs/js/api_page_generator.js ('K') | « chrome/common/extensions/docs/tutorials.html ('k') | chrome/common/extensions/docs/webNavigation.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(Empty)
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 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
6 browser, it will be re-generated from the template, json schema and
7 authored overview content.
8 4) The <body>.innerHTML is also generated by an offline step so that this
9 page may easily be indexed by search engines.
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head>
11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print">
14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js">
15 </script>
16 <script type="text/javascript" src="../../../../third_party/json_minify/mini fy-sans-regexp.js">
17 </script>
18 <script type="text/javascript" src="js/api_page_generator.js"></script>
19 <script type="text/javascript" src="js/bootstrap.js"></script>
20 <script type="text/javascript" src="js/sidebar.js"></script>
21 <meta name="description" content="Documentation for the chrome.types module, w hich is part of the Google Chrome extension APIs."><title>Types - Google Chrome Extensions - Google Code</title></head>
22 <body> <div id="devModeWarning" class="displayModeWarning">
23 You are viewing extension docs in chrome via the 'file:' scheme: are you exp ecting to see local changes when you refresh? You'll need run chrome with --allo w-file-access-from-files.
24 </div>
25 <div id="branchWarning" class="displayModeWarning">
26 <span>WARNING: This is the <span id="branchName">BETA</span> documentation.
27 It may not work with the stable release of Chrome.</span>
28 <select id="branchChooser">
29 <option>Choose a different version...
30 </option><option value="">Stable
31 </option><option value="beta">Beta
32 </option><option value="dev">Dev
33 </option><option value="trunk">Trunk
34 </option></select>
35 </div>
36 <div id="unofficialWarning" class="displayModeWarning">
37 <span>WARNING: This is unofficial documentation. It may not work with the
38 current release of Chrome.</span>
39 <button id="goToOfficialDocs">Go to the official docs</button>
40 </div>
41 <div id="gc-container" class="labs">
42 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
43 <!-- In particular, sub-templates that recurse, must be used by allowing
44 jstemplate to make a copy of the template in this section which
45 are not operated on by way of the jsskip="true" -->
46 <!-- /SUBTEMPLATES -->
47 <a id="top"></a>
48 <div id="skipto">
49 <a href="#gc-pagecontent">Skip to page content</a>
50 <a href="#gc-toc">Skip to main navigation</a>
51 </div>
52 <!-- API HEADER -->
53 <table id="header" width="100%" cellspacing="0" border="0">
54 <tbody><tr>
55 <td valign="middle"><a href="http://code.google.com/"><img src="images/c ode_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border: 0; margin:0;"></a></td>
56 <td valign="middle" width="100%" style="padding-left:0.6em;">
57 <form action="http://www.google.com/cse" id="cse" style="margin-top:0. 5em">
58 <div id="gsc-search-box">
59 <input type="hidden" name="cx" value="002967670403910741006:61_cvz fqtno">
60 <input type="hidden" name="ie" value="UTF-8">
61 <input type="text" name="q" value="" size="55">
62 <input class="gsc-search-button" type="submit" name="sa" value="Se arch">
63 <br>
64 <span class="greytext">e.g. "page action" or "tabs"</span>
65 </div>
66 </form>
67 <script type="text/javascript" src="https://www.google.com/jsapi"></sc ript>
68 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
69 <script type="text/javascript" src="https://www.google.com/coop/cse/t1 3n?form=cse&amp;t13n_langs=en"></script>
70 <script type="text/javascript" src="https://www.google.com/coop/cse/br and?form=cse&amp;lang=en"></script>
71 </td>
72 </tr>
73 </tbody></table>
74 <div id="codesiteContent" class="">
75 <a id="gc-topnav-anchor"></a>
76 <div id="gc-topnav">
77 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab s</a>)</h1>
78 <ul id="home" class="gc-topnav-tabs">
79 <li id="home_link">
80 <a href="index.html" title="Google Chrome Extensions home page">Home </a>
81 </li>
82 <li id="docs_link">
83 <a href="docs.html" title="Official Google Chrome Extensions documen tation">Docs</a>
84 </li>
85 <li id="faq_link">
86 <a href="faq.html" title="Answers to frequently asked questions abou t Google Chrome Extensions">FAQ</a>
87 </li>
88 <li id="samples_link">
89 <a href="samples.html" title="Sample extensions (with source code)"> Samples</a>
90 </li>
91 <li id="group_link">
92 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte nsions" title="Google Chrome Extensions developer forum">Group</a>
93 </li>
94 <li id="so_link">
95 <a href="http://stackoverflow.com/questions/tagged/google-chrome-ext ension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>
96 </li>
97 </ul>
98 </div> <!-- end gc-topnav -->
99 <div class="g-section g-tpl-170">
100 <!-- SIDENAV -->
101 <div class="g-unit g-first" id="gc-toc">
102 <ul>
103 <li><a href="getstarted.html">Getting Started</a></li>
104 <li><a href="overview.html">Overview</a></li>
105 <li><a href="whats_new.html">What's New?</a></li>
106 <li><h2><a href="devguide.html">Developer's Guide</a></h2>
107 <ul>
108 <li>Browser UI
109 <ul>
110 <li><a href="browserAction.html">Browser Actions</a></li>
111 <li><a href="contextMenus.html">Context Menus</a></li>
112 <li><a href="notifications.html">Desktop Notifications</a></li >
113 <li><a href="omnibox.html">Omnibox</a></li>
114 <li><a href="options.html">Options Pages</a></li>
115 <li><a href="override.html">Override Pages</a></li>
116 <li><a href="pageAction.html">Page Actions</a></li>
117 </ul>
118 </li>
119 <li>Browser Interaction
120 <ul>
121 <li><a href="bookmarks.html">Bookmarks</a></li>
122 <li><a href="cookies.html">Cookies</a></li>
123 <li><a href="devtools.html">Developer Tools</a></li>
124 <li><a href="events.html">Events</a></li>
125 <li><a href="history.html">History</a></li>
126 <li><a href="management.html">Management</a></li>
127 <li><a href="tabs.html">Tabs</a></li>
128 <li><a href="windows.html">Windows</a></li>
129 </ul>
130 </li>
131 <li>Implementation
132 <ul>
133 <li><a href="a11y.html">Accessibility</a></li>
134 <li><a href="background_pages.html">Background Pages</a></li>
135 <li><a href="content_scripts.html">Content Scripts</a></li>
136 <li><a href="xhr.html">Cross-Origin XHR</a></li>
137 <li><a href="i18n.html">Internationalization</a></li>
138 <li><a href="messaging.html">Message Passing</a></li>
139 <li><a href="permissions.html">Optional Permissions</a></li>
140 <li><a href="npapi.html">NPAPI Plugins</a></li>
141 </ul>
142 </li>
143 <li>Finishing
144 <ul>
145 <li><a href="hosting.html">Hosting</a></li>
146 <li><a href="external_extensions.html">Other Deployment Option s</a></li>
147 </ul>
148 </li>
149 </ul>
150 </li>
151 <li><h2><a href="apps.html">Packaged Apps</a></h2></li>
152 <li><h2><a href="tutorials.html">Tutorials</a></h2>
153 <ul>
154 <li><a href="tut_debugging.html">Debugging</a></li>
155 <li><a href="tut_analytics.html">Google Analytics</a></li>
156 <li><a href="tut_oauth.html">OAuth</a></li>
157 </ul>
158 </li>
159 <li><h2>Reference</h2>
160 <ul>
161 <li>Formats
162 <ul>
163 <li><a href="manifest.html">Manifest Files</a></li>
164 <li><a href="match_patterns.html">Match Patterns</a></li>
165 </ul>
166 </li>
167 <li><a href="permission_warnings.html">Permission Warnings</a></li >
168 <li><a href="api_index.html">chrome.* APIs</a></li>
169 <li><a href="api_other.html">Other APIs</a></li>
170 </ul>
171 </li>
172 <li><h2><a href="samples.html">Samples</a></h2></li>
173 <div class="line"> </div>
174 <li><h2>More</h2>
175 <ul>
176 <li><a href="http://code.google.com/chrome/webstore/docs/index.htm l">Chrome Web Store</a></li>
177 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu ide.html">Hosted Apps</a></li>
178 <li><a href="themes.html">Themes</a></li>
179 </ul>
180 </li>
181 </ul>
182 </div>
183 <script>
184 initToggles();
185 </script>
186 <div class="g-unit" id="gc-pagecontent">
187 <div id="pageTitle">
188 <h1 class="page_title">Types</h1>
189 </div>
190 <!-- TABLE OF CONTENTS -->
191 <div id="toc">
192 <h2>Contents</h2>
193 <ol>
194 <li>
195 <a href="#ChromeSetting">Chrome settings</a>
196 <ol>
197 <li>
198 <a href="#ChromeSetting-lifecycle">Scope and life cycle</a>
199 </li><li>
200 <a href="#ChromeSetting-precedence">Precedence</a>
201 </li>
202 </ol>
203 </li>
204 <li>
205 <a href="#apiReference">API reference: chrome.types</a>
206 <ol>
207 <li>
208 <a href="#types">Types</a>
209 <ol>
210 <li>
211 <a href="#type-ChromeSetting">ChromeSetting</a>
212 <ol>
213 <li>
214 <a href="#global-ChromeSetting-methods">Methods</a>
215 <ol>
216 <li>
217 <a href="#method-ChromeSetting-clear">clear</a>
218 </li><li>
219 <a href="#method-ChromeSetting-get">get</a>
220 </li><li>
221 <a href="#method-ChromeSetting-set">set</a>
222 </li>
223 </ol>
224 </li>
225 <li>
226 <a href="#global-ChromeSetting-events">Events</a>
227 <ol>
228 <li>
229 <a href="#event-ChromeSetting-onChange">onChange</a>
230 </li>
231 </ol>
232 </li>
233 </ol>
234 </li>
235 </ol>
236 </li>
237 </ol>
238 </li>
239 </ol>
240 </div>
241 <!-- /TABLE OF CONTENTS -->
242 <!-- Standard content lead-in for experimental API pages -->
243 <!-- STATIC CONTENT PLACEHOLDER -->
244 <div id="static"><div id="pageData-name" class="pageData">Types</div>
245 <!-- BEGIN AUTHORED CONTENT -->
246 <p id="classSummary">
247 The <code>chrome.types</code> module contains type declarations for Chrome.
248 Currently this comprises only a prototype for giving other
249 modules access to manage Chrome browser settings. This prototype is used,
250 for example, for <a href="proxy.html#property-settings"><code>chrome.proxy.setti ngs</code></a>.
251 </p>
252 <h2 id="ChromeSetting">Chrome settings</h2>
253 <p>
254 The <code>ChromeSetting</code> prototype provides a common set of functions
255 (<code>get()</code>, <code>set()</code>, and <code>clear()</code>) as
256 well as an event publisher (<code>onChange</code>) for settings of the
257 Chrome browser. The <a href="proxy.html#overview-examples">proxy settings
258 examples</a> demonstrate how these functions are intended to be used.
259 </p>
260 <h3 id="ChromeSetting-lifecycle">Scope and life cycle</h3>
261 <p>
262 Chrome distinguishes between three different scopes of browser settings:
263 </p><dl>
264 <dt><code>regular</code></dt>
265 <dd>Settings set in the <code>regular</code> scope apply to regular
266 browser windows and are inherited by incognito windows if they are not
267 overwritten. These settings are stored to disk and remain in place until
268 they are cleared by the governing extension, or the governing extension is
269 disabled or uninstalled.</dd>
270 <dt><code>incognito_persistent</code></dt>
271 <dd>Settings set in the <code>incognito_persistent</code> scope apply only
272 to incognito windows. For these, they override <code>regular</code>
273 settings. These settings are stored to disk and remain in place until
274 they are cleared by the governing extension, or the governing extension is
275 disabled or uninstalled.</dd>
276 <dt><code>incognito_session_only</code></dt>
277 <dd>Settings set in the <code>incognito_session_only</code> scope apply only
278 to incognito windows. For these, they override <code>regular</code> and
279 <code>incognito_session_only</code> settings. These settings are not
280 stored to disk and are cleared when the last incognito window is closed. They
281 can only be set when at least one incognito window is open.</dd>
282 </dl>
283 <p></p>
284 <h3 id="ChromeSetting-precedence">Precedence</h3>
285 <p>
286 Chrome manages settings on different layers. The following list describes the
287 layers that may influence the effective settings, in increasing order of
288 precedence.
289 </p><ol>
290 <li>System settings provided by the operating system</li>
291 <li>Command-line parameters</li>
292 <li>Settings provided by extensions</li>
293 <li>Policies</li>
294 </ol>
295 <p></p>
296 <p>
297 As the list implies, policies might overrule any changes that you specify with
298 your extension. You can use the <code>get()</code> function to determine whether
299 your extension is capable of providing a setting or whether this setting would
300 be overridden.
301 </p>
302 <p>
303 As discussed above, Chrome allows using different settings for regular
304 windows and incognito windows. The following example illustrates the behavior.
305 Assume that no policy overrides the settings and that an extension can set
306 settings for regular windows <b>(R)</b> and settings for incognito windows
307 <b>(I)</b>.
308 </p>
309 <p>
310 </p><ul>
311 <li>If only <b>(R)</b> is set, these settings are effective for both
312 regular and incognito windows.</li>
313 <li>If only <b>(I)</b> is set, these settings are effective for only
314 incognito windows. Regular windows use the settings determined by the lower
315 layers (command-line options and system settings).</li>
316 <li>If both <b>(R)</b> and <b>(I)</b> are set, the respective settings are
317 used for regular and incognito windows.</li>
318 </ul>
319 <p></p>
320 <p>
321 If two or more extensions want to set the same setting to different values,
322 the extension installed most recently takes precedence over the other
323 extensions. If the most recently installed extension sets only <b>(I)</b>, the
324 settings of regular windows can be defined by previously installed extensions.
325 </p>
326 <p>
327 The <em>effective</em> value of a setting is the one that results from
328 considering the precedence rules. It is used by Chrome.
329 </p><p>
330 <!-- END AUTHORED CONTENT -->
331 </p></div>
332 <!-- API PAGE -->
333 <div class="apiPage">
334 <a name="apiReference"></a>
335 <h2>API reference: chrome.types</h2>
336 <!-- PROPERTIES -->
337 <!-- /apiGroup -->
338 <!-- METHODS -->
339 <!-- /apiGroup -->
340 <!-- EVENTS -->
341 <!-- /apiGroup -->
342 <!-- TYPES -->
343 <div class="apiGroup">
344 <a name="types"></a>
345 <h3 id="types">Types</h3>
346 <!-- iterates over all types -->
347 <div class="apiItem">
348 <a name="type-ChromeSetting"></a>
349 <h4>ChromeSetting</h4>
350 <div>
351 <dt>
352 <em>
353 <!-- TYPE -->
354 <div style="display:inline">
355 (
356 <span id="typeTemplate">
357 <span>
358 <span>object</span>
359 </span>
360 </span>
361 )
362 </div>
363 </em>
364 </dt>
365 <dd>An interface which allows access to a Chrome browser setting.</dd>
366 <!-- OBJECT PROPERTIES -->
367 <!-- OBJECT METHODS -->
368 <dd>
369 <div class="apiGroup">
370 <a name="global-ChromeSetting-methods"></a>
371 <h3>Methods of ChromeSetting</h3>
372 <!-- iterates over all functions -->
373 <div class="apiItem">
374 <a name="method-ChromeSetting-clear"></a> <!-- method-anchor -->
375 <h4>clear</h4>
376 <div class="summary">
377 <!-- Note: intentionally longer 80 columns -->
378 <span>chromeSetting.clear</span>(<span class="null"><span>obje ct</span>
379 <var><span>details</span></var></span><span class="optiona l"><span>, </span><span>function</span>
380 <var><span>callback</span></var></span>)</div>
381 <div class="description">
382 <p>Clears the setting. This way default settings can become effe ctive again.</p>
383 <!-- PARAMETERS -->
384 <h4>Parameters</h4>
385 <dl>
386 <div>
387 <div>
388 <dt>
389 <var>details</var>
390 <em>
391 <!-- TYPE -->
392 <div style="display:inline">
393 (
394 <span id="typeTemplate">
395 <span>
396 <span>object</span>
397 </span>
398 </span>
399 )
400 </div>
401 </em>
402 </dt>
403 <dd>What setting to clear.</dd>
404 <!-- OBJECT PROPERTIES -->
405 <dd>
406 <dl>
407 <div>
408 <div>
409 <dt>
410 <var>scope</var>
411 <em>
412 <!-- TYPE -->
413 <div style="display:inline">
414 (
415 <span class="optional">optional</span>
416 <span class="enum">enumerated</span>
417 <span id="typeTemplate">
418 <span>
419 <span>string</span>
420 <span>["regular", "incognito_persistent", "incognito_ses sion_only"]</span>
421 </span>
422 </span>
423 )
424 </div>
425 </em>
426 </dt>
427 <dd>Where to clear the setting (default: regular). One of<br><var>regu lar</var>: setting for the regular profile (which is inherited by the incognito profile if not overridden elsewhere),<br><var>regular_only</var>: setting for th e regular profile only (not inherited by the incognito profile),<br><var>incogni to_persistent</var>: setting for the incognito profile that survives browser res tarts (overrides regular preferences),<br><var>incognito_session_only</var>: set ting for the incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular and incognito_ persistent preferences).</dd>
428 <!-- OBJECT PROPERTIES -->
429 <!-- OBJECT METHODS -->
430 <!-- OBJECT EVENT FIELDS -->
431 <!-- FUNCTION PARAMETERS -->
432 </div>
433 </div>
434 </dl>
435 </dd>
436 <!-- OBJECT METHODS -->
437 <!-- OBJECT EVENT FIELDS -->
438 <!-- FUNCTION PARAMETERS -->
439 </div>
440 </div><div>
441 <div>
442 <dt>
443 <var>callback</var>
444 <em>
445 <!-- TYPE -->
446 <div style="display:inline">
447 (
448 <span class="optional">optional</span>
449 <span id="typeTemplate">
450 <span>
451 <span>function</span>
452 </span>
453 </span>
454 )
455 </div>
456 </em>
457 </dt>
458 <dd>Called after the setting has been cleared.</dd>
459 <!-- OBJECT PROPERTIES -->
460 <!-- OBJECT METHODS -->
461 <!-- OBJECT EVENT FIELDS -->
462 <!-- FUNCTION PARAMETERS -->
463 </div>
464 </div>
465 </dl>
466 <!-- RETURNS -->
467 <dl>
468 </dl>
469 <!-- CALLBACK -->
470 <div>
471 <div>
472 <h4>Callback function</h4>
473 <p>
474 If you specify the <em>callback</em> parameter, it should
475 specify a function that looks like this:
476 </p>
477 <!-- Note: intentionally longer 80 columns -->
478 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
479 <dl>
480 </dl>
481 </div>
482 </div>
483 <!-- MIN_VERSION -->
484 </div> <!-- /description -->
485 </div><div class="apiItem">
486 <a name="method-ChromeSetting-get"></a> <!-- method-anchor -->
487 <h4>get</h4>
488 <div class="summary">
489 <!-- Note: intentionally longer 80 columns -->
490 <span>chromeSetting.get</span>(<span class="null"><span>object </span>
491 <var><span>details</span></var></span><span class="null">< span>, </span><span>function</span>
492 <var><span>callback</span></var></span>)</div>
493 <div class="description">
494 <p>Gets the value of a setting.</p>
495 <!-- PARAMETERS -->
496 <h4>Parameters</h4>
497 <dl>
498 <div>
499 <div>
500 <dt>
501 <var>details</var>
502 <em>
503 <!-- TYPE -->
504 <div style="display:inline">
505 (
506 <span id="typeTemplate">
507 <span>
508 <span>object</span>
509 </span>
510 </span>
511 )
512 </div>
513 </em>
514 </dt>
515 <dd>What setting to consider.</dd>
516 <!-- OBJECT PROPERTIES -->
517 <dd>
518 <dl>
519 <div>
520 <div>
521 <dt>
522 <var>incognito</var>
523 <em>
524 <!-- TYPE -->
525 <div style="display:inline">
526 (
527 <span class="optional">optional</span>
528 <span id="typeTemplate">
529 <span>
530 <span>boolean</span>
531 </span>
532 </span>
533 )
534 </div>
535 </em>
536 </dt>
537 <dd>Whether to return the setting that applies to the incognito sessio n (default false).</dd>
538 <!-- OBJECT PROPERTIES -->
539 <!-- OBJECT METHODS -->
540 <!-- OBJECT EVENT FIELDS -->
541 <!-- FUNCTION PARAMETERS -->
542 </div>
543 </div>
544 </dl>
545 </dd>
546 <!-- OBJECT METHODS -->
547 <!-- OBJECT EVENT FIELDS -->
548 <!-- FUNCTION PARAMETERS -->
549 </div>
550 </div><div>
551 <div>
552 <dt>
553 <var>callback</var>
554 <em>
555 <!-- TYPE -->
556 <div style="display:inline">
557 (
558 <span id="typeTemplate">
559 <span>
560 <span>function</span>
561 </span>
562 </span>
563 )
564 </div>
565 </em>
566 </dt>
567 <dd class="todo">
568 Undocumented.
569 </dd>
570 <!-- OBJECT PROPERTIES -->
571 <!-- OBJECT METHODS -->
572 <!-- OBJECT EVENT FIELDS -->
573 <!-- FUNCTION PARAMETERS -->
574 </div>
575 </div>
576 </dl>
577 <!-- RETURNS -->
578 <dl>
579 </dl>
580 <!-- CALLBACK -->
581 <div>
582 <div>
583 <h4>Callback function</h4>
584 <p>
585 The <em>callback</em> parameter should specify a function
586 that looks like this:
587 </p>
588 <!-- Note: intentionally longer 80 columns -->
589 <pre>function(<span>object details</span>) <span class="subdue d">{...}</span>;</pre>
590 <dl>
591 <div>
592 <div>
593 <dt>
594 <var>details</var>
595 <em>
596 <!-- TYPE -->
597 <div style="display:inline">
598 (
599 <span id="typeTemplate">
600 <span>
601 <span>object</span>
602 </span>
603 </span>
604 )
605 </div>
606 </em>
607 </dt>
608 <dd>Details of the currently effective value.</dd>
609 <!-- OBJECT PROPERTIES -->
610 <dd>
611 <dl>
612 <div>
613 <div>
614 <dt>
615 <var>value</var>
616 <em>
617 <!-- TYPE -->
618 <div style="display:inline">
619 (
620 <span id="typeTemplate">
621 <span>
622 <span>any</span>
623 </span>
624 </span>
625 )
626 </div>
627 </em>
628 </dt>
629 <dd>The value of the setting.</dd>
630 <!-- OBJECT PROPERTIES -->
631 <!-- OBJECT METHODS -->
632 <!-- OBJECT EVENT FIELDS -->
633 <!-- FUNCTION PARAMETERS -->
634 </div>
635 </div><div>
636 <div>
637 <dt>
638 <var>levelOfControl</var>
639 <em>
640 <!-- TYPE -->
641 <div style="display:inline">
642 (
643 <span class="enum">enumerated</span>
644 <span id="typeTemplate">
645 <span>
646 <span>string</span>
647 <span>["not_controllable", "controlled_by_other_extensio ns", "controllable_by_this_extension", "controlled_by_this_extension"]</span>
648 </span>
649 </span>
650 )
651 </div>
652 </em>
653 </dt>
654 <dd>One of<br><var>not_controllable</var>: cannot be controlled by any extension<br><var>controlled_by_other_extensions</var>: controlled by extension s with higher precedence<br><var>controllable_by_this_extension</var>: can be co ntrolled by this extension<br><var>controlled_by_this_extension</var>: controlle d by this extension</dd>
655 <!-- OBJECT PROPERTIES -->
656 <!-- OBJECT METHODS -->
657 <!-- OBJECT EVENT FIELDS -->
658 <!-- FUNCTION PARAMETERS -->
659 </div>
660 </div><div>
661 <div>
662 <dt>
663 <var>incognitoSpecific</var>
664 <em>
665 <!-- TYPE -->
666 <div style="display:inline">
667 (
668 <span class="optional">optional</span>
669 <span id="typeTemplate">
670 <span>
671 <span>boolean</span>
672 </span>
673 </span>
674 )
675 </div>
676 </em>
677 </dt>
678 <dd>Whether the effective value is specific to the incognito session.< br>This property will <em>only</em> be present if the <var>incognito</var> prope rty in the <var>details</var> parameter of <code>get()</code> was true.</dd>
679 <!-- OBJECT PROPERTIES -->
680 <!-- OBJECT METHODS -->
681 <!-- OBJECT EVENT FIELDS -->
682 <!-- FUNCTION PARAMETERS -->
683 </div>
684 </div>
685 </dl>
686 </dd>
687 <!-- OBJECT METHODS -->
688 <!-- OBJECT EVENT FIELDS -->
689 <!-- FUNCTION PARAMETERS -->
690 </div>
691 </div>
692 </dl>
693 </div>
694 </div>
695 <!-- MIN_VERSION -->
696 </div> <!-- /description -->
697 </div><div class="apiItem">
698 <a name="method-ChromeSetting-set"></a> <!-- method-anchor -->
699 <h4>set</h4>
700 <div class="summary">
701 <!-- Note: intentionally longer 80 columns -->
702 <span>chromeSetting.set</span>(<span class="null"><span>object </span>
703 <var><span>details</span></var></span><span class="optiona l"><span>, </span><span>function</span>
704 <var><span>callback</span></var></span>)</div>
705 <div class="description">
706 <p>Sets the value of a setting.</p>
707 <!-- PARAMETERS -->
708 <h4>Parameters</h4>
709 <dl>
710 <div>
711 <div>
712 <dt>
713 <var>details</var>
714 <em>
715 <!-- TYPE -->
716 <div style="display:inline">
717 (
718 <span id="typeTemplate">
719 <span>
720 <span>object</span>
721 </span>
722 </span>
723 )
724 </div>
725 </em>
726 </dt>
727 <dd>What setting to change.</dd>
728 <!-- OBJECT PROPERTIES -->
729 <dd>
730 <dl>
731 <div>
732 <div>
733 <dt>
734 <var>value</var>
735 <em>
736 <!-- TYPE -->
737 <div style="display:inline">
738 (
739 <span id="typeTemplate">
740 <span>
741 <span>any</span>
742 </span>
743 </span>
744 )
745 </div>
746 </em>
747 </dt>
748 <dd>The value of the setting. <br>Note that every setting has a specif ic value type, which is described together with the setting. An extension should <em>not</em> set a value of a different type.</dd>
749 <!-- OBJECT PROPERTIES -->
750 <!-- OBJECT METHODS -->
751 <!-- OBJECT EVENT FIELDS -->
752 <!-- FUNCTION PARAMETERS -->
753 </div>
754 </div><div>
755 <div>
756 <dt>
757 <var>scope</var>
758 <em>
759 <!-- TYPE -->
760 <div style="display:inline">
761 (
762 <span class="optional">optional</span>
763 <span class="enum">enumerated</span>
764 <span id="typeTemplate">
765 <span>
766 <span>string</span>
767 <span>["regular", "regular_only", "incognito_persistent" , "incognito_session_only"]</span>
768 </span>
769 </span>
770 )
771 </div>
772 </em>
773 </dt>
774 <dd>Where to set the setting (default: regular). One of<br><var>regula r</var>: setting for the regular profile (which is inherited by the incognito pr ofile if not overridden elsewhere),<br><var>regular_only</var>: setting for the regular profile only (not inherited by the incognito profile),<br><var>incognito _persistent</var>: setting for the incognito profile that survives browser resta rts (overrides regular preferences),<br><var>incognito_session_only</var>: setti ng for the incognito profile that can only be set during an incognito session an d is deleted when the incognito session ends (overrides regular and incognito_pe rsistent preferences).</dd>
775 <!-- OBJECT PROPERTIES -->
776 <!-- OBJECT METHODS -->
777 <!-- OBJECT EVENT FIELDS -->
778 <!-- FUNCTION PARAMETERS -->
779 </div>
780 </div>
781 </dl>
782 </dd>
783 <!-- OBJECT METHODS -->
784 <!-- OBJECT EVENT FIELDS -->
785 <!-- FUNCTION PARAMETERS -->
786 </div>
787 </div><div>
788 <div>
789 <dt>
790 <var>callback</var>
791 <em>
792 <!-- TYPE -->
793 <div style="display:inline">
794 (
795 <span class="optional">optional</span>
796 <span id="typeTemplate">
797 <span>
798 <span>function</span>
799 </span>
800 </span>
801 )
802 </div>
803 </em>
804 </dt>
805 <dd>Called after the setting has been set.</dd>
806 <!-- OBJECT PROPERTIES -->
807 <!-- OBJECT METHODS -->
808 <!-- OBJECT EVENT FIELDS -->
809 <!-- FUNCTION PARAMETERS -->
810 </div>
811 </div>
812 </dl>
813 <!-- RETURNS -->
814 <dl>
815 </dl>
816 <!-- CALLBACK -->
817 <div>
818 <div>
819 <h4>Callback function</h4>
820 <p>
821 If you specify the <em>callback</em> parameter, it should
822 specify a function that looks like this:
823 </p>
824 <!-- Note: intentionally longer 80 columns -->
825 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
826 <dl>
827 </dl>
828 </div>
829 </div>
830 <!-- MIN_VERSION -->
831 </div> <!-- /description -->
832 </div> <!-- /apiItem -->
833 </div>
834 </dd>
835 <!-- OBJECT EVENT FIELDS -->
836 <dd>
837 <div class="apiGroup">
838 <a name="global-ChromeSetting-events"></a>
839 <h3>Events of ChromeSetting</h3>
840 <!-- iterates over all events -->
841 <div class="apiItem">
842 <a name="event-ChromeSetting-onChange"></a>
843 <h4>onChange</h4>
844 <div class="summary">
845 <!-- Note: intentionally longer 80 columns -->
846 <span class="subdued">chromeSetting.</span><span>onChange</span> <span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span><span></span>);
847 </div>
848 <div class="description">
849 <p>Fired when the value of the setting changes.</p>
850 <!-- LISTENER PARAMETERS -->
851 <div>
852 <h4>Listener parameters</h4>
853 <dl>
854 <div>
855 <div>
856 <dt>
857 <var>details</var>
858 <em>
859 <!-- TYPE -->
860 <div style="display:inline">
861 (
862 <span id="typeTemplate">
863 <span>
864 <span>object</span>
865 </span>
866 </span>
867 )
868 </div>
869 </em>
870 </dt>
871 <dd class="todo">
872 Undocumented.
873 </dd>
874 <!-- OBJECT PROPERTIES -->
875 <dd>
876 <dl>
877 <div>
878 <div>
879 <dt>
880 <var>value</var>
881 <em>
882 <!-- TYPE -->
883 <div style="display:inline">
884 (
885 <span id="typeTemplate">
886 <span>
887 <span>any</span>
888 </span>
889 </span>
890 )
891 </div>
892 </em>
893 </dt>
894 <dd>The value of the setting.</dd>
895 <!-- OBJECT PROPERTIES -->
896 <!-- OBJECT METHODS -->
897 <!-- OBJECT EVENT FIELDS -->
898 <!-- FUNCTION PARAMETERS -->
899 </div>
900 </div><div>
901 <div>
902 <dt>
903 <var>levelOfControl</var>
904 <em>
905 <!-- TYPE -->
906 <div style="display:inline">
907 (
908 <span class="enum">enumerated</span>
909 <span id="typeTemplate">
910 <span>
911 <span>string</span>
912 <span>["not_controllable", "controlled_by_other_extensio ns", "controllable_by_this_extension", "controlled_by_this_extension"]</span>
913 </span>
914 </span>
915 )
916 </div>
917 </em>
918 </dt>
919 <dd>One of<br><var>not_controllable</var>: cannot be controlled by any extension<br><var>controlled_by_other_extensions</var>: controlled by extension s with higher precedence<br><var>controllable_by_this_extension</var>: can be co ntrolled by this extension<br><var>controlled_by_this_extension</var>: controlle d by this extension</dd>
920 <!-- OBJECT PROPERTIES -->
921 <!-- OBJECT METHODS -->
922 <!-- OBJECT EVENT FIELDS -->
923 <!-- FUNCTION PARAMETERS -->
924 </div>
925 </div><div>
926 <div>
927 <dt>
928 <var>incognitoSpecific</var>
929 <em>
930 <!-- TYPE -->
931 <div style="display:inline">
932 (
933 <span class="optional">optional</span>
934 <span id="typeTemplate">
935 <span>
936 <span>boolean</span>
937 </span>
938 </span>
939 )
940 </div>
941 </em>
942 </dt>
943 <dd>Whether the value that has changed is specific to the incognito se ssion.<br>This property will <em>only</em> be present if the user has enabled th e extension in incognito mode.</dd>
944 <!-- OBJECT PROPERTIES -->
945 <!-- OBJECT METHODS -->
946 <!-- OBJECT EVENT FIELDS -->
947 <!-- FUNCTION PARAMETERS -->
948 </div>
949 </div>
950 </dl>
951 </dd>
952 <!-- OBJECT METHODS -->
953 <!-- OBJECT EVENT FIELDS -->
954 <!-- FUNCTION PARAMETERS -->
955 </div>
956 </div>
957 </dl>
958 </div>
959 <!-- EXTRA PARAMETERS -->
960 <!-- LISTENER RETURN VALUE -->
961 <dl>
962 </dl>
963 </div> <!-- /description -->
964 <!-- /description -->
965 </div> <!-- /apiItem -->
966 </div>
967 </dd>
968 <!-- FUNCTION PARAMETERS -->
969 </div>
970 </div> <!-- /apiItem -->
971 </div> <!-- /apiGroup -->
972 </div> <!-- /apiPage -->
973 </div> <!-- /gc-pagecontent -->
974 </div> <!-- /g-section -->
975 </div> <!-- /codesiteContent -->
976 <div id="gc-footer" --="">
977 <div class="text">
978 <p>
979 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
980 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
981 Attribution 3.0 License</a>, and code samples are licensed under the
982 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
983 </p>
984 <p>
985 ©2011 Google
986 </p>
987 <!-- begin analytics -->
988 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>
989 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>
990 <script type="text/javascript">
991 // chrome doc tracking
992 try {
993 var engdocs = _gat._getTracker("YT-10763712-2");
994 engdocs._trackPageview();
995 } catch(err) {}
996 // code.google.com site-wide tracking
997 try {
998 _uacct="UA-18071-1";
999 _uanchor=1;
1000 _uff=0;
1001 urchinTracker();
1002 }
1003 catch(e) {/* urchinTracker not available. */}
1004 </script>
1005 <!-- end analytics -->
1006 </div>
1007 </div> <!-- /gc-footer -->
1008 </div> <!-- /gc-container -->
1009 </body></html>
OLDNEW
« chrome/common/extensions/docs/js/api_page_generator.js ('K') | « chrome/common/extensions/docs/tutorials.html ('k') | chrome/common/extensions/docs/webNavigation.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698