API reference - Class Qt_CursorShape

Notation used in Ruby API documentation

Module: QtCore

Description: This class represents the Qt::CursorShape enum

This class is equivalent to the class Qt::CursorShape

Public constructors

new Qt_CursorShape ptrnew(int i)Creates an enum from an integer value
new Qt_CursorShape ptrnew(string s)Creates an enum from a string value

Public methods

[const]bool!=(const Qt_CursorShape other)Compares two enums for inequality
[const]bool!=(int other)Compares an enum with an integer for inequality
[const]bool<(const Qt_CursorShape other)Returns true if the first enum is less (in the enum symbol order) than the second
[const]bool<(int other)Returns true if the enum is less (in the enum symbol order) than the integer value
[const]bool==(const Qt_CursorShape other)Compares two enums
[const]bool==(int other)Compares an enum with an integer value
[const]Qt_CursorShape 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.
voidassign(const Qt_CursorShape other)Assigns another object to self
[const]new Qt_CursorShape ptrdupCreates a copy of self
[const]inthashGets the hash value from the enum
[const]stringinspectConverts an enum to a visual string
[const]intto_iGets the integer value from the enum
[const]stringto_sGets the symbolic string from an enum
[const]Qt_QFlags_CursorShape|(const Qt_CursorShape other)Creates a flag set by combining the two flags
[const]Qt_QFlags_CursorShape|(const Qt_QFlags_CursorShape other)Combines the flag and the flag set

Public static methods and constants

[static,const]Qt_CursorShapeArrowCursorEnum constant Qt::ArrowCursor
[static,const]Qt_CursorShapeBitmapCursorEnum constant Qt::BitmapCursor
[static,const]Qt_CursorShapeBlankCursorEnum constant Qt::BlankCursor
[static,const]Qt_CursorShapeBusyCursorEnum constant Qt::BusyCursor
[static,const]Qt_CursorShapeClosedHandCursorEnum constant Qt::ClosedHandCursor
[static,const]Qt_CursorShapeCrossCursorEnum constant Qt::CrossCursor
[static,const]Qt_CursorShapeCustomCursorEnum constant Qt::CustomCursor
[static,const]Qt_CursorShapeDragCopyCursorEnum constant Qt::DragCopyCursor
[static,const]Qt_CursorShapeDragLinkCursorEnum constant Qt::DragLinkCursor
[static,const]Qt_CursorShapeDragMoveCursorEnum constant Qt::DragMoveCursor
[static,const]Qt_CursorShapeForbiddenCursorEnum constant Qt::ForbiddenCursor
[static,const]Qt_CursorShapeIBeamCursorEnum constant Qt::IBeamCursor
[static,const]Qt_CursorShapeLastCursorEnum constant Qt::LastCursor
[static,const]Qt_CursorShapeOpenHandCursorEnum constant Qt::OpenHandCursor
[static,const]Qt_CursorShapePointingHandCursorEnum constant Qt::PointingHandCursor
[static,const]Qt_CursorShapeSizeAllCursorEnum constant Qt::SizeAllCursor
[static,const]Qt_CursorShapeSizeBDiagCursorEnum constant Qt::SizeBDiagCursor
[static,const]Qt_CursorShapeSizeFDiagCursorEnum constant Qt::SizeFDiagCursor
[static,const]Qt_CursorShapeSizeHorCursorEnum constant Qt::SizeHorCursor
[static,const]Qt_CursorShapeSizeVerCursorEnum constant Qt::SizeVerCursor
[static,const]Qt_CursorShapeSplitHCursorEnum constant Qt::SplitHCursor
[static,const]Qt_CursorShapeSplitVCursorEnum constant Qt::SplitVCursor
[static,const]Qt_CursorShapeUpArrowCursorEnum constant Qt::UpArrowCursor
[static,const]Qt_CursorShapeWaitCursorEnum constant Qt::WaitCursor
[static,const]Qt_CursorShapeWhatsThisCursorEnum constant Qt::WhatsThisCursor

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

!=

(1) Signature: [const] bool != (const Qt_CursorShape other)

Description: Compares two enums for inequality

(2) Signature: [const] bool != (int other)

Description: Compares an enum with an integer for inequality

<

(1) Signature: [const] bool < (const Qt_CursorShape other)

Description: Returns true if the first enum is less (in the enum symbol order) than the second

(2) Signature: [const] bool < (int other)

Description: Returns true if the enum is less (in the enum symbol order) than the integer value

==

(1) Signature: [const] bool == (const Qt_CursorShape other)

Description: Compares two enums

(2) Signature: [const] bool == (int other)

Description: Compares an enum with an integer value

ArrowCursor

Signature: [static,const] Qt_CursorShape ArrowCursor

Description: Enum constant Qt::ArrowCursor

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

BitmapCursor

Signature: [static,const] Qt_CursorShape BitmapCursor

Description: Enum constant Qt::BitmapCursor

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

BlankCursor

Signature: [static,const] Qt_CursorShape BlankCursor

Description: Enum constant Qt::BlankCursor

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

BusyCursor

Signature: [static,const] Qt_CursorShape BusyCursor

Description: Enum constant Qt::BusyCursor

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

ClosedHandCursor

Signature: [static,const] Qt_CursorShape ClosedHandCursor

Description: Enum constant Qt::ClosedHandCursor

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

CrossCursor

Signature: [static,const] Qt_CursorShape CrossCursor

Description: Enum constant Qt::CrossCursor

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

CustomCursor

Signature: [static,const] Qt_CursorShape CustomCursor

Description: Enum constant Qt::CustomCursor

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

DragCopyCursor

Signature: [static,const] Qt_CursorShape DragCopyCursor

Description: Enum constant Qt::DragCopyCursor

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

DragLinkCursor

Signature: [static,const] Qt_CursorShape DragLinkCursor

Description: Enum constant Qt::DragLinkCursor

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

DragMoveCursor

Signature: [static,const] Qt_CursorShape DragMoveCursor

Description: Enum constant Qt::DragMoveCursor

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

ForbiddenCursor

Signature: [static,const] Qt_CursorShape ForbiddenCursor

Description: Enum constant Qt::ForbiddenCursor

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

IBeamCursor

Signature: [static,const] Qt_CursorShape IBeamCursor

Description: Enum constant Qt::IBeamCursor

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

LastCursor

Signature: [static,const] Qt_CursorShape LastCursor

Description: Enum constant Qt::LastCursor

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

OpenHandCursor

Signature: [static,const] Qt_CursorShape OpenHandCursor

Description: Enum constant Qt::OpenHandCursor

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

PointingHandCursor

Signature: [static,const] Qt_CursorShape PointingHandCursor

Description: Enum constant Qt::PointingHandCursor

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

SizeAllCursor

Signature: [static,const] Qt_CursorShape SizeAllCursor

Description: Enum constant Qt::SizeAllCursor

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

SizeBDiagCursor

Signature: [static,const] Qt_CursorShape SizeBDiagCursor

Description: Enum constant Qt::SizeBDiagCursor

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

SizeFDiagCursor

Signature: [static,const] Qt_CursorShape SizeFDiagCursor

Description: Enum constant Qt::SizeFDiagCursor

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

SizeHorCursor

Signature: [static,const] Qt_CursorShape SizeHorCursor

Description: Enum constant Qt::SizeHorCursor

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

SizeVerCursor

Signature: [static,const] Qt_CursorShape SizeVerCursor

Description: Enum constant Qt::SizeVerCursor

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

SplitHCursor

Signature: [static,const] Qt_CursorShape SplitHCursor

Description: Enum constant Qt::SplitHCursor

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

SplitVCursor

Signature: [static,const] Qt_CursorShape SplitVCursor

Description: Enum constant Qt::SplitVCursor

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

UpArrowCursor

Signature: [static,const] Qt_CursorShape UpArrowCursor

Description: Enum constant Qt::UpArrowCursor

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

WaitCursor

Signature: [static,const] Qt_CursorShape WaitCursor

Description: Enum constant Qt::WaitCursor

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

WhatsThisCursor

Signature: [static,const] Qt_CursorShape WhatsThisCursor

Description: Enum constant Qt::WhatsThisCursor

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

_const_cast

Signature: [const] Qt_CursorShape 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: void assign (const Qt_CursorShape other)

Description: Assigns another object to self

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 Qt_CursorShape ptr dup

Description: Creates a copy of self

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

hash

Signature: [const] int hash

Description: Gets the hash value from the enum

Python specific notes:
This method is also available as 'hash(object)'.

inspect

Signature: [const] string inspect

Description: Converts an enum to a visual string

Python specific notes:
This method is also available as 'repr(object)'.

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.

new

(1) Signature: [static] new Qt_CursorShape ptr new (int i)

Description: Creates an enum from an integer value

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

(2) Signature: [static] new Qt_CursorShape ptr new (string s)

Description: Creates an enum from a string value

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

to_i

Signature: [const] int to_i

Description: Gets the integer value from the enum

Python specific notes:
This method is also available as 'int(object)'.

to_s

Signature: [const] string to_s

Description: Gets the symbolic string from an enum

Python specific notes:
This method is also available as 'str(object)'.

|

(1) Signature: [const] Qt_QFlags_CursorShape | (const Qt_CursorShape other)

Description: Creates a flag set by combining the two flags

(2) Signature: [const] Qt_QFlags_CursorShape | (const Qt_QFlags_CursorShape other)

Description: Combines the flag and the flag set