API reference - Class QAccessible_StateFlag

Notation used in Ruby API documentation

Description: This class represents the QAccessible::StateFlag enum

Class hierarchy: QAccessible_StateFlag » QAccessible_QFlags_StateFlag

This class is equivalent to the top-level class QAccessible::StateFlag

Public constructors

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

Public methods

[const]bool==(QAccessible_StateFlag 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_StateFlag other)Assigns another object to self
[const]new QAccessible_StateFlag 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_StateFlag ptrAnimatedEnum constant QAccessible::Animated
[static,const]new QAccessible_StateFlag ptrBusyEnum constant QAccessible::Busy
[static,const]new QAccessible_StateFlag ptrCheckedEnum constant QAccessible::Checked
[static,const]new QAccessible_StateFlag ptrCollapsedEnum constant QAccessible::Collapsed
[static,const]new QAccessible_StateFlag ptrDefaultButtonEnum constant QAccessible::DefaultButton
[static,const]new QAccessible_StateFlag ptrExpandedEnum constant QAccessible::Expanded
[static,const]new QAccessible_StateFlag ptrExtSelectableEnum constant QAccessible::ExtSelectable
[static,const]new QAccessible_StateFlag ptrFocusableEnum constant QAccessible::Focusable
[static,const]new QAccessible_StateFlag ptrFocusedEnum constant QAccessible::Focused
[static,const]new QAccessible_StateFlag ptrHasInvokeExtensionEnum constant QAccessible::HasInvokeExtension
[static,const]new QAccessible_StateFlag ptrHasPopupEnum constant QAccessible::HasPopup
[static,const]new QAccessible_StateFlag ptrHotTrackedEnum constant QAccessible::HotTracked
[static,const]new QAccessible_StateFlag ptrInvisibleEnum constant QAccessible::Invisible
[static,const]new QAccessible_StateFlag ptrLinkedEnum constant QAccessible::Linked
[static,const]new QAccessible_StateFlag ptrMarqueedEnum constant QAccessible::Marqueed
[static,const]new QAccessible_StateFlag ptrMixedEnum constant QAccessible::Mixed
[static,const]new QAccessible_StateFlag ptrModalEnum constant QAccessible::Modal
[static,const]new QAccessible_StateFlag ptrMovableEnum constant QAccessible::Movable
[static,const]new QAccessible_StateFlag ptrMultiSelectableEnum constant QAccessible::MultiSelectable
[static,const]new QAccessible_StateFlag ptrNormalEnum constant QAccessible::Normal
[static,const]new QAccessible_StateFlag ptrOffscreenEnum constant QAccessible::Offscreen
[static,const]new QAccessible_StateFlag ptrPressedEnum constant QAccessible::Pressed
[static,const]new QAccessible_StateFlag ptrProtectedEnum constant QAccessible::Protected
[static,const]new QAccessible_StateFlag ptrReadOnlyEnum constant QAccessible::ReadOnly
[static,const]new QAccessible_StateFlag ptrSelectableEnum constant QAccessible::Selectable
[static,const]new QAccessible_StateFlag ptrSelectedEnum constant QAccessible::Selected
[static,const]new QAccessible_StateFlag ptrSelfVoicingEnum constant QAccessible::SelfVoicing
[static,const]new QAccessible_StateFlag ptrSizeableEnum constant QAccessible::Sizeable
[static,const]new QAccessible_StateFlag ptrTraversedEnum constant QAccessible::Traversed
[static,const]new QAccessible_StateFlag ptrUnavailableEnum constant QAccessible::Unavailable

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_StateFlag 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_StateFlag ptr Animated

Description: Enum constant QAccessible::Animated

[static,const] new QAccessible_StateFlag ptr Busy

Description: Enum constant QAccessible::Busy

[static,const] new QAccessible_StateFlag ptr Checked

Description: Enum constant QAccessible::Checked

[static,const] new QAccessible_StateFlag ptr Collapsed

Description: Enum constant QAccessible::Collapsed

[static,const] new QAccessible_StateFlag ptr DefaultButton

Description: Enum constant QAccessible::DefaultButton

[static,const] new QAccessible_StateFlag ptr Expanded

Description: Enum constant QAccessible::Expanded

[static,const] new QAccessible_StateFlag ptr ExtSelectable

Description: Enum constant QAccessible::ExtSelectable

[static,const] new QAccessible_StateFlag ptr Focusable

Description: Enum constant QAccessible::Focusable

[static,const] new QAccessible_StateFlag ptr Focused

Description: Enum constant QAccessible::Focused

[static,const] new QAccessible_StateFlag ptr HasInvokeExtension

Description: Enum constant QAccessible::HasInvokeExtension

[static,const] new QAccessible_StateFlag ptr HasPopup

Description: Enum constant QAccessible::HasPopup

[static,const] new QAccessible_StateFlag ptr HotTracked

Description: Enum constant QAccessible::HotTracked

[static,const] new QAccessible_StateFlag ptr Invisible

Description: Enum constant QAccessible::Invisible

[static,const] new QAccessible_StateFlag ptr Linked

Description: Enum constant QAccessible::Linked

[static,const] new QAccessible_StateFlag ptr Marqueed

Description: Enum constant QAccessible::Marqueed

[static,const] new QAccessible_StateFlag ptr Mixed

Description: Enum constant QAccessible::Mixed

[static,const] new QAccessible_StateFlag ptr Modal

Description: Enum constant QAccessible::Modal

[static,const] new QAccessible_StateFlag ptr Movable

Description: Enum constant QAccessible::Movable

[static,const] new QAccessible_StateFlag ptr MultiSelectable

Description: Enum constant QAccessible::MultiSelectable

[static,const] new QAccessible_StateFlag ptr Normal

Description: Enum constant QAccessible::Normal

[static,const] new QAccessible_StateFlag ptr Offscreen

Description: Enum constant QAccessible::Offscreen

[static,const] new QAccessible_StateFlag ptr Pressed

Description: Enum constant QAccessible::Pressed

[static,const] new QAccessible_StateFlag ptr Protected

Description: Enum constant QAccessible::Protected

[static,const] new QAccessible_StateFlag ptr ReadOnly

Description: Enum constant QAccessible::ReadOnly

[static,const] new QAccessible_StateFlag ptr Selectable

Description: Enum constant QAccessible::Selectable

[static,const] new QAccessible_StateFlag ptr Selected

Description: Enum constant QAccessible::Selected

[static,const] new QAccessible_StateFlag ptr SelfVoicing

Description: Enum constant QAccessible::SelfVoicing

[static,const] new QAccessible_StateFlag ptr Sizeable

Description: Enum constant QAccessible::Sizeable

[static,const] new QAccessible_StateFlag ptr Traversed

Description: Enum constant QAccessible::Traversed

[static,const] new QAccessible_StateFlag ptr Unavailable

Description: Enum constant QAccessible::Unavailable

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_StateFlag 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_StateFlag 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_StateFlag 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)'