1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
|
/* vim: se cin sw=2 ts=2 et : */
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "nsISupports.idl"
interface nsIDocShell;
interface nsITaskbarPreview;
interface nsITaskbarPreviewButton;
/**
* nsITaskbarPreviewCallback
*
* Provides an interface for async image result callbacks. See
* nsITaskbarPreviewController request apis below.
*/
[scriptable, function, uuid(f3744696-320d-4804-9c27-6a84c29acaa6)]
interface nsITaskbarPreviewCallback : nsISupports
{
void done(in nsISupports aCanvas, in boolean aDrawBorder);
};
/**
* nsITaskbarPreviewController
*
* nsITaskbarPreviewController provides the behavior for the taskbar previews.
* Its methods and properties are used by nsITaskbarPreview. Clients are
* intended to provide their own implementation of this interface. Depending on
* the interface the controller is attached to, only certain methods/attributes
* are required to be implemented.
*/
[scriptable, uuid(8b427646-e446-4941-ae0b-c1122a173a68)]
interface nsITaskbarPreviewController : nsISupports
{
/**
* The width of the preview image. This value is allowed to change at any
* time. See drawPreview for more information.
*/
readonly attribute unsigned long width;
/**
* The height of the preview image. This value is allowed to change at any
* time. See drawPreview for more information.
*/
readonly attribute unsigned long height;
/**
* The aspect ratio of the thumbnail - this does not need to match the ratio
* of the preview. This value is allowed to change at any time. See
* drawThumbnail for more information.
*/
readonly attribute float thumbnailAspectRatio;
[deprecated]
boolean drawPreview(in nsISupports ctx);
[deprecated]
boolean drawThumbnail(in nsISupports ctx, in unsigned long width, in unsigned long height);
/**
* Invoked by nsITaskbarPreview when it needs to render the preview.
*
* @param aCallback Async callback the controller should invoke once
* the thumbnail is rendered. aCallback receives as its only parameter
* a canvas containing the preview image.
*/
void requestPreview(in nsITaskbarPreviewCallback aCallback);
/**
* An asynchronous version of drawPreview and drawThumbnail apis
* implemented in nsITaskbarPreviewController.
*
* Note: it is guaranteed that width/height == thumbnailAspectRatio
* (modulo rounding errors)
*
* Also note that the context is not attached to a canvas element.
*
* @param aCallback Async callback the controller should invoke once
* the thumbnail is rendered. aCallback receives as its only parameter
* a canvas containing the thumbnail image. Canvas dimensions should
* match the requested width or height otherwise setting the thumbnail
* will fail.
* @param width The width of the requested thumbnail
* @param height The height of the requested thumbnail
*/
void requestThumbnail(in nsITaskbarPreviewCallback aCallback,
in unsigned long width, in unsigned long height);
/**
* Invoked when the user presses the close button on the tab preview.
*/
void onClose();
/**
* Invoked when the user clicks on the tab preview.
*
* @return true if the top level window corresponding to the preview should
* be activated, false if activation is not accepted.
*/
boolean onActivate();
/**
* Invoked when one of the buttons on the window preview's toolbar is pressed.
*
* @param button The button that was pressed. This can be compared with the
* buttons returned by nsITaskbarWindowPreview.getButton.
*/
void onClick(in nsITaskbarPreviewButton button);
};
|
