KLayout Manual: Main Index » Class Index » API reference - Class Qt_MouseButton

API reference - Class Qt_MouseButton

Notation used in Ruby API documentation

Description: This class represents the Qt::MouseButton enum

Public constructors

new Qt_MouseButtonnew(unsigned int arg1)Creates the enum object from an integer

Public methods

[const]bool==(Qt_MouseButton other)Compares the enum class against an enum of it's own type
[const]bool==(unsigned int other)Compares the enum class against an integer
[const]voidassign(const Qt_MouseButton other)Assign the contents of another object to self
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]Qt_MouseButtondupCreates a copy of self
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]unsigned intto_iConverts the enum class to an integer
[const]stringto_sConverts the enum class to a string

Public static methods and constants

new Qt_MouseButtonLeftButtonEnum constant Qt::LeftButton
new Qt_MouseButtonMidButtonEnum constant Qt::MidButton
new Qt_MouseButtonMouseButtonMaskEnum constant Qt::MouseButtonMask
new Qt_MouseButtonNoButtonEnum constant Qt::NoButton
new Qt_MouseButtonRightButtonEnum constant Qt::RightButton
new Qt_MouseButtonXButton1Enum constant Qt::XButton1
new Qt_MouseButtonXButton2Enum constant Qt::XButton2

Detailed description

[const] bool ==(Qt_MouseButton other)

Description: Compares the enum class against an enum of it's own type

[const] bool ==(unsigned int other)

Description: Compares the enum class against an integer

[static] new Qt_MouseButton LeftButton

Description: Enum constant Qt::LeftButton

[static] new Qt_MouseButton MidButton

Description: Enum constant Qt::MidButton

[static] new Qt_MouseButton MouseButtonMask

Description: Enum constant Qt::MouseButtonMask

[static] new Qt_MouseButton NoButton

Description: Enum constant Qt::NoButton

[static] new Qt_MouseButton RightButton

Description: Enum constant Qt::RightButton

[static] new Qt_MouseButton XButton1

Description: Enum constant Qt::XButton1

[static] new Qt_MouseButton XButton2

Description: Enum constant Qt::XButton2

[const] void assign(const Qt_MouseButton other)

Description: Assign the contents of another object to self

This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.

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.

void destroy

Description: Explicitly destroy the object

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

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

[const] Qt_MouseButton dup

Description: Creates a copy of self

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

[static] new Qt_MouseButton new(unsigned int arg1)

Description: Creates the enum object from an integer

[const] unsigned int to_i

Description: Converts the enum class to an integer

[const] string to_s

Description: Converts the enum class to a string