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
|
/* This file is part of the KDE libraries
Copyright (C) 1998 Kurt Granroth ([email protected])
2000 Carsten Pfeiffer <[email protected]>
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.
*/
/*
* $Id$
*
*/
#ifndef _KCURSOR_H
#define _KCURSOR_H
#include <qcursor.h>
#include <kdelibs_export.h>
class QWidget;
/**
* @short A QCursor wrapper allowing "themed" cursors and auto-hiding cursors.
*
* A wrapper around QCursor that allows for "themed" cursors.
*
* Currently, the only themed cursor is a hand shaped cursor.
*
* A typical usage would be
* \code
* setCursor(KCursor::handCursor());
* \endcode
*
* @author Kurt Granroth <[email protected]>
*/
class KDEUI_EXPORT KCursor : public Qt
{
public:
/**
* Constructor.
*
* Does not do anything so far.
**/
KCursor();
/**
* Returns the proper hand cursor according to
* the current GUI style (static function).
*/
static QCursor handCursor();
/**
* Returns the proper arrow+hourglass cursor according to
* the current GUI style (static function).
*/
static QCursor workingCursor();
/**
* Returns the proper arrow cursor according to
* the current GUI style (static function).
*/
static QCursor arrowCursor();
/**
* Returns the proper up arrow cursor according to
* the current GUI style (static function).
*/
static QCursor upArrowCursor();
/**
* Returns the proper cross-hair cursor according to
* the current GUI style (static function).
*/
static QCursor crossCursor();
/**
* Returns the proper hourglass cursor according to
* the current GUI style (static function).
*/
static QCursor waitCursor();
/**
* Returns the proper text cursor according to
* the current GUI style (static function).
*/
static QCursor ibeamCursor();
/**
* Returns the proper vertical resize cursor
* according to the current GUI style (static function).
*/
static QCursor sizeVerCursor();
/**
* Returns the proper horizontal resize cursor
* according to the current GUI style (static function).
*/
static QCursor sizeHorCursor();
/**
* Returns the proper diagonal resize (/) cursor
* according to the current GUI style (static function).
*/
static QCursor sizeBDiagCursor();
/**
* Returns the proper diagonal resize (\) cursor
* according to the current GUI style (static function).
*/
static QCursor sizeFDiagCursor();
/**
* Returns the proper all-directions resize cursor
* according to the current GUI style (static function).
*/
static QCursor sizeAllCursor();
/**
* Returns a blank or invisible cursor (static function).
*/
static QCursor blankCursor();
/**
* Returns a WhatsThis cursor (static function).
*/
static QCursor whatsThisCursor();
/**
* Sets auto-hiding the cursor for widget @p w. Enabling it will result in
* the cursor being hidden when
* @li a key-event happens
* @li there are no key-events for a configured time-frame (see
* setHideCursorDelay())
*
* The cursor will be shown again when the focus is lost or a mouse-event
* happens.
*
* Side effect: when enabling auto-hide, mouseTracking is enabled for the
* specified widget, because it's needed to get mouse-move-events. So
* don't disable mouseTracking for a widget while using auto-hide for it.
*
* When disabling auto-hide, mouseTracking will be disabled, so if you need
* mouseTracking after disabling auto-hide, you have to reenable
* mouseTracking.
*
* If you want to use auto-hiding for widgets that don't take focus, e.g.
* a QCanvasView, then you have to pass all key-events that should trigger
* auto-hiding to autoHideEventFilter().
*/
static void setAutoHideCursor( QWidget *w, bool enable );
/**
* Overloaded method for the case where you have an event-filter installed
* on the widget you want to enable auto-cursor-hiding.
*
* In this case set @p customEventFilter to true and call
* autoHideEventFilter() from the beginning of your eventFilter().
*
* @see autoHideEventFilter
*/
static void setAutoHideCursor( QWidget *w, bool enable,
bool customEventFilter );
/**
* Sets the delay time in milliseconds for auto-hiding. When no keyboard
* events arrive for that time-frame, the cursor will be hidden.
*
* Default is 5000, i.e. 5 seconds.
*/
static void setHideCursorDelay( int ms );
/**
* @returns the current auto-hide delay time.
*
* Default is 5000, i.e. 5 seconds.
*/
static int hideCursorDelay();
/**
* KCursor has to install an eventFilter over the widget you want to
* auto-hide. If you have an own eventFilter() on that widget and stop
* some events by returning true, you might break auto-hiding, because
* KCursor doesn't get those events.
*
* In this case, you need to call setAutoHideCursor( widget, true, true );
* to tell KCursor not to install an eventFilter. Then you call this method
* from the beginning of your eventFilter, for example:
* \code
* edit = new KEdit( this, "some edit widget" );
* edit->installEventFilter( this );
* KCursor::setAutoHideCursor( edit, true, true );
*
* [...]
*
* bool YourClass::eventFilter( QObject *o, QEvent *e )
* {
* if ( o == edit ) // only that widget where you enabled auto-hide!
* KCursor::autoHideEventFilter( o, e );
*
* // now you can do your own event-processing
* [...]
* }
* \endcode
*
* Note that you must not call KCursor::autoHideEventFilter() when you
* didn't enable or after disabling auto-hiding.
*/
static void autoHideEventFilter( QObject *, QEvent * );
private:
static QCursor *s_handCursor;
};
#endif // _KCURSOR_H
|
