widget/nsITaskbarTabPreview.idl@b8a032363ba2 (annotated)
widget/nsITaskbarTabPreview.idl
Thu, 22 Jan 2015 13:21:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 22 Jan 2015 13:21:57 +0100
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
- permissions
- -rw-r--r--
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
| michael@0 | 1 | /* vim: se cin sw=2 ts=2 et : */ |
| michael@0 | 2 | /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- |
| michael@0 | 3 | * |
| michael@0 | 4 | * This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 5 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 6 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 7 | |
| michael@0 | 8 | #include "nsITaskbarPreview.idl" |
| michael@0 | 9 | interface imgIContainer; |
| michael@0 | 10 | |
| michael@0 | 11 | /* |
| michael@0 | 12 | * nsITaskbarTabPreview |
| michael@0 | 13 | * |
| michael@0 | 14 | * This interface controls tab preview-specific behavior. Creating an |
| michael@0 | 15 | * nsITaskbarTabPreview for a window will hide that window's |
| michael@0 | 16 | * nsITaskbarWindowPreview in the taskbar - the native API performs this |
| michael@0 | 17 | * unconditionally. When there are no more tab previews for a window, the |
| michael@0 | 18 | * nsITaskbarWindowPreview will automatically become visible again. |
| michael@0 | 19 | * |
| michael@0 | 20 | * An application may have as many tab previews per window as memory allows. |
| michael@0 | 21 | * |
| michael@0 | 22 | */ |
| michael@0 | 23 | [scriptable, uuid(11E4C8BD-5C2D-4E1A-A9A1-79DD5B0FE544)] |
| michael@0 | 24 | interface nsITaskbarTabPreview : nsITaskbarPreview |
| michael@0 | 25 | { |
| michael@0 | 26 | /** |
| michael@0 | 27 | * The title displayed above the thumbnail |
| michael@0 | 28 | * |
| michael@0 | 29 | * Default: an empty string |
| michael@0 | 30 | */ |
| michael@0 | 31 | attribute DOMString title; |
| michael@0 | 32 | |
| michael@0 | 33 | /** |
| michael@0 | 34 | * The icon displayed next to the title in the preview |
| michael@0 | 35 | * |
| michael@0 | 36 | * Default: null |
| michael@0 | 37 | */ |
| michael@0 | 38 | attribute imgIContainer icon; |
| michael@0 | 39 | |
| michael@0 | 40 | /** |
| michael@0 | 41 | * Rearranges the preview relative to another tab preview from the same window |
| michael@0 | 42 | * @param aNext The preview to the right of this one. A value of null |
| michael@0 | 43 | * indicates that the preview is the rightmost one. |
| michael@0 | 44 | */ |
| michael@0 | 45 | void move(in nsITaskbarTabPreview aNext); |
| michael@0 | 46 | |
| michael@0 | 47 | /** |
| michael@0 | 48 | * Used internally to grab the handle to the proxy window. |
| michael@0 | 49 | */ |
| michael@0 | 50 | [notxpcom] |
| michael@0 | 51 | nativeWindow GetHWND(); |
| michael@0 | 52 | |
| michael@0 | 53 | /** |
| michael@0 | 54 | * Used internally to ensure that the taskbar knows about this preview. If a |
| michael@0 | 55 | * preview is not registered, then the API call to set its sibling (via move) |
| michael@0 | 56 | * will silently fail. |
| michael@0 | 57 | * |
| michael@0 | 58 | * This method is only invoked when it is safe to make taskbar API calls. |
| michael@0 | 59 | */ |
| michael@0 | 60 | [notxpcom] |
| michael@0 | 61 | void EnsureRegistration(); |
| michael@0 | 62 | }; |
| michael@0 | 63 |
