The Tor Browser / file comparison
comparison: widget/nsITaskbarPreview.idl
widget/nsITaskbarPreview.idl
- branch
- TOR_BUG_3246
- changeset 6
- 8bccb770b82d
equal
deleted
inserted
replaced
| -1:000000000000 | 0:4ab05f6c7885 |
|---|---|
| 1 /* vim: se cin sw=2 ts=2 et : */ | |
| 2 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- | |
| 3 * | |
| 4 * This Source Code Form is subject to the terms of the Mozilla Public | |
| 5 * License, v. 2.0. If a copy of the MPL was not distributed with this | |
| 6 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ | |
| 7 | |
| 8 #include "nsISupports.idl" | |
| 9 #include "nsIBaseWindow.idl" | |
| 10 | |
| 11 interface nsITaskbarPreviewController; | |
| 12 | |
| 13 /** | |
| 14 * nsITaskbarPreview | |
| 15 * | |
| 16 * Common interface for both window and tab taskbar previews. This interface | |
| 17 * cannot be instantiated directly. | |
| 18 * | |
| 19 */ | |
| 20 [scriptable, uuid(CBFDF766-D002-403B-A3D9-B091C9AD465B)] | |
| 21 interface nsITaskbarPreview : nsISupports | |
| 22 { | |
| 23 /** | |
| 24 * The controller for this preview. A controller is required to provide | |
| 25 * the behavior and appearance of the taskbar previews. It is responsible for | |
| 26 * determining the size and contents of the preview, which buttons are | |
| 27 * displayed and how the application responds to user actions on the preview. | |
| 28 * | |
| 29 * Neither preview makes full use of the controller. See the documentation | |
| 30 * for nsITaskbarWindowPreview and nsITaskbarTabPreview for details on which | |
| 31 * controller methods are used. | |
| 32 * | |
| 33 * The controller is not allowed to be null. | |
| 34 * | |
| 35 * @see nsITaskbarPreviewController | |
| 36 */ | |
| 37 attribute nsITaskbarPreviewController controller; | |
| 38 | |
| 39 /** | |
| 40 * The tooltip displayed above the preview when the user hovers over it | |
| 41 * | |
| 42 * Default: an empty string | |
| 43 */ | |
| 44 attribute DOMString tooltip; | |
| 45 | |
| 46 /** | |
| 47 * Whether or not the preview is visible. | |
| 48 * | |
| 49 * Changing this option is expensive for tab previews since toggling this | |
| 50 * option will destroy/create the proxy window and its registration with the | |
| 51 * taskbar. If any step of that fails, an exception will be thrown. | |
| 52 * | |
| 53 * For window previews, this operation is very cheap. | |
| 54 * | |
| 55 * Default: false | |
| 56 */ | |
| 57 attribute boolean visible; | |
| 58 | |
| 59 /** | |
| 60 * Gets/sets whether or not the preview is marked active (selected) in the | |
| 61 * taskbar. | |
| 62 */ | |
| 63 attribute boolean active; | |
| 64 | |
| 65 /** | |
| 66 * Invalidates the taskbar's cached image of this preview, forcing a redraw | |
| 67 * if necessary | |
| 68 */ | |
| 69 void invalidate(); | |
| 70 }; | |
| 71 |
