OLD | NEW |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | 1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 // Use the <code>chrome.app.window</code> API to create windows. Windows | 5 // Use the <code>chrome.app.window</code> API to create windows. Windows |
6 // have an optional frame with title bar and size controls. They are not | 6 // have an optional frame with title bar and size controls. They are not |
7 // associated with any Chrome browser windows. | 7 // associated with any Chrome browser windows. |
8 namespace app.window { | 8 namespace app.window { |
9 dictionary Bounds { | 9 dictionary Bounds { |
10 long? left; | 10 long? left; |
(...skipping 90 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
101 // created if another window with the same id doesn't already exist. If a | 101 // created if another window with the same id doesn't already exist. If a |
102 // window with the same id already exists that window is activated instead. | 102 // window with the same id already exists that window is activated instead. |
103 // If you do want to create multiple windows with the same id, you can | 103 // If you do want to create multiple windows with the same id, you can |
104 // set this property to false. | 104 // set this property to false. |
105 boolean? singleton; | 105 boolean? singleton; |
106 | 106 |
107 // If true, the window will stay above most other windows. If there are | 107 // If true, the window will stay above most other windows. If there are |
108 // multiple windows of this kind, the currently focused window will be in | 108 // multiple windows of this kind, the currently focused window will be in |
109 // the foreground. Defaults to false. Call <code>setAlwaysOnTop()</code> on | 109 // the foreground. Defaults to false. Call <code>setAlwaysOnTop()</code> on |
110 // the window to change this property after creation. | 110 // the window to change this property after creation. |
111 // Currently available in the Dev channel only. | |
112 boolean? alwaysOnTop; | 111 boolean? alwaysOnTop; |
113 }; | 112 }; |
114 | 113 |
115 // Called in the creating window (parent) before the load event is called in | 114 // Called in the creating window (parent) before the load event is called in |
116 // the created window (child). The parent can set fields or functions on the | 115 // the created window (child). The parent can set fields or functions on the |
117 // child usable from onload. E.g. background.js:<br> | 116 // child usable from onload. E.g. background.js:<br> |
118 // <code>function(created_window) { created_window.contentWindow.foo = | 117 // <code>function(createdWindow) { createdWindow.contentWindow.foo = |
119 // function () { }; };</code> | 118 // function () { }; };</code> |
120 // <br>window.js:<br> | 119 // <br>window.js:<br> |
121 // <code>window.onload = function () { foo(); }</code> | 120 // <code>window.onload = function () { foo(); }</code> |
122 callback CreateWindowCallback = | 121 callback CreateWindowCallback = |
123 void ([instanceOf=AppWindow] object created_window); | 122 void ([instanceOf=AppWindow] object createdWindow); |
124 | 123 |
125 [noinline_doc] dictionary AppWindow { | 124 [noinline_doc] dictionary AppWindow { |
126 // Focus the window. | 125 // Focus the window. |
127 static void focus(); | 126 static void focus(); |
128 | 127 |
129 // Fullscreens the window. | 128 // Fullscreens the window. |
130 static void fullscreen(); | 129 static void fullscreen(); |
131 | 130 |
132 // Is the window fullscreen? | 131 // Is the window fullscreen? |
133 static boolean isFullscreen(); | 132 static boolean isFullscreen(); |
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
170 | 169 |
171 // Get the window's bounds as a $ref:Bounds object. | 170 // Get the window's bounds as a $ref:Bounds object. |
172 [nocompile] static Bounds getBounds(); | 171 [nocompile] static Bounds getBounds(); |
173 | 172 |
174 // Set the window's bounds. | 173 // Set the window's bounds. |
175 static void setBounds(Bounds bounds); | 174 static void setBounds(Bounds bounds); |
176 | 175 |
177 // Set the app icon for the window (experimental). | 176 // Set the app icon for the window (experimental). |
178 // Currently this is only being implemented on Ash. | 177 // Currently this is only being implemented on Ash. |
179 // TODO(stevenjb): Investigate implementing this on Windows and OSX. | 178 // TODO(stevenjb): Investigate implementing this on Windows and OSX. |
180 [nodoc] static void setIcon(DOMString icon_url); | 179 [nodoc] static void setIcon(DOMString iconUrl); |
181 | 180 |
182 // Is the window always on top? | 181 // Is the window always on top? |
183 // Currently available in the Dev channel only. | |
184 static boolean isAlwaysOnTop(); | 182 static boolean isAlwaysOnTop(); |
185 | 183 |
186 // Set whether the window should stay above most other windows. | 184 // Set whether the window should stay above most other windows. |
187 // Currently available in the Dev channel only. | 185 static void setAlwaysOnTop(boolean alwaysOnTop); |
188 static void setAlwaysOnTop(boolean always_on_top); | |
189 | 186 |
190 // The JavaScript 'window' object for the created child. | 187 // The JavaScript 'window' object for the created child. |
191 [instanceOf=Window] object contentWindow; | 188 [instanceOf=Window] object contentWindow; |
192 }; | 189 }; |
193 | 190 |
194 interface Functions { | 191 interface Functions { |
195 // The size and position of a window can be specified in a number of | 192 // The size and position of a window can be specified in a number of |
196 // different ways. The most simple option is not specifying anything at | 193 // different ways. The most simple option is not specifying anything at |
197 // all, in which case a default size and platform dependent position will | 194 // all, in which case a default size and platform dependent position will |
198 // be used. | 195 // be used. |
(...skipping 36 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
235 // Fired when the window is maximized. | 232 // Fired when the window is maximized. |
236 [nocompile] static void onMaximized(); | 233 [nocompile] static void onMaximized(); |
237 | 234 |
238 // Fired when the window is minimized. | 235 // Fired when the window is minimized. |
239 [nocompile] static void onMinimized(); | 236 [nocompile] static void onMinimized(); |
240 | 237 |
241 // Fired when the window is restored from being minimized or maximized. | 238 // Fired when the window is restored from being minimized or maximized. |
242 [nocompile] static void onRestored(); | 239 [nocompile] static void onRestored(); |
243 }; | 240 }; |
244 }; | 241 }; |
OLD | NEW |