API reference - Class QAccessible_Role

!=

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

Description: Compares two enums

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

Description: Compares an enum with an integer value

AlertMessage

Signature: [static,const] QAccessible_Role AlertMessage

Description: Enum constant QAccessible::AlertMessage

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

Animation

Signature: [static,const] QAccessible_Role Animation

Description: Enum constant QAccessible::Animation

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

Application

Signature: [static,const] QAccessible_Role Application

Description: Enum constant QAccessible::Application

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

Assistant

Signature: [static,const] QAccessible_Role Assistant

Description: Enum constant QAccessible::Assistant

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

Border

Signature: [static,const] QAccessible_Role Border

Description: Enum constant QAccessible::Border

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

Button

Signature: [static,const] QAccessible_Role Button

Description: Enum constant QAccessible::Button

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

ButtonDropDown

Signature: [static,const] QAccessible_Role ButtonDropDown

Description: Enum constant QAccessible::ButtonDropDown

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

ButtonDropGrid

Signature: [static,const] QAccessible_Role ButtonDropGrid

Description: Enum constant QAccessible::ButtonDropGrid

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

ButtonMenu

Signature: [static,const] QAccessible_Role ButtonMenu

Description: Enum constant QAccessible::ButtonMenu

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

Canvas

Signature: [static,const] QAccessible_Role Canvas

Description: Enum constant QAccessible::Canvas

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

Caret

Signature: [static,const] QAccessible_Role Caret

Description: Enum constant QAccessible::Caret

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

Cell

Signature: [static,const] QAccessible_Role Cell

Description: Enum constant QAccessible::Cell

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

Chart

Signature: [static,const] QAccessible_Role Chart

Description: Enum constant QAccessible::Chart

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

CheckBox

Signature: [static,const] QAccessible_Role CheckBox

Description: Enum constant QAccessible::CheckBox

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

Client

Signature: [static,const] QAccessible_Role Client

Description: Enum constant QAccessible::Client

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

Clock

Signature: [static,const] QAccessible_Role Clock

Description: Enum constant QAccessible::Clock

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

ColorChooser

Signature: [static,const] QAccessible_Role ColorChooser

Description: Enum constant QAccessible::ColorChooser

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

Column

Signature: [static,const] QAccessible_Role Column

Description: Enum constant QAccessible::Column

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

ColumnHeader

Signature: [static,const] QAccessible_Role ColumnHeader

Description: Enum constant QAccessible::ColumnHeader

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

ComboBox

Signature: [static,const] QAccessible_Role ComboBox

Description: Enum constant QAccessible::ComboBox

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

ComplementaryContent

Signature: [static,const] QAccessible_Role ComplementaryContent

Description: Enum constant QAccessible::ComplementaryContent

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

Cursor

Signature: [static,const] QAccessible_Role Cursor

Description: Enum constant QAccessible::Cursor

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

Desktop

Signature: [static,const] QAccessible_Role Desktop

Description: Enum constant QAccessible::Desktop

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

Dial

Signature: [static,const] QAccessible_Role Dial

Description: Enum constant QAccessible::Dial

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

Dialog

Signature: [static,const] QAccessible_Role Dialog

Description: Enum constant QAccessible::Dialog

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

Document

Signature: [static,const] QAccessible_Role Document

Description: Enum constant QAccessible::Document

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

EditableText

Signature: [static,const] QAccessible_Role EditableText

Description: Enum constant QAccessible::EditableText

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

Equation

Signature: [static,const] QAccessible_Role Equation

Description: Enum constant QAccessible::Equation

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

Footer

Signature: [static,const] QAccessible_Role Footer

Description: Enum constant QAccessible::Footer

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

Form

Signature: [static,const] QAccessible_Role Form

Description: Enum constant QAccessible::Form

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

Graphic

Signature: [static,const] QAccessible_Role Graphic

Description: Enum constant QAccessible::Graphic

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

Grip

Signature: [static,const] QAccessible_Role Grip

Description: Enum constant QAccessible::Grip

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

Grouping

Signature: [static,const] QAccessible_Role Grouping

Description: Enum constant QAccessible::Grouping

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

Heading

Signature: [static,const] QAccessible_Role Heading

Description: Enum constant QAccessible::Heading

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

HelpBalloon

Signature: [static,const] QAccessible_Role HelpBalloon

Description: Enum constant QAccessible::HelpBalloon

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

HotkeyField

Signature: [static,const] QAccessible_Role HotkeyField

Description: Enum constant QAccessible::HotkeyField

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

Indicator

Signature: [static,const] QAccessible_Role Indicator

Description: Enum constant QAccessible::Indicator

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

LayeredPane

Signature: [static,const] QAccessible_Role LayeredPane

Description: Enum constant QAccessible::LayeredPane

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

Link

Signature: [static,const] QAccessible_Role Link

Description: Enum constant QAccessible::Link

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

List

Signature: [static,const] QAccessible_Role List

Description: Enum constant QAccessible::List

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

ListItem

Signature: [static,const] QAccessible_Role ListItem

Description: Enum constant QAccessible::ListItem

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

MenuBar

Signature: [static,const] QAccessible_Role MenuBar

Description: Enum constant QAccessible::MenuBar

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

MenuItem

Signature: [static,const] QAccessible_Role MenuItem

Description: Enum constant QAccessible::MenuItem

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

NoRole

Signature: [static,const] QAccessible_Role NoRole

Description: Enum constant QAccessible::NoRole

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

Note

Signature: [static,const] QAccessible_Role Note

Description: Enum constant QAccessible::Note

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

Notification

Signature: [static,const] QAccessible_Role Notification

Description: Enum constant QAccessible::Notification

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

PageTab

Signature: [static,const] QAccessible_Role PageTab

Description: Enum constant QAccessible::PageTab

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

PageTabList

Signature: [static,const] QAccessible_Role PageTabList

Description: Enum constant QAccessible::PageTabList

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

Pane

Signature: [static,const] QAccessible_Role Pane

Description: Enum constant QAccessible::Pane

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

Paragraph

Signature: [static,const] QAccessible_Role Paragraph

Description: Enum constant QAccessible::Paragraph

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

PopupMenu

Signature: [static,const] QAccessible_Role PopupMenu

Description: Enum constant QAccessible::PopupMenu

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

ProgressBar

Signature: [static,const] QAccessible_Role ProgressBar

Description: Enum constant QAccessible::ProgressBar

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

PropertyPage

Signature: [static,const] QAccessible_Role PropertyPage

Description: Enum constant QAccessible::PropertyPage

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

PushButton

Signature: [static,const] QAccessible_Role PushButton

Description: Enum constant QAccessible::PushButton

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

RadioButton

Signature: [static,const] QAccessible_Role RadioButton

Description: Enum constant QAccessible::RadioButton

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

Row

Signature: [static,const] QAccessible_Role Row

Description: Enum constant QAccessible::Row

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

RowHeader

Signature: [static,const] QAccessible_Role RowHeader

Description: Enum constant QAccessible::RowHeader

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

ScrollBar

Signature: [static,const] QAccessible_Role ScrollBar

Description: Enum constant QAccessible::ScrollBar

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

Section

Signature: [static,const] QAccessible_Role Section

Description: Enum constant QAccessible::Section

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

Separator

Signature: [static,const] QAccessible_Role Separator

Description: Enum constant QAccessible::Separator

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

Slider

Signature: [static,const] QAccessible_Role Slider

Description: Enum constant QAccessible::Slider

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

Sound

Signature: [static,const] QAccessible_Role Sound

Description: Enum constant QAccessible::Sound

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

SpinBox

Signature: [static,const] QAccessible_Role SpinBox

Description: Enum constant QAccessible::SpinBox

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

Splitter

Signature: [static,const] QAccessible_Role Splitter

Description: Enum constant QAccessible::Splitter

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

StaticText

Signature: [static,const] QAccessible_Role StaticText

Description: Enum constant QAccessible::StaticText

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

StatusBar

Signature: [static,const] QAccessible_Role StatusBar

Description: Enum constant QAccessible::StatusBar

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

Table

Signature: [static,const] QAccessible_Role Table

Description: Enum constant QAccessible::Table

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

Terminal

Signature: [static,const] QAccessible_Role Terminal

Description: Enum constant QAccessible::Terminal

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

TitleBar

Signature: [static,const] QAccessible_Role TitleBar

Description: Enum constant QAccessible::TitleBar

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

ToolBar

Signature: [static,const] QAccessible_Role ToolBar

Description: Enum constant QAccessible::ToolBar

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

ToolTip

Signature: [static,const] QAccessible_Role ToolTip

Description: Enum constant QAccessible::ToolTip

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

Tree

Signature: [static,const] QAccessible_Role Tree

Description: Enum constant QAccessible::Tree

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

TreeItem

Signature: [static,const] QAccessible_Role TreeItem

Description: Enum constant QAccessible::TreeItem

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

UserRole

Signature: [static,const] QAccessible_Role UserRole

Description: Enum constant QAccessible::UserRole

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

WebDocument

Signature: [static,const] QAccessible_Role WebDocument

Description: Enum constant QAccessible::WebDocument

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

Whitespace

Signature: [static,const] QAccessible_Role Whitespace

Description: Enum constant QAccessible::Whitespace

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

Window

Signature: [static,const] QAccessible_Role Window

Description: Enum constant QAccessible::Window

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

_const_cast

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

Description: Creates a flag set by combining the two flags

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

Description: Combines the flag and the flag set