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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 269079: Implement new page action API. (Closed)
Patch Set: compile fixes 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') | chrome/common/extensions/extension_action.h » ('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 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla te_compiled.js">
14 </script>
15 <script type="text/javascript" src="js/api_page_generator.js"></script>
16 <script type="text/javascript" src="js/bootstrap.js"></script>
17 <title>chrome.pageAction</title></head><body> <div id="container">
18 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
19 <!-- In particular, sub-templates that recurse, must be used by allowing
20 jstemplate to make a copy of the template in this section which
21 are not operated on by way of the jsskip="true" -->
22 <div style="display:none">
23
24 <!-- VALUE -->
25 <div id="valueTemplate">
26 <dt>
27 <var>paramName</var>
28 <em>
29
30 <!-- TYPE -->
31 <div style="display:inline">
32 (
33 <span class="optional">optional</span>
34 <span id="typeTemplate">
35 <span>
36 <a> Type</a>
37 </span>
38 <span>
39 <span>
40 array of <span><span></span></span>
41 </span>
42 <span>paramType</span>
43 </span>
44 </span>
45 )
46 </div>
47
48 </em>
49 </dt>
50 <dd class="todo">
51 Undocumented.
52 </dd>
53 <dd>
54 Description of this parameter from the json schema.
55 </dd>
56
57 <!-- OBJECT PROPERTIES -->
58 <dd>
59 <dl>
60 <div>
61 <div>
62 </div>
63 </div>
64 </dl>
65 </dd>
66 </div> <!-- /VALUE -->
67
68 </div> <!-- /SUBTEMPLATES -->
69
70 <a name="top"> </a>
71 <!-- API HEADER -->
72 <div id="pageHeader">
73 <div id="searchbox">
74 <form action="http://www.google.com/cse" id="cse-search-box">
75 <div>
76 <input type="hidden" name="cx" value="002967670403910741006:61_cvzfq tno">
77 <input type="hidden" name="ie" value="UTF-8">
78 <input type="text" name="q" size="31">
79 <input type="submit" name="sa" value="Search">
80 </div>
81 </form>
82
83 <script type="text/javascript" src="http://www.google.com/jsapi"></scrip t>
84 <script type="text/javascript">google.load("elements", "1", {packages: " transliteration"});</script>
85 <script type="text/javascript" src="http://www.google.com/coop/cse/t13n? form=cse-search-box&amp;t13n_langs=en"></script>
86 <script type="text/javascript" src="http://www.google.com/coop/cse/brand ?form=cse-search-box&amp;lang=en"></script>
87 </div>
88 <div id="pageTitle">
89 <h1>chrome.pageAction</h1>
90 </div>
91 </div> <!-- /pageHeader -->
92
93 <div id="pageContent">
94 <!-- SIDENAV -->
95 <div id="leftNav">
96 <ul>
97 <li> <a href="index.html">Home</a></li>
98 <li> <a href="getstarted.html">Getting Started</a></li>
99 <li> <a href="overview.html">Overview</a></li>
100 <li> <a href="devguide.html"><div>Developer's Guide</div></a>
101 <ul>
102 <li><a href="toolstrip.html">Toolstrips</a></li>
103 <li><a href="pageActions.html">Page Actions</a></li>
104 <li><a href="background_pages.html">Background Pages</a></li>
105 <li><a href="content_scripts.html">Content Scripts</a></li>
106 <li><a href="events.html">Events</a></li>
107 <li><a href="tabs.html">Tabs</a></li>
108 <li><a href="windows.html">Windows</a></li>
109 <li><a href="bookmarks.html">Bookmarks</a></li>
110 <li><a href="themes.html">Themes</a></li>
111 <li><a href="npapi.html">NPAPI Plugins</a></li>
112 <li><a href="xhr.html">Cross-Origin XHR</a></li>
113 <li><a href="packaging.html">Packaging</a></li>
114 <li><a href="autoupdate.html">Autoupdate</a></li>
115 </ul>
116 </li>
117 <li><a href="tutorials.html"><div>Tutorials</div></a>
118 <ul>
119 <li><a href="tut_debugging.html">Debugging</a></li>
120 </ul>
121 </li>
122 <li>Reference
123 <ul>
124 <li> Formats
125 <ul>
126 <li><a href="manifest.html">Manifest Files</a></li>
127 <li><a href="match_patterns.html">Match Patterns</a></li>
128 <!-- <li>Packages (.crx)</li> -->
129 </ul>
130 </li>
131 <li> <a href="api_index.html">chrome.* APIs</a> </li>
132 <li> <a href="api_other.html">Other APIs</a> </li>
133 </ul>
134 </li>
135 <li><a href="http://dev.chromium.org/developers/design-documents/extens ions/samples">Samples</a></li>
136 </ul>
137 </div>
138
139 <div id="mainColumn">
140 <!-- TABLE OF CONTENTS -->
141 <div id="toc">
142 <p>Contents</p>
143 <ol>
144 <li jsinstance="*0" style="display: none; ">
145 <a>h2Name</a>
146 <ol>
147 <li>
148 <a>h3Name</a>
149 </li>
150 </ol>
151 </li>
152 <div>
153 <li>
154 <a href="#apiReference">API reference: chrome.pageAction</a>
155 <ol>
156 <li style="display: none; ">
157 <a href="#properties">Properties</a>
158 <ol>
159 <li>
160 <a href="#property-anchor">propertyName</a>
161 </li>
162 </ol>
163 </li>
164 <li>
165 <a href="#methods">Methods</a>
166 <ol>
167 <li jsinstance="0">
168 <a href="#method-hide">hide</a>
169 </li><li jsinstance="1">
170 <a href="#method-setBadgeBackgroundColor">setBadgeBackgr oundColor</a>
171 </li><li jsinstance="2">
172 <a href="#method-setBadgeText">setBadgeText</a>
173 </li><li jsinstance="3">
174 <a href="#method-setBadgeTextColor">setBadgeTextColor</a >
175 </li><li jsinstance="4">
176 <a href="#method-setIcon">setIcon</a>
177 </li><li jsinstance="5">
178 <a href="#method-setTitle">setTitle</a>
179 </li><li jsinstance="*6">
180 <a href="#method-show">show</a>
181 </li>
182 </ol>
183 </li>
184 <li>
185 <a href="#events">Events</a>
186 <ol>
187 <li jsinstance="*0">
188 <a href="#event-onClicked">onClicked</a>
189 </li>
190 </ol>
191 </li>
192 <li style="display: none; ">
193 <a href="#types">Types</a>
194 <ol>
195 <li>
196 <a href="#id-anchor">id</a>
197 </li>
198 </ol>
199 </li>
200 </ol>
201 </li>
202 </div>
203 </ol>
204 </div>
205 <!-- /TABLE OF CONTENTS -->
206
207 <!-- STATIC CONTENT PLACEHOLDER -->
208 <div id="static"></div>
209
210 <!-- API PAGE -->
211 <div class="apiPage">
212 <a name="apiReference"></a>
213 <h2>API reference: chrome.pageAction</h2>
214
215 <!-- PROPERTIES -->
216 <div class="apiGroup" style="display: none; ">
217 <a name="properties"></a>
218 <h3 id="properties">Properties</h3>
219
220 <div>
221 <a></a>
222 <h4>getLastError</h4>
223 <div class="summary">
224 <!-- Note: intentionally longer 80 columns -->
225 <span>chrome.extension</span><span>lastError</span>
226 </div>
227 <div>
228 </div>
229 </div>
230
231 </div> <!-- /apiGroup -->
232
233 <!-- METHODS -->
234 <div class="apiGroup" id="methods">
235 <a name="methods"></a>
236 <h3>Methods</h3>
237
238 <!-- iterates over all functions -->
239 <div class="apiItem" jsinstance="0">
240 <a name="method-hide"></a> <!-- method-anchor -->
241 <h4>hide</h4>
242
243 <div class="summary"><span style="display: none; ">void</span>
244 <!-- Note: intentionally longer 80 columns -->
245 <span>chrome.pageAction.hide</span>(<span jsinstance="*0" clas s="null"><span style="display: none; ">, </span><span>integer</span>
246 <var><span>tabId</span></var></span>)</div>
247
248 <div class="description">
249 <p class="todo" style="display: none; ">Undocumented.</p>
250 <p>Hide the page action.</p>
251
252 <!-- PARAMETERS -->
253 <h4>Parameters</h4>
254 <dl>
255 <div jsinstance="*0">
256 <div>
257 <dt>
258 <var>tabId</var>
259 <em>
260
261 <!-- TYPE -->
262 <div style="display:inline">
263 (
264 <span class="optional" style="display: none; ">optional</spa n>
265 <span id="typeTemplate">
266 <span style="display: none; ">
267 <a> Type</a>
268 </span>
269 <span>
270 <span style="display: none; ">
271 array of <span><span></span></span>
272 </span>
273 <span>integer</span>
274 </span>
275 </span>
276 )
277 </div>
278
279 </em>
280 </dt>
281 <dd class="todo" style="display: none; ">
282 Undocumented.
283 </dd>
284 <dd>The id of the tab for which you want to modify the page action.</d d>
285
286 <!-- OBJECT PROPERTIES -->
287 <dd style="display: none; ">
288 <dl>
289 <div>
290 <div>
291 </div>
292 </div>
293 </dl>
294 </dd>
295 </div>
296 </div>
297 </dl>
298
299 <!-- RETURNS -->
300 <h4 style="display: none; ">Returns</h4>
301 <dl>
302 <div style="display: none; ">
303 <div>
304 </div>
305 </div>
306 </dl>
307
308 <!-- CALLBACK -->
309 <div style="display: none; ">
310 <div>
311 <h4>Callback function</h4>
312 <p>
313 If you specify the <em>callback</em> parameter,
314 it should specify a function that looks like this:
315 </p>
316
317 <!-- Note: intentionally longer 80 columns -->
318 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>);</pre>
319 <dl>
320 <div>
321 <div>
322 </div>
323 </div>
324 </dl>
325 </div>
326 </div>
327
328 </div> <!-- /description -->
329
330 </div><div class="apiItem" jsinstance="1">
331 <a name="method-setBadgeBackgroundColor"></a> <!-- method-anchor - ->
332 <h4>setBadgeBackgroundColor</h4>
333
334 <div class="summary"><span style="display: none; ">void</span>
335 <!-- Note: intentionally longer 80 columns -->
336 <span>chrome.pageAction.setBadgeBackgroundColor</span>(<span j sinstance="*0" class="null"><span style="display: none; ">, </span><span>object< /span>
337 <var><span>details</span></var></span>)</div>
338
339 <div class="description">
340 <p class="todo" style="display: none; ">Undocumented.</p>
341 <p>Sets the background color for the badge.</p>
342
343 <!-- PARAMETERS -->
344 <h4>Parameters</h4>
345 <dl>
346 <div jsinstance="*0">
347 <div>
348 <dt>
349 <var>details</var>
350 <em>
351
352 <!-- TYPE -->
353 <div style="display:inline">
354 (
355 <span class="optional" style="display: none; ">optional</spa n>
356 <span id="typeTemplate">
357 <span style="display: none; ">
358 <a> Type</a>
359 </span>
360 <span>
361 <span style="display: none; ">
362 array of <span><span></span></span>
363 </span>
364 <span>object</span>
365 </span>
366 </span>
367 )
368 </div>
369
370 </em>
371 </dt>
372 <dd class="todo">
373 Undocumented.
374 </dd>
375 <dd style="display: none; ">
376 Description of this parameter from the json schema.
377 </dd>
378
379 <!-- OBJECT PROPERTIES -->
380 <dd>
381 <dl>
382 <div jsinstance="0">
383 <div>
384 <dt>
385 <var>tabId</var>
386 <em>
387
388 <!-- TYPE -->
389 <div style="display:inline">
390 (
391 <span class="optional" style="display: none; ">optional</spa n>
392 <span id="typeTemplate">
393 <span style="display: none; ">
394 <a> Type</a>
395 </span>
396 <span>
397 <span style="display: none; ">
398 array of <span><span></span></span>
399 </span>
400 <span>integer</span>
401 </span>
402 </span>
403 )
404 </div>
405
406 </em>
407 </dt>
408 <dd class="todo" style="display: none; ">
409 Undocumented.
410 </dd>
411 <dd>The id of the tab for which you want to modify the page action.</d d>
412
413 <!-- OBJECT PROPERTIES -->
414 <dd style="display: none; ">
415 <dl>
416 <div>
417 <div>
418 </div>
419 </div>
420 </dl>
421 </dd>
422 </div>
423 </div><div jsinstance="*1">
424 <div>
425 <dt>
426 <var>color</var>
427 <em>
428
429 <!-- TYPE -->
430 <div style="display:inline">
431 (
432 <span class="optional" style="display: none; ">optional</spa n>
433 <span id="typeTemplate">
434 <span style="display: none; ">
435 <a> Type</a>
436 </span>
437 <span>
438 <span>
439 array of <span><span>
440 <span style="display: none; ">
441 <a> Type</a>
442 </span>
443 <span>
444 <span style="display: none; ">
445 array of <span><span></span></span>
446 </span>
447 <span>integer</span>
448 </span>
449 </span></span>
450 </span>
451 <span style="display: none; ">paramType</span>
452 </span>
453 </span>
454 )
455 </div>
456
457 </em>
458 </dt>
459 <dd class="todo" style="display: none; ">
460 Undocumented.
461 </dd>
462 <dd>An array of four integers in the range [0,255] that make up the AR GB color for the text of the badge.</dd>
463
464 <!-- OBJECT PROPERTIES -->
465 <dd style="display: none; ">
466 <dl>
467 <div>
468 <div>
469 </div>
470 </div>
471 </dl>
472 </dd>
473 </div>
474 </div>
475 </dl>
476 </dd>
477 </div>
478 </div>
479 </dl>
480
481 <!-- RETURNS -->
482 <h4 style="display: none; ">Returns</h4>
483 <dl>
484 <div style="display: none; ">
485 <div>
486 </div>
487 </div>
488 </dl>
489
490 <!-- CALLBACK -->
491 <div style="display: none; ">
492 <div>
493 <h4>Callback function</h4>
494 <p>
495 If you specify the <em>callback</em> parameter,
496 it should specify a function that looks like this:
497 </p>
498
499 <!-- Note: intentionally longer 80 columns -->
500 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>);</pre>
501 <dl>
502 <div>
503 <div>
504 </div>
505 </div>
506 </dl>
507 </div>
508 </div>
509
510 </div> <!-- /description -->
511
512 </div><div class="apiItem" jsinstance="2">
513 <a name="method-setBadgeText"></a> <!-- method-anchor -->
514 <h4>setBadgeText</h4>
515
516 <div class="summary"><span style="display: none; ">void</span>
517 <!-- Note: intentionally longer 80 columns -->
518 <span>chrome.pageAction.setBadgeText</span>(<span jsinstance=" *0" class="null"><span style="display: none; ">, </span><span>object</span>
519 <var><span>details</span></var></span>)</div>
520
521 <div class="description">
522 <p class="todo" style="display: none; ">Undocumented.</p>
523 <p>Sets the badge text for the page action. This is printed on t op of the icon.</p>
524
525 <!-- PARAMETERS -->
526 <h4>Parameters</h4>
527 <dl>
528 <div jsinstance="*0">
529 <div>
530 <dt>
531 <var>details</var>
532 <em>
533
534 <!-- TYPE -->
535 <div style="display:inline">
536 (
537 <span class="optional" style="display: none; ">optional</spa n>
538 <span id="typeTemplate">
539 <span style="display: none; ">
540 <a> Type</a>
541 </span>
542 <span>
543 <span style="display: none; ">
544 array of <span><span></span></span>
545 </span>
546 <span>object</span>
547 </span>
548 </span>
549 )
550 </div>
551
552 </em>
553 </dt>
554 <dd class="todo">
555 Undocumented.
556 </dd>
557 <dd style="display: none; ">
558 Description of this parameter from the json schema.
559 </dd>
560
561 <!-- OBJECT PROPERTIES -->
562 <dd>
563 <dl>
564 <div jsinstance="0">
565 <div>
566 <dt>
567 <var>tabId</var>
568 <em>
569
570 <!-- TYPE -->
571 <div style="display:inline">
572 (
573 <span class="optional" style="display: none; ">optional</spa n>
574 <span id="typeTemplate">
575 <span style="display: none; ">
576 <a> Type</a>
577 </span>
578 <span>
579 <span style="display: none; ">
580 array of <span><span></span></span>
581 </span>
582 <span>integer</span>
583 </span>
584 </span>
585 )
586 </div>
587
588 </em>
589 </dt>
590 <dd class="todo" style="display: none; ">
591 Undocumented.
592 </dd>
593 <dd>The id of the tab for which you want to modify the page action.</d d>
594
595 <!-- OBJECT PROPERTIES -->
596 <dd style="display: none; ">
597 <dl>
598 <div>
599 <div>
600 </div>
601 </div>
602 </dl>
603 </dd>
604 </div>
605 </div><div jsinstance="*1">
606 <div>
607 <dt>
608 <var>text</var>
609 <em>
610
611 <!-- TYPE -->
612 <div style="display:inline">
613 (
614 <span class="optional" style="display: none; ">optional</spa n>
615 <span id="typeTemplate">
616 <span style="display: none; ">
617 <a> Type</a>
618 </span>
619 <span>
620 <span style="display: none; ">
621 array of <span><span></span></span>
622 </span>
623 <span>string</span>
624 </span>
625 </span>
626 )
627 </div>
628
629 </em>
630 </dt>
631 <dd class="todo" style="display: none; ">
632 Undocumented.
633 </dd>
634 <dd>Any number of characters can be passed, but only about four can fi t in the space.</dd>
635
636 <!-- OBJECT PROPERTIES -->
637 <dd style="display: none; ">
638 <dl>
639 <div>
640 <div>
641 </div>
642 </div>
643 </dl>
644 </dd>
645 </div>
646 </div>
647 </dl>
648 </dd>
649 </div>
650 </div>
651 </dl>
652
653 <!-- RETURNS -->
654 <h4 style="display: none; ">Returns</h4>
655 <dl>
656 <div style="display: none; ">
657 <div>
658 </div>
659 </div>
660 </dl>
661
662 <!-- CALLBACK -->
663 <div style="display: none; ">
664 <div>
665 <h4>Callback function</h4>
666 <p>
667 If you specify the <em>callback</em> parameter,
668 it should specify a function that looks like this:
669 </p>
670
671 <!-- Note: intentionally longer 80 columns -->
672 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>);</pre>
673 <dl>
674 <div>
675 <div>
676 </div>
677 </div>
678 </dl>
679 </div>
680 </div>
681
682 </div> <!-- /description -->
683
684 </div><div class="apiItem" jsinstance="3">
685 <a name="method-setBadgeTextColor"></a> <!-- method-anchor -->
686 <h4>setBadgeTextColor</h4>
687
688 <div class="summary"><span style="display: none; ">void</span>
689 <!-- Note: intentionally longer 80 columns -->
690 <span>chrome.pageAction.setBadgeTextColor</span>(<span jsinsta nce="*0" class="null"><span style="display: none; ">, </span><span>object</span>
691 <var><span>details</span></var></span>)</div>
692
693 <div class="description">
694 <p class="todo" style="display: none; ">Undocumented.</p>
695 <p>Sets the text color for the badge.</p>
696
697 <!-- PARAMETERS -->
698 <h4>Parameters</h4>
699 <dl>
700 <div jsinstance="*0">
701 <div>
702 <dt>
703 <var>details</var>
704 <em>
705
706 <!-- TYPE -->
707 <div style="display:inline">
708 (
709 <span class="optional" style="display: none; ">optional</spa n>
710 <span id="typeTemplate">
711 <span style="display: none; ">
712 <a> Type</a>
713 </span>
714 <span>
715 <span style="display: none; ">
716 array of <span><span></span></span>
717 </span>
718 <span>object</span>
719 </span>
720 </span>
721 )
722 </div>
723
724 </em>
725 </dt>
726 <dd class="todo">
727 Undocumented.
728 </dd>
729 <dd style="display: none; ">
730 Description of this parameter from the json schema.
731 </dd>
732
733 <!-- OBJECT PROPERTIES -->
734 <dd>
735 <dl>
736 <div jsinstance="0">
737 <div>
738 <dt>
739 <var>tabId</var>
740 <em>
741
742 <!-- TYPE -->
743 <div style="display:inline">
744 (
745 <span class="optional" style="display: none; ">optional</spa n>
746 <span id="typeTemplate">
747 <span style="display: none; ">
748 <a> Type</a>
749 </span>
750 <span>
751 <span style="display: none; ">
752 array of <span><span></span></span>
753 </span>
754 <span>integer</span>
755 </span>
756 </span>
757 )
758 </div>
759
760 </em>
761 </dt>
762 <dd class="todo" style="display: none; ">
763 Undocumented.
764 </dd>
765 <dd>The id of the tab for which you want to modify the page action.</d d>
766
767 <!-- OBJECT PROPERTIES -->
768 <dd style="display: none; ">
769 <dl>
770 <div>
771 <div>
772 </div>
773 </div>
774 </dl>
775 </dd>
776 </div>
777 </div><div jsinstance="*1">
778 <div>
779 <dt>
780 <var>color</var>
781 <em>
782
783 <!-- TYPE -->
784 <div style="display:inline">
785 (
786 <span class="optional" style="display: none; ">optional</spa n>
787 <span id="typeTemplate">
788 <span style="display: none; ">
789 <a> Type</a>
790 </span>
791 <span>
792 <span>
793 array of <span><span>
794 <span style="display: none; ">
795 <a> Type</a>
796 </span>
797 <span>
798 <span style="display: none; ">
799 array of <span><span></span></span>
800 </span>
801 <span>integer</span>
802 </span>
803 </span></span>
804 </span>
805 <span style="display: none; ">paramType</span>
806 </span>
807 </span>
808 )
809 </div>
810
811 </em>
812 </dt>
813 <dd class="todo" style="display: none; ">
814 Undocumented.
815 </dd>
816 <dd>An array of four integers in the range [0,255] that make up the AR GB color for the text of the badge.</dd>
817
818 <!-- OBJECT PROPERTIES -->
819 <dd style="display: none; ">
820 <dl>
821 <div>
822 <div>
823 </div>
824 </div>
825 </dl>
826 </dd>
827 </div>
828 </div>
829 </dl>
830 </dd>
831 </div>
832 </div>
833 </dl>
834
835 <!-- RETURNS -->
836 <h4 style="display: none; ">Returns</h4>
837 <dl>
838 <div style="display: none; ">
839 <div>
840 </div>
841 </div>
842 </dl>
843
844 <!-- CALLBACK -->
845 <div style="display: none; ">
846 <div>
847 <h4>Callback function</h4>
848 <p>
849 If you specify the <em>callback</em> parameter,
850 it should specify a function that looks like this:
851 </p>
852
853 <!-- Note: intentionally longer 80 columns -->
854 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>);</pre>
855 <dl>
856 <div>
857 <div>
858 </div>
859 </div>
860 </dl>
861 </div>
862 </div>
863
864 </div> <!-- /description -->
865
866 </div><div class="apiItem" jsinstance="4">
867 <a name="method-setIcon"></a> <!-- method-anchor -->
868 <h4>setIcon</h4>
869
870 <div class="summary"><span style="display: none; ">void</span>
871 <!-- Note: intentionally longer 80 columns -->
872 <span>chrome.pageAction.setIcon</span>(<span jsinstance="*0" c lass="null"><span style="display: none; ">, </span><span>object</span>
873 <var><span>details</span></var></span>)</div>
874
875 <div class="description">
876 <p class="todo" style="display: none; ">Undocumented.</p>
877 <p>Sets the icon for the page action. The icon can be specified either as the index of one of the icons that was pre-specified in the manifest, or as the pixel data from a Canvas element. Either the iconIndex or the imageDat a property must be specified.</p>
878
879 <!-- PARAMETERS -->
880 <h4>Parameters</h4>
881 <dl>
882 <div jsinstance="*0">
883 <div>
884 <dt>
885 <var>details</var>
886 <em>
887
888 <!-- TYPE -->
889 <div style="display:inline">
890 (
891 <span class="optional" style="display: none; ">optional</spa n>
892 <span id="typeTemplate">
893 <span style="display: none; ">
894 <a> Type</a>
895 </span>
896 <span>
897 <span style="display: none; ">
898 array of <span><span></span></span>
899 </span>
900 <span>object</span>
901 </span>
902 </span>
903 )
904 </div>
905
906 </em>
907 </dt>
908 <dd class="todo">
909 Undocumented.
910 </dd>
911 <dd style="display: none; ">
912 Description of this parameter from the json schema.
913 </dd>
914
915 <!-- OBJECT PROPERTIES -->
916 <dd>
917 <dl>
918 <div jsinstance="0">
919 <div>
920 <dt>
921 <var>tabId</var>
922 <em>
923
924 <!-- TYPE -->
925 <div style="display:inline">
926 (
927 <span class="optional" style="display: none; ">optional</spa n>
928 <span id="typeTemplate">
929 <span style="display: none; ">
930 <a> Type</a>
931 </span>
932 <span>
933 <span style="display: none; ">
934 array of <span><span></span></span>
935 </span>
936 <span>integer</span>
937 </span>
938 </span>
939 )
940 </div>
941
942 </em>
943 </dt>
944 <dd class="todo" style="display: none; ">
945 Undocumented.
946 </dd>
947 <dd>The id of the tab for which you want to modify the page action.</d d>
948
949 <!-- OBJECT PROPERTIES -->
950 <dd style="display: none; ">
951 <dl>
952 <div>
953 <div>
954 </div>
955 </div>
956 </dl>
957 </dd>
958 </div>
959 </div><div jsinstance="1">
960 <div>
961 <dt>
962 <var>imageData</var>
963 <em>
964
965 <!-- TYPE -->
966 <div style="display:inline">
967 (
968 <span class="optional">optional</span>
969 <span id="typeTemplate">
970 <span style="display: none; ">
971 <a> Type</a>
972 </span>
973 <span>
974 <span style="display: none; ">
975 array of <span><span></span></span>
976 </span>
977 <span>any</span>
978 </span>
979 </span>
980 )
981 </div>
982
983 </em>
984 </dt>
985 <dd class="todo" style="display: none; ">
986 Undocumented.
987 </dd>
988 <dd>Pixel data for an image. Must be an ImageData object (eg from a <c ode>canvas</code> element).</dd>
989
990 <!-- OBJECT PROPERTIES -->
991 <dd style="display: none; ">
992 <dl>
993 <div>
994 <div>
995 </div>
996 </div>
997 </dl>
998 </dd>
999 </div>
1000 </div><div jsinstance="*2">
1001 <div>
1002 <dt>
1003 <var>iconIndex</var>
1004 <em>
1005
1006 <!-- TYPE -->
1007 <div style="display:inline">
1008 (
1009 <span class="optional">optional</span>
1010 <span id="typeTemplate">
1011 <span style="display: none; ">
1012 <a> Type</a>
1013 </span>
1014 <span>
1015 <span style="display: none; ">
1016 array of <span><span></span></span>
1017 </span>
1018 <span>integer</span>
1019 </span>
1020 </span>
1021 )
1022 </div>
1023
1024 </em>
1025 </dt>
1026 <dd class="todo" style="display: none; ">
1027 Undocumented.
1028 </dd>
1029 <dd>The zero-based index into the |icons| vector specified in the mani fest.</dd>
1030
1031 <!-- OBJECT PROPERTIES -->
1032 <dd style="display: none; ">
1033 <dl>
1034 <div>
1035 <div>
1036 </div>
1037 </div>
1038 </dl>
1039 </dd>
1040 </div>
1041 </div>
1042 </dl>
1043 </dd>
1044 </div>
1045 </div>
1046 </dl>
1047
1048 <!-- RETURNS -->
1049 <h4 style="display: none; ">Returns</h4>
1050 <dl>
1051 <div style="display: none; ">
1052 <div>
1053 </div>
1054 </div>
1055 </dl>
1056
1057 <!-- CALLBACK -->
1058 <div style="display: none; ">
1059 <div>
1060 <h4>Callback function</h4>
1061 <p>
1062 If you specify the <em>callback</em> parameter,
1063 it should specify a function that looks like this:
1064 </p>
1065
1066 <!-- Note: intentionally longer 80 columns -->
1067 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>);</pre>
1068 <dl>
1069 <div>
1070 <div>
1071 </div>
1072 </div>
1073 </dl>
1074 </div>
1075 </div>
1076
1077 </div> <!-- /description -->
1078
1079 </div><div class="apiItem" jsinstance="5">
1080 <a name="method-setTitle"></a> <!-- method-anchor -->
1081 <h4>setTitle</h4>
1082
1083 <div class="summary"><span style="display: none; ">void</span>
1084 <!-- Note: intentionally longer 80 columns -->
1085 <span>chrome.pageAction.setTitle</span>(<span jsinstance="*0" class="null"><span style="display: none; ">, </span><span>object</span>
1086 <var><span>details</span></var></span>)</div>
1087
1088 <div class="description">
1089 <p class="todo" style="display: none; ">Undocumented.</p>
1090 <p>Set the title of the page action. This is displayed in a tool tip over the page action.</p>
1091
1092 <!-- PARAMETERS -->
1093 <h4>Parameters</h4>
1094 <dl>
1095 <div jsinstance="*0">
1096 <div>
1097 <dt>
1098 <var>details</var>
1099 <em>
1100
1101 <!-- TYPE -->
1102 <div style="display:inline">
1103 (
1104 <span class="optional" style="display: none; ">optional</spa n>
1105 <span id="typeTemplate">
1106 <span style="display: none; ">
1107 <a> Type</a>
1108 </span>
1109 <span>
1110 <span style="display: none; ">
1111 array of <span><span></span></span>
1112 </span>
1113 <span>object</span>
1114 </span>
1115 </span>
1116 )
1117 </div>
1118
1119 </em>
1120 </dt>
1121 <dd class="todo">
1122 Undocumented.
1123 </dd>
1124 <dd style="display: none; ">
1125 Description of this parameter from the json schema.
1126 </dd>
1127
1128 <!-- OBJECT PROPERTIES -->
1129 <dd>
1130 <dl>
1131 <div jsinstance="0">
1132 <div>
1133 <dt>
1134 <var>tabId</var>
1135 <em>
1136
1137 <!-- TYPE -->
1138 <div style="display:inline">
1139 (
1140 <span class="optional" style="display: none; ">optional</spa n>
1141 <span id="typeTemplate">
1142 <span style="display: none; ">
1143 <a> Type</a>
1144 </span>
1145 <span>
1146 <span style="display: none; ">
1147 array of <span><span></span></span>
1148 </span>
1149 <span>integer</span>
1150 </span>
1151 </span>
1152 )
1153 </div>
1154
1155 </em>
1156 </dt>
1157 <dd class="todo" style="display: none; ">
1158 Undocumented.
1159 </dd>
1160 <dd>The id of the tab for which you want to modify the page action.</d d>
1161
1162 <!-- OBJECT PROPERTIES -->
1163 <dd style="display: none; ">
1164 <dl>
1165 <div>
1166 <div>
1167 </div>
1168 </div>
1169 </dl>
1170 </dd>
1171 </div>
1172 </div><div jsinstance="*1">
1173 <div>
1174 <dt>
1175 <var>title</var>
1176 <em>
1177
1178 <!-- TYPE -->
1179 <div style="display:inline">
1180 (
1181 <span class="optional" style="display: none; ">optional</spa n>
1182 <span id="typeTemplate">
1183 <span style="display: none; ">
1184 <a> Type</a>
1185 </span>
1186 <span>
1187 <span style="display: none; ">
1188 array of <span><span></span></span>
1189 </span>
1190 <span>string</span>
1191 </span>
1192 </span>
1193 )
1194 </div>
1195
1196 </em>
1197 </dt>
1198 <dd class="todo" style="display: none; ">
1199 Undocumented.
1200 </dd>
1201 <dd>The tooltip string.</dd>
1202
1203 <!-- OBJECT PROPERTIES -->
1204 <dd style="display: none; ">
1205 <dl>
1206 <div>
1207 <div>
1208 </div>
1209 </div>
1210 </dl>
1211 </dd>
1212 </div>
1213 </div>
1214 </dl>
1215 </dd>
1216 </div>
1217 </div>
1218 </dl>
1219
1220 <!-- RETURNS -->
1221 <h4 style="display: none; ">Returns</h4>
1222 <dl>
1223 <div style="display: none; ">
1224 <div>
1225 </div>
1226 </div>
1227 </dl>
1228
1229 <!-- CALLBACK -->
1230 <div style="display: none; ">
1231 <div>
1232 <h4>Callback function</h4>
1233 <p>
1234 If you specify the <em>callback</em> parameter,
1235 it should specify a function that looks like this:
1236 </p>
1237
1238 <!-- Note: intentionally longer 80 columns -->
1239 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>);</pre>
1240 <dl>
1241 <div>
1242 <div>
1243 </div>
1244 </div>
1245 </dl>
1246 </div>
1247 </div>
1248
1249 </div> <!-- /description -->
1250
1251 </div><div class="apiItem" jsinstance="*6">
1252 <a name="method-show"></a> <!-- method-anchor -->
1253 <h4>show</h4>
1254
1255 <div class="summary"><span style="display: none; ">void</span>
1256 <!-- Note: intentionally longer 80 columns -->
1257 <span>chrome.pageAction.show</span>(<span jsinstance="*0" clas s="null"><span style="display: none; ">, </span><span>integer</span>
1258 <var><span>tabId</span></var></span>)</div>
1259
1260 <div class="description">
1261 <p class="todo" style="display: none; ">Undocumented.</p>
1262 <p>Show the page action. The page action is shown whenever the t ab is selected.</p>
1263
1264 <!-- PARAMETERS -->
1265 <h4>Parameters</h4>
1266 <dl>
1267 <div jsinstance="*0">
1268 <div>
1269 <dt>
1270 <var>tabId</var>
1271 <em>
1272
1273 <!-- TYPE -->
1274 <div style="display:inline">
1275 (
1276 <span class="optional" style="display: none; ">optional</spa n>
1277 <span id="typeTemplate">
1278 <span style="display: none; ">
1279 <a> Type</a>
1280 </span>
1281 <span>
1282 <span style="display: none; ">
1283 array of <span><span></span></span>
1284 </span>
1285 <span>integer</span>
1286 </span>
1287 </span>
1288 )
1289 </div>
1290
1291 </em>
1292 </dt>
1293 <dd class="todo" style="display: none; ">
1294 Undocumented.
1295 </dd>
1296 <dd>The id of the tab for which you want to modify the page action.</d d>
1297
1298 <!-- OBJECT PROPERTIES -->
1299 <dd style="display: none; ">
1300 <dl>
1301 <div>
1302 <div>
1303 </div>
1304 </div>
1305 </dl>
1306 </dd>
1307 </div>
1308 </div>
1309 </dl>
1310
1311 <!-- RETURNS -->
1312 <h4 style="display: none; ">Returns</h4>
1313 <dl>
1314 <div style="display: none; ">
1315 <div>
1316 </div>
1317 </div>
1318 </dl>
1319
1320 <!-- CALLBACK -->
1321 <div style="display: none; ">
1322 <div>
1323 <h4>Callback function</h4>
1324 <p>
1325 If you specify the <em>callback</em> parameter,
1326 it should specify a function that looks like this:
1327 </p>
1328
1329 <!-- Note: intentionally longer 80 columns -->
1330 <pre>function(<span>Type param1, Type param2</span>) <span cla ss="subdued">{...}</span>);</pre>
1331 <dl>
1332 <div>
1333 <div>
1334 </div>
1335 </div>
1336 </dl>
1337 </div>
1338 </div>
1339
1340 </div> <!-- /description -->
1341
1342 </div> <!-- /apiItem -->
1343
1344 </div> <!-- /apiGroup -->
1345
1346 <!-- EVENTS -->
1347 <div class="apiGroup">
1348 <a name="events"></a>
1349 <h3 id="events">Events</h3>
1350
1351 <!-- iterates over all events -->
1352 <div class="apiItem" jsinstance="*0">
1353 <a name="event-onClicked"></a>
1354 <h4>onClicked</h4>
1355
1356 <div class="summary">
1357 <!-- Note: intentionally longer 80 columns -->
1358 <span class="subdued">chrome.pageAction.</span><span>onClicked</ span><span class="subdued">.addListener</span>(function(<span>Tab tab</span>) <s pan class="subdued">{...}</span>);
1359 </div>
1360
1361 <div class="description">
1362 <p class="todo" style="display: none; ">Undocumented.</p>
1363 <p>Fired when a page action button is clicked.</p>
1364
1365 <!-- PARAMETERS -->
1366 <h4>Parameters</h4>
1367 <dl>
1368 <div jsinstance="*0">
1369 <div>
1370 <dt>
1371 <var>tab</var>
1372 <em>
1373
1374 <!-- TYPE -->
1375 <div style="display:inline">
1376 (
1377 <span class="optional" style="display: none; ">optional</spa n>
1378 <span id="typeTemplate">
1379 <span>
1380 <a href="tabs.html#type-Tab">Tab</a>
1381 </span>
1382 <span style="display: none; ">
1383 <span>
1384 array of <span><span></span></span>
1385 </span>
1386 <span>paramType</span>
1387 </span>
1388 </span>
1389 )
1390 </div>
1391
1392 </em>
1393 </dt>
1394 <dd class="todo">
1395 Undocumented.
1396 </dd>
1397 <dd style="display: none; ">
1398 Description of this parameter from the json schema.
1399 </dd>
1400
1401 <!-- OBJECT PROPERTIES -->
1402 <dd style="display: none; ">
1403 <dl>
1404 <div>
1405 <div>
1406 </div>
1407 </div>
1408 </dl>
1409 </dd>
1410 </div>
1411 </div>
1412 </dl>
1413
1414 </div> <!-- /decription -->
1415
1416 </div> <!-- /apiItem -->
1417
1418 </div> <!-- /apiGroup -->
1419
1420 <!-- TYPES -->
1421 <div class="apiGroup" style="display: none; ">
1422 <a name="types.sort(sortByName)"></a>
1423 <h3 id="types">Types</h3>
1424
1425 <!-- iterates over all types -->
1426 <div class="apiItem">
1427 <a></a>
1428 <h4>type name</h4>
1429
1430 <div>
1431 </div>
1432
1433 </div> <!-- /apiItem -->
1434
1435 </div> <!-- /apiGroup -->
1436
1437 </div> <!-- /apiPage -->
1438 </div> <!-- /mainColumn -->
1439 </div> <!-- /pageContent -->
1440 <div id="pageFooter" --="">
1441 <p>
1442 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
1443 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
1444 Attribution 3.0 License</a>, and code samples are licensed under the
1445 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
1446 </p>
1447 <p>
1448 ©2009 Google
1449 </p>
1450
1451 <!-- begin analytics -->
1452 <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">< /script>
1453 <script src="http://www.google-analytics.com/ga.js" type="text/javascript"></scr ipt>
1454
1455 <script type="text/javascript">
1456 // chrome doc tracking
1457 try {
1458 var engdocs = _gat._getTracker("YT-10763712-2");
1459 engdocs._trackPageview();
1460 } catch(err) {}
1461
1462 // code.google.com site-wide tracking
1463 try {
1464 _uacct="UA-18071-1";
1465 _uanchor=1;
1466 _uff=0;
1467 urchinTracker();
1468 }
1469 catch(e) {/* urchinTracker not available. */}
1470 </script>
1471 <!-- end analytics -->
1472
1473 </div> <!-- /pageFooter -->
1474 </div> <!-- /container -->
1475 </body></html>
1476
OLDNEW
« no previous file with comments | « chrome/common/extensions/api/extension_api.json ('k') | chrome/common/extensions/extension_action.h » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698