KLayout 0.29.8 (2024-11-26 926dac96c) [master]

API reference - Class QAccessible_StateFlag

Notation used in Ruby API documentation

Module: QtGui

Description: This class represents the QAccessible::StateFlag enum

This class is equivalent to the class QAccessible::StateFlag

Public constructors

new QAccessible_StateFlag ptrnew(int i)Creates an enum from an integer value
new QAccessible_StateFlag ptrnew(string s)Creates an enum from a string value

Public methods

[const]bool!=(const QAccessible_StateFlag other)Compares two enums for inequality
[const]bool!=(int other)Compares an enum with an integer for inequality
[const]bool<(const QAccessible_StateFlag other)Returns true if the first enum is less (in the enum symbol order) than the second
[const]bool<(int other)Returns true if the enum is less (in the enum symbol order) than the integer value
[const]bool==(const QAccessible_StateFlag other)Compares two enums
[const]bool==(int other)Compares an enum with an integer value
[const]QAccessible_StateFlag ptr_const_castReturns a non-const reference to self.
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]inthashGets the hash value from the enum
[const]stringinspectConverts an enum to a visual string
[const]intto_iGets the integer value from the enum
[const]stringto_sGets the symbolic string from an enum
[const]QAccessible_QFlags_StateFlag|(const QAccessible_StateFlag other)Creates a flag set by combining the two flags
[const]QAccessible_QFlags_StateFlag|(const QAccessible_QFlags_StateFlag other)Combines the flag and the flag set

Public static methods and constants

[static,const]QAccessible_StateFlagAnimatedEnum constant QAccessible::Animated
[static,const]QAccessible_StateFlagBusyEnum constant QAccessible::Busy
[static,const]QAccessible_StateFlagCheckedEnum constant QAccessible::Checked
[static,const]QAccessible_StateFlagCollapsedEnum constant QAccessible::Collapsed
[static,const]QAccessible_StateFlagDefaultButtonEnum constant QAccessible::DefaultButton
[static,const]QAccessible_StateFlagExpandedEnum constant QAccessible::Expanded
[static,const]QAccessible_StateFlagExtSelectableEnum constant QAccessible::ExtSelectable
[static,const]QAccessible_StateFlagFocusableEnum constant QAccessible::Focusable
[static,const]QAccessible_StateFlagFocusedEnum constant QAccessible::Focused
[static,const]QAccessible_StateFlagHasInvokeExtensionEnum constant QAccessible::HasInvokeExtension
[static,const]QAccessible_StateFlagHasPopupEnum constant QAccessible::HasPopup
[static,const]QAccessible_StateFlagHotTrackedEnum constant QAccessible::HotTracked
[static,const]QAccessible_StateFlagInvisibleEnum constant QAccessible::Invisible
[static,const]QAccessible_StateFlagLinkedEnum constant QAccessible::Linked
[static,const]QAccessible_StateFlagMarqueedEnum constant QAccessible::Marqueed
[static,const]QAccessible_StateFlagMixedEnum constant QAccessible::Mixed
[static,const]QAccessible_StateFlagModalEnum constant QAccessible::Modal
[static,const]QAccessible_StateFlagMovableEnum constant QAccessible::Movable
[static,const]QAccessible_StateFlagMultiSelectableEnum constant QAccessible::MultiSelectable
[static,const]QAccessible_StateFlagNormalEnum constant QAccessible::Normal
[static,const]QAccessible_StateFlagOffscreenEnum constant QAccessible::Offscreen
[static,const]QAccessible_StateFlagPressedEnum constant QAccessible::Pressed
[static,const]QAccessible_StateFlagProtectedEnum constant QAccessible::Protected
[static,const]QAccessible_StateFlagReadOnlyEnum constant QAccessible::ReadOnly
[static,const]QAccessible_StateFlagSelectableEnum constant QAccessible::Selectable
[static,const]QAccessible_StateFlagSelectedEnum constant QAccessible::Selected
[static,const]QAccessible_StateFlagSelfVoicingEnum constant QAccessible::SelfVoicing
[static,const]QAccessible_StateFlagSizeableEnum constant QAccessible::Sizeable
[static,const]QAccessible_StateFlagTraversedEnum constant QAccessible::Traversed
[static,const]QAccessible_StateFlagUnavailableEnum 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

!=

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

Description: Compares two enums

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

Description: Compares an enum with an integer value

Animated

Signature: [static,const] QAccessible_StateFlag Animated

Description: Enum constant QAccessible::Animated

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

Busy

Signature: [static,const] QAccessible_StateFlag Busy

Description: Enum constant QAccessible::Busy

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

Checked

Signature: [static,const] QAccessible_StateFlag Checked

Description: Enum constant QAccessible::Checked

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

Collapsed

Signature: [static,const] QAccessible_StateFlag Collapsed

Description: Enum constant QAccessible::Collapsed

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

DefaultButton

Signature: [static,const] QAccessible_StateFlag DefaultButton

Description: Enum constant QAccessible::DefaultButton

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

Expanded

Signature: [static,const] QAccessible_StateFlag Expanded

Description: Enum constant QAccessible::Expanded

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

ExtSelectable

Signature: [static,const] QAccessible_StateFlag ExtSelectable

Description: Enum constant QAccessible::ExtSelectable

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

Focusable

Signature: [static,const] QAccessible_StateFlag Focusable

Description: Enum constant QAccessible::Focusable

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

Focused

Signature: [static,const] QAccessible_StateFlag Focused

Description: Enum constant QAccessible::Focused

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

HasInvokeExtension

Signature: [static,const] QAccessible_StateFlag HasInvokeExtension

Description: Enum constant QAccessible::HasInvokeExtension

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

HasPopup

Signature: [static,const] QAccessible_StateFlag HasPopup

Description: Enum constant QAccessible::HasPopup

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

HotTracked

Signature: [static,const] QAccessible_StateFlag HotTracked

Description: Enum constant QAccessible::HotTracked

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

Invisible

Signature: [static,const] QAccessible_StateFlag Invisible

Description: Enum constant QAccessible::Invisible

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

Linked

Signature: [static,const] QAccessible_StateFlag Linked

Description: Enum constant QAccessible::Linked

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

Marqueed

Signature: [static,const] QAccessible_StateFlag Marqueed

Description: Enum constant QAccessible::Marqueed

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

Mixed

Signature: [static,const] QAccessible_StateFlag Mixed

Description: Enum constant QAccessible::Mixed

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

Modal

Signature: [static,const] QAccessible_StateFlag Modal

Description: Enum constant QAccessible::Modal

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

Movable

Signature: [static,const] QAccessible_StateFlag Movable

Description: Enum constant QAccessible::Movable

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

MultiSelectable

Signature: [static,const] QAccessible_StateFlag MultiSelectable

Description: Enum constant QAccessible::MultiSelectable

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

Normal

Signature: [static,const] QAccessible_StateFlag Normal

Description: Enum constant QAccessible::Normal

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

Offscreen

Signature: [static,const] QAccessible_StateFlag Offscreen

Description: Enum constant QAccessible::Offscreen

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

Pressed

Signature: [static,const] QAccessible_StateFlag Pressed

Description: Enum constant QAccessible::Pressed

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

Protected

Signature: [static,const] QAccessible_StateFlag Protected

Description: Enum constant QAccessible::Protected

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

ReadOnly

Signature: [static,const] QAccessible_StateFlag ReadOnly

Description: Enum constant QAccessible::ReadOnly

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

Selectable

Signature: [static,const] QAccessible_StateFlag Selectable

Description: Enum constant QAccessible::Selectable

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

Selected

Signature: [static,const] QAccessible_StateFlag Selected

Description: Enum constant QAccessible::Selected

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

SelfVoicing

Signature: [static,const] QAccessible_StateFlag SelfVoicing

Description: Enum constant QAccessible::SelfVoicing

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

Sizeable

Signature: [static,const] QAccessible_StateFlag Sizeable

Description: Enum constant QAccessible::Sizeable

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

Traversed

Signature: [static,const] QAccessible_StateFlag Traversed

Description: Enum constant QAccessible::Traversed

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

Unavailable

Signature: [static,const] QAccessible_StateFlag Unavailable

Description: Enum constant QAccessible::Unavailable

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

_const_cast

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

Description: Creates a flag set by combining the two flags

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

Description: Combines the flag and the flag set