API reference - Class QCursor

Notation used in Ruby API documentation

Module: QtGui

Description: Binding of QCursor

Public constructors

new QCursornewConstructor QCursor::QCursor()
new QCursornew(const Qt_CursorShape shape)Constructor QCursor::QCursor(Qt::CursorShape shape)
new QCursornew(const QBitmap bitmap,
const QBitmap mask,
int hotX = -1,
int hotY = -1)
Constructor QCursor::QCursor(const QBitmap &bitmap, const QBitmap &mask, int hotX, int hotY)
new QCursornew(const QPixmap pixmap,
int hotX = -1,
int hotY = -1)
Constructor QCursor::QCursor(const QPixmap &pixmap, int hotX, int hotY)
new QCursornew(const QCursor cursor)Constructor QCursor::QCursor(const QCursor &cursor)

Public methods

[const]bool!=(const QCursor rhs)Operator bool ::operator!=(const QCursor &lhs, const QCursor &rhs)
[const]bool==(const QCursor rhs)Operator bool ::operator==(const QCursor &lhs, const QCursor &rhs)
void_assign(const QCursor other)Assigns another object to self
[const]QCursor ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
QCursorassign(const QCursor cursor)Method QCursor &QCursor::operator=(const QCursor &cursor)
[const]const QBitmap ptrbitmapMethod const QBitmap *QCursor::bitmap()
[const]new QCursor ptrdupCreates a copy of self
[const]QPointhotSpotMethod QPoint QCursor::hotSpot()
[const]const QBitmap ptrmaskMethod const QBitmap *QCursor::mask()
[const]QPixmappixmapMethod QPixmap QCursor::pixmap()
voidsetShape(const Qt_CursorShape newShape)Method void QCursor::setShape(Qt::CursorShape newShape)
[const]Qt_CursorShapeshapeMethod Qt::CursorShape QCursor::shape()
voidshape=(const Qt_CursorShape newShape)Method void QCursor::setShape(Qt::CursorShape newShape)
voidswap(QCursor other)Method void QCursor::swap(QCursor &other)

Public static methods and constants

QPointposStatic method QPoint QCursor::pos()
QPointpos(const QScreen ptr screen)Static method QPoint QCursor::pos(const QScreen *screen)
voidpos=(const QPoint p)Static method void QCursor::setPos(const QPoint &p)
voidsetPos(int x,
int y)
Static method void QCursor::setPos(int x, int y)
voidsetPos(QScreen ptr screen,
int x,
int y)
Static method void QCursor::setPos(QScreen *screen, int x, int y)
voidsetPos(const QPoint p)Static method void QCursor::setPos(const QPoint &p)
voidsetPos(QScreen ptr screen,
const QPoint p)
Static method void QCursor::setPos(QScreen *screen, const QPoint &p)

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

!=

Signature: [const] bool != (const QCursor rhs)

Description: Operator bool ::operator!=(const QCursor &lhs, const QCursor &rhs)

This is the mapping of the global operator to the instance method.

==

Signature: [const] bool == (const QCursor rhs)

Description: Operator bool ::operator==(const QCursor &lhs, const QCursor &rhs)

This is the mapping of the global operator to the instance method.

_assign

Signature: void _assign (const QCursor other)

Description: Assigns another object to self

_const_cast

Signature: [const] QCursor ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

assign

Signature: QCursor assign (const QCursor cursor)

Description: Method QCursor &QCursor::operator=(const QCursor &cursor)

bitmap

Signature: [const] const QBitmap ptr bitmap

Description: Method const QBitmap *QCursor::bitmap()

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

dup

Signature: [const] new QCursor ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

hotSpot

Signature: [const] QPoint hotSpot

Description: Method QPoint QCursor::hotSpot()

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

mask

Signature: [const] const QBitmap ptr mask

Description: Method const QBitmap *QCursor::mask()

new

(1) Signature: [static] new QCursor new

Description: Constructor QCursor::QCursor()

This method creates an object of class QCursor.

Python specific notes:
This method is the default initializer of the object.

(2) Signature: [static] new QCursor new (const Qt_CursorShape shape)

Description: Constructor QCursor::QCursor(Qt::CursorShape shape)

This method creates an object of class QCursor.

Python specific notes:
This method is the default initializer of the object.

(3) Signature: [static] new QCursor new (const QBitmap bitmap, const QBitmap mask, int hotX = -1, int hotY = -1)

Description: Constructor QCursor::QCursor(const QBitmap &bitmap, const QBitmap &mask, int hotX, int hotY)

This method creates an object of class QCursor.

Python specific notes:
This method is the default initializer of the object.

(4) Signature: [static] new QCursor new (const QPixmap pixmap, int hotX = -1, int hotY = -1)

Description: Constructor QCursor::QCursor(const QPixmap &pixmap, int hotX, int hotY)

This method creates an object of class QCursor.

Python specific notes:
This method is the default initializer of the object.

(5) Signature: [static] new QCursor new (const QCursor cursor)

Description: Constructor QCursor::QCursor(const QCursor &cursor)

This method creates an object of class QCursor.

Python specific notes:
This method is the default initializer of the object.

pixmap

Signature: [const] QPixmap pixmap

Description: Method QPixmap QCursor::pixmap()

pos

(1) Signature: [static] QPoint pos

Description: Static method QPoint QCursor::pos()

This method is static and can be called without an instance.

Python specific notes:
The object exposes a readable attribute 'pos'. This is the getter.

(2) Signature: [static] QPoint pos (const QScreen ptr screen)

Description: Static method QPoint QCursor::pos(const QScreen *screen)

This method is static and can be called without an instance.

Python specific notes:
This method is available as 'pos_' in Python to distiguish it from the property with the same name.

pos=

Signature: [static] void pos= (const QPoint p)

Description: Static method void QCursor::setPos(const QPoint &p)

This method is static and can be called without an instance.

Python specific notes:
The object exposes a writable attribute 'pos'. This is the setter.

setPos

(1) Signature: [static] void setPos (int x, int y)

Description: Static method void QCursor::setPos(int x, int y)

This method is static and can be called without an instance.

(2) Signature: [static] void setPos (QScreen ptr screen, int x, int y)

Description: Static method void QCursor::setPos(QScreen *screen, int x, int y)

This method is static and can be called without an instance.

(3) Signature: [static] void setPos (const QPoint p)

Description: Static method void QCursor::setPos(const QPoint &p)

This method is static and can be called without an instance.

Python specific notes:
The object exposes a writable attribute 'pos'. This is the setter.

(4) Signature: [static] void setPos (QScreen ptr screen, const QPoint p)

Description: Static method void QCursor::setPos(QScreen *screen, const QPoint &p)

This method is static and can be called without an instance.

setShape

Signature: void setShape (const Qt_CursorShape newShape)

Description: Method void QCursor::setShape(Qt::CursorShape newShape)

Python specific notes:
The object exposes a writable attribute 'shape'. This is the setter.

shape

Signature: [const] Qt_CursorShape shape

Description: Method Qt::CursorShape QCursor::shape()

Python specific notes:
The object exposes a readable attribute 'shape'. This is the getter.

shape=

Signature: void shape= (const Qt_CursorShape newShape)

Description: Method void QCursor::setShape(Qt::CursorShape newShape)

Python specific notes:
The object exposes a writable attribute 'shape'. This is the setter.

swap

Signature: void swap (QCursor other)

Description: Method void QCursor::swap(QCursor &other)