From bd0f3345a938b35ce6a12f6150373b0955b8dd12 Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Sun, 10 Jul 2011 15:24:15 -0500 Subject: Add Qt3 development HEAD version --- doc/html/qcursor.html | 287 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 287 insertions(+) create mode 100644 doc/html/qcursor.html (limited to 'doc/html/qcursor.html') diff --git a/doc/html/qcursor.html b/doc/html/qcursor.html new file mode 100644 index 0000000..927c182 --- /dev/null +++ b/doc/html/qcursor.html @@ -0,0 +1,287 @@ + + + + + +QCursor Class + + + + + + + +
+ +Home + | +All Classes + | +Main Classes + | +Annotated + | +Grouped Classes + | +Functions +

QCursor Class Reference

+ +

The QCursor class provides a mouse cursor with an arbitrary +shape. +More... +

#include <qcursor.h> +

Inherits Qt. +

List of all member functions. +

Public Members

+ +

Static Public Members

+ +

Related Functions

+ +

Detailed Description

+ + +

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 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(). +

Cursor Shapes
+

See also QWidget, GUI Design Handbook: + Cursors, Widget Appearance and Style, and Implicitly and Explicitly Shared Classes. + +

On X11, Qt supports the 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. +

+
Qt::CursorShape Values Cursor Names +
Qt::ArrowCursor left_ptr +
Qt::UpArrowCursor up_arrow +
Qt::CrossCursor cross +
Qt::WaitCursor wait +
Qt::BusyCursor left_ptr_watch +
Qt::IbeamCursor ibeam +
Qt::SizeVerCursor size_ver +
Qt::SizeHorCursor size_hor +
Qt::SizeBDiagCursor size_bdiag +
Qt::SizeFDiagCursor size_fdiag +
Qt::SizeAllCursor size_all +
Qt::SplitVCursor split_v +
Qt::SplitHCursor split_h +
Qt::PointingHandCursor pointing_hand +
Qt::ForbiddenCursor forbidden +
Qt::WhatsThisCursor whats_this +
+ +

Member Function Documentation

+

QCursor::QCursor () +

+Constructs a cursor with the default arrow shape. + +

QCursor::QCursor ( int shape ) +

+Constructs a cursor with the specified shape. +

See CursorShape for a list of shapes. +

See also setShape(). + +

QCursor::QCursor ( const QBitmap & bitmap, const QBitmap & mask, int hotX = -1, int hotY = -1 ) +

+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 color0 to draw 0-pixels and color1 to +draw 1-pixels in the bitmaps. +

Valid cursor sizes depend on the display hardware (or the +underlying window system). We recommend using 32x32 cursors, +because this size is supported on all platforms. Some platforms +also support 16x16, 48x48 and 64x64 cursors. +

See also QBitmap::QBitmap() and QBitmap::setMask(). + +

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 32x32 cursors, +because this size is supported on all platforms. Some platforms +also support 16x16, 48x48 and 64x64 cursors. +

Currently, only black-and-white pixmaps can be used. +

See also QPixmap::QPixmap() and QPixmap::setMask(). + +

QCursor::QCursor ( const QCursor & c ) +

+Constructs a copy of the cursor c. + +

QCursor::QCursor ( HCURSOR handle ) +

+ +

Creates a cursor with the specified window system handle handle. +

Warning: +Portable in principle, but if you use it you are probably about to +do something non-portable. Be careful. + +

QCursor::~QCursor () +

+Destroys the cursor. + +

const QBitmap * QCursor::bitmap () const +

+Returns the cursor bitmap, or 0 if it is one of the standard +cursors. + +

void QCursor::cleanup () [static] +

+Internal function that deinitializes the predefined cursors. +This function is called from the QApplication destructor. +

See also initialize(). + +

HANDLE QCursor::handle () const +

+Returns the window system cursor handle. +

Warning: +Portable in principle, but if you use it you are probably about to +do something non-portable. Be careful. + +

QPoint QCursor::hotSpot () const +

+Returns the cursor hot spot, or (0, 0) if it is one of the +standard cursors. + +

void QCursor::initialize () [static] +

+Internal function that initializes the predefined cursors. +This function is called from the QApplication constructor. +

See also cleanup(). + +

const QBitmap * QCursor::mask () const +

+Returns the cursor bitmap mask, or 0 if it is one of the standard +cursors. + +

QCursor & QCursor::operator= ( const QCursor & c ) +

+Assigns c to this cursor and returns a reference to this +cursor. + +

QPoint QCursor::pos () [static] +

+Returns the position of the cursor (hot spot) in global screen +coordinates. +

You can call QWidget::mapFromGlobal() to translate it to widget +coordinates. +

See also setPos(), QWidget::mapFromGlobal(), and QWidget::mapToGlobal(). + +

Examples: chart/canvasview.cpp, fileiconview/qfileiconview.cpp, and menu/menu.cpp. +

void QCursor::setPos ( int x, int y ) [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. +

See also pos(), QWidget::mapFromGlobal(), and QWidget::mapToGlobal(). + +

void QCursor::setPos ( const QPoint & ) [static] +

+This is an overloaded member function, provided for convenience. It behaves essentially like the above function. +

+

void QCursor::setShape ( int shape ) +

+Sets the cursor to the shape identified by shape. +

See CursorShape for the list of cursor shapes. +

See also shape(). + +

int QCursor::shape () const +

+Returns the cursor shape identifier. The return value is one of +the CursorShape enum values (cast to an int). +

See also setShape(). + +

Related Functions

+

QDataStream & operator<< ( QDataStream & s, const QCursor & c ) +

+ +Writes the cursor c to the stream s. +

See also Format of the QDataStream operators. + +

QDataStream & operator>> ( QDataStream & s, QCursor & c ) +

+ +Reads a cursor from the stream s and sets c to the read data. +

See also Format of the QDataStream operators. + + +

+This file is part of the Qt toolkit. +Copyright © 1995-2007 +Trolltech. All Rights Reserved.

+ +
Copyright © 2007 +TrolltechTrademarks +
Qt 3.3.8
+
+ -- cgit v1.2.1