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
|
/* This file is part of the KDE libraries
Copyright (C) 1999 Matthias Ettrich <ettrich@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License version 2 as published by the Free Software Foundation.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KSYSTEMTRAY_H
#define KSYSTEMTRAY_H
#include <kglobal.h>
#include <tqlabel.h>
class KActionCollection;
class KPopupMenu;
class KSystemTrayPrivate;
/**
* \brief %KDE System Tray Window class
*
* This class implements system tray windows.
*
* A tray window is a small window (typically 24x24 pixel) that docks
* into the system tray in the desktop panel. It usually displays an
* icon or an animated icon there. The icon represents
* the application, similar to a taskbar button, but consumes less
* screen space.
*
* When the user clicks with the left mouse button on the icon, the
* main application window is shown/raised and activated. With the
* right mouse button, she gets a popupmenu with application specific
* commands, including "Minimize/Restore" and "Quit".
*
* Docking happens magically when calling show(). The window undocks
* with either hide() or when it is destroyed.
*
* KSystemTray inherits methods such as setPixmap() and setMovie() to
* specify an icon or movie (animated icon) respectively. It is
* designed to be usable "as is", without the need to subclass it. In
* case you need to provide something special (such as an additional
* popupmenu on a click with the left mouse button), you can subclass
* anyway, of course.
*
* Having an icon on the system tray is a useful technique for
* daemon-like applications that may run for some time without user
* interaction but have to be there immediately when the user needs
* them. Examples are kppp, kisdn, kscd, kmix or knotes. With kppp and
* kisdn, the docked icon even provides real-time information about
* the network status.
*
* @author Matthias Ettrich <ettrich@kde.org>
**/
class TDEUI_EXPORT KSystemTray : public TQLabel
{
Q_OBJECT
public:
/**
* Construct a KSystemTray widget just like any other widget.
*
* The parent widget @p parent has a special meaning:
* Besides owning the tray window, the parent widget will
* dissappear from taskbars when it is iconified while the tray
* window is visible. This is the desired behavior. After all,
* the tray window @p is the parent's taskbar icon.
*
* Furthermore, the parent widget is shown or raised respectively
* when the user clicks on the trray window with the left mouse
* button.
**/
KSystemTray( TQWidget* parent = 0, const char* name = 0 );
/*
Destructor
*/
~KSystemTray();
/**
Access to the context menu. This makes it easy to add new items
to it.
*/
KPopupMenu* contextMenu() const;
/**
Easy access to the actions in the context menu
Currently includes KStdAction::Quit and minimizeRestore
@since 3.1
*/
KActionCollection* actionCollection();
/**
* Changes the tray's icon.
*/
virtual void setPixmap( const TQPixmap& icon );
/**
* Changes the tray's text description (which can be seen e.g. in the systray
* configuration dialog). The default value is KAboutData::programName().
*/
virtual void setCaption( const TQString& title );
/**
* Loads an icon @p icon using the icon loader class of the given instance @p instance.
* The icon is applied the panel effect as it should only be used to be shown in the
* system tray.
* It's commonly used in the form : systray->setPixmap( systray->loadIcon( "mysystray" ) );
*
* @since 3.2
*/
static TQPixmap loadIcon( const TQString &icon, KInstance *instance=KGlobal::instance() );
/**
* Loads an icon @p icon using the icon loader class of the given instance @p instance.
* The icon is applied the panel effect as it should only be used to be shown in the
* system tray.
* It's commonly used in the form : systray->setPixmap( systray->loadIcon( "mysystray", iconWidth ) );
* This is essentially the same as loadIcon(), but with a forced icon size
*
* @since 3.5.12
*/
static TQPixmap loadSizedIcon( const TQString &icon, int iconWidth, KInstance *instance=KGlobal::instance() );
signals:
/**
* Emitted when quit is selected in the menu. If you want to perform any other
* action than to close the main application window please connect to this signal.
* @since 3.1
*/
void quitSelected();
public slots:
/**
* Toggles the state of the window associated with this system tray icon (hides it,
* shows it or activates it depending on the window state). The default implementation
* of mousePressEvent() calls toggleActive() when the tray icon is left-clicked, use
* it when reimplementing mousePressEvent().
* @since 3.3
*/
void toggleActive();
/**
* Activates the window associated with this system tray icon, regardless of its current state.
* @since 3.3
*/
void setActive();
/**
* Hides the window associated with this system tray icon, regardless of its current state.
* @since 3.3
*/
void setInactive();
protected:
/**
Reimplemented to provide the standard show/raise behavior
for the parentWidget() and the context menu.
Feel free to reimplement this if you need something special.
*/
void mousePressEvent( TQMouseEvent * );
/**
Reimplemented to provide the standard show/raise behavior
for the parentWidget() and the context menu.
Feel free to reimplement this if you need something special.
*/
void mouseReleaseEvent( TQMouseEvent * );
/**
Makes it easy to adjust some menu items right before the
context menu becomes visible.
*/
virtual void contextMenuAboutToShow( KPopupMenu* menu );
/**
Reimplemented for internal reasons.
*/
void showEvent( TQShowEvent * );
/**
Reimplemented for internal reasons.
*/
void enterEvent( TQEvent* );
private slots:
void minimizeRestoreAction();
void maybeQuit();
private:
void activateOrHide();
void minimizeRestore( bool restore );
KPopupMenu* menu;
// minimizeRestoreId is no longer needed. remove in KDE 4.0
int minimizeRestoreId;
uint hasQuit :1;
protected:
virtual void virtual_hook( int id, void* data );
private:
KSystemTrayPrivate* d;
};
#endif
|
