API reference - Class Qt_MouseButton

!=

(1) Signature: [const] bool != (const Qt_MouseButton 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_MouseButton 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_MouseButton other)

Description: Compares two enums

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

Description: Compares an enum with an integer value

AllButtons

Signature: [static,const] Qt_MouseButton AllButtons

Description: Enum constant Qt::AllButtons

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

BackButton

Signature: [static,const] Qt_MouseButton BackButton

Description: Enum constant Qt::BackButton

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

ExtraButton1

Signature: [static,const] Qt_MouseButton ExtraButton1

Description: Enum constant Qt::ExtraButton1

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

ExtraButton10

Signature: [static,const] Qt_MouseButton ExtraButton10

Description: Enum constant Qt::ExtraButton10

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

ExtraButton11

Signature: [static,const] Qt_MouseButton ExtraButton11

Description: Enum constant Qt::ExtraButton11

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

ExtraButton12

Signature: [static,const] Qt_MouseButton ExtraButton12

Description: Enum constant Qt::ExtraButton12

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

ExtraButton13

Signature: [static,const] Qt_MouseButton ExtraButton13

Description: Enum constant Qt::ExtraButton13

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

ExtraButton14

Signature: [static,const] Qt_MouseButton ExtraButton14

Description: Enum constant Qt::ExtraButton14

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

ExtraButton15

Signature: [static,const] Qt_MouseButton ExtraButton15

Description: Enum constant Qt::ExtraButton15

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

ExtraButton16

Signature: [static,const] Qt_MouseButton ExtraButton16

Description: Enum constant Qt::ExtraButton16

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

ExtraButton17

Signature: [static,const] Qt_MouseButton ExtraButton17

Description: Enum constant Qt::ExtraButton17

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

ExtraButton18

Signature: [static,const] Qt_MouseButton ExtraButton18

Description: Enum constant Qt::ExtraButton18

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

ExtraButton19

Signature: [static,const] Qt_MouseButton ExtraButton19

Description: Enum constant Qt::ExtraButton19

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

ExtraButton2

Signature: [static,const] Qt_MouseButton ExtraButton2

Description: Enum constant Qt::ExtraButton2

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

ExtraButton20

Signature: [static,const] Qt_MouseButton ExtraButton20

Description: Enum constant Qt::ExtraButton20

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

ExtraButton21

Signature: [static,const] Qt_MouseButton ExtraButton21

Description: Enum constant Qt::ExtraButton21

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

ExtraButton22

Signature: [static,const] Qt_MouseButton ExtraButton22

Description: Enum constant Qt::ExtraButton22

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

ExtraButton23

Signature: [static,const] Qt_MouseButton ExtraButton23

Description: Enum constant Qt::ExtraButton23

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

ExtraButton24

Signature: [static,const] Qt_MouseButton ExtraButton24

Description: Enum constant Qt::ExtraButton24

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

ExtraButton3

Signature: [static,const] Qt_MouseButton ExtraButton3

Description: Enum constant Qt::ExtraButton3

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

ExtraButton4

Signature: [static,const] Qt_MouseButton ExtraButton4

Description: Enum constant Qt::ExtraButton4

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

ExtraButton5

Signature: [static,const] Qt_MouseButton ExtraButton5

Description: Enum constant Qt::ExtraButton5

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

ExtraButton6

Signature: [static,const] Qt_MouseButton ExtraButton6

Description: Enum constant Qt::ExtraButton6

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

ExtraButton7

Signature: [static,const] Qt_MouseButton ExtraButton7

Description: Enum constant Qt::ExtraButton7

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

ExtraButton8

Signature: [static,const] Qt_MouseButton ExtraButton8

Description: Enum constant Qt::ExtraButton8

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

ExtraButton9

Signature: [static,const] Qt_MouseButton ExtraButton9

Description: Enum constant Qt::ExtraButton9

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

ForwardButton

Signature: [static,const] Qt_MouseButton ForwardButton

Description: Enum constant Qt::ForwardButton

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

LeftButton

Signature: [static,const] Qt_MouseButton LeftButton

Description: Enum constant Qt::LeftButton

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

MaxMouseButton

Signature: [static,const] Qt_MouseButton MaxMouseButton

Description: Enum constant Qt::MaxMouseButton

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

MidButton

Signature: [static,const] Qt_MouseButton MidButton

Description: Enum constant Qt::MidButton

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

MiddleButton

Signature: [static,const] Qt_MouseButton MiddleButton

Description: Enum constant Qt::MiddleButton

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

MouseButtonMask

Signature: [static,const] Qt_MouseButton MouseButtonMask

Description: Enum constant Qt::MouseButtonMask

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

NoButton

Signature: [static,const] Qt_MouseButton NoButton

Description: Enum constant Qt::NoButton

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

RightButton

Signature: [static,const] Qt_MouseButton RightButton

Description: Enum constant Qt::RightButton

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

TaskButton

Signature: [static,const] Qt_MouseButton TaskButton

Description: Enum constant Qt::TaskButton

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

XButton1

Signature: [static,const] Qt_MouseButton XButton1

Description: Enum constant Qt::XButton1

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

XButton2

Signature: [static,const] Qt_MouseButton XButton2

Description: Enum constant Qt::XButton2

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

_const_cast

Signature: [const] Qt_MouseButton 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_MouseButton 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_MouseButton 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_MouseButton 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_MouseButton 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_MouseButton | (const Qt_MouseButton other)

Description: Creates a flag set by combining the two flags

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

Description: Combines the flag and the flag set