API reference - Class QAccessible_Method

Notation used in Ruby API documentation

Description: This class represents the QAccessible::Method enum

Class hierarchy: QAccessible_Method » QAccessible_QFlags_Method

Public constructors

new QAccessible_Methodnew(unsigned int value)Creates the enum object from an integer

Public methods

[const]bool==(QAccessible_Method 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 QAccessible_Method 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]QAccessible_MethoddupCreates 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 QAccessible_MethodBackgroundColorEnum constant QAccessible::BackgroundColor
new QAccessible_MethodForegroundColorEnum constant QAccessible::ForegroundColor
new QAccessible_MethodGetCursorPositionEnum constant QAccessible::GetCursorPosition
new QAccessible_MethodListSupportedMethodsEnum constant QAccessible::ListSupportedMethods
new QAccessible_MethodSetCursorPositionEnum constant QAccessible::SetCursorPosition

Detailed description

[const] bool ==(QAccessible_Method 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 QAccessible_Method BackgroundColor

Description: Enum constant QAccessible::BackgroundColor

[static] new QAccessible_Method ForegroundColor

Description: Enum constant QAccessible::ForegroundColor

[static] new QAccessible_Method GetCursorPosition

Description: Enum constant QAccessible::GetCursorPosition

[static] new QAccessible_Method ListSupportedMethods

Description: Enum constant QAccessible::ListSupportedMethods

[static] new QAccessible_Method SetCursorPosition

Description: Enum constant QAccessible::SetCursorPosition

[const] void assign(const QAccessible_Method 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] QAccessible_Method 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 QAccessible_Method new(unsigned int value)

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