API reference - Class QAccessible::RelationFlag

Notation used in Ruby API documentation

Description: This class represents the QAccessible::RelationFlag enum

Class hierarchy: QAccessible::RelationFlag » QAccessible_QFlags_RelationFlag

This class is equivalent to the top-level class QAccessible_RelationFlag

Public constructors

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

Public methods

[const]bool==(QAccessible_RelationFlag 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
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 QAccessible_RelationFlag other)Assigns another object to self
[const]new QAccessible_RelationFlag ptrdupCreates a copy of self
[const]stringinspectConverts the enum class to a string
[const]unsigned intto_iConverts the enum class to an integer
[const]stringto_sConverts the enum class to a string

Public static methods and constants

[static,const]new QAccessible_RelationFlag ptrAncestorEnum constant QAccessible::Ancestor
[static,const]new QAccessible_RelationFlag ptrChildEnum constant QAccessible::Child
[static,const]new QAccessible_RelationFlag ptrControlledEnum constant QAccessible::Controlled
[static,const]new QAccessible_RelationFlag ptrControllerEnum constant QAccessible::Controller
[static,const]new QAccessible_RelationFlag ptrCoveredEnum constant QAccessible::Covered
[static,const]new QAccessible_RelationFlag ptrCoversEnum constant QAccessible::Covers
[static,const]new QAccessible_RelationFlag ptrDescendentEnum constant QAccessible::Descendent
[static,const]new QAccessible_RelationFlag ptrDownEnum constant QAccessible::Down
[static,const]new QAccessible_RelationFlag ptrFocusChildEnum constant QAccessible::FocusChild
[static,const]new QAccessible_RelationFlag ptrGeometryMaskEnum constant QAccessible::GeometryMask
[static,const]new QAccessible_RelationFlag ptrHierarchyMaskEnum constant QAccessible::HierarchyMask
[static,const]new QAccessible_RelationFlag ptrLabelEnum constant QAccessible::Label
[static,const]new QAccessible_RelationFlag ptrLabelledEnum constant QAccessible::Labelled
[static,const]new QAccessible_RelationFlag ptrLeftEnum constant QAccessible::Left
[static,const]new QAccessible_RelationFlag ptrLogicalMaskEnum constant QAccessible::LogicalMask
[static,const]new QAccessible_RelationFlag ptrRightEnum constant QAccessible::Right
[static,const]new QAccessible_RelationFlag ptrSelfEnum constant QAccessible::Self
[static,const]new QAccessible_RelationFlag ptrSiblingEnum constant QAccessible::Sibling
[static,const]new QAccessible_RelationFlag ptrUnrelatedEnum constant QAccessible::Unrelated
[static,const]new QAccessible_RelationFlag ptrUpEnum constant QAccessible::Up

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

[const] bool ==(QAccessible_RelationFlag 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,const] new QAccessible_RelationFlag ptr Ancestor

Description: Enum constant QAccessible::Ancestor

[static,const] new QAccessible_RelationFlag ptr Child

Description: Enum constant QAccessible::Child

[static,const] new QAccessible_RelationFlag ptr Controlled

Description: Enum constant QAccessible::Controlled

[static,const] new QAccessible_RelationFlag ptr Controller

Description: Enum constant QAccessible::Controller

[static,const] new QAccessible_RelationFlag ptr Covered

Description: Enum constant QAccessible::Covered

[static,const] new QAccessible_RelationFlag ptr Covers

Description: Enum constant QAccessible::Covers

[static,const] new QAccessible_RelationFlag ptr Descendent

Description: Enum constant QAccessible::Descendent

[static,const] new QAccessible_RelationFlag ptr Down

Description: Enum constant QAccessible::Down

[static,const] new QAccessible_RelationFlag ptr FocusChild

Description: Enum constant QAccessible::FocusChild

[static,const] new QAccessible_RelationFlag ptr GeometryMask

Description: Enum constant QAccessible::GeometryMask

[static,const] new QAccessible_RelationFlag ptr HierarchyMask

Description: Enum constant QAccessible::HierarchyMask

[static,const] new QAccessible_RelationFlag ptr Label

Description: Enum constant QAccessible::Label

[static,const] new QAccessible_RelationFlag ptr Labelled

Description: Enum constant QAccessible::Labelled

[static,const] new QAccessible_RelationFlag ptr Left

Description: Enum constant QAccessible::Left

[static,const] new QAccessible_RelationFlag ptr LogicalMask

Description: Enum constant QAccessible::LogicalMask

[static,const] new QAccessible_RelationFlag ptr Right

Description: Enum constant QAccessible::Right

[static,const] new QAccessible_RelationFlag ptr Self

Description: Enum constant QAccessible::Self

[static,const] new QAccessible_RelationFlag ptr Sibling

Description: Enum constant QAccessible::Sibling

[static,const] new QAccessible_RelationFlag ptr Unrelated

Description: Enum constant QAccessible::Unrelated

[static,const] new QAccessible_RelationFlag ptr Up

Description: Enum constant QAccessible::Up

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

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

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.

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.

void assign(const QAccessible_RelationFlag other)

Description: Assigns another object to self

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

[const] new QAccessible_RelationFlag ptr dup

Description: Creates a copy of self

[const] string inspect

Description: Converts the enum class to a string

Python specific notes:

This method is also available as 'str(object)'

This method is also available as 'repr(object)'

[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

[static] new QAccessible_RelationFlag ptr new(unsigned int value)

Description: Creates the enum object from an integer

Python specific notes:

This method is the default initializer of the object

[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

Python specific notes:

This method is also available as 'str(object)'

This method is also available as 'repr(object)'