Qt 4.8
|
The QCursor class provides a mouse cursor with an arbitrary shape. More...
#include <qcursor.h>
Public Functions | |
const QBitmap * | bitmap () const |
Returns the cursor bitmap, or 0 if it is one of the standard cursors. More... | |
HCURSOR_or_HANDLE | handle () const |
Returns a platform-specific cursor handle. More... | |
QPoint | hotSpot () const |
Returns the cursor hot spot, or (0, 0) if it is one of the standard cursors. More... | |
const QBitmap * | mask () const |
Returns the cursor bitmap mask, or 0 if it is one of the standard cursors. More... | |
operator QVariant () const | |
Returns the cursor as a QVariant. More... | |
QCursor & | operator= (const QCursor &cursor) |
Assigns c to this cursor and returns a reference to this cursor. More... | |
QPixmap | pixmap () const |
Returns the cursor pixmap. More... | |
QCursor () | |
Constructs a cursor with the default arrow shape. More... | |
QCursor (Qt::CursorShape shape) | |
Constructs a cursor with the specified shape. More... | |
QCursor (const QBitmap &bitmap, const QBitmap &mask, int hotX=-1, int hotY=-1) | |
Constructs a custom bitmap cursor. More... | |
QCursor (const QPixmap &pixmap, int hotX=-1, int hotY=-1) | |
Constructs a custom pixmap cursor. More... | |
QCursor (const QCursor &cursor) | |
Constructs a copy of the cursor c. More... | |
QCursor (HCURSOR cursor) | |
Constructs a Qt cursor from the given Windows cursor. More... | |
QCursor (Qt::HANDLE cursor) | |
Constructs a Qt cursor from the given handle. More... | |
void | setShape (Qt::CursorShape newShape) |
Sets the cursor to the shape identified by shape. More... | |
Qt::CursorShape | shape () const |
Returns the cursor shape identifier. More... | |
~QCursor () | |
Destroys the cursor. More... | |
Static Public Functions | |
static QPoint | pos () |
Returns the position of the cursor (hot spot) in global screen coordinates. More... | |
static void | setPos (int x, int y) |
Moves the cursor (hot spot) to the global screen position (x, y). More... | |
static void | setPos (const QPoint &p) |
Moves the cursor (hot spot) to the global screen position at point p. More... | |
Properties | |
QCursorData * | d |
Friends | |
void * | qt_mac_nsCursorForQCursor (const QCursor &c) |
void | qt_mac_set_cursor (const QCursor *c) |
void | qt_mac_updateCursorWithWidgetUnderMouse (QWidget *widgetUnderMouse) |
Related Functions | |
(Note that these are not member functions.) | |
QDataStream & | operator<< (QDataStream &stream, const QCursor &cursor) |
Writes the cursor to the stream. More... | |
QDataStream & | operator>> (QDataStream &stream, QCursor &cursor) |
Reads the cursor from the stream. More... | |
The QCursor class provides a mouse cursor with an arbitrary shape.
This class is mainly used to create mouse cursors that are associated with particular widgets and to get and set the position of the mouse cursor.
Qt has a number of standard cursor shapes, but you can also make custom cursor shapes based on a QBitmap, a mask and a hotspot.
To associate a cursor with a widget, use QWidget::setCursor(). To associate a cursor with all widgets (normally for a short period of time), use QApplication::setOverrideCursor().
To set a cursor shape use QCursor::setShape() or use the QCursor constructor which takes the shape as argument, or you can use one of the predefined cursors defined in the Qt::CursorShape enum.
If you want to create a cursor with your own bitmap, either use the QCursor constructor which takes a bitmap and a mask or the constructor which takes a pixmap as arguments.
To set or get the position of the mouse cursor use the static methods QCursor::pos() and QCursor::setPos().
Note: It is possible to create a QCursor before QApplication, but it is not useful except as a place-holder for a real QCursor created after QApplication. Attempting to use a QCursor that was created before QApplication will result in a crash.
On X11, Qt supports the http://www.xfree86.org/4.3.0/Xcursor.3.html Xcursor library, which allows for full color icon themes. The table below shows the cursor name used for each Qt::CursorShape value. If a cursor cannot be found using the name shown below, a standard X11 cursor will be used instead. Note: X11 does not provide appropriate cursors for all possible Qt::CursorShape values. It is possible that some cursors will be taken from the Xcursor theme, while others will use an internal bitmap cursor.
Shape | Qt::CursorShape Value | Cursor Name | Shape | Qt::CursorShape Value | Cursor Name |
Qt::ArrowCursor | left_ptr | Qt::SizeVerCursor | size_ver | ||
Qt::UpArrowCursor | up_arrow | Qt::SizeHorCursor | size_hor | ||
Qt::CrossCursor | cross | Qt::SizeBDiagCursor | size_bdiag | ||
Qt::IBeamCursor | ibeam | Qt::SizeFDiagCursor | size_fdiag | ||
Qt::WaitCursor | wait | Qt::SizeAllCursor | size_all | ||
Qt::BusyCursor | left_ptr_watch | Qt::SplitVCursor | split_v | ||
Qt::ForbiddenCursor | forbidden | Qt::SplitHCursor | split_h | ||
Qt::PointingHandCursor | pointing_hand | Qt::OpenHandCursor | openhand | ||
Qt::WhatsThisCursor | whats_this | Qt::ClosedHandCursor | closedhand | ||
Qt::DragMoveCursor | dnd-move or move | Qt::DragCopyCursor | dnd-copy or copy | ||
Qt::DragLinkCursor | dnd-link or link |
QCursor::QCursor | ( | ) |
Constructs a cursor with the default arrow shape.
Definition at line 433 of file qcursor.cpp.
QCursor::QCursor | ( | Qt::CursorShape | shape | ) |
Constructs a cursor with the specified shape.
See Qt::CursorShape for a list of shapes.
Definition at line 454 of file qcursor.cpp.
Constructs a custom bitmap cursor.
bitmap and mask make up the bitmap. hotX and hotY define the cursor's hot spot.
If hotX is negative, it is set to the bitmap().width()/2
. If hotY is negative, it is set to the bitmap().height()/2
.
The cursor bitmap (B) and mask (M) bits are combined like this:
Use the global Qt color Qt::color0 to draw 0-pixels and Qt::color1 to draw 1-pixels in the bitmaps.
Valid cursor sizes depend on the display hardware (or the underlying window system). We recommend using 32 x 32 cursors, because this size is supported on all platforms. Some platforms also support 16 x 16, 48 x 48, and 64 x 64 cursors.
Definition at line 392 of file qcursor.cpp.
QCursor::QCursor | ( | const QPixmap & | pixmap, |
int | hotX = -1 , |
||
int | hotY = -1 |
||
) |
Constructs a custom pixmap cursor.
pixmap is the image. It is usual to give it a mask (set using QPixmap::setMask()). hotX and hotY define the cursor's hot spot.
If hotX is negative, it is set to the pixmap().width()/2
. If hotY is negative, it is set to the pixmap().height()/2
.
Valid cursor sizes depend on the display hardware (or the underlying window system). We recommend using 32 x 32 cursors, because this size is supported on all platforms. Some platforms also support 16 x 16, 48 x 48, and 64 x 64 cursors.
Definition at line 333 of file qcursor.cpp.
QCursor::QCursor | ( | const QCursor & | cursor | ) |
QCursor::~QCursor | ( | ) |
QCursor::QCursor | ( | HCURSOR | cursor | ) |
Constructs a Qt cursor from the given Windows cursor.
Definition at line 104 of file qcursor_win.cpp.
QCursor::QCursor | ( | Qt::HANDLE | handle | ) |
Constructs a Qt cursor from the given handle.
Definition at line 100 of file qcursor_x11.cpp.
const QBitmap * QCursor::bitmap | ( | ) | const |
Returns the cursor bitmap, or 0 if it is one of the standard cursors.
Definition at line 504 of file qcursor.cpp.
Referenced by QXlibCursor::createCursorBitmap(), and operator<<().
Qt::HANDLE QCursor::handle | ( | ) | const |
Returns a platform-specific cursor handle.
The HCURSOR_or_HANDLE
type is HCURSOR
on Windows and Qt::HANDLE on X11 and Mac OS X. On Qt for Embedded Linux it is an integer.
Definition at line 301 of file qcursor_mac.mm.
Referenced by QXlibCursor::changeCursor(), effectiveState(), isServerProcess(), parseGeometry(), QGuiEventDispatcherWin32::processEvents(), QCursor(), qJournalRecordProc(), qstring_to_xtp(), qt_grab_cursor(), qt_mac_set_cursor(), qt_try_modal(), qt_win_set_cursor(), qt_x11_enforce_cursor(), QtWndProc(), QApplication::qwsProcessEvent(), and QETWidget::translateMouseEvent().
QPoint QCursor::hotSpot | ( | ) | const |
Returns the cursor hot spot, or (0, 0) if it is one of the standard cursors.
Definition at line 540 of file qcursor.cpp.
Referenced by QDirectFBCursor::changeCursor(), QPlatformSoftwareCursor::changeCursor(), QXlibCursor::createCursorBitmap(), and operator<<().
const QBitmap * QCursor::mask | ( | ) | const |
Returns the cursor bitmap mask, or 0 if it is one of the standard cursors.
Definition at line 516 of file qcursor.cpp.
Referenced by QXlibCursor::createCursorBitmap(), and operator<<().
QCursor::operator QVariant | ( | ) | const |
Returns the cursor as a QVariant.
Definition at line 590 of file qcursor.cpp.
Assigns c to this cursor and returns a reference to this cursor.
Definition at line 575 of file qcursor.cpp.
QPixmap QCursor::pixmap | ( | ) | const |
Returns the cursor pixmap.
This is only valid if the cursor is a pixmap cursor.
Definition at line 528 of file qcursor.cpp.
Referenced by QDirectFBCursor::changeCursor(), QPlatformSoftwareCursor::changeCursor(), operator<<(), and QCursor().
|
static |
Returns the position of the cursor (hot spot) in global screen coordinates.
You can call QWidget::mapFromGlobal() to translate it to widget coordinates.
Definition at line 310 of file qcursor_mac.mm.
Referenced by QDialog::adjustPosition(), QGraphicsViewPrivate::centerView(), QApplicationPrivate::dispatchEnterLeave(), QX11Data::dndEnable(), QAbstractItemView::doAutoScroll(), QWidgetResizeHandler::doMove(), QWidgetResizeHandler::doResize(), QTreeView::drawTree(), QShortcut::event(), QDockWidget::event(), QToolBar::event(), findRealWindow(), QSystemTrayIconSys::findTrayGeometry(), QPlatformSoftwareCursor::getCurrentRect(), QApplicationPrivate::globalEventProcessor(), QAbstractItemView::horizontalScrollbarValueChanged(), QColorDialogPrivate::init(), QFontDialogPrivate::init(), QMenu::internalDelayedPopup(), QGraphicsItem::isUnderMouse(), QWidgetResizeHandler::keyPressEvent(), QApplicationPrivate::leaveModal_sys(), QGraphicsScenePrivate::leaveScene(), QWorkspaceTitleBar::paintEvent(), QMenu::popup(), QContextMenuEvent::QContextMenuEvent(), QCursor(), QMouseEvent::QMouseEvent(), qt_keyrelease_scanner(), qt_mac_update_cursor(), qt_qpa_set_cursor(), QtWndProc(), QWhatsThisPrivate::QWhatsThisPrivate(), QWheelEvent::QWheelEvent(), QMacPinchGestureRecognizer::reset(), QApplicationPrivate::sendSyntheticEnterLeave(), QGraphicsItem::setCursor(), QHeaderView::setOffset(), QTextBrowserPrivate::setSource(), QWizard::sizeHint(), QTreeView::timerEvent(), QPlainTextEdit::timerEvent(), QTextEdit::timerEvent(), QGraphicsItem::unsetCursor(), QMessageBoxPrivate::updateSize(), QAbstractItemView::verticalScrollbarValueChanged(), QSystemTrayIconSys::winEvent(), QApplication::x11EventFilter(), QMouseEvent::~QMouseEvent(), and QWheelEvent::~QWheelEvent().
|
static |
Moves the cursor (hot spot) to the global screen position (x, y).
You can call QWidget::mapToGlobal() to translate widget coordinates to global screen coordinates.
Definition at line 315 of file qcursor_mac.mm.
Referenced by QBBScreenEventHandler::handleTouchEvent(), QWidgetResizeHandler::keyPressEvent(), QMdiSubWindow::keyPressEvent(), QTest::mouseEvent(), QCursor(), QHeaderView::setOffset(), and QDialog::setVisible().
|
inlinestatic |
Moves the cursor (hot spot) to the global screen position at point p.
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Definition at line 115 of file qcursor.h.
Referenced by setPos().
void QCursor::setShape | ( | Qt::CursorShape | shape | ) |
Sets the cursor to the shape identified by shape.
See Qt::CursorShape for the list of cursor shapes.
Definition at line 483 of file qcursor.cpp.
Referenced by operator>>(), and QCursor().
Qt::CursorShape QCursor::shape | ( | ) | const |
Returns the cursor shape identifier.
The return value is one of the Qt::CursorShape enum values (cast to an int).
Definition at line 469 of file qcursor.cpp.
Referenced by QTextBrowserPrivate::_q_highlightLink(), QWaylandCursor::changeCursor(), QXlibCursor::changeCursor(), QDirectFBCursor::changeCursor(), QPlatformSoftwareCursor::changeCursor(), QCursorData::cleanup(), QScriptEdit::extraAreaMouseEvent(), QCursorData::initialize(), QHeaderView::mouseDoubleClickEvent(), operator<<(), QWidget::setCursor(), and setShape().
|
related |
Writes the cursor to the stream.
Definition at line 255 of file qcursor.cpp.
|
related |
Reads the cursor from the stream.
Definition at line 285 of file qcursor.cpp.
|
friend |
Definition at line 100 of file qcursor_mac.mm.
|
friend |
Definition at line 108 of file qcursor_mac.mm.
|
friend |
Definition at line 144 of file qcursor_mac.mm.
|
private |
Definition at line 141 of file qcursor.h.
Referenced by bitmap(), hotSpot(), mask(), operator=(), pixmap(), QCursor(), qt_mac_nsCursorForQCursor(), qt_mac_set_cursor(), qt_mac_updateCursorWithWidgetUnderMouse(), setShape(), shape(), and ~QCursor().