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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 329001: Remove pageAction badge functions (Closed)
Patch Set: pre commit Created 11 years, 2 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
« no previous file with comments | « chrome/common/extensions/api/extension_api.json ('k') | no next file » | 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 182 matching lines...) Expand 10 before | Expand all | Expand 10 after
193 <a href="#property-anchor">propertyName</a> 193 <a href="#property-anchor">propertyName</a>
194 </li> 194 </li>
195 </ol> 195 </ol>
196 </li> 196 </li>
197 <li> 197 <li>
198 <a href="#methods">Methods</a> 198 <a href="#methods">Methods</a>
199 <ol> 199 <ol>
200 <li jsinstance="0"> 200 <li jsinstance="0">
201 <a href="#method-hide">hide</a> 201 <a href="#method-hide">hide</a>
202 </li><li jsinstance="1"> 202 </li><li jsinstance="1">
203 <a href="#method-setBadgeBackgroundColor">setBadgeBackgr oundColor</a> 203 <a href="#method-setIcon">setIcon</a>
204 </li><li jsinstance="2"> 204 </li><li jsinstance="2">
205 <a href="#method-setBadgeText">setBadgeText</a>
206 </li><li jsinstance="3">
207 <a href="#method-setBadgeTextColor">setBadgeTextColor</a >
208 </li><li jsinstance="4">
209 <a href="#method-setIcon">setIcon</a>
210 </li><li jsinstance="5">
211 <a href="#method-setTitle">setTitle</a> 205 <a href="#method-setTitle">setTitle</a>
212 </li><li jsinstance="*6"> 206 </li><li jsinstance="*3">
213 <a href="#method-show">show</a> 207 <a href="#method-show">show</a>
214 </li> 208 </li>
215 </ol> 209 </ol>
216 </li> 210 </li>
217 <li> 211 <li>
218 <a href="#events">Events</a> 212 <a href="#events">Events</a>
219 <ol> 213 <ol>
220 <li jsinstance="*0"> 214 <li jsinstance="*0">
221 <a href="#event-onClicked">onClicked</a> 215 <a href="#event-onClicked">onClicked</a>
222 </li> 216 </li>
(...skipping 242 matching lines...) Expand 10 before | Expand all | Expand 10 after
465 <div> 459 <div>
466 </div> 460 </div>
467 </div> 461 </div>
468 </dl> 462 </dl>
469 </div> 463 </div>
470 </div> 464 </div>
471 465
472 </div> <!-- /description --> 466 </div> <!-- /description -->
473 467
474 </div><div class="apiItem" jsinstance="1"> 468 </div><div class="apiItem" jsinstance="1">
475 <a name="method-setBadgeBackgroundColor"></a> <!-- method-anchor - ->
476 <h4>setBadgeBackgroundColor</h4>
477
478 <div class="summary"><span style="display: none; ">void</span>
479 <!-- Note: intentionally longer 80 columns -->
480 <span>chrome.pageAction.setBadgeBackgroundColor</span>(<span j sinstance="*0" class="null"><span style="display: none; ">, </span><span>object< /span>
481 <var><span>details</span></var></span>)</div>
482
483 <div class="description">
484 <p class="todo" style="display: none; ">Undocumented.</p>
485 <p>Sets the background color for the badge.</p>
486
487 <!-- PARAMETERS -->
488 <h4>Parameters</h4>
489 <dl>
490 <div jsinstance="*0">
491 <div>
492 <dt>
493 <var>details</var>
494 <em>
495
496 <!-- TYPE -->
497 <div style="display:inline">
498 (
499 <span class="optional" style="display: none; ">optional</spa n>
500 <span id="typeTemplate">
501 <span style="display: none; ">
502 <a> Type</a>
503 </span>
504 <span>
505 <span style="display: none; ">
506 array of <span><span></span></span>
507 </span>
508 <span>object</span>
509 </span>
510 </span>
511 )
512 </div>
513
514 </em>
515 </dt>
516 <dd class="todo">
517 Undocumented.
518 </dd>
519 <dd style="display: none; ">
520 Description of this parameter from the json schema.
521 </dd>
522
523 <!-- OBJECT PROPERTIES -->
524 <dd>
525 <dl>
526 <div jsinstance="0">
527 <div>
528 <dt>
529 <var>tabId</var>
530 <em>
531
532 <!-- TYPE -->
533 <div style="display:inline">
534 (
535 <span class="optional" style="display: none; ">optional</spa n>
536 <span id="typeTemplate">
537 <span style="display: none; ">
538 <a> Type</a>
539 </span>
540 <span>
541 <span style="display: none; ">
542 array of <span><span></span></span>
543 </span>
544 <span>integer</span>
545 </span>
546 </span>
547 )
548 </div>
549
550 </em>
551 </dt>
552 <dd class="todo" style="display: none; ">
553 Undocumented.
554 </dd>
555 <dd>The id of the tab for which you want to modify the page action.</d d>
556
557 <!-- OBJECT PROPERTIES -->
558 <dd style="display: none; ">
559 <dl>
560 <div>
561 <div>
562 </div>
563 </div>
564 </dl>
565 </dd>
566 </div>
567 </div><div jsinstance="*1">
568 <div>
569 <dt>
570 <var>color</var>
571 <em>
572
573 <!-- TYPE -->
574 <div style="display:inline">
575 (
576 <span class="optional" style="display: none; ">optional</spa n>
577 <span id="typeTemplate">
578 <span style="display: none; ">
579 <a> Type</a>
580 </span>
581 <span>
582 <span>
583 array of <span><span>
584 <span style="display: none; ">
585 <a> Type</a>
586 </span>
587 <span>
588 <span style="display: none; ">
589 array of <span><span></span></span>
590 </span>
591 <span>integer</span>
592 </span>
593 </span></span>
594 </span>
595 <span style="display: none; ">paramType</span>
596 </span>
597 </span>
598 )
599 </div>
600
601 </em>
602 </dt>
603 <dd class="todo" style="display: none; ">
604 Undocumented.
605 </dd>
606 <dd>An array of four integers in the range [0,255] that make up the RG BA color of the badge. For example, opaque red is <code>[255, 0, 0, 255]</code>. </dd>
607
608 <!-- OBJECT PROPERTIES -->
609 <dd style="display: none; ">
610 <dl>
611 <div>
612 <div>
613 </div>
614 </div>
615 </dl>
616 </dd>
617 </div>
618 </div>
619 </dl>
620 </dd>
621 </div>
622 </div>
623 </dl>
624
625 <!-- RETURNS -->
626 <h4 style="display: none; ">Returns</h4>
627 <dl>
628 <div style="display: none; ">
629 <div>
630 </div>
631 </div>
632 </dl>
633
634 <!-- CALLBACK -->
635 <div style="display: none; ">
636 <div>
637 <h4>Callback function</h4>
638 <p>
639 If you specify the <em>callback</em> parameter,
640 it should specify a function that looks like this:
641 </p>
642
643 <!-- Note: intentionally longer 80 columns -->
644 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>);</pre>
645 <dl>
646 <div>
647 <div>
648 </div>
649 </div>
650 </dl>
651 </div>
652 </div>
653
654 </div> <!-- /description -->
655
656 </div><div class="apiItem" jsinstance="2">
657 <a name="method-setBadgeText"></a> <!-- method-anchor -->
658 <h4>setBadgeText</h4>
659
660 <div class="summary"><span style="display: none; ">void</span>
661 <!-- Note: intentionally longer 80 columns -->
662 <span>chrome.pageAction.setBadgeText</span>(<span jsinstance=" *0" class="null"><span style="display: none; ">, </span><span>object</span>
663 <var><span>details</span></var></span>)</div>
664
665 <div class="description">
666 <p class="todo" style="display: none; ">Undocumented.</p>
667 <p>Sets the badge text for the page action. The badge is display ed on top of the icon.</p>
668
669 <!-- PARAMETERS -->
670 <h4>Parameters</h4>
671 <dl>
672 <div jsinstance="*0">
673 <div>
674 <dt>
675 <var>details</var>
676 <em>
677
678 <!-- TYPE -->
679 <div style="display:inline">
680 (
681 <span class="optional" style="display: none; ">optional</spa n>
682 <span id="typeTemplate">
683 <span style="display: none; ">
684 <a> Type</a>
685 </span>
686 <span>
687 <span style="display: none; ">
688 array of <span><span></span></span>
689 </span>
690 <span>object</span>
691 </span>
692 </span>
693 )
694 </div>
695
696 </em>
697 </dt>
698 <dd class="todo">
699 Undocumented.
700 </dd>
701 <dd style="display: none; ">
702 Description of this parameter from the json schema.
703 </dd>
704
705 <!-- OBJECT PROPERTIES -->
706 <dd>
707 <dl>
708 <div jsinstance="0">
709 <div>
710 <dt>
711 <var>tabId</var>
712 <em>
713
714 <!-- TYPE -->
715 <div style="display:inline">
716 (
717 <span class="optional" style="display: none; ">optional</spa n>
718 <span id="typeTemplate">
719 <span style="display: none; ">
720 <a> Type</a>
721 </span>
722 <span>
723 <span style="display: none; ">
724 array of <span><span></span></span>
725 </span>
726 <span>integer</span>
727 </span>
728 </span>
729 )
730 </div>
731
732 </em>
733 </dt>
734 <dd class="todo" style="display: none; ">
735 Undocumented.
736 </dd>
737 <dd>The id of the tab for which you want to modify the page action.</d d>
738
739 <!-- OBJECT PROPERTIES -->
740 <dd style="display: none; ">
741 <dl>
742 <div>
743 <div>
744 </div>
745 </div>
746 </dl>
747 </dd>
748 </div>
749 </div><div jsinstance="*1">
750 <div>
751 <dt>
752 <var>text</var>
753 <em>
754
755 <!-- TYPE -->
756 <div style="display:inline">
757 (
758 <span class="optional" style="display: none; ">optional</spa n>
759 <span id="typeTemplate">
760 <span style="display: none; ">
761 <a> Type</a>
762 </span>
763 <span>
764 <span style="display: none; ">
765 array of <span><span></span></span>
766 </span>
767 <span>string</span>
768 </span>
769 </span>
770 )
771 </div>
772
773 </em>
774 </dt>
775 <dd class="todo" style="display: none; ">
776 Undocumented.
777 </dd>
778 <dd>Any number of characters can be passed, but only about four can fi t in the space.</dd>
779
780 <!-- OBJECT PROPERTIES -->
781 <dd style="display: none; ">
782 <dl>
783 <div>
784 <div>
785 </div>
786 </div>
787 </dl>
788 </dd>
789 </div>
790 </div>
791 </dl>
792 </dd>
793 </div>
794 </div>
795 </dl>
796
797 <!-- RETURNS -->
798 <h4 style="display: none; ">Returns</h4>
799 <dl>
800 <div style="display: none; ">
801 <div>
802 </div>
803 </div>
804 </dl>
805
806 <!-- CALLBACK -->
807 <div style="display: none; ">
808 <div>
809 <h4>Callback function</h4>
810 <p>
811 If you specify the <em>callback</em> parameter,
812 it should specify a function that looks like this:
813 </p>
814
815 <!-- Note: intentionally longer 80 columns -->
816 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>);</pre>
817 <dl>
818 <div>
819 <div>
820 </div>
821 </div>
822 </dl>
823 </div>
824 </div>
825
826 </div> <!-- /description -->
827
828 </div><div class="apiItem" jsinstance="3">
829 <a name="method-setBadgeTextColor"></a> <!-- method-anchor -->
830 <h4>setBadgeTextColor</h4>
831
832 <div class="summary"><span style="display: none; ">void</span>
833 <!-- Note: intentionally longer 80 columns -->
834 <span>chrome.pageAction.setBadgeTextColor</span>(<span jsinsta nce="*0" class="null"><span style="display: none; ">, </span><span>object</span>
835 <var><span>details</span></var></span>)</div>
836
837 <div class="description">
838 <p class="todo" style="display: none; ">Undocumented.</p>
839 <p>Sets the text color for the badge.</p>
840
841 <!-- PARAMETERS -->
842 <h4>Parameters</h4>
843 <dl>
844 <div jsinstance="*0">
845 <div>
846 <dt>
847 <var>details</var>
848 <em>
849
850 <!-- TYPE -->
851 <div style="display:inline">
852 (
853 <span class="optional" style="display: none; ">optional</spa n>
854 <span id="typeTemplate">
855 <span style="display: none; ">
856 <a> Type</a>
857 </span>
858 <span>
859 <span style="display: none; ">
860 array of <span><span></span></span>
861 </span>
862 <span>object</span>
863 </span>
864 </span>
865 )
866 </div>
867
868 </em>
869 </dt>
870 <dd class="todo">
871 Undocumented.
872 </dd>
873 <dd style="display: none; ">
874 Description of this parameter from the json schema.
875 </dd>
876
877 <!-- OBJECT PROPERTIES -->
878 <dd>
879 <dl>
880 <div jsinstance="0">
881 <div>
882 <dt>
883 <var>tabId</var>
884 <em>
885
886 <!-- TYPE -->
887 <div style="display:inline">
888 (
889 <span class="optional" style="display: none; ">optional</spa n>
890 <span id="typeTemplate">
891 <span style="display: none; ">
892 <a> Type</a>
893 </span>
894 <span>
895 <span style="display: none; ">
896 array of <span><span></span></span>
897 </span>
898 <span>integer</span>
899 </span>
900 </span>
901 )
902 </div>
903
904 </em>
905 </dt>
906 <dd class="todo" style="display: none; ">
907 Undocumented.
908 </dd>
909 <dd>The id of the tab for which you want to modify the page action.</d d>
910
911 <!-- OBJECT PROPERTIES -->
912 <dd style="display: none; ">
913 <dl>
914 <div>
915 <div>
916 </div>
917 </div>
918 </dl>
919 </dd>
920 </div>
921 </div><div jsinstance="*1">
922 <div>
923 <dt>
924 <var>color</var>
925 <em>
926
927 <!-- TYPE -->
928 <div style="display:inline">
929 (
930 <span class="optional" style="display: none; ">optional</spa n>
931 <span id="typeTemplate">
932 <span style="display: none; ">
933 <a> Type</a>
934 </span>
935 <span>
936 <span>
937 array of <span><span>
938 <span style="display: none; ">
939 <a> Type</a>
940 </span>
941 <span>
942 <span style="display: none; ">
943 array of <span><span></span></span>
944 </span>
945 <span>integer</span>
946 </span>
947 </span></span>
948 </span>
949 <span style="display: none; ">paramType</span>
950 </span>
951 </span>
952 )
953 </div>
954
955 </em>
956 </dt>
957 <dd class="todo" style="display: none; ">
958 Undocumented.
959 </dd>
960 <dd>An array of four integers in the range [0,255] that make up the RG BA color for the text of the badge.</dd>
961
962 <!-- OBJECT PROPERTIES -->
963 <dd style="display: none; ">
964 <dl>
965 <div>
966 <div>
967 </div>
968 </div>
969 </dl>
970 </dd>
971 </div>
972 </div>
973 </dl>
974 </dd>
975 </div>
976 </div>
977 </dl>
978
979 <!-- RETURNS -->
980 <h4 style="display: none; ">Returns</h4>
981 <dl>
982 <div style="display: none; ">
983 <div>
984 </div>
985 </div>
986 </dl>
987
988 <!-- CALLBACK -->
989 <div style="display: none; ">
990 <div>
991 <h4>Callback function</h4>
992 <p>
993 If you specify the <em>callback</em> parameter,
994 it should specify a function that looks like this:
995 </p>
996
997 <!-- Note: intentionally longer 80 columns -->
998 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>);</pre>
999 <dl>
1000 <div>
1001 <div>
1002 </div>
1003 </div>
1004 </dl>
1005 </div>
1006 </div>
1007
1008 </div> <!-- /description -->
1009
1010 </div><div class="apiItem" jsinstance="4">
1011 <a name="method-setIcon"></a> <!-- method-anchor --> 469 <a name="method-setIcon"></a> <!-- method-anchor -->
1012 <h4>setIcon</h4> 470 <h4>setIcon</h4>
1013 471
1014 <div class="summary"><span style="display: none; ">void</span> 472 <div class="summary"><span style="display: none; ">void</span>
1015 <!-- Note: intentionally longer 80 columns --> 473 <!-- Note: intentionally longer 80 columns -->
1016 <span>chrome.pageAction.setIcon</span>(<span jsinstance="*0" c lass="null"><span style="display: none; ">, </span><span>object</span> 474 <span>chrome.pageAction.setIcon</span>(<span jsinstance="*0" c lass="null"><span style="display: none; ">, </span><span>object</span>
1017 <var><span>details</span></var></span>)</div> 475 <var><span>details</span></var></span>)</div>
1018 476
1019 <div class="description"> 477 <div class="description">
1020 <p class="todo" style="display: none; ">Undocumented.</p> 478 <p class="todo" style="display: none; ">Undocumented.</p>
(...skipping 192 matching lines...) Expand 10 before | Expand all | Expand 10 after
1213 <div> 671 <div>
1214 <div> 672 <div>
1215 </div> 673 </div>
1216 </div> 674 </div>
1217 </dl> 675 </dl>
1218 </div> 676 </div>
1219 </div> 677 </div>
1220 678
1221 </div> <!-- /description --> 679 </div> <!-- /description -->
1222 680
1223 </div><div class="apiItem" jsinstance="5"> 681 </div><div class="apiItem" jsinstance="2">
1224 <a name="method-setTitle"></a> <!-- method-anchor --> 682 <a name="method-setTitle"></a> <!-- method-anchor -->
1225 <h4>setTitle</h4> 683 <h4>setTitle</h4>
1226 684
1227 <div class="summary"><span style="display: none; ">void</span> 685 <div class="summary"><span style="display: none; ">void</span>
1228 <!-- Note: intentionally longer 80 columns --> 686 <!-- Note: intentionally longer 80 columns -->
1229 <span>chrome.pageAction.setTitle</span>(<span jsinstance="*0" class="null"><span style="display: none; ">, </span><span>object</span> 687 <span>chrome.pageAction.setTitle</span>(<span jsinstance="*0" class="null"><span style="display: none; ">, </span><span>object</span>
1230 <var><span>details</span></var></span>)</div> 688 <var><span>details</span></var></span>)</div>
1231 689
1232 <div class="description"> 690 <div class="description">
1233 <p class="todo" style="display: none; ">Undocumented.</p> 691 <p class="todo" style="display: none; ">Undocumented.</p>
(...skipping 151 matching lines...) Expand 10 before | Expand all | Expand 10 after
1385 <div> 843 <div>
1386 <div> 844 <div>
1387 </div> 845 </div>
1388 </div> 846 </div>
1389 </dl> 847 </dl>
1390 </div> 848 </div>
1391 </div> 849 </div>
1392 850
1393 </div> <!-- /description --> 851 </div> <!-- /description -->
1394 852
1395 </div><div class="apiItem" jsinstance="*6"> 853 </div><div class="apiItem" jsinstance="*3">
1396 <a name="method-show"></a> <!-- method-anchor --> 854 <a name="method-show"></a> <!-- method-anchor -->
1397 <h4>show</h4> 855 <h4>show</h4>
1398 856
1399 <div class="summary"><span style="display: none; ">void</span> 857 <div class="summary"><span style="display: none; ">void</span>
1400 <!-- Note: intentionally longer 80 columns --> 858 <!-- Note: intentionally longer 80 columns -->
1401 <span>chrome.pageAction.show</span>(<span jsinstance="*0" clas s="null"><span style="display: none; ">, </span><span>integer</span> 859 <span>chrome.pageAction.show</span>(<span jsinstance="*0" clas s="null"><span style="display: none; ">, </span><span>integer</span>
1402 <var><span>tabId</span></var></span>)</div> 860 <var><span>tabId</span></var></span>)</div>
1403 861
1404 <div class="description"> 862 <div class="description">
1405 <p class="todo" style="display: none; ">Undocumented.</p> 863 <p class="todo" style="display: none; ">Undocumented.</p>
(...skipping 205 matching lines...) Expand 10 before | Expand all | Expand 10 after
1611 urchinTracker(); 1069 urchinTracker();
1612 } 1070 }
1613 catch(e) {/* urchinTracker not available. */} 1071 catch(e) {/* urchinTracker not available. */}
1614 </script> 1072 </script>
1615 <!-- end analytics --> 1073 <!-- end analytics -->
1616 1074
1617 </div> <!-- /pageFooter --> 1075 </div> <!-- /pageFooter -->
1618 </div> <!-- /container --> 1076 </div> <!-- /container -->
1619 </body></html> 1077 </body></html>
1620 1078
OLDNEW
« no previous file with comments | « chrome/common/extensions/api/extension_api.json ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698