1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/widget/nsITaskbarTabPreview.idl Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,63 @@
1.4 +/* vim: se cin sw=2 ts=2 et : */
1.5 +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
1.6 + *
1.7 + * This Source Code Form is subject to the terms of the Mozilla Public
1.8 + * License, v. 2.0. If a copy of the MPL was not distributed with this
1.9 + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
1.10 +
1.11 +#include "nsITaskbarPreview.idl"
1.12 +interface imgIContainer;
1.13 +
1.14 +/*
1.15 + * nsITaskbarTabPreview
1.16 + *
1.17 + * This interface controls tab preview-specific behavior. Creating an
1.18 + * nsITaskbarTabPreview for a window will hide that window's
1.19 + * nsITaskbarWindowPreview in the taskbar - the native API performs this
1.20 + * unconditionally. When there are no more tab previews for a window, the
1.21 + * nsITaskbarWindowPreview will automatically become visible again.
1.22 + *
1.23 + * An application may have as many tab previews per window as memory allows.
1.24 + *
1.25 + */
1.26 +[scriptable, uuid(11E4C8BD-5C2D-4E1A-A9A1-79DD5B0FE544)]
1.27 +interface nsITaskbarTabPreview : nsITaskbarPreview
1.28 +{
1.29 + /**
1.30 + * The title displayed above the thumbnail
1.31 + *
1.32 + * Default: an empty string
1.33 + */
1.34 + attribute DOMString title;
1.35 +
1.36 + /**
1.37 + * The icon displayed next to the title in the preview
1.38 + *
1.39 + * Default: null
1.40 + */
1.41 + attribute imgIContainer icon;
1.42 +
1.43 + /**
1.44 + * Rearranges the preview relative to another tab preview from the same window
1.45 + * @param aNext The preview to the right of this one. A value of null
1.46 + * indicates that the preview is the rightmost one.
1.47 + */
1.48 + void move(in nsITaskbarTabPreview aNext);
1.49 +
1.50 + /**
1.51 + * Used internally to grab the handle to the proxy window.
1.52 + */
1.53 + [notxpcom]
1.54 + nativeWindow GetHWND();
1.55 +
1.56 + /**
1.57 + * Used internally to ensure that the taskbar knows about this preview. If a
1.58 + * preview is not registered, then the API call to set its sibling (via move)
1.59 + * will silently fail.
1.60 + *
1.61 + * This method is only invoked when it is safe to make taskbar API calls.
1.62 + */
1.63 + [notxpcom]
1.64 + void EnsureRegistration();
1.65 +};
1.66 +
