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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 10829301: Extension docs: Manual merge crrev.com/143652 (Closed) Base URL: svn://svn.chromium.org/chrome/branches/1180/src/
Patch Set: Created 8 years, 4 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
« no previous file with comments | « chrome/common/extensions/docs/devtools.panels.html ('k') | chrome/common/extensions/docs/experimental.devtools.audits.html » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
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 204 matching lines...) Expand 10 before | Expand all | Expand 10 after
215 </li> 215 </li>
216 </ol> 216 </ol>
217 </li> 217 </li>
218 <li> 218 <li>
219 <a href="#apiReference">API reference: chrome.events</a> 219 <a href="#apiReference">API reference: chrome.events</a>
220 <ol> 220 <ol>
221 <li> 221 <li>
222 <a href="#types">Types</a> 222 <a href="#types">Types</a>
223 <ol> 223 <ol>
224 <li> 224 <li>
225 <a href="#type-Event">null</a> 225 <a href="#type-events.Event">Event</a>
226 <ol> 226 <ol>
227 <li> 227 <li>
228 <a href="#global-Event-methods">Methods</a> 228 <a href="#global-events.Event-methods">Methods</a>
229 <ol> 229 <ol>
230 <li> 230 <li>
231 <a href="#method-Event-addListener">addListener</a> 231 <a href="#method-events.Event-addListener">addListener</a>
232 </li><li> 232 </li><li>
233 <a href="#method-Event-addRules">addRules</a> 233 <a href="#method-events.Event-addRules">addRules</a>
234 </li><li> 234 </li><li>
235 <a href="#method-Event-getRules">getRules</a> 235 <a href="#method-events.Event-getRules">getRules</a>
236 </li><li> 236 </li><li>
237 <a href="#method-Event-hasListener">hasListener</a> 237 <a href="#method-events.Event-hasListener">hasListener</a>
238 </li><li> 238 </li><li>
239 <a href="#method-Event-hasListeners">hasListeners</a> 239 <a href="#method-events.Event-hasListeners">hasListeners</a>
240 </li><li> 240 </li><li>
241 <a href="#method-Event-removeListener">removeListener</a> 241 <a href="#method-events.Event-removeListener">removeListener</a>
242 </li><li> 242 </li><li>
243 <a href="#method-Event-removeRules">removeRules</a> 243 <a href="#method-events.Event-removeRules">removeRules</a>
244 </li> 244 </li>
245 </ol> 245 </ol>
246 </li> 246 </li>
247 </ol> 247 </ol>
248 </li><li> 248 </li><li>
249 <a href="#type-Rule">null</a> 249 <a href="#type-events.Rule">Rule</a>
250 <ol> 250 <ol>
251 </ol> 251 </ol>
252 </li><li> 252 </li><li>
253 <a href="#type-UrlFilter">null</a> 253 <a href="#type-events.UrlFilter">UrlFilter</a>
254 <ol> 254 <ol>
255 </ol> 255 </ol>
256 </li> 256 </li>
257 </ol> 257 </ol>
258 </li> 258 </li>
259 </ol> 259 </ol>
260 </li> 260 </li>
261 </ol> 261 </ol>
262 </div> 262 </div>
263 <!-- /TABLE OF CONTENTS --> 263 <!-- /TABLE OF CONTENTS -->
(...skipping 141 matching lines...) Expand 10 before | Expand all | Expand 10 after
405 <!-- METHODS --> 405 <!-- METHODS -->
406 <!-- /apiGroup --> 406 <!-- /apiGroup -->
407 <!-- EVENTS --> 407 <!-- EVENTS -->
408 <!-- /apiGroup --> 408 <!-- /apiGroup -->
409 <!-- TYPES --> 409 <!-- TYPES -->
410 <div class="apiGroup"> 410 <div class="apiGroup">
411 <a name="types"></a> 411 <a name="types"></a>
412 <h3 id="types">Types</h3> 412 <h3 id="types">Types</h3>
413 <!-- iterates over all types --> 413 <!-- iterates over all types -->
414 <div class="apiItem"> 414 <div class="apiItem">
415 <a name="type-Event"></a> 415 <a name="type-events.Event"></a>
416 <h4>Event</h4> 416 <h4>events.Event</h4>
417 <div> 417 <div>
418 <dt> 418 <dt>
419 <em> 419 <em>
420 <!-- TYPE --> 420 <!-- TYPE -->
421 <div style="display:inline"> 421 <div style="display:inline">
422 ( 422 (
423 <span id="typeTemplate"> 423 <span id="typeTemplate">
424 <span> 424 <span>
425 <span>object</span> 425 <span>object</span>
426 </span> 426 </span>
427 </span> 427 </span>
428 ) 428 )
429 </div> 429 </div>
430 </em> 430 </em>
431 </dt> 431 </dt>
432 <dd>An object which allows the addition and removal of listeners for a Chrome event.</dd> 432 <dd>An object which allows the addition and removal of listeners for a Chrome event.</dd>
433 <!-- OBJECT PROPERTIES --> 433 <!-- OBJECT PROPERTIES -->
434 <!-- OBJECT METHODS --> 434 <!-- OBJECT METHODS -->
435 <dd> 435 <dd>
436 <div class="apiGroup"> 436 <div class="apiGroup">
437 <a name="global-Event-methods"></a> 437 <a name="global-events.Event-methods"></a>
438 <h3>Methods of Event</h3> 438 <h3>Methods of events.Event</h3>
439 <!-- iterates over all functions --> 439 <!-- iterates over all functions -->
440 <div class="apiItem"> 440 <div class="apiItem">
441 <a name="method-Event-addListener"></a> <!-- method-anchor --> 441 <a name="method-events.Event-addListener"></a> <!-- method-anchor -->
442 <h4>addListener</h4> 442 <h4>addListener</h4>
443 <div class="summary"> 443 <div class="summary">
444 <!-- Note: intentionally longer 80 columns --> 444 <!-- Note: intentionally longer 80 columns -->
445 <span>event.addListener</span>()</div> 445 <span>events.Event.addListener</span>()</div>
446 <div class="description"> 446 <div class="description">
447 <!-- PARAMETERS --> 447 <!-- PARAMETERS -->
448 <dl> 448 <dl>
449 </dl> 449 </dl>
450 <!-- RETURNS --> 450 <!-- RETURNS -->
451 <dl> 451 <dl>
452 </dl> 452 </dl>
453 <!-- CALLBACK --> 453 <!-- CALLBACK -->
454 <!-- MIN_VERSION --> 454 <!-- MIN_VERSION -->
455 </div> <!-- /description --> 455 </div> <!-- /description -->
456 </div><div class="apiItem"> 456 </div><div class="apiItem">
457 <a name="method-Event-addRules"></a> <!-- method-anchor --> 457 <a name="method-events.Event-addRules"></a> <!-- method-anchor -->
458 <h4>addRules</h4> 458 <h4>addRules</h4>
459 <div class="summary"> 459 <div class="summary">
460 <!-- Note: intentionally longer 80 columns --> 460 <!-- Note: intentionally longer 80 columns -->
461 <span>event.addRules</span>(<span class="null"><span>array of Rule</span> 461 <span>events.Event.addRules</span>(<span class="null"><span>ar ray of events.Rule</span>
462 <var><span>rules</span></var></span><span class="optional" ><span>, </span><span>function</span> 462 <var><span>rules</span></var></span><span class="optional" ><span>, </span><span>function</span>
463 <var><span>callback</span></var></span>)</div> 463 <var><span>callback</span></var></span>)</div>
464 <div class="description"> 464 <div class="description">
465 <p>Registers rules to handle events.</p> 465 <p>Registers rules to handle events.</p>
466 <!-- PARAMETERS --> 466 <!-- PARAMETERS -->
467 <h4>Parameters</h4> 467 <h4>Parameters</h4>
468 <dl> 468 <dl>
469 <div> 469 <div>
470 <div> 470 <div>
471 <dt> 471 <dt>
472 <var>rules</var> 472 <var>rules</var>
473 <em> 473 <em>
474 <!-- TYPE --> 474 <!-- TYPE -->
475 <div style="display:inline"> 475 <div style="display:inline">
476 ( 476 (
477 <span id="typeTemplate"> 477 <span id="typeTemplate">
478 <span> 478 <span>
479 <span> 479 <span>
480 array of <span><span> 480 array of <span><span>
481 <span> 481 <span>
482 <a href="events.html#type-Rule">Rule</a> 482 <a href="events.html#type-events.Rule">events.Rule</a>
483 </span> 483 </span>
484 </span></span> 484 </span></span>
485 </span> 485 </span>
486 </span> 486 </span>
487 </span> 487 </span>
488 ) 488 )
489 </div> 489 </div>
490 </em> 490 </em>
491 </dt> 491 </dt>
492 <dd>Rules to be registered. These do not replace previously registered rules.</dd> 492 <dd>Rules to be registered. These do not replace previously registered rules.</dd>
(...skipping 28 matching lines...) Expand all
521 </div> 521 </div>
522 </div> 522 </div>
523 </dl> 523 </dl>
524 <!-- RETURNS --> 524 <!-- RETURNS -->
525 <dl> 525 <dl>
526 </dl> 526 </dl>
527 <!-- CALLBACK --> 527 <!-- CALLBACK -->
528 <!-- MIN_VERSION --> 528 <!-- MIN_VERSION -->
529 </div> <!-- /description --> 529 </div> <!-- /description -->
530 </div><div class="apiItem"> 530 </div><div class="apiItem">
531 <a name="method-Event-getRules"></a> <!-- method-anchor --> 531 <a name="method-events.Event-getRules"></a> <!-- method-anchor -->
532 <h4>getRules</h4> 532 <h4>getRules</h4>
533 <div class="summary"> 533 <div class="summary">
534 <!-- Note: intentionally longer 80 columns --> 534 <!-- Note: intentionally longer 80 columns -->
535 <span>event.getRules</span>(<span class="optional"><span>array of string</span> 535 <span>events.Event.getRules</span>(<span class="optional"><spa n>array of string</span>
536 <var><span>ruleIdentifiers</span></var></span><span class= "null"><span>, </span><span>function</span> 536 <var><span>ruleIdentifiers</span></var></span><span class= "null"><span>, </span><span>function</span>
537 <var><span>callback</span></var></span>)</div> 537 <var><span>callback</span></var></span>)</div>
538 <div class="description"> 538 <div class="description">
539 <p>Returns currently registered rules.</p> 539 <p>Returns currently registered rules.</p>
540 <!-- PARAMETERS --> 540 <!-- PARAMETERS -->
541 <h4>Parameters</h4> 541 <h4>Parameters</h4>
542 <dl> 542 <dl>
543 <div> 543 <div>
544 <div> 544 <div>
545 <dt> 545 <dt>
(...skipping 49 matching lines...) Expand 10 before | Expand all | Expand 10 after
595 </div> 595 </div>
596 </div> 596 </div>
597 </dl> 597 </dl>
598 <!-- RETURNS --> 598 <!-- RETURNS -->
599 <dl> 599 <dl>
600 </dl> 600 </dl>
601 <!-- CALLBACK --> 601 <!-- CALLBACK -->
602 <!-- MIN_VERSION --> 602 <!-- MIN_VERSION -->
603 </div> <!-- /description --> 603 </div> <!-- /description -->
604 </div><div class="apiItem"> 604 </div><div class="apiItem">
605 <a name="method-Event-hasListener"></a> <!-- method-anchor --> 605 <a name="method-events.Event-hasListener"></a> <!-- method-anchor -->
606 <h4>hasListener</h4> 606 <h4>hasListener</h4>
607 <div class="summary"> 607 <div class="summary">
608 <!-- Note: intentionally longer 80 columns --> 608 <!-- Note: intentionally longer 80 columns -->
609 <span>event.hasListener</span>()</div> 609 <span>events.Event.hasListener</span>()</div>
610 <div class="description"> 610 <div class="description">
611 <!-- PARAMETERS --> 611 <!-- PARAMETERS -->
612 <dl> 612 <dl>
613 </dl> 613 </dl>
614 <!-- RETURNS --> 614 <!-- RETURNS -->
615 <dl> 615 <dl>
616 </dl> 616 </dl>
617 <!-- CALLBACK --> 617 <!-- CALLBACK -->
618 <!-- MIN_VERSION --> 618 <!-- MIN_VERSION -->
619 </div> <!-- /description --> 619 </div> <!-- /description -->
620 </div><div class="apiItem"> 620 </div><div class="apiItem">
621 <a name="method-Event-hasListeners"></a> <!-- method-anchor --> 621 <a name="method-events.Event-hasListeners"></a> <!-- method-anchor -->
622 <h4>hasListeners</h4> 622 <h4>hasListeners</h4>
623 <div class="summary"> 623 <div class="summary">
624 <!-- Note: intentionally longer 80 columns --> 624 <!-- Note: intentionally longer 80 columns -->
625 <span>event.hasListeners</span>()</div> 625 <span>events.Event.hasListeners</span>()</div>
626 <div class="description"> 626 <div class="description">
627 <!-- PARAMETERS --> 627 <!-- PARAMETERS -->
628 <dl> 628 <dl>
629 </dl> 629 </dl>
630 <!-- RETURNS --> 630 <!-- RETURNS -->
631 <dl> 631 <dl>
632 </dl> 632 </dl>
633 <!-- CALLBACK --> 633 <!-- CALLBACK -->
634 <!-- MIN_VERSION --> 634 <!-- MIN_VERSION -->
635 </div> <!-- /description --> 635 </div> <!-- /description -->
636 </div><div class="apiItem"> 636 </div><div class="apiItem">
637 <a name="method-Event-removeListener"></a> <!-- method-anchor --> 637 <a name="method-events.Event-removeListener"></a> <!-- method-anch or -->
638 <h4>removeListener</h4> 638 <h4>removeListener</h4>
639 <div class="summary"> 639 <div class="summary">
640 <!-- Note: intentionally longer 80 columns --> 640 <!-- Note: intentionally longer 80 columns -->
641 <span>event.removeListener</span>()</div> 641 <span>events.Event.removeListener</span>()</div>
642 <div class="description"> 642 <div class="description">
643 <!-- PARAMETERS --> 643 <!-- PARAMETERS -->
644 <dl> 644 <dl>
645 </dl> 645 </dl>
646 <!-- RETURNS --> 646 <!-- RETURNS -->
647 <dl> 647 <dl>
648 </dl> 648 </dl>
649 <!-- CALLBACK --> 649 <!-- CALLBACK -->
650 <!-- MIN_VERSION --> 650 <!-- MIN_VERSION -->
651 </div> <!-- /description --> 651 </div> <!-- /description -->
652 </div><div class="apiItem"> 652 </div><div class="apiItem">
653 <a name="method-Event-removeRules"></a> <!-- method-anchor --> 653 <a name="method-events.Event-removeRules"></a> <!-- method-anchor -->
654 <h4>removeRules</h4> 654 <h4>removeRules</h4>
655 <div class="summary"> 655 <div class="summary">
656 <!-- Note: intentionally longer 80 columns --> 656 <!-- Note: intentionally longer 80 columns -->
657 <span>event.removeRules</span>(<span class="optional"><span>ar ray of string</span> 657 <span>events.Event.removeRules</span>(<span class="optional">< span>array of string</span>
658 <var><span>ruleIdentifiers</span></var></span><span class= "optional"><span>, </span><span>function</span> 658 <var><span>ruleIdentifiers</span></var></span><span class= "optional"><span>, </span><span>function</span>
659 <var><span>callback</span></var></span>)</div> 659 <var><span>callback</span></var></span>)</div>
660 <div class="description"> 660 <div class="description">
661 <p>Unregisters currently registered rules.</p> 661 <p>Unregisters currently registered rules.</p>
662 <!-- PARAMETERS --> 662 <!-- PARAMETERS -->
663 <h4>Parameters</h4> 663 <h4>Parameters</h4>
664 <dl> 664 <dl>
665 <div> 665 <div>
666 <div> 666 <div>
667 <dt> 667 <dt>
(...skipping 56 matching lines...) Expand 10 before | Expand all | Expand 10 after
724 <!-- CALLBACK --> 724 <!-- CALLBACK -->
725 <!-- MIN_VERSION --> 725 <!-- MIN_VERSION -->
726 </div> <!-- /description --> 726 </div> <!-- /description -->
727 </div> <!-- /apiItem --> 727 </div> <!-- /apiItem -->
728 </div> 728 </div>
729 </dd> 729 </dd>
730 <!-- OBJECT EVENT FIELDS --> 730 <!-- OBJECT EVENT FIELDS -->
731 <!-- FUNCTION PARAMETERS --> 731 <!-- FUNCTION PARAMETERS -->
732 </div> 732 </div>
733 </div><div class="apiItem"> 733 </div><div class="apiItem">
734 <a name="type-Rule"></a> 734 <a name="type-events.Rule"></a>
735 <h4>Rule</h4> 735 <h4>events.Rule</h4>
736 <div> 736 <div>
737 <dt> 737 <dt>
738 <em> 738 <em>
739 <!-- TYPE --> 739 <!-- TYPE -->
740 <div style="display:inline"> 740 <div style="display:inline">
741 ( 741 (
742 <span id="typeTemplate"> 742 <span id="typeTemplate">
743 <span> 743 <span>
744 <span>object</span> 744 <span>object</span>
745 </span> 745 </span>
(...skipping 113 matching lines...) Expand 10 before | Expand all | Expand 10 after
859 <!-- FUNCTION PARAMETERS --> 859 <!-- FUNCTION PARAMETERS -->
860 </div> 860 </div>
861 </div> 861 </div>
862 </dl> 862 </dl>
863 </dd> 863 </dd>
864 <!-- OBJECT METHODS --> 864 <!-- OBJECT METHODS -->
865 <!-- OBJECT EVENT FIELDS --> 865 <!-- OBJECT EVENT FIELDS -->
866 <!-- FUNCTION PARAMETERS --> 866 <!-- FUNCTION PARAMETERS -->
867 </div> 867 </div>
868 </div><div class="apiItem"> 868 </div><div class="apiItem">
869 <a name="type-UrlFilter"></a> 869 <a name="type-events.UrlFilter"></a>
870 <h4>UrlFilter</h4> 870 <h4>events.UrlFilter</h4>
871 <div> 871 <div>
872 <dt> 872 <dt>
873 <em> 873 <em>
874 <!-- TYPE --> 874 <!-- TYPE -->
875 <div style="display:inline"> 875 <div style="display:inline">
876 ( 876 (
877 <span id="typeTemplate"> 877 <span id="typeTemplate">
878 <span> 878 <span>
879 <span>object</span> 879 <span>object</span>
880 </span> 880 </span>
(...skipping 499 matching lines...) Expand 10 before | Expand all | Expand 10 after
1380 _uff=0; 1380 _uff=0;
1381 urchinTracker(); 1381 urchinTracker();
1382 } 1382 }
1383 catch(e) {/* urchinTracker not available. */} 1383 catch(e) {/* urchinTracker not available. */}
1384 </script> 1384 </script>
1385 <!-- end analytics --> 1385 <!-- end analytics -->
1386 </div> 1386 </div>
1387 </div> <!-- /gc-footer --> 1387 </div> <!-- /gc-footer -->
1388 </div> <!-- /gc-container --> 1388 </div> <!-- /gc-container -->
1389 </body></html> 1389 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/devtools.panels.html ('k') | chrome/common/extensions/docs/experimental.devtools.audits.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698