Qyoto  4.0.7
Qyoto is a C# language binding for Qt
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties
QtGui.QCursor Class Reference

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

Inheritance diagram for QtGui.QCursor:
Collaboration diagram for QtGui.QCursor:

Public Member Functions

 QCursor ()
  More...
 
 QCursor (QCursor cursor)
  More...
 
 QCursor (System.IntPtr cursor)
  More...
 
 QCursor (QBitmap bitmap, QBitmap mask, int hotX=-1, int hotY=-1)
  More...
 
 QCursor (QPixmap pixmap, int hotX=-1, int hotY=-1)
  More...
 
 QCursor (Qt.CursorShape shape)
  More...
 
virtual void CreateProxy ()
 
new void Dispose ()
 

Static Public Member Functions

static void SetPos (int x, int y)
  More...
 

Protected Member Functions

 QCursor (System.Type dummy)
 

Protected Attributes

SmokeInvocation interceptor
 

Properties

static QPoint Pos [get, set]
  More...
 
Qt.CursorShape Shape [get, set]
  More...
 
QBitmap Bitmap [get]
  More...
 
System.IntPtr Handle [get]
  More...
 
QPoint HotSpot [get]
  More...
 
QBitmap Mask [get]
  More...
 
QPixmap Pixmap [get]
  More...
 
virtual System.IntPtr SmokeObject [get, set]
 

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 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.

A Note for X11 Users

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.

ShapeQt::CursorShape ValueCursor NameShapeQt::CursorShape ValueCursor 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

See also QWidget and GUI Design Handbook: Cursors.

Constructor & Destructor Documentation

QtGui.QCursor.QCursor ( System.Type  dummy)
protected
QtGui.QCursor.QCursor ( )

Constructs a cursor with the default arrow shape.

Here is the call graph for this function:

QtGui.QCursor.QCursor ( QCursor  cursor)

Constructs a copy of the cursor c.

Here is the call graph for this function:

QtGui.QCursor.QCursor ( System.IntPtr  cursor)

Constructs a Qt cursor from the given Windows cursor.

Warning: This function is only available on Windows.

See also handle().

Here is the call graph for this function:

QtGui.QCursor.QCursor ( QBitmap  bitmap,
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:

B=1 and M=1 gives black.

B=0 and M=1 gives white.

B=0 and M=0 gives transparent.

B=1 and M=0 gives an XOR'd result under Windows, undefined results on all other platforms.

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.

Note: On Windows CE, the cursor size is fixed. If the pixmap is bigger than the system size, it will be scaled.

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

Here is the call graph for this function:

QtGui.QCursor.QCursor ( 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.

Note: On Windows CE, the cursor size is fixed. If the pixmap is bigger than the system size, it will be scaled.

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

Here is the call graph for this function:

QtGui.QCursor.QCursor ( Qt.CursorShape  shape)

Constructs a cursor with the specified shape.

See Qt::CursorShape for a list of shapes.

See also setShape().

Here is the call graph for this function:

Member Function Documentation

virtual void QtGui.QCursor.CreateProxy ( )
virtual

Here is the caller graph for this function:

new void QtGui.QCursor.Dispose ( )
static void QtGui.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().

Member Data Documentation

SmokeInvocation QtGui.QCursor.interceptor
protected

Property Documentation

QBitmap QtGui.QCursor.Bitmap
get

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

System.IntPtr QtGui.QCursor.Handle
get

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.

Warning: Using the value returned by this function is not portable.

QPoint QtGui.QCursor.HotSpot
get

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

QBitmap QtGui.QCursor.Mask
get

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

QPixmap QtGui.QCursor.Pixmap
get

Returns the cursor pixmap. This is only valid if the cursor is a pixmap cursor.

QPoint QtGui.QCursor.Pos
staticgetset

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

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

This is an overloaded function.

Moves the cursor (hot spot) to the global screen position at point p.

Qt.CursorShape QtGui.QCursor.Shape
getset

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

Sets the cursor to the shape identified by shape.

See Qt::CursorShape for the list of cursor shapes.

virtual System.IntPtr QtGui.QCursor.SmokeObject
getset