KCursor Class Reference
#include <kcursor.h>
Inheritance diagram for KCursor:

Detailed Description
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
setCursor(KCursor::handCursor());
Definition at line 45 of file kcursor.h.
Public Member Functions | |
KCursor () | |
Static Public Member Functions | |
static QCursor | handCursor () |
static QCursor | workingCursor () |
static QCursor | arrowCursor () |
static QCursor | upArrowCursor () |
static QCursor | crossCursor () |
static QCursor | waitCursor () |
static QCursor | ibeamCursor () |
static QCursor | sizeVerCursor () |
static QCursor | sizeHorCursor () |
static QCursor | sizeBDiagCursor () |
static QCursor | sizeFDiagCursor () |
static QCursor | sizeAllCursor () |
static QCursor | blankCursor () |
static QCursor | whatsThisCursor () |
static void | setAutoHideCursor (QWidget *w, bool enable) |
static void | setAutoHideCursor (QWidget *w, bool enable, bool customEventFilter) |
static void | setHideCursorDelay (int ms) |
static int | hideCursorDelay () |
static void | autoHideEventFilter (QObject *, QEvent *) |
Constructor & Destructor Documentation
KCursor::KCursor | ( | ) |
Member Function Documentation
QCursor KCursor::handCursor | ( | ) | [static] |
Returns the proper hand cursor according to the current GUI style (static function).
Q_WS_WIN
Definition at line 43 of file kcursor.cpp.
QCursor KCursor::workingCursor | ( | ) | [static] |
Returns the proper arrow+hourglass cursor according to the current GUI style (static function).
Definition at line 125 of file kcursor.cpp.
QCursor KCursor::arrowCursor | ( | ) | [static] |
Returns the proper arrow cursor according to the current GUI style (static function).
This will change at some later date
Definition at line 146 of file kcursor.cpp.
QCursor KCursor::upArrowCursor | ( | ) | [static] |
Returns the proper up arrow cursor according to the current GUI style (static function).
Definition at line 152 of file kcursor.cpp.
QCursor KCursor::crossCursor | ( | ) | [static] |
Returns the proper cross-hair cursor according to the current GUI style (static function).
Definition at line 158 of file kcursor.cpp.
QCursor KCursor::waitCursor | ( | ) | [static] |
Returns the proper hourglass cursor according to the current GUI style (static function).
Definition at line 164 of file kcursor.cpp.
QCursor KCursor::ibeamCursor | ( | ) | [static] |
Returns the proper text cursor according to the current GUI style (static function).
Definition at line 170 of file kcursor.cpp.
QCursor KCursor::sizeVerCursor | ( | ) | [static] |
Returns the proper vertical resize cursor according to the current GUI style (static function).
Definition at line 176 of file kcursor.cpp.
QCursor KCursor::sizeHorCursor | ( | ) | [static] |
Returns the proper horizontal resize cursor according to the current GUI style (static function).
Definition at line 182 of file kcursor.cpp.
QCursor KCursor::sizeBDiagCursor | ( | ) | [static] |
Returns the proper diagonal resize (/) cursor according to the current GUI style (static function).
Definition at line 188 of file kcursor.cpp.
QCursor KCursor::sizeFDiagCursor | ( | ) | [static] |
Returns the proper diagonal resize (\) cursor according to the current GUI style (static function).
Definition at line 194 of file kcursor.cpp.
QCursor KCursor::sizeAllCursor | ( | ) | [static] |
Returns the proper all-directions resize cursor according to the current GUI style (static function).
Definition at line 200 of file kcursor.cpp.
QCursor KCursor::blankCursor | ( | ) | [static] |
QCursor KCursor::whatsThisCursor | ( | ) | [static] |
void KCursor::setAutoHideCursor | ( | QWidget * | w, | |
bool | enable | |||
) | [static] |
Sets auto-hiding the cursor for widget w
.
Enabling it will result in the cursor being hidden when
- a key-event happens
- there are no key-events for a configured time-frame (see setHideCursorDelay())
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().
Definition at line 218 of file kcursor.cpp.
void KCursor::setAutoHideCursor | ( | QWidget * | w, | |
bool | enable, | |||
bool | customEventFilter | |||
) | [static] |
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 customEventFilter
to true and call autoHideEventFilter() from the beginning of your eventFilter().
- See also:
- autoHideEventFilter
Definition at line 223 of file kcursor.cpp.
void KCursor::setHideCursorDelay | ( | int | ms | ) | [static] |
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.
Definition at line 234 of file kcursor.cpp.
int KCursor::hideCursorDelay | ( | ) | [static] |
- Returns:
- the current auto-hide delay time.
Default is 5000, i.e. 5 seconds.
Definition at line 239 of file kcursor.cpp.
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:
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 [...] }
Note that you must not call KCursor::autoHideEventFilter() when you didn't enable or after disabling auto-hiding.
Definition at line 229 of file kcursor.cpp.
The documentation for this class was generated from the following files: