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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: 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
« no previous file with comments | « chrome/common/extensions/docs/whats_new.html ('k') | chrome/common/extensions/docs/xhr.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.windows module, which is part of the Google Chrome extension APIs."><title>Windows - Google Ch rome 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 class="leftNavSelected">Windows</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">Windows</h1>
189 </div>
190 <!-- TABLE OF CONTENTS -->
191 <div id="toc">
192 <h2>Contents</h2>
193 <ol>
194 <li>
195 <a href="#manifest">Manifest</a>
196 <ol>
197 </ol>
198 </li><li>
199 <a href="#current-window">The current window</a>
200 <ol>
201 </ol>
202 </li><li>
203 <a href="#examples"> Examples </a>
204 <ol>
205 </ol>
206 </li>
207 <li>
208 <a href="#apiReference">API reference: chrome.windows</a>
209 <ol>
210 <li>
211 <a href="#properties">Properties</a>
212 <ol>
213 <li>
214 <a href="#property-WINDOW_ID_NONE">WINDOW_ID_NONE</a>
215 </li><li>
216 <a href="#property-WINDOW_ID_CURRENT">WINDOW_ID_CURRENT</a>
217 </li>
218 </ol>
219 </li>
220 <li>
221 <a href="#global-methods">Methods</a>
222 <ol>
223 <li>
224 <a href="#method-create">create</a>
225 </li><li>
226 <a href="#method-get">get</a>
227 </li><li>
228 <a href="#method-getAll">getAll</a>
229 </li><li>
230 <a href="#method-getCurrent">getCurrent</a>
231 </li><li>
232 <a href="#method-getLastFocused">getLastFocused</a>
233 </li><li>
234 <a href="#method-remove">remove</a>
235 </li><li>
236 <a href="#method-update">update</a>
237 </li>
238 </ol>
239 </li>
240 <li>
241 <a href="#global-events">Events</a>
242 <ol>
243 <li>
244 <a href="#event-onCreated">onCreated</a>
245 </li><li>
246 <a href="#event-onFocusChanged">onFocusChanged</a>
247 </li><li>
248 <a href="#event-onRemoved">onRemoved</a>
249 </li>
250 </ol>
251 </li>
252 <li>
253 <a href="#types">Types</a>
254 <ol>
255 <li>
256 <a href="#type-Window">Window</a>
257 <ol>
258 </ol>
259 </li>
260 </ol>
261 </li>
262 </ol>
263 </li>
264 </ol>
265 </div>
266 <!-- /TABLE OF CONTENTS -->
267 <!-- Standard content lead-in for experimental API pages -->
268 <!-- STATIC CONTENT PLACEHOLDER -->
269 <div id="static"><div id="pageData-name" class="pageData">Windows</div>
270 <!-- BEGIN AUTHORED CONTENT -->
271 <p id="classSummary">
272 Use the <code>chrome.windows</code> module
273 to interact with browser windows.
274 You can use this module to
275 create, modify, and rearrange windows in the browser.
276 </p>
277 <img src="images/windows.png" width="256" height="76" alt="Two windows, each wit h one tab">
278 <h2 id="manifest">Manifest</h2>
279 <p>
280 To use the windows API,
281 you must declare the "tabs" permission
282 in <a href="manifest.html">manifest.json</a>.
283 (No, that isn't a typo —
284 the window and tabs modules interact so closely we
285 decided to just share one permission between them.)
286 For example:
287 </p>
288 <pre>{
289 "name": "My extension",
290 ...
291 <b>"permissions": ["tabs"]</b>,
292 ...
293 }</pre>
294 <h2 id="current-window">The current window</h2>
295 <p>Many functions in the extension system
296 take an optional <var>windowId</var> parameter,
297 which defaults to the current window.
298 </p>
299 <p>The <em>current window</em> is the window that
300 contains the code that is currently executing.
301 It's important to realize that this can be
302 different from the topmost or focused window.
303 </p>
304 <p>For example, say an extension
305 creates a few tabs or windows from a single HTML file,
306 and that the HTML file
307 contains a call to
308 <a href="tabs.html#method-getSelected">chrome.tabs.getSelected</a>.
309 The current window is the window that contains the page that made
310 the call, no matter what the topmost window is.
311 </p>
312 <p>In the case of the <a href="background_pages.html">background page</a>,
313 the value of the current window falls back to the last active window. Under some
314 circumstances, there may be no current window for background pages.
315 </p>
316 <h2 id="examples"> Examples </h2>
317 <p>
318 You can find simple examples of using the windows module in the
319 <a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extension s/docs/examples/api/windows/">examples/api/windows</a>
320 directory.
321 Another example is in the
322 <a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extension s/docs/examples/api/tabs/inspector/tabs_api.html?content-type=text/plain">tabs_a pi.html</a> file
323 of the
324 <a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extension s/docs/examples/api/tabs/inspector/">inspector</a>
325 example.
326 For other examples and for help in viewing the source code, see
327 <a href="samples.html">Samples</a>.
328 </p>
329 <!-- END AUTHORED CONTENT -->
330 </div>
331 <!-- API PAGE -->
332 <div class="apiPage">
333 <a name="apiReference"></a>
334 <h2>API reference: chrome.windows</h2>
335 <!-- PROPERTIES -->
336 <div class="apiGroup">
337 <a name="properties"></a>
338 <h3 id="properties">Properties</h3>
339 <div>
340 <a name="property-WINDOW_ID_NONE"></a>
341 <h4>WINDOW_ID_NONE</h4>
342 <div class="summary">
343 <!-- Note: intentionally longer 80 columns -->
344 <span>chrome.windows.</span><span>WINDOW_ID_NONE</span>
345 </div>
346 <div>
347 <dt>
348 <var>WINDOW_ID_NONE</var>
349 <em>
350 <!-- TYPE -->
351 <div style="display:inline">
352 (
353 <span id="typeTemplate">
354 <code>-1</code>
355 </span>
356 )
357 </div>
358 </em>
359 </dt>
360 <dd>The windowId value that represents the absence of a chrome browser window.</dd>
361 <!-- OBJECT PROPERTIES -->
362 <!-- OBJECT METHODS -->
363 <!-- OBJECT EVENT FIELDS -->
364 <!-- FUNCTION PARAMETERS -->
365 </div>
366 </div><div>
367 <a name="property-WINDOW_ID_CURRENT"></a>
368 <h4>WINDOW_ID_CURRENT</h4>
369 <div class="summary">
370 <!-- Note: intentionally longer 80 columns -->
371 <span>chrome.windows.</span><span>WINDOW_ID_CURRENT</span>
372 </div>
373 <div>
374 <dt>
375 <var>WINDOW_ID_CURRENT</var>
376 <em>
377 <!-- TYPE -->
378 <div style="display:inline">
379 (
380 <span id="typeTemplate">
381 <code>-2</code>
382 </span>
383 )
384 </div>
385 </em>
386 </dt>
387 <dd>The windowId value that represents the <a href="windows.html#curre nt-window">current window</a>.</dd>
388 <!-- OBJECT PROPERTIES -->
389 <!-- OBJECT METHODS -->
390 <!-- OBJECT EVENT FIELDS -->
391 <!-- FUNCTION PARAMETERS -->
392 </div>
393 </div>
394 </div> <!-- /apiGroup -->
395 <!-- METHODS -->
396 <div id="methodsTemplate" class="apiGroup">
397 <a name="global-methods"></a>
398 <h3>Methods</h3>
399 <!-- iterates over all functions -->
400 <div class="apiItem">
401 <a name="method-create"></a> <!-- method-anchor -->
402 <h4>create</h4>
403 <div class="summary">
404 <!-- Note: intentionally longer 80 columns -->
405 <span>chrome.windows.create</span>(<span class="optional"><spa n>object</span>
406 <var><span>createData</span></var></span><span class="opti onal"><span>, </span><span>function</span>
407 <var><span>callback</span></var></span>)</div>
408 <div class="description">
409 <p>Creates (opens) a new browser with any optional sizing, posit ion or default URL provided.</p>
410 <!-- PARAMETERS -->
411 <h4>Parameters</h4>
412 <dl>
413 <div>
414 <div>
415 <dt>
416 <var>createData</var>
417 <em>
418 <!-- TYPE -->
419 <div style="display:inline">
420 (
421 <span class="optional">optional</span>
422 <span id="typeTemplate">
423 <span>
424 <span>object</span>
425 </span>
426 </span>
427 )
428 </div>
429 </em>
430 </dt>
431 <dd class="todo">
432 Undocumented.
433 </dd>
434 <!-- OBJECT PROPERTIES -->
435 <dd>
436 <dl>
437 <div>
438 <div>
439 <dt>
440 <var>url</var>
441 <em>
442 <!-- TYPE -->
443 <div style="display:inline">
444 (
445 <span class="optional">optional</span>
446 <span id="typeTemplate">
447 <span>
448 <span>string or array of string</span>
449 </span>
450 </span>
451 )
452 </div>
453 </em>
454 </dt>
455 <dd>A URL or list of URLs to open as tabs in the window. Fully-qualifi ed URLs must include a scheme (i.e. 'http://www.google.com', not 'www.google.com '). Relative URLs will be relative to the current page within the extension. Def aults to the New Tab Page.</dd>
456 <!-- OBJECT PROPERTIES -->
457 <!-- OBJECT METHODS -->
458 <!-- OBJECT EVENT FIELDS -->
459 <!-- FUNCTION PARAMETERS -->
460 </div>
461 </div><div>
462 <div>
463 <dt>
464 <var>tabId</var>
465 <em>
466 <!-- TYPE -->
467 <div style="display:inline">
468 (
469 <span class="optional">optional</span>
470 <span id="typeTemplate">
471 <span>
472 <span>integer</span>
473 </span>
474 </span>
475 )
476 </div>
477 </em>
478 </dt>
479 <dd>The id of the tab for which you want to adopt to the new window.</ dd>
480 <!-- OBJECT PROPERTIES -->
481 <!-- OBJECT METHODS -->
482 <!-- OBJECT EVENT FIELDS -->
483 <!-- FUNCTION PARAMETERS -->
484 </div>
485 </div><div>
486 <div>
487 <dt>
488 <var>left</var>
489 <em>
490 <!-- TYPE -->
491 <div style="display:inline">
492 (
493 <span class="optional">optional</span>
494 <span id="typeTemplate">
495 <span>
496 <span>integer</span>
497 </span>
498 </span>
499 )
500 </div>
501 </em>
502 </dt>
503 <dd>The number of pixels to position the new window from the left edge of the screen. If not specified, the new window is offset naturally from the la st focused window. This value is ignored for panels.</dd>
504 <!-- OBJECT PROPERTIES -->
505 <!-- OBJECT METHODS -->
506 <!-- OBJECT EVENT FIELDS -->
507 <!-- FUNCTION PARAMETERS -->
508 </div>
509 </div><div>
510 <div>
511 <dt>
512 <var>top</var>
513 <em>
514 <!-- TYPE -->
515 <div style="display:inline">
516 (
517 <span class="optional">optional</span>
518 <span id="typeTemplate">
519 <span>
520 <span>integer</span>
521 </span>
522 </span>
523 )
524 </div>
525 </em>
526 </dt>
527 <dd>The number of pixels to position the new window from the top edge of the screen. If not specified, the new window is offset naturally from the las t focused window. This value is ignored for panels.</dd>
528 <!-- OBJECT PROPERTIES -->
529 <!-- OBJECT METHODS -->
530 <!-- OBJECT EVENT FIELDS -->
531 <!-- FUNCTION PARAMETERS -->
532 </div>
533 </div><div>
534 <div>
535 <dt>
536 <var>width</var>
537 <em>
538 <!-- TYPE -->
539 <div style="display:inline">
540 (
541 <span class="optional">optional</span>
542 <span id="typeTemplate">
543 <span>
544 <span>integer</span>
545 </span>
546 </span>
547 )
548 </div>
549 </em>
550 </dt>
551 <dd>The width in pixels of the new window. If not specified defaults t o a natural width.</dd>
552 <!-- OBJECT PROPERTIES -->
553 <!-- OBJECT METHODS -->
554 <!-- OBJECT EVENT FIELDS -->
555 <!-- FUNCTION PARAMETERS -->
556 </div>
557 </div><div>
558 <div>
559 <dt>
560 <var>height</var>
561 <em>
562 <!-- TYPE -->
563 <div style="display:inline">
564 (
565 <span class="optional">optional</span>
566 <span id="typeTemplate">
567 <span>
568 <span>integer</span>
569 </span>
570 </span>
571 )
572 </div>
573 </em>
574 </dt>
575 <dd>The height in pixels of the new window. If not specified defaults to a natural height.</dd>
576 <!-- OBJECT PROPERTIES -->
577 <!-- OBJECT METHODS -->
578 <!-- OBJECT EVENT FIELDS -->
579 <!-- FUNCTION PARAMETERS -->
580 </div>
581 </div><div>
582 <div>
583 <dt>
584 <var>focused</var>
585 <em>
586 <!-- TYPE -->
587 <div style="display:inline">
588 (
589 <span class="optional">optional</span>
590 <span id="typeTemplate">
591 <span>
592 <span>boolean</span>
593 </span>
594 </span>
595 )
596 </div>
597 </em>
598 </dt>
599 <dd>If true, opens an active window. If false, opens an inactive windo w.</dd>
600 <!-- OBJECT PROPERTIES -->
601 <!-- OBJECT METHODS -->
602 <!-- OBJECT EVENT FIELDS -->
603 <!-- FUNCTION PARAMETERS -->
604 </div>
605 </div><div>
606 <div>
607 <dt>
608 <var>incognito</var>
609 <em>
610 <!-- TYPE -->
611 <div style="display:inline">
612 (
613 <span class="optional">optional</span>
614 <span id="typeTemplate">
615 <span>
616 <span>boolean</span>
617 </span>
618 </span>
619 )
620 </div>
621 </em>
622 </dt>
623 <dd>Whether the new window should be an incognito window.</dd>
624 <!-- OBJECT PROPERTIES -->
625 <!-- OBJECT METHODS -->
626 <!-- OBJECT EVENT FIELDS -->
627 <!-- FUNCTION PARAMETERS -->
628 </div>
629 </div><div>
630 <div>
631 <dt>
632 <var>type</var>
633 <em>
634 <!-- TYPE -->
635 <div style="display:inline">
636 (
637 <span class="optional">optional</span>
638 <span class="enum">enumerated</span>
639 <span id="typeTemplate">
640 <span>
641 <span>string</span>
642 <span>["normal", "popup", "panel"]</span>
643 </span>
644 </span>
645 )
646 </div>
647 </em>
648 </dt>
649 <dd>Specifies what type of browser window to create. The 'panel' type creates a popup unless the '--enable-panels' flag is set.</dd>
650 <!-- OBJECT PROPERTIES -->
651 <!-- OBJECT METHODS -->
652 <!-- OBJECT EVENT FIELDS -->
653 <!-- FUNCTION PARAMETERS -->
654 </div>
655 </div>
656 </dl>
657 </dd>
658 <!-- OBJECT METHODS -->
659 <!-- OBJECT EVENT FIELDS -->
660 <!-- FUNCTION PARAMETERS -->
661 </div>
662 </div><div>
663 <div>
664 <dt>
665 <var>callback</var>
666 <em>
667 <!-- TYPE -->
668 <div style="display:inline">
669 (
670 <span class="optional">optional</span>
671 <span id="typeTemplate">
672 <span>
673 <span>function</span>
674 </span>
675 </span>
676 )
677 </div>
678 </em>
679 </dt>
680 <dd class="todo">
681 Undocumented.
682 </dd>
683 <!-- OBJECT PROPERTIES -->
684 <!-- OBJECT METHODS -->
685 <!-- OBJECT EVENT FIELDS -->
686 <!-- FUNCTION PARAMETERS -->
687 </div>
688 </div>
689 </dl>
690 <!-- RETURNS -->
691 <dl>
692 </dl>
693 <!-- CALLBACK -->
694 <div>
695 <div>
696 <h4>Callback function</h4>
697 <p>
698 If you specify the <em>callback</em> parameter, it should
699 specify a function that looks like this:
700 </p>
701 <!-- Note: intentionally longer 80 columns -->
702 <pre>function(<span>Window window</span>) <span class="subdued ">{...}</span>;</pre>
703 <dl>
704 <div>
705 <div>
706 <dt>
707 <var>window</var>
708 <em>
709 <!-- TYPE -->
710 <div style="display:inline">
711 (
712 <span class="optional">optional</span>
713 <span id="typeTemplate">
714 <span>
715 <a href="windows.html#type-Window">Window</a>
716 </span>
717 </span>
718 )
719 </div>
720 </em>
721 </dt>
722 <dd>Contains details about the created window.</dd>
723 <!-- OBJECT PROPERTIES -->
724 <!-- OBJECT METHODS -->
725 <!-- OBJECT EVENT FIELDS -->
726 <!-- FUNCTION PARAMETERS -->
727 </div>
728 </div>
729 </dl>
730 </div>
731 </div>
732 <!-- MIN_VERSION -->
733 </div> <!-- /description -->
734 </div><div class="apiItem">
735 <a name="method-get"></a> <!-- method-anchor -->
736 <h4>get</h4>
737 <div class="summary">
738 <!-- Note: intentionally longer 80 columns -->
739 <span>chrome.windows.get</span>(<span class="null"><span>integ er</span>
740 <var><span>windowId</span></var></span><span class="option al"><span>, </span><span>object</span>
741 <var><span>getInfo</span></var></span><span class="null">< span>, </span><span>function</span>
742 <var><span>callback</span></var></span>)</div>
743 <div class="description">
744 <p>Gets details about a window.</p>
745 <!-- PARAMETERS -->
746 <h4>Parameters</h4>
747 <dl>
748 <div>
749 <div>
750 <dt>
751 <var>windowId</var>
752 <em>
753 <!-- TYPE -->
754 <div style="display:inline">
755 (
756 <span id="typeTemplate">
757 <span>
758 <span>integer</span>
759 </span>
760 </span>
761 )
762 </div>
763 </em>
764 </dt>
765 <dd class="todo">
766 Undocumented.
767 </dd>
768 <!-- OBJECT PROPERTIES -->
769 <!-- OBJECT METHODS -->
770 <!-- OBJECT EVENT FIELDS -->
771 <!-- FUNCTION PARAMETERS -->
772 </div>
773 </div><div>
774 <div>
775 <dt>
776 <var>getInfo</var>
777 <em>
778 <!-- TYPE -->
779 <div style="display:inline">
780 (
781 <span class="optional">optional</span>
782 <span id="typeTemplate">
783 <span>
784 <span>object</span>
785 </span>
786 </span>
787 )
788 </div>
789 </em>
790 </dt>
791 <dd class="todo">
792 Undocumented.
793 </dd>
794 <!-- OBJECT PROPERTIES -->
795 <dd>
796 <dl>
797 <div>
798 <div>
799 <dt>
800 <var>populate</var>
801 <em>
802 <!-- TYPE -->
803 <div style="display:inline">
804 (
805 <span class="optional">optional</span>
806 <span id="typeTemplate">
807 <span>
808 <span>boolean</span>
809 </span>
810 </span>
811 )
812 </div>
813 </em>
814 </dt>
815 <dd>If true, the window object will have a <var>tabs</var> property th at contains a list of the $ref:tabs.Tab objects</dd>
816 <!-- OBJECT PROPERTIES -->
817 <!-- OBJECT METHODS -->
818 <!-- OBJECT EVENT FIELDS -->
819 <!-- FUNCTION PARAMETERS -->
820 </div>
821 </div>
822 </dl>
823 </dd>
824 <!-- OBJECT METHODS -->
825 <!-- OBJECT EVENT FIELDS -->
826 <!-- FUNCTION PARAMETERS -->
827 </div>
828 </div><div>
829 <div>
830 <dt>
831 <var>callback</var>
832 <em>
833 <!-- TYPE -->
834 <div style="display:inline">
835 (
836 <span id="typeTemplate">
837 <span>
838 <span>function</span>
839 </span>
840 </span>
841 )
842 </div>
843 </em>
844 </dt>
845 <dd class="todo">
846 Undocumented.
847 </dd>
848 <!-- OBJECT PROPERTIES -->
849 <!-- OBJECT METHODS -->
850 <!-- OBJECT EVENT FIELDS -->
851 <!-- FUNCTION PARAMETERS -->
852 </div>
853 </div>
854 </dl>
855 <!-- RETURNS -->
856 <dl>
857 </dl>
858 <!-- CALLBACK -->
859 <div>
860 <div>
861 <h4>Callback function</h4>
862 <p>
863 The <em>callback</em> parameter should specify a function
864 that looks like this:
865 </p>
866 <!-- Note: intentionally longer 80 columns -->
867 <pre>function(<span>Window window</span>) <span class="subdued ">{...}</span>;</pre>
868 <dl>
869 <div>
870 <div>
871 <dt>
872 <var>window</var>
873 <em>
874 <!-- TYPE -->
875 <div style="display:inline">
876 (
877 <span id="typeTemplate">
878 <span>
879 <a href="windows.html#type-Window">Window</a>
880 </span>
881 </span>
882 )
883 </div>
884 </em>
885 </dt>
886 <dd class="todo">
887 Undocumented.
888 </dd>
889 <!-- OBJECT PROPERTIES -->
890 <!-- OBJECT METHODS -->
891 <!-- OBJECT EVENT FIELDS -->
892 <!-- FUNCTION PARAMETERS -->
893 </div>
894 </div>
895 </dl>
896 </div>
897 </div>
898 <!-- MIN_VERSION -->
899 </div> <!-- /description -->
900 </div><div class="apiItem">
901 <a name="method-getAll"></a> <!-- method-anchor -->
902 <h4>getAll</h4>
903 <div class="summary">
904 <!-- Note: intentionally longer 80 columns -->
905 <span>chrome.windows.getAll</span>(<span class="optional"><spa n>object</span>
906 <var><span>getInfo</span></var></span><span class="null">< span>, </span><span>function</span>
907 <var><span>callback</span></var></span>)</div>
908 <div class="description">
909 <p>Gets all windows.</p>
910 <!-- PARAMETERS -->
911 <h4>Parameters</h4>
912 <dl>
913 <div>
914 <div>
915 <dt>
916 <var>getInfo</var>
917 <em>
918 <!-- TYPE -->
919 <div style="display:inline">
920 (
921 <span class="optional">optional</span>
922 <span id="typeTemplate">
923 <span>
924 <span>object</span>
925 </span>
926 </span>
927 )
928 </div>
929 </em>
930 </dt>
931 <dd class="todo">
932 Undocumented.
933 </dd>
934 <!-- OBJECT PROPERTIES -->
935 <dd>
936 <dl>
937 <div>
938 <div>
939 <dt>
940 <var>populate</var>
941 <em>
942 <!-- TYPE -->
943 <div style="display:inline">
944 (
945 <span class="optional">optional</span>
946 <span id="typeTemplate">
947 <span>
948 <span>boolean</span>
949 </span>
950 </span>
951 )
952 </div>
953 </em>
954 </dt>
955 <dd>If true, each window object will have a <var>tabs</var> property t hat contains a list of the $ref:tabs.Tab objects for that window.</dd>
956 <!-- OBJECT PROPERTIES -->
957 <!-- OBJECT METHODS -->
958 <!-- OBJECT EVENT FIELDS -->
959 <!-- FUNCTION PARAMETERS -->
960 </div>
961 </div>
962 </dl>
963 </dd>
964 <!-- OBJECT METHODS -->
965 <!-- OBJECT EVENT FIELDS -->
966 <!-- FUNCTION PARAMETERS -->
967 </div>
968 </div><div>
969 <div>
970 <dt>
971 <var>callback</var>
972 <em>
973 <!-- TYPE -->
974 <div style="display:inline">
975 (
976 <span id="typeTemplate">
977 <span>
978 <span>function</span>
979 </span>
980 </span>
981 )
982 </div>
983 </em>
984 </dt>
985 <dd class="todo">
986 Undocumented.
987 </dd>
988 <!-- OBJECT PROPERTIES -->
989 <!-- OBJECT METHODS -->
990 <!-- OBJECT EVENT FIELDS -->
991 <!-- FUNCTION PARAMETERS -->
992 </div>
993 </div>
994 </dl>
995 <!-- RETURNS -->
996 <dl>
997 </dl>
998 <!-- CALLBACK -->
999 <div>
1000 <div>
1001 <h4>Callback function</h4>
1002 <p>
1003 The <em>callback</em> parameter should specify a function
1004 that looks like this:
1005 </p>
1006 <!-- Note: intentionally longer 80 columns -->
1007 <pre>function(<span>array of Window windows</span>) <span clas s="subdued">{...}</span>;</pre>
1008 <dl>
1009 <div>
1010 <div>
1011 <dt>
1012 <var>windows</var>
1013 <em>
1014 <!-- TYPE -->
1015 <div style="display:inline">
1016 (
1017 <span id="typeTemplate">
1018 <span>
1019 <span>
1020 array of <span><span>
1021 <span>
1022 <a href="windows.html#type-Window">Window</a>
1023 </span>
1024 </span></span>
1025 </span>
1026 </span>
1027 </span>
1028 )
1029 </div>
1030 </em>
1031 </dt>
1032 <dd class="todo">
1033 Undocumented.
1034 </dd>
1035 <!-- OBJECT PROPERTIES -->
1036 <!-- OBJECT METHODS -->
1037 <!-- OBJECT EVENT FIELDS -->
1038 <!-- FUNCTION PARAMETERS -->
1039 </div>
1040 </div>
1041 </dl>
1042 </div>
1043 </div>
1044 <!-- MIN_VERSION -->
1045 </div> <!-- /description -->
1046 </div><div class="apiItem">
1047 <a name="method-getCurrent"></a> <!-- method-anchor -->
1048 <h4>getCurrent</h4>
1049 <div class="summary">
1050 <!-- Note: intentionally longer 80 columns -->
1051 <span>chrome.windows.getCurrent</span>(<span class="optional"> <span>object</span>
1052 <var><span>getInfo</span></var></span><span class="null">< span>, </span><span>function</span>
1053 <var><span>callback</span></var></span>)</div>
1054 <div class="description">
1055 <p>Gets the <a href="#current-window">current window</a>.</p>
1056 <!-- PARAMETERS -->
1057 <h4>Parameters</h4>
1058 <dl>
1059 <div>
1060 <div>
1061 <dt>
1062 <var>getInfo</var>
1063 <em>
1064 <!-- TYPE -->
1065 <div style="display:inline">
1066 (
1067 <span class="optional">optional</span>
1068 <span id="typeTemplate">
1069 <span>
1070 <span>object</span>
1071 </span>
1072 </span>
1073 )
1074 </div>
1075 </em>
1076 </dt>
1077 <dd class="todo">
1078 Undocumented.
1079 </dd>
1080 <!-- OBJECT PROPERTIES -->
1081 <dd>
1082 <dl>
1083 <div>
1084 <div>
1085 <dt>
1086 <var>populate</var>
1087 <em>
1088 <!-- TYPE -->
1089 <div style="display:inline">
1090 (
1091 <span class="optional">optional</span>
1092 <span id="typeTemplate">
1093 <span>
1094 <span>boolean</span>
1095 </span>
1096 </span>
1097 )
1098 </div>
1099 </em>
1100 </dt>
1101 <dd>If true, the window object will have a <var>tabs</var> property th at contains a list of the $ref:tabs.Tab objects</dd>
1102 <!-- OBJECT PROPERTIES -->
1103 <!-- OBJECT METHODS -->
1104 <!-- OBJECT EVENT FIELDS -->
1105 <!-- FUNCTION PARAMETERS -->
1106 </div>
1107 </div>
1108 </dl>
1109 </dd>
1110 <!-- OBJECT METHODS -->
1111 <!-- OBJECT EVENT FIELDS -->
1112 <!-- FUNCTION PARAMETERS -->
1113 </div>
1114 </div><div>
1115 <div>
1116 <dt>
1117 <var>callback</var>
1118 <em>
1119 <!-- TYPE -->
1120 <div style="display:inline">
1121 (
1122 <span id="typeTemplate">
1123 <span>
1124 <span>function</span>
1125 </span>
1126 </span>
1127 )
1128 </div>
1129 </em>
1130 </dt>
1131 <dd class="todo">
1132 Undocumented.
1133 </dd>
1134 <!-- OBJECT PROPERTIES -->
1135 <!-- OBJECT METHODS -->
1136 <!-- OBJECT EVENT FIELDS -->
1137 <!-- FUNCTION PARAMETERS -->
1138 </div>
1139 </div>
1140 </dl>
1141 <!-- RETURNS -->
1142 <dl>
1143 </dl>
1144 <!-- CALLBACK -->
1145 <div>
1146 <div>
1147 <h4>Callback function</h4>
1148 <p>
1149 The <em>callback</em> parameter should specify a function
1150 that looks like this:
1151 </p>
1152 <!-- Note: intentionally longer 80 columns -->
1153 <pre>function(<span>Window window</span>) <span class="subdued ">{...}</span>;</pre>
1154 <dl>
1155 <div>
1156 <div>
1157 <dt>
1158 <var>window</var>
1159 <em>
1160 <!-- TYPE -->
1161 <div style="display:inline">
1162 (
1163 <span id="typeTemplate">
1164 <span>
1165 <a href="windows.html#type-Window">Window</a>
1166 </span>
1167 </span>
1168 )
1169 </div>
1170 </em>
1171 </dt>
1172 <dd class="todo">
1173 Undocumented.
1174 </dd>
1175 <!-- OBJECT PROPERTIES -->
1176 <!-- OBJECT METHODS -->
1177 <!-- OBJECT EVENT FIELDS -->
1178 <!-- FUNCTION PARAMETERS -->
1179 </div>
1180 </div>
1181 </dl>
1182 </div>
1183 </div>
1184 <!-- MIN_VERSION -->
1185 </div> <!-- /description -->
1186 </div><div class="apiItem">
1187 <a name="method-getLastFocused"></a> <!-- method-anchor -->
1188 <h4>getLastFocused</h4>
1189 <div class="summary">
1190 <!-- Note: intentionally longer 80 columns -->
1191 <span>chrome.windows.getLastFocused</span>(<span class="option al"><span>object</span>
1192 <var><span>getInfo</span></var></span><span class="null">< span>, </span><span>function</span>
1193 <var><span>callback</span></var></span>)</div>
1194 <div class="description">
1195 <p>Gets the window that was most recently focused — typically th e window 'on top'.</p>
1196 <!-- PARAMETERS -->
1197 <h4>Parameters</h4>
1198 <dl>
1199 <div>
1200 <div>
1201 <dt>
1202 <var>getInfo</var>
1203 <em>
1204 <!-- TYPE -->
1205 <div style="display:inline">
1206 (
1207 <span class="optional">optional</span>
1208 <span id="typeTemplate">
1209 <span>
1210 <span>object</span>
1211 </span>
1212 </span>
1213 )
1214 </div>
1215 </em>
1216 </dt>
1217 <dd class="todo">
1218 Undocumented.
1219 </dd>
1220 <!-- OBJECT PROPERTIES -->
1221 <dd>
1222 <dl>
1223 <div>
1224 <div>
1225 <dt>
1226 <var>populate</var>
1227 <em>
1228 <!-- TYPE -->
1229 <div style="display:inline">
1230 (
1231 <span class="optional">optional</span>
1232 <span id="typeTemplate">
1233 <span>
1234 <span>boolean</span>
1235 </span>
1236 </span>
1237 )
1238 </div>
1239 </em>
1240 </dt>
1241 <dd>If true, the window object will have a <var>tabs</var> property th at contains a list of the $ref:tabs.Tab objects</dd>
1242 <!-- OBJECT PROPERTIES -->
1243 <!-- OBJECT METHODS -->
1244 <!-- OBJECT EVENT FIELDS -->
1245 <!-- FUNCTION PARAMETERS -->
1246 </div>
1247 </div>
1248 </dl>
1249 </dd>
1250 <!-- OBJECT METHODS -->
1251 <!-- OBJECT EVENT FIELDS -->
1252 <!-- FUNCTION PARAMETERS -->
1253 </div>
1254 </div><div>
1255 <div>
1256 <dt>
1257 <var>callback</var>
1258 <em>
1259 <!-- TYPE -->
1260 <div style="display:inline">
1261 (
1262 <span id="typeTemplate">
1263 <span>
1264 <span>function</span>
1265 </span>
1266 </span>
1267 )
1268 </div>
1269 </em>
1270 </dt>
1271 <dd class="todo">
1272 Undocumented.
1273 </dd>
1274 <!-- OBJECT PROPERTIES -->
1275 <!-- OBJECT METHODS -->
1276 <!-- OBJECT EVENT FIELDS -->
1277 <!-- FUNCTION PARAMETERS -->
1278 </div>
1279 </div>
1280 </dl>
1281 <!-- RETURNS -->
1282 <dl>
1283 </dl>
1284 <!-- CALLBACK -->
1285 <div>
1286 <div>
1287 <h4>Callback function</h4>
1288 <p>
1289 The <em>callback</em> parameter should specify a function
1290 that looks like this:
1291 </p>
1292 <!-- Note: intentionally longer 80 columns -->
1293 <pre>function(<span>Window window</span>) <span class="subdued ">{...}</span>;</pre>
1294 <dl>
1295 <div>
1296 <div>
1297 <dt>
1298 <var>window</var>
1299 <em>
1300 <!-- TYPE -->
1301 <div style="display:inline">
1302 (
1303 <span id="typeTemplate">
1304 <span>
1305 <a href="windows.html#type-Window">Window</a>
1306 </span>
1307 </span>
1308 )
1309 </div>
1310 </em>
1311 </dt>
1312 <dd class="todo">
1313 Undocumented.
1314 </dd>
1315 <!-- OBJECT PROPERTIES -->
1316 <!-- OBJECT METHODS -->
1317 <!-- OBJECT EVENT FIELDS -->
1318 <!-- FUNCTION PARAMETERS -->
1319 </div>
1320 </div>
1321 </dl>
1322 </div>
1323 </div>
1324 <!-- MIN_VERSION -->
1325 </div> <!-- /description -->
1326 </div><div class="apiItem">
1327 <a name="method-remove"></a> <!-- method-anchor -->
1328 <h4>remove</h4>
1329 <div class="summary">
1330 <!-- Note: intentionally longer 80 columns -->
1331 <span>chrome.windows.remove</span>(<span class="null"><span>in teger</span>
1332 <var><span>windowId</span></var></span><span class="option al"><span>, </span><span>function</span>
1333 <var><span>callback</span></var></span>)</div>
1334 <div class="description">
1335 <p>Removes (closes) a window, and all the tabs inside it.</p>
1336 <!-- PARAMETERS -->
1337 <h4>Parameters</h4>
1338 <dl>
1339 <div>
1340 <div>
1341 <dt>
1342 <var>windowId</var>
1343 <em>
1344 <!-- TYPE -->
1345 <div style="display:inline">
1346 (
1347 <span id="typeTemplate">
1348 <span>
1349 <span>integer</span>
1350 </span>
1351 </span>
1352 )
1353 </div>
1354 </em>
1355 </dt>
1356 <dd class="todo">
1357 Undocumented.
1358 </dd>
1359 <!-- OBJECT PROPERTIES -->
1360 <!-- OBJECT METHODS -->
1361 <!-- OBJECT EVENT FIELDS -->
1362 <!-- FUNCTION PARAMETERS -->
1363 </div>
1364 </div><div>
1365 <div>
1366 <dt>
1367 <var>callback</var>
1368 <em>
1369 <!-- TYPE -->
1370 <div style="display:inline">
1371 (
1372 <span class="optional">optional</span>
1373 <span id="typeTemplate">
1374 <span>
1375 <span>function</span>
1376 </span>
1377 </span>
1378 )
1379 </div>
1380 </em>
1381 </dt>
1382 <dd class="todo">
1383 Undocumented.
1384 </dd>
1385 <!-- OBJECT PROPERTIES -->
1386 <!-- OBJECT METHODS -->
1387 <!-- OBJECT EVENT FIELDS -->
1388 <!-- FUNCTION PARAMETERS -->
1389 </div>
1390 </div>
1391 </dl>
1392 <!-- RETURNS -->
1393 <dl>
1394 </dl>
1395 <!-- CALLBACK -->
1396 <div>
1397 <div>
1398 <h4>Callback function</h4>
1399 <p>
1400 If you specify the <em>callback</em> parameter, it should
1401 specify a function that looks like this:
1402 </p>
1403 <!-- Note: intentionally longer 80 columns -->
1404 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
1405 <dl>
1406 </dl>
1407 </div>
1408 </div>
1409 <!-- MIN_VERSION -->
1410 </div> <!-- /description -->
1411 </div><div class="apiItem">
1412 <a name="method-update"></a> <!-- method-anchor -->
1413 <h4>update</h4>
1414 <div class="summary">
1415 <!-- Note: intentionally longer 80 columns -->
1416 <span>chrome.windows.update</span>(<span class="null"><span>in teger</span>
1417 <var><span>windowId</span></var></span><span class="null"> <span>, </span><span>object</span>
1418 <var><span>updateInfo</span></var></span><span class="opti onal"><span>, </span><span>function</span>
1419 <var><span>callback</span></var></span>)</div>
1420 <div class="description">
1421 <p>Updates the properties of a window. Specify only the properti es that you want to change; unspecified properties will be left unchanged.</p>
1422 <!-- PARAMETERS -->
1423 <h4>Parameters</h4>
1424 <dl>
1425 <div>
1426 <div>
1427 <dt>
1428 <var>windowId</var>
1429 <em>
1430 <!-- TYPE -->
1431 <div style="display:inline">
1432 (
1433 <span id="typeTemplate">
1434 <span>
1435 <span>integer</span>
1436 </span>
1437 </span>
1438 )
1439 </div>
1440 </em>
1441 </dt>
1442 <dd class="todo">
1443 Undocumented.
1444 </dd>
1445 <!-- OBJECT PROPERTIES -->
1446 <!-- OBJECT METHODS -->
1447 <!-- OBJECT EVENT FIELDS -->
1448 <!-- FUNCTION PARAMETERS -->
1449 </div>
1450 </div><div>
1451 <div>
1452 <dt>
1453 <var>updateInfo</var>
1454 <em>
1455 <!-- TYPE -->
1456 <div style="display:inline">
1457 (
1458 <span id="typeTemplate">
1459 <span>
1460 <span>object</span>
1461 </span>
1462 </span>
1463 )
1464 </div>
1465 </em>
1466 </dt>
1467 <dd class="todo">
1468 Undocumented.
1469 </dd>
1470 <!-- OBJECT PROPERTIES -->
1471 <dd>
1472 <dl>
1473 <div>
1474 <div>
1475 <dt>
1476 <var>left</var>
1477 <em>
1478 <!-- TYPE -->
1479 <div style="display:inline">
1480 (
1481 <span class="optional">optional</span>
1482 <span id="typeTemplate">
1483 <span>
1484 <span>integer</span>
1485 </span>
1486 </span>
1487 )
1488 </div>
1489 </em>
1490 </dt>
1491 <dd>The offset from the left edge of the screen to move the window to in pixels. This value is ignored for panels.</dd>
1492 <!-- OBJECT PROPERTIES -->
1493 <!-- OBJECT METHODS -->
1494 <!-- OBJECT EVENT FIELDS -->
1495 <!-- FUNCTION PARAMETERS -->
1496 </div>
1497 </div><div>
1498 <div>
1499 <dt>
1500 <var>top</var>
1501 <em>
1502 <!-- TYPE -->
1503 <div style="display:inline">
1504 (
1505 <span class="optional">optional</span>
1506 <span id="typeTemplate">
1507 <span>
1508 <span>integer</span>
1509 </span>
1510 </span>
1511 )
1512 </div>
1513 </em>
1514 </dt>
1515 <dd>The offset from the top edge of the screen to move the window to i n pixels. This value is ignored for panels.</dd>
1516 <!-- OBJECT PROPERTIES -->
1517 <!-- OBJECT METHODS -->
1518 <!-- OBJECT EVENT FIELDS -->
1519 <!-- FUNCTION PARAMETERS -->
1520 </div>
1521 </div><div>
1522 <div>
1523 <dt>
1524 <var>width</var>
1525 <em>
1526 <!-- TYPE -->
1527 <div style="display:inline">
1528 (
1529 <span class="optional">optional</span>
1530 <span id="typeTemplate">
1531 <span>
1532 <span>integer</span>
1533 </span>
1534 </span>
1535 )
1536 </div>
1537 </em>
1538 </dt>
1539 <dd>The width to resize the window to in pixels. This value is ignored for panels.</dd>
1540 <!-- OBJECT PROPERTIES -->
1541 <!-- OBJECT METHODS -->
1542 <!-- OBJECT EVENT FIELDS -->
1543 <!-- FUNCTION PARAMETERS -->
1544 </div>
1545 </div><div>
1546 <div>
1547 <dt>
1548 <var>height</var>
1549 <em>
1550 <!-- TYPE -->
1551 <div style="display:inline">
1552 (
1553 <span class="optional">optional</span>
1554 <span id="typeTemplate">
1555 <span>
1556 <span>integer</span>
1557 </span>
1558 </span>
1559 )
1560 </div>
1561 </em>
1562 </dt>
1563 <dd>The height to resize the window to in pixels. This value is ignore d for panels.</dd>
1564 <!-- OBJECT PROPERTIES -->
1565 <!-- OBJECT METHODS -->
1566 <!-- OBJECT EVENT FIELDS -->
1567 <!-- FUNCTION PARAMETERS -->
1568 </div>
1569 </div><div>
1570 <div>
1571 <dt>
1572 <var>focused</var>
1573 <em>
1574 <!-- TYPE -->
1575 <div style="display:inline">
1576 (
1577 <span class="optional">optional</span>
1578 <span id="typeTemplate">
1579 <span>
1580 <span>boolean</span>
1581 </span>
1582 </span>
1583 )
1584 </div>
1585 </em>
1586 </dt>
1587 <dd>If true, brings the window to the front. If false, brings the next window in the z-order to the front.</dd>
1588 <!-- OBJECT PROPERTIES -->
1589 <!-- OBJECT METHODS -->
1590 <!-- OBJECT EVENT FIELDS -->
1591 <!-- FUNCTION PARAMETERS -->
1592 </div>
1593 </div><div>
1594 <div>
1595 <dt>
1596 <var>drawAttention</var>
1597 <em>
1598 <!-- TYPE -->
1599 <div style="display:inline">
1600 (
1601 <span class="optional">optional</span>
1602 <span id="typeTemplate">
1603 <span>
1604 <span>boolean</span>
1605 </span>
1606 </span>
1607 )
1608 </div>
1609 </em>
1610 </dt>
1611 <dd>If true, causes the window to be displayed in a manner that draws the user's attention to the window, without changing the focused window. The eff ect lasts until the user changes focus to the window. This option has no effect if the window already has focus. Set to false to cancel a previous draw attentio n request.</dd>
1612 <!-- OBJECT PROPERTIES -->
1613 <!-- OBJECT METHODS -->
1614 <!-- OBJECT EVENT FIELDS -->
1615 <!-- FUNCTION PARAMETERS -->
1616 </div>
1617 </div><div>
1618 <div>
1619 <dt>
1620 <var>state</var>
1621 <em>
1622 <!-- TYPE -->
1623 <div style="display:inline">
1624 (
1625 <span class="optional">optional</span>
1626 <span class="enum">enumerated</span>
1627 <span id="typeTemplate">
1628 <span>
1629 <span>string</span>
1630 <span>["normal", "minimized", "maximized", "fullscreen"] </span>
1631 </span>
1632 </span>
1633 )
1634 </div>
1635 </em>
1636 </dt>
1637 <dd>The new state of the window. The 'minimized', 'maximized' and 'ful lscreen' states cannot be combined with 'left', 'top', 'width' or 'height'.</dd>
1638 <!-- OBJECT PROPERTIES -->
1639 <!-- OBJECT METHODS -->
1640 <!-- OBJECT EVENT FIELDS -->
1641 <!-- FUNCTION PARAMETERS -->
1642 </div>
1643 </div>
1644 </dl>
1645 </dd>
1646 <!-- OBJECT METHODS -->
1647 <!-- OBJECT EVENT FIELDS -->
1648 <!-- FUNCTION PARAMETERS -->
1649 </div>
1650 </div><div>
1651 <div>
1652 <dt>
1653 <var>callback</var>
1654 <em>
1655 <!-- TYPE -->
1656 <div style="display:inline">
1657 (
1658 <span class="optional">optional</span>
1659 <span id="typeTemplate">
1660 <span>
1661 <span>function</span>
1662 </span>
1663 </span>
1664 )
1665 </div>
1666 </em>
1667 </dt>
1668 <dd class="todo">
1669 Undocumented.
1670 </dd>
1671 <!-- OBJECT PROPERTIES -->
1672 <!-- OBJECT METHODS -->
1673 <!-- OBJECT EVENT FIELDS -->
1674 <!-- FUNCTION PARAMETERS -->
1675 </div>
1676 </div>
1677 </dl>
1678 <!-- RETURNS -->
1679 <dl>
1680 </dl>
1681 <!-- CALLBACK -->
1682 <div>
1683 <div>
1684 <h4>Callback function</h4>
1685 <p>
1686 If you specify the <em>callback</em> parameter, it should
1687 specify a function that looks like this:
1688 </p>
1689 <!-- Note: intentionally longer 80 columns -->
1690 <pre>function(<span>Window window</span>) <span class="subdued ">{...}</span>;</pre>
1691 <dl>
1692 <div>
1693 <div>
1694 <dt>
1695 <var>window</var>
1696 <em>
1697 <!-- TYPE -->
1698 <div style="display:inline">
1699 (
1700 <span id="typeTemplate">
1701 <span>
1702 <a href="windows.html#type-Window">Window</a>
1703 </span>
1704 </span>
1705 )
1706 </div>
1707 </em>
1708 </dt>
1709 <dd class="todo">
1710 Undocumented.
1711 </dd>
1712 <!-- OBJECT PROPERTIES -->
1713 <!-- OBJECT METHODS -->
1714 <!-- OBJECT EVENT FIELDS -->
1715 <!-- FUNCTION PARAMETERS -->
1716 </div>
1717 </div>
1718 </dl>
1719 </div>
1720 </div>
1721 <!-- MIN_VERSION -->
1722 </div> <!-- /description -->
1723 </div> <!-- /apiItem -->
1724 </div> <!-- /apiGroup -->
1725 <!-- EVENTS -->
1726 <div id="eventsTemplate" class="apiGroup">
1727 <a name="global-events"></a>
1728 <h3>Events</h3>
1729 <!-- iterates over all events -->
1730 <div class="apiItem">
1731 <a name="event-onCreated"></a>
1732 <h4>onCreated</h4>
1733 <div class="summary">
1734 <!-- Note: intentionally longer 80 columns -->
1735 <span class="subdued">chrome.windows.</span><span>onCreated</spa n><span class="subdued">.addListener</span>(function(<span>Window window</span>) <span class="subdued">{...}</span><span></span>);
1736 </div>
1737 <div class="description">
1738 <p>Fired when a window is created.</p>
1739 <!-- LISTENER PARAMETERS -->
1740 <div>
1741 <h4>Listener parameters</h4>
1742 <dl>
1743 <div>
1744 <div>
1745 <dt>
1746 <var>window</var>
1747 <em>
1748 <!-- TYPE -->
1749 <div style="display:inline">
1750 (
1751 <span id="typeTemplate">
1752 <span>
1753 <a href="windows.html#type-Window">Window</a>
1754 </span>
1755 </span>
1756 )
1757 </div>
1758 </em>
1759 </dt>
1760 <dd>Details of the window that was created.</dd>
1761 <!-- OBJECT PROPERTIES -->
1762 <!-- OBJECT METHODS -->
1763 <!-- OBJECT EVENT FIELDS -->
1764 <!-- FUNCTION PARAMETERS -->
1765 </div>
1766 </div>
1767 </dl>
1768 </div>
1769 <!-- EXTRA PARAMETERS -->
1770 <!-- LISTENER RETURN VALUE -->
1771 <dl>
1772 </dl>
1773 </div> <!-- /description -->
1774 <!-- /description -->
1775 </div><div class="apiItem">
1776 <a name="event-onFocusChanged"></a>
1777 <h4>onFocusChanged</h4>
1778 <div class="summary">
1779 <!-- Note: intentionally longer 80 columns -->
1780 <span class="subdued">chrome.windows.</span><span>onFocusChanged </span><span class="subdued">.addListener</span>(function(<span>integer windowId </span>) <span class="subdued">{...}</span><span></span>);
1781 </div>
1782 <div class="description">
1783 <p>Fired when the currently focused window changes. Will be chro me.windows.WINDOW_ID_NONE if all chrome windows have lost focus. Note: On some L inux window managers, WINDOW_ID_NONE will always be sent immediately preceding a switch from one chrome window to another.</p>
1784 <!-- LISTENER PARAMETERS -->
1785 <div>
1786 <h4>Listener parameters</h4>
1787 <dl>
1788 <div>
1789 <div>
1790 <dt>
1791 <var>windowId</var>
1792 <em>
1793 <!-- TYPE -->
1794 <div style="display:inline">
1795 (
1796 <span id="typeTemplate">
1797 <span>
1798 <span>integer</span>
1799 </span>
1800 </span>
1801 )
1802 </div>
1803 </em>
1804 </dt>
1805 <dd>ID of the newly focused window.</dd>
1806 <!-- OBJECT PROPERTIES -->
1807 <!-- OBJECT METHODS -->
1808 <!-- OBJECT EVENT FIELDS -->
1809 <!-- FUNCTION PARAMETERS -->
1810 </div>
1811 </div>
1812 </dl>
1813 </div>
1814 <!-- EXTRA PARAMETERS -->
1815 <!-- LISTENER RETURN VALUE -->
1816 <dl>
1817 </dl>
1818 </div> <!-- /description -->
1819 <!-- /description -->
1820 </div><div class="apiItem">
1821 <a name="event-onRemoved"></a>
1822 <h4>onRemoved</h4>
1823 <div class="summary">
1824 <!-- Note: intentionally longer 80 columns -->
1825 <span class="subdued">chrome.windows.</span><span>onRemoved</spa n><span class="subdued">.addListener</span>(function(<span>integer windowId</spa n>) <span class="subdued">{...}</span><span></span>);
1826 </div>
1827 <div class="description">
1828 <p>Fired when a window is removed (closed).</p>
1829 <!-- LISTENER PARAMETERS -->
1830 <div>
1831 <h4>Listener parameters</h4>
1832 <dl>
1833 <div>
1834 <div>
1835 <dt>
1836 <var>windowId</var>
1837 <em>
1838 <!-- TYPE -->
1839 <div style="display:inline">
1840 (
1841 <span id="typeTemplate">
1842 <span>
1843 <span>integer</span>
1844 </span>
1845 </span>
1846 )
1847 </div>
1848 </em>
1849 </dt>
1850 <dd>ID of the removed window.</dd>
1851 <!-- OBJECT PROPERTIES -->
1852 <!-- OBJECT METHODS -->
1853 <!-- OBJECT EVENT FIELDS -->
1854 <!-- FUNCTION PARAMETERS -->
1855 </div>
1856 </div>
1857 </dl>
1858 </div>
1859 <!-- EXTRA PARAMETERS -->
1860 <!-- LISTENER RETURN VALUE -->
1861 <dl>
1862 </dl>
1863 </div> <!-- /description -->
1864 <!-- /description -->
1865 </div> <!-- /apiItem -->
1866 </div> <!-- /apiGroup -->
1867 <!-- TYPES -->
1868 <div class="apiGroup">
1869 <a name="types"></a>
1870 <h3 id="types">Types</h3>
1871 <!-- iterates over all types -->
1872 <div class="apiItem">
1873 <a name="type-Window"></a>
1874 <h4>Window</h4>
1875 <div>
1876 <dt>
1877 <em>
1878 <!-- TYPE -->
1879 <div style="display:inline">
1880 (
1881 <span id="typeTemplate">
1882 <span>
1883 <span>object</span>
1884 </span>
1885 </span>
1886 )
1887 </div>
1888 </em>
1889 </dt>
1890 <dd class="todo">
1891 Undocumented.
1892 </dd>
1893 <!-- OBJECT PROPERTIES -->
1894 <dd>
1895 <dl>
1896 <div>
1897 <div>
1898 <dt>
1899 <var>id</var>
1900 <em>
1901 <!-- TYPE -->
1902 <div style="display:inline">
1903 (
1904 <span id="typeTemplate">
1905 <span>
1906 <span>integer</span>
1907 </span>
1908 </span>
1909 )
1910 </div>
1911 </em>
1912 </dt>
1913 <dd>The ID of the window. Window IDs are unique within a browser sessi on.</dd>
1914 <!-- OBJECT PROPERTIES -->
1915 <!-- OBJECT METHODS -->
1916 <!-- OBJECT EVENT FIELDS -->
1917 <!-- FUNCTION PARAMETERS -->
1918 </div>
1919 </div><div>
1920 <div>
1921 <dt>
1922 <var>focused</var>
1923 <em>
1924 <!-- TYPE -->
1925 <div style="display:inline">
1926 (
1927 <span id="typeTemplate">
1928 <span>
1929 <span>boolean</span>
1930 </span>
1931 </span>
1932 )
1933 </div>
1934 </em>
1935 </dt>
1936 <dd>Whether the window is currently the focused window.</dd>
1937 <!-- OBJECT PROPERTIES -->
1938 <!-- OBJECT METHODS -->
1939 <!-- OBJECT EVENT FIELDS -->
1940 <!-- FUNCTION PARAMETERS -->
1941 </div>
1942 </div><div>
1943 <div>
1944 <dt>
1945 <var>top</var>
1946 <em>
1947 <!-- TYPE -->
1948 <div style="display:inline">
1949 (
1950 <span id="typeTemplate">
1951 <span>
1952 <span>integer</span>
1953 </span>
1954 </span>
1955 )
1956 </div>
1957 </em>
1958 </dt>
1959 <dd>The offset of the window from the top edge of the screen in pixels .</dd>
1960 <!-- OBJECT PROPERTIES -->
1961 <!-- OBJECT METHODS -->
1962 <!-- OBJECT EVENT FIELDS -->
1963 <!-- FUNCTION PARAMETERS -->
1964 </div>
1965 </div><div>
1966 <div>
1967 <dt>
1968 <var>left</var>
1969 <em>
1970 <!-- TYPE -->
1971 <div style="display:inline">
1972 (
1973 <span id="typeTemplate">
1974 <span>
1975 <span>integer</span>
1976 </span>
1977 </span>
1978 )
1979 </div>
1980 </em>
1981 </dt>
1982 <dd>The offset of the window from the left edge of the screen in pixel s.</dd>
1983 <!-- OBJECT PROPERTIES -->
1984 <!-- OBJECT METHODS -->
1985 <!-- OBJECT EVENT FIELDS -->
1986 <!-- FUNCTION PARAMETERS -->
1987 </div>
1988 </div><div>
1989 <div>
1990 <dt>
1991 <var>width</var>
1992 <em>
1993 <!-- TYPE -->
1994 <div style="display:inline">
1995 (
1996 <span id="typeTemplate">
1997 <span>
1998 <span>integer</span>
1999 </span>
2000 </span>
2001 )
2002 </div>
2003 </em>
2004 </dt>
2005 <dd>The width of the window in pixels.</dd>
2006 <!-- OBJECT PROPERTIES -->
2007 <!-- OBJECT METHODS -->
2008 <!-- OBJECT EVENT FIELDS -->
2009 <!-- FUNCTION PARAMETERS -->
2010 </div>
2011 </div><div>
2012 <div>
2013 <dt>
2014 <var>height</var>
2015 <em>
2016 <!-- TYPE -->
2017 <div style="display:inline">
2018 (
2019 <span id="typeTemplate">
2020 <span>
2021 <span>integer</span>
2022 </span>
2023 </span>
2024 )
2025 </div>
2026 </em>
2027 </dt>
2028 <dd>The height of the window in pixels.</dd>
2029 <!-- OBJECT PROPERTIES -->
2030 <!-- OBJECT METHODS -->
2031 <!-- OBJECT EVENT FIELDS -->
2032 <!-- FUNCTION PARAMETERS -->
2033 </div>
2034 </div><div>
2035 <div>
2036 <dt>
2037 <var>tabs</var>
2038 <em>
2039 <!-- TYPE -->
2040 <div style="display:inline">
2041 (
2042 <span class="optional">optional</span>
2043 <span id="typeTemplate">
2044 <span>
2045 <span>
2046 array of <span><span>
2047 <span>
2048 <a>tabs.Tab</a>
2049 </span>
2050 </span></span>
2051 </span>
2052 </span>
2053 </span>
2054 )
2055 </div>
2056 </em>
2057 </dt>
2058 <dd>Array of $ref:tabs.Tab objects representing the current tabs in th e window.</dd>
2059 <!-- OBJECT PROPERTIES -->
2060 <!-- OBJECT METHODS -->
2061 <!-- OBJECT EVENT FIELDS -->
2062 <!-- FUNCTION PARAMETERS -->
2063 </div>
2064 </div><div>
2065 <div>
2066 <dt>
2067 <var>incognito</var>
2068 <em>
2069 <!-- TYPE -->
2070 <div style="display:inline">
2071 (
2072 <span id="typeTemplate">
2073 <span>
2074 <span>boolean</span>
2075 </span>
2076 </span>
2077 )
2078 </div>
2079 </em>
2080 </dt>
2081 <dd>Whether the window is incognito.</dd>
2082 <!-- OBJECT PROPERTIES -->
2083 <!-- OBJECT METHODS -->
2084 <!-- OBJECT EVENT FIELDS -->
2085 <!-- FUNCTION PARAMETERS -->
2086 </div>
2087 </div><div>
2088 <div>
2089 <dt>
2090 <var>type</var>
2091 <em>
2092 <!-- TYPE -->
2093 <div style="display:inline">
2094 (
2095 <span class="enum">enumerated</span>
2096 <span id="typeTemplate">
2097 <span>
2098 <span>string</span>
2099 <span>["normal", "popup", "panel", "app"]</span>
2100 </span>
2101 </span>
2102 )
2103 </div>
2104 </em>
2105 </dt>
2106 <dd>The type of browser window this is.</dd>
2107 <!-- OBJECT PROPERTIES -->
2108 <!-- OBJECT METHODS -->
2109 <!-- OBJECT EVENT FIELDS -->
2110 <!-- FUNCTION PARAMETERS -->
2111 </div>
2112 </div><div>
2113 <div>
2114 <dt>
2115 <var>state</var>
2116 <em>
2117 <!-- TYPE -->
2118 <div style="display:inline">
2119 (
2120 <span class="enum">enumerated</span>
2121 <span id="typeTemplate">
2122 <span>
2123 <span>string</span>
2124 <span>["normal", "minimized", "maximized", "fullscreen"] </span>
2125 </span>
2126 </span>
2127 )
2128 </div>
2129 </em>
2130 </dt>
2131 <dd>The state of this browser window.</dd>
2132 <!-- OBJECT PROPERTIES -->
2133 <!-- OBJECT METHODS -->
2134 <!-- OBJECT EVENT FIELDS -->
2135 <!-- FUNCTION PARAMETERS -->
2136 </div>
2137 </div><div>
2138 <div>
2139 <dt>
2140 <var>alwaysOnTop</var>
2141 <em>
2142 <!-- TYPE -->
2143 <div style="display:inline">
2144 (
2145 <span id="typeTemplate">
2146 <span>
2147 <span>boolean</span>
2148 </span>
2149 </span>
2150 )
2151 </div>
2152 </em>
2153 </dt>
2154 <dd>Whether the window is set to be always on top.</dd>
2155 <!-- OBJECT PROPERTIES -->
2156 <!-- OBJECT METHODS -->
2157 <!-- OBJECT EVENT FIELDS -->
2158 <!-- FUNCTION PARAMETERS -->
2159 </div>
2160 </div>
2161 </dl>
2162 </dd>
2163 <!-- OBJECT METHODS -->
2164 <!-- OBJECT EVENT FIELDS -->
2165 <!-- FUNCTION PARAMETERS -->
2166 </div>
2167 </div> <!-- /apiItem -->
2168 </div> <!-- /apiGroup -->
2169 </div> <!-- /apiPage -->
2170 </div> <!-- /gc-pagecontent -->
2171 </div> <!-- /g-section -->
2172 </div> <!-- /codesiteContent -->
2173 <div id="gc-footer" --="">
2174 <div class="text">
2175 <p>
2176 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
2177 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
2178 Attribution 3.0 License</a>, and code samples are licensed under the
2179 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
2180 </p>
2181 <p>
2182 ©2011 Google
2183 </p>
2184 <!-- begin analytics -->
2185 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>
2186 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>
2187 <script type="text/javascript">
2188 // chrome doc tracking
2189 try {
2190 var engdocs = _gat._getTracker("YT-10763712-2");
2191 engdocs._trackPageview();
2192 } catch(err) {}
2193 // code.google.com site-wide tracking
2194 try {
2195 _uacct="UA-18071-1";
2196 _uanchor=1;
2197 _uff=0;
2198 urchinTracker();
2199 }
2200 catch(e) {/* urchinTracker not available. */}
2201 </script>
2202 <!-- end analytics -->
2203 </div>
2204 </div> <!-- /gc-footer -->
2205 </div> <!-- /gc-container -->
2206 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/whats_new.html ('k') | chrome/common/extensions/docs/xhr.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698