OLD | NEW |
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc.
Note: | 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 | 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 | 3 across api docs and should be edited only with knowledge of the |
4 templating mechanism. | 4 templating mechanism. |
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a | 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 | 6 browser, it will be re-generated from the template, json schema and |
7 authored overview content. | 7 authored overview content. |
8 4) The <body>.innerHTML is also generated by an offline step so that this | 8 4) The <body>.innerHTML is also generated by an offline step so that this |
9 page may easily be indexed by search engines. | 9 page may easily be indexed by search engines. |
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> | 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> |
(...skipping 192 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
203 </li> | 203 </li> |
204 </ol> | 204 </ol> |
205 </li> | 205 </li> |
206 <li> | 206 <li> |
207 <a href="#apiReference">API reference: chrome.types</a> | 207 <a href="#apiReference">API reference: chrome.types</a> |
208 <ol> | 208 <ol> |
209 <li> | 209 <li> |
210 <a href="#types">Types</a> | 210 <a href="#types">Types</a> |
211 <ol> | 211 <ol> |
212 <li> | 212 <li> |
213 <a href="#type-ChromeSetting">null</a> | 213 <a href="#type-types.ChromeSetting">ChromeSetting</a> |
214 <ol> | 214 <ol> |
215 <li> | 215 <li> |
216 <a href="#global-ChromeSetting-methods">Methods</a> | 216 <a href="#global-types.ChromeSetting-methods">Methods</a> |
217 <ol> | 217 <ol> |
218 <li> | 218 <li> |
219 <a href="#method-ChromeSetting-clear">clear</a> | 219 <a href="#method-types.ChromeSetting-clear">clear</a> |
220 </li><li> | 220 </li><li> |
221 <a href="#method-ChromeSetting-get">get</a> | 221 <a href="#method-types.ChromeSetting-get">get</a> |
222 </li><li> | 222 </li><li> |
223 <a href="#method-ChromeSetting-set">set</a> | 223 <a href="#method-types.ChromeSetting-set">set</a> |
224 </li> | 224 </li> |
225 </ol> | 225 </ol> |
226 </li> | 226 </li> |
227 <li> | 227 <li> |
228 <a href="#global-ChromeSetting-events">Events</a> | 228 <a href="#global-types.ChromeSetting-events">Events</a> |
229 <ol> | 229 <ol> |
230 <li> | 230 <li> |
231 <a href="#event-ChromeSetting-onChange">onChange</a> | 231 <a href="#event-types.ChromeSetting-onChange">onChange</a> |
232 </li> | 232 </li> |
233 </ol> | 233 </ol> |
234 </li> | 234 </li> |
235 </ol> | 235 </ol> |
236 </li> | 236 </li> |
237 </ol> | 237 </ol> |
238 </li> | 238 </li> |
239 </ol> | 239 </ol> |
240 </li> | 240 </li> |
241 </ol> | 241 </ol> |
(...skipping 98 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
340 <!-- METHODS --> | 340 <!-- METHODS --> |
341 <!-- /apiGroup --> | 341 <!-- /apiGroup --> |
342 <!-- EVENTS --> | 342 <!-- EVENTS --> |
343 <!-- /apiGroup --> | 343 <!-- /apiGroup --> |
344 <!-- TYPES --> | 344 <!-- TYPES --> |
345 <div class="apiGroup"> | 345 <div class="apiGroup"> |
346 <a name="types"></a> | 346 <a name="types"></a> |
347 <h3 id="types">Types</h3> | 347 <h3 id="types">Types</h3> |
348 <!-- iterates over all types --> | 348 <!-- iterates over all types --> |
349 <div class="apiItem"> | 349 <div class="apiItem"> |
350 <a name="type-ChromeSetting"></a> | 350 <a name="type-types.ChromeSetting"></a> |
351 <h4>ChromeSetting</h4> | 351 <h4>types.ChromeSetting</h4> |
352 <div> | 352 <div> |
353 <dt> | 353 <dt> |
354 <em> | 354 <em> |
355 <!-- TYPE --> | 355 <!-- TYPE --> |
356 <div style="display:inline"> | 356 <div style="display:inline"> |
357 ( | 357 ( |
358 <span id="typeTemplate"> | 358 <span id="typeTemplate"> |
359 <span> | 359 <span> |
360 <span>object</span> | 360 <span>object</span> |
361 </span> | 361 </span> |
362 </span> | 362 </span> |
363 ) | 363 ) |
364 </div> | 364 </div> |
365 </em> | 365 </em> |
366 </dt> | 366 </dt> |
367 <dd>An interface which allows access to a Chrome browser setting.</dd> | 367 <dd>An interface which allows access to a Chrome browser setting.</dd> |
368 <!-- OBJECT PROPERTIES --> | 368 <!-- OBJECT PROPERTIES --> |
369 <!-- OBJECT METHODS --> | 369 <!-- OBJECT METHODS --> |
370 <dd> | 370 <dd> |
371 <div class="apiGroup"> | 371 <div class="apiGroup"> |
372 <a name="global-ChromeSetting-methods"></a> | 372 <a name="global-types.ChromeSetting-methods"></a> |
373 <h3>Methods of ChromeSetting</h3> | 373 <h3>Methods of types.ChromeSetting</h3> |
374 <!-- iterates over all functions --> | 374 <!-- iterates over all functions --> |
375 <div class="apiItem"> | 375 <div class="apiItem"> |
376 <a name="method-ChromeSetting-clear"></a> <!-- method-anchor --> | 376 <a name="method-types.ChromeSetting-clear"></a> <!-- method-anchor
--> |
377 <h4>clear</h4> | 377 <h4>clear</h4> |
378 <div class="summary"> | 378 <div class="summary"> |
379 <!-- Note: intentionally longer 80 columns --> | 379 <!-- Note: intentionally longer 80 columns --> |
380 <span>chromeSetting.clear</span>(<span class="null"><span>obje
ct</span> | 380 <span>types.ChromeSetting.clear</span>(<span class="null"><spa
n>object</span> |
381 <var><span>details</span></var></span><span class="optiona
l"><span>, </span><span>function</span> | 381 <var><span>details</span></var></span><span class="optiona
l"><span>, </span><span>function</span> |
382 <var><span>callback</span></var></span>)</div> | 382 <var><span>callback</span></var></span>)</div> |
383 <div class="description"> | 383 <div class="description"> |
384 <p>Clears the setting. This way default settings can become effe
ctive again.</p> | 384 <p>Clears the setting. This way default settings can become effe
ctive again.</p> |
385 <!-- PARAMETERS --> | 385 <!-- PARAMETERS --> |
386 <h4>Parameters</h4> | 386 <h4>Parameters</h4> |
387 <dl> | 387 <dl> |
388 <div> | 388 <div> |
389 <div> | 389 <div> |
390 <dt> | 390 <dt> |
(...skipping 74 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
465 </div> | 465 </div> |
466 </div> | 466 </div> |
467 </dl> | 467 </dl> |
468 <!-- RETURNS --> | 468 <!-- RETURNS --> |
469 <dl> | 469 <dl> |
470 </dl> | 470 </dl> |
471 <!-- CALLBACK --> | 471 <!-- CALLBACK --> |
472 <!-- MIN_VERSION --> | 472 <!-- MIN_VERSION --> |
473 </div> <!-- /description --> | 473 </div> <!-- /description --> |
474 </div><div class="apiItem"> | 474 </div><div class="apiItem"> |
475 <a name="method-ChromeSetting-get"></a> <!-- method-anchor --> | 475 <a name="method-types.ChromeSetting-get"></a> <!-- method-anchor -
-> |
476 <h4>get</h4> | 476 <h4>get</h4> |
477 <div class="summary"> | 477 <div class="summary"> |
478 <!-- Note: intentionally longer 80 columns --> | 478 <!-- Note: intentionally longer 80 columns --> |
479 <span>chromeSetting.get</span>(<span class="null"><span>object
</span> | 479 <span>types.ChromeSetting.get</span>(<span class="null"><span>
object</span> |
480 <var><span>details</span></var></span><span class="null"><
span>, </span><span>function</span> | 480 <var><span>details</span></var></span><span class="null"><
span>, </span><span>function</span> |
481 <var><span>callback</span></var></span>)</div> | 481 <var><span>callback</span></var></span>)</div> |
482 <div class="description"> | 482 <div class="description"> |
483 <p>Gets the value of a setting.</p> | 483 <p>Gets the value of a setting.</p> |
484 <!-- PARAMETERS --> | 484 <!-- PARAMETERS --> |
485 <h4>Parameters</h4> | 485 <h4>Parameters</h4> |
486 <dl> | 486 <dl> |
487 <div> | 487 <div> |
488 <div> | 488 <div> |
489 <dt> | 489 <dt> |
(...skipping 73 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
563 </div> | 563 </div> |
564 </div> | 564 </div> |
565 </dl> | 565 </dl> |
566 <!-- RETURNS --> | 566 <!-- RETURNS --> |
567 <dl> | 567 <dl> |
568 </dl> | 568 </dl> |
569 <!-- CALLBACK --> | 569 <!-- CALLBACK --> |
570 <!-- MIN_VERSION --> | 570 <!-- MIN_VERSION --> |
571 </div> <!-- /description --> | 571 </div> <!-- /description --> |
572 </div><div class="apiItem"> | 572 </div><div class="apiItem"> |
573 <a name="method-ChromeSetting-set"></a> <!-- method-anchor --> | 573 <a name="method-types.ChromeSetting-set"></a> <!-- method-anchor -
-> |
574 <h4>set</h4> | 574 <h4>set</h4> |
575 <div class="summary"> | 575 <div class="summary"> |
576 <!-- Note: intentionally longer 80 columns --> | 576 <!-- Note: intentionally longer 80 columns --> |
577 <span>chromeSetting.set</span>(<span class="null"><span>object
</span> | 577 <span>types.ChromeSetting.set</span>(<span class="null"><span>
object</span> |
578 <var><span>details</span></var></span><span class="optiona
l"><span>, </span><span>function</span> | 578 <var><span>details</span></var></span><span class="optiona
l"><span>, </span><span>function</span> |
579 <var><span>callback</span></var></span>)</div> | 579 <var><span>callback</span></var></span>)</div> |
580 <div class="description"> | 580 <div class="description"> |
581 <p>Sets the value of a setting.</p> | 581 <p>Sets the value of a setting.</p> |
582 <!-- PARAMETERS --> | 582 <!-- PARAMETERS --> |
583 <h4>Parameters</h4> | 583 <h4>Parameters</h4> |
584 <dl> | 584 <dl> |
585 <div> | 585 <div> |
586 <div> | 586 <div> |
587 <dt> | 587 <dt> |
(...skipping 102 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
690 </dl> | 690 </dl> |
691 <!-- CALLBACK --> | 691 <!-- CALLBACK --> |
692 <!-- MIN_VERSION --> | 692 <!-- MIN_VERSION --> |
693 </div> <!-- /description --> | 693 </div> <!-- /description --> |
694 </div> <!-- /apiItem --> | 694 </div> <!-- /apiItem --> |
695 </div> | 695 </div> |
696 </dd> | 696 </dd> |
697 <!-- OBJECT EVENT FIELDS --> | 697 <!-- OBJECT EVENT FIELDS --> |
698 <dd> | 698 <dd> |
699 <div class="apiGroup"> | 699 <div class="apiGroup"> |
700 <a name="global-ChromeSetting-events"></a> | 700 <a name="global-types.ChromeSetting-events"></a> |
701 <h3>Events of ChromeSetting</h3> | 701 <h3>Events of types.ChromeSetting</h3> |
702 <!-- iterates over all events --> | 702 <!-- iterates over all events --> |
703 <div class="apiItem"> | 703 <div class="apiItem"> |
704 <a name="event-ChromeSetting-onChange"></a> | 704 <a name="event-types.ChromeSetting-onChange"></a> |
705 <h4>onChange</h4> | 705 <h4>onChange</h4> |
706 <div class="summary"> | 706 <div class="summary"> |
707 <!-- Note: intentionally longer 80 columns --> | 707 <!-- Note: intentionally longer 80 columns --> |
708 <span class="subdued">chromeSetting.</span><span>onChange</span>
<span class="subdued">.addListener</span>(function(<span>object details</span>)
<span class="subdued">{...}</span><span></span>); | 708 <span class="subdued">types.ChromeSetting.</span><span>onChange<
/span><span class="subdued">.addListener</span>(function(<span>object details</s
pan>) <span class="subdued">{...}</span><span></span>); |
709 </div> | 709 </div> |
710 <div class="description"> | 710 <div class="description"> |
711 <p>Fired when the value of the setting changes.</p> | 711 <p>Fired when the value of the setting changes.</p> |
712 <!-- LISTENER PARAMETERS --> | 712 <!-- LISTENER PARAMETERS --> |
713 <div> | 713 <div> |
714 <h4>Listener parameters</h4> | 714 <h4>Listener parameters</h4> |
715 <dl> | 715 <dl> |
716 <div> | 716 <div> |
717 <div> | 717 <div> |
718 <dt> | 718 <dt> |
(...skipping 152 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
871 _uff=0; | 871 _uff=0; |
872 urchinTracker(); | 872 urchinTracker(); |
873 } | 873 } |
874 catch(e) {/* urchinTracker not available. */} | 874 catch(e) {/* urchinTracker not available. */} |
875 </script> | 875 </script> |
876 <!-- end analytics --> | 876 <!-- end analytics --> |
877 </div> | 877 </div> |
878 </div> <!-- /gc-footer --> | 878 </div> <!-- /gc-footer --> |
879 </div> <!-- /gc-container --> | 879 </div> <!-- /gc-container --> |
880 </body></html> | 880 </body></html> |
OLD | NEW |