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
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
/* vi: ts=8 sts=4 sw=4
*
* $Id$
* This file is part of the KDE project, module kdesktop.
* Copyright (C) 1999,2000 Geert Jansen <jansen@kde.org>
*
* You can Freely distribute this program under the GNU Library General
* Public License. See the file "COPYING.LIB" for the exact licensing terms.
*/
#ifndef __KRootPixmap_h_Included__
#define __KRootPixmap_h_Included__
#include <tqobject.h>
#include <tqcolor.h>
#include <kdelibs_export.h>
#ifndef Q_WS_QWS //FIXME
class TQRect;
class TQWidget;
class TQTimer;
class KSharedPixmap;
class KRootPixmapData;
/**
* Creates pseudo-transparent widgets.
*
* A pseudo-transparent widget is a widget with its background pixmap set to
* that part of the desktop background that it is currently obscuring. This
* gives a transparency effect.
*
* To create a transparent widget, construct a KRootPixmap and pass it a
* pointer to your widget. That's it! Moving, resizing and background changes
* are handled automatically.
*
* Instead of using the default behavior, you can ask KRootPixmap
* to emit a backgroundUpdated(const TQPixmap &) signal whenever
* the background needs updating by using setCustomPainting(bool).
* Alternatively by reimplementing updateBackground(KSharedPixmap*)
* you can take complete control of the behavior.
*
* @author Geert Jansen <jansen@kde.org>
* @version $Id$
*/
class KDEUI_EXPORT KRootPixmap: public TQObject
{
Q_OBJECT
public:
/**
* Constructs a KRootPixmap. The KRootPixmap will be created as a child
* of the target widget so it will be deleted automatically when the
* widget is destroyed.
*
* @param target A pointer to the widget that you want to make pseudo
* transparent.
* @param name The internal name of the pixmap
*/
KRootPixmap( TQWidget *target, const char *name=0 );
/**
* Constructs a KRootPixmap where the parent TQObject and target TQWidget are
* different.
*/
KRootPixmap( TQWidget *target, TQObject *parent, const char *name=0 );
/**
* Destructs the object.
*/
virtual ~KRootPixmap();
/**
* Checks if pseudo-transparency is available.
* @return @p true if transparency is available, @p false otherwise.
*/
bool isAvailable() const;
/**
* Returns true if the KRootPixmap is active.
*/
bool isActive() const { return m_bActive; }
/**
* Returns the number of the current desktop.
*/
int currentDesktop() const;
/**
* Returns true if custom painting is enabled, false otherwise.
* @see setCustomPainting(bool)
*/
bool customPainting() const { return m_bCustomPaint; }
#ifndef KDE_NO_COMPAT
/**
* Deprecated, use isAvailable() instead.
* @deprecated
*/
KDE_DEPRECATED bool checkAvailable(bool) { return isAvailable(); }
#endif
/** @since 3.2
* @return the fade color.
*/
const TQColor &color() const { return m_FadeColor; }
/** @since 3.5
* @return the blur radius.
*/
const double &blurRadius() const { return m_BlurRadius; }
/** @since 3.5
* @return the blur sigma.
*/
const double &blurSigma() const { return m_BlurSigma; }
/** @since 3.2
* @return the color opacity.
*/
double opacity() const { return m_Fade; }
public slots:
/**
* Starts background handling.
*/
virtual void start();
/**
* Stops background handling.
*/
virtual void stop();
/**
* Sets the fade effect.
*
* This effect will fade the background to the
* specified color.
* @param opacity A value between 0 and 1, indicating the opacity
* of the color. A value of 0 will not change the image, a value of 1
* will use the fade color unchanged.
* @param color The color to fade to.
*/
void setFadeEffect(double opacity, const TQColor &color);
/**
* Sets the blue effect.
*
* This effect will blur the background with the specified values.
* If both values are set to zero no blur is applied (this is the default).
* @param radius The radius of the gaussian not counting the
* center pixel. Use 0 and a suitable radius will be automatically used.
* @param sigma The standard deviation of the gaussian. Use 1 if you're not
* sure.
*/
void setBlurEffect(double radius, double sigma);
/**
* Repaints the widget background. Normally, you shouldn't need this
* as it is handled automatically.
*
* @param force Force a repaint, even if the contents did not change.
*/
void repaint( bool force );
/**
* Repaints the widget background. Normally, you shouldn't need this
* as it is handled automatically. This is equivalent to calling
* repaint( false ).
*/
void repaint();
/**
* Enables custom handling of the background painting. If custom
* painting is enabled then KRootPixmap will emit a
* backgroundUpdated() signal when the background for the
* target widget changes, instead of applying the new background.
*/
void setCustomPainting( bool enable ) { m_bCustomPaint = enable; }
/**
* Asks KDesktop to export the desktop background as a KSharedPixmap.
* This method uses DCOP to call KBackgroundIface/setExport(int).
*/
void enableExports();
/**
* Returns the name of the shared pixmap (only needed for low level access)
*/
static TQString pixmapName(int desk);
signals:
/**
* Emitted when the background needs updating and custom painting
* (see setCustomPainting(bool) ) is enabled.
*
* @param pm A pixmap containing the new background.
*/
void backgroundUpdated( const TQPixmap &pm );
protected:
/**
* Reimplemented to filter the events from the target widget and
* track its movements.
*/
virtual bool eventFilter(TQObject *, TQEvent *);
/**
* Called when the pixmap has been updated. The default implementation
* applies the fade effect, then sets the target's background, or emits
* backgroundUpdated(const TQPixmap &) depending on the painting mode.
*/
virtual void updateBackground( KSharedPixmap * );
private slots:
void slotBackgroundChanged(int);
void slotDone(bool);
void desktopChanged(int desktop);
void desktopChanged( WId window, unsigned int properties );
private:
bool m_bActive, m_bInit, m_bCustomPaint;
int m_Desk;
double m_Fade;
TQColor m_FadeColor;
double m_BlurRadius;
double m_BlurSigma;
TQRect m_Rect;
TQWidget *m_pWidget;
TQTimer *m_pTimer;
KSharedPixmap *m_pPixmap;
KRootPixmapData *d;
void init();
};
#endif // ! Q_WS_QWS
#endif // __KRootPixmap_h_Included__
|
