API reference - Class QAccessible::Role

Notation used in Ruby API documentation

Description: This class represents the QAccessible::Role enum

This class is equivalent to the class QAccessible_Role

Public constructors

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

Public methods

[const]bool!=(const QAccessible_Role other)Compares two enums for inequality
[const]bool<(const QAccessible_Role other)Returns true if the first enum is less (in the enum symbol order) than the second
[const]bool==(const QAccessible_Role other)Compares two enums
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_Role other)Assigns another object to self
[const]new QAccessible_Role ptrdupCreates a copy of self
[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_Role|(const QAccessible_Role other)Creates a flag set by combining the two flags
[const]QAccessible_QFlags_Role|(const QAccessible_QFlags_Role other)Combines the flag and the flag set

Public static methods and constants

[static,const]QAccessible_RoleAlertMessageEnum constant QAccessible::AlertMessage
[static,const]QAccessible_RoleAnimationEnum constant QAccessible::Animation
[static,const]QAccessible_RoleApplicationEnum constant QAccessible::Application
[static,const]QAccessible_RoleAssistantEnum constant QAccessible::Assistant
[static,const]QAccessible_RoleBorderEnum constant QAccessible::Border
[static,const]QAccessible_RoleButtonEnum constant QAccessible::Button
[static,const]QAccessible_RoleButtonDropDownEnum constant QAccessible::ButtonDropDown
[static,const]QAccessible_RoleButtonDropGridEnum constant QAccessible::ButtonDropGrid
[static,const]QAccessible_RoleButtonMenuEnum constant QAccessible::ButtonMenu
[static,const]QAccessible_RoleCanvasEnum constant QAccessible::Canvas
[static,const]QAccessible_RoleCaretEnum constant QAccessible::Caret
[static,const]QAccessible_RoleCellEnum constant QAccessible::Cell
[static,const]QAccessible_RoleChartEnum constant QAccessible::Chart
[static,const]QAccessible_RoleCheckBoxEnum constant QAccessible::CheckBox
[static,const]QAccessible_RoleClientEnum constant QAccessible::Client
[static,const]QAccessible_RoleClockEnum constant QAccessible::Clock
[static,const]QAccessible_RoleColorChooserEnum constant QAccessible::ColorChooser
[static,const]QAccessible_RoleColumnEnum constant QAccessible::Column
[static,const]QAccessible_RoleColumnHeaderEnum constant QAccessible::ColumnHeader
[static,const]QAccessible_RoleComboBoxEnum constant QAccessible::ComboBox
[static,const]QAccessible_RoleComplementaryContentEnum constant QAccessible::ComplementaryContent
[static,const]QAccessible_RoleCursorEnum constant QAccessible::Cursor
[static,const]QAccessible_RoleDesktopEnum constant QAccessible::Desktop
[static,const]QAccessible_RoleDialEnum constant QAccessible::Dial
[static,const]QAccessible_RoleDialogEnum constant QAccessible::Dialog
[static,const]QAccessible_RoleDocumentEnum constant QAccessible::Document
[static,const]QAccessible_RoleEditableTextEnum constant QAccessible::EditableText
[static,const]QAccessible_RoleEquationEnum constant QAccessible::Equation
[static,const]QAccessible_RoleFooterEnum constant QAccessible::Footer
[static,const]QAccessible_RoleFormEnum constant QAccessible::Form
[static,const]QAccessible_RoleGraphicEnum constant QAccessible::Graphic
[static,const]QAccessible_RoleGripEnum constant QAccessible::Grip
[static,const]QAccessible_RoleGroupingEnum constant QAccessible::Grouping
[static,const]QAccessible_RoleHeadingEnum constant QAccessible::Heading
[static,const]QAccessible_RoleHelpBalloonEnum constant QAccessible::HelpBalloon
[static,const]QAccessible_RoleHotkeyFieldEnum constant QAccessible::HotkeyField
[static,const]QAccessible_RoleIndicatorEnum constant QAccessible::Indicator
[static,const]QAccessible_RoleLayeredPaneEnum constant QAccessible::LayeredPane
[static,const]QAccessible_RoleLinkEnum constant QAccessible::Link
[static,const]QAccessible_RoleListEnum constant QAccessible::List
[static,const]QAccessible_RoleListItemEnum constant QAccessible::ListItem
[static,const]QAccessible_RoleMenuBarEnum constant QAccessible::MenuBar
[static,const]QAccessible_RoleMenuItemEnum constant QAccessible::MenuItem
[static,const]QAccessible_RoleNoRoleEnum constant QAccessible::NoRole
[static,const]QAccessible_RoleNoteEnum constant QAccessible::Note
[static,const]QAccessible_RolePageTabEnum constant QAccessible::PageTab
[static,const]QAccessible_RolePageTabListEnum constant QAccessible::PageTabList
[static,const]QAccessible_RolePaneEnum constant QAccessible::Pane
[static,const]QAccessible_RoleParagraphEnum constant QAccessible::Paragraph
[static,const]QAccessible_RolePopupMenuEnum constant QAccessible::PopupMenu
[static,const]QAccessible_RoleProgressBarEnum constant QAccessible::ProgressBar
[static,const]QAccessible_RolePropertyPageEnum constant QAccessible::PropertyPage
[static,const]QAccessible_RolePushButtonEnum constant QAccessible::PushButton
[static,const]QAccessible_RoleRadioButtonEnum constant QAccessible::RadioButton
[static,const]QAccessible_RoleRowEnum constant QAccessible::Row
[static,const]QAccessible_RoleRowHeaderEnum constant QAccessible::RowHeader
[static,const]QAccessible_RoleScrollBarEnum constant QAccessible::ScrollBar
[static,const]QAccessible_RoleSectionEnum constant QAccessible::Section
[static,const]QAccessible_RoleSeparatorEnum constant QAccessible::Separator
[static,const]QAccessible_RoleSliderEnum constant QAccessible::Slider
[static,const]QAccessible_RoleSoundEnum constant QAccessible::Sound
[static,const]QAccessible_RoleSpinBoxEnum constant QAccessible::SpinBox
[static,const]QAccessible_RoleSplitterEnum constant QAccessible::Splitter
[static,const]QAccessible_RoleStaticTextEnum constant QAccessible::StaticText
[static,const]QAccessible_RoleStatusBarEnum constant QAccessible::StatusBar
[static,const]QAccessible_RoleTableEnum constant QAccessible::Table
[static,const]QAccessible_RoleTerminalEnum constant QAccessible::Terminal
[static,const]QAccessible_RoleTitleBarEnum constant QAccessible::TitleBar
[static,const]QAccessible_RoleToolBarEnum constant QAccessible::ToolBar
[static,const]QAccessible_RoleToolTipEnum constant QAccessible::ToolTip
[static,const]QAccessible_RoleTreeEnum constant QAccessible::Tree
[static,const]QAccessible_RoleTreeItemEnum constant QAccessible::TreeItem
[static,const]QAccessible_RoleUserRoleEnum constant QAccessible::UserRole
[static,const]QAccessible_RoleWebDocumentEnum constant QAccessible::WebDocument
[static,const]QAccessible_RoleWhitespaceEnum constant QAccessible::Whitespace
[static,const]QAccessible_RoleWindowEnum constant QAccessible::Window

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

!=

Signature: [const] bool != (const QAccessible_Role other)

Description: Compares two enums for inequality

<

Signature: [const] bool < (const QAccessible_Role other)

Description: Returns true if the first enum is less (in the enum symbol order) than the second

==

Signature: [const] bool == (const QAccessible_Role other)

Description: Compares two enums

AlertMessage

Signature: [static,const] QAccessible_Role AlertMessage

Description: Enum constant QAccessible::AlertMessage

Animation

Signature: [static,const] QAccessible_Role Animation

Description: Enum constant QAccessible::Animation

Application

Signature: [static,const] QAccessible_Role Application

Description: Enum constant QAccessible::Application

Assistant

Signature: [static,const] QAccessible_Role Assistant

Description: Enum constant QAccessible::Assistant

Border

Signature: [static,const] QAccessible_Role Border

Description: Enum constant QAccessible::Border

Button

Signature: [static,const] QAccessible_Role Button

Description: Enum constant QAccessible::Button

ButtonDropDown

Signature: [static,const] QAccessible_Role ButtonDropDown

Description: Enum constant QAccessible::ButtonDropDown

ButtonDropGrid

Signature: [static,const] QAccessible_Role ButtonDropGrid

Description: Enum constant QAccessible::ButtonDropGrid

ButtonMenu

Signature: [static,const] QAccessible_Role ButtonMenu

Description: Enum constant QAccessible::ButtonMenu

Canvas

Signature: [static,const] QAccessible_Role Canvas

Description: Enum constant QAccessible::Canvas

Caret

Signature: [static,const] QAccessible_Role Caret

Description: Enum constant QAccessible::Caret

Cell

Signature: [static,const] QAccessible_Role Cell

Description: Enum constant QAccessible::Cell

Chart

Signature: [static,const] QAccessible_Role Chart

Description: Enum constant QAccessible::Chart

CheckBox

Signature: [static,const] QAccessible_Role CheckBox

Description: Enum constant QAccessible::CheckBox

Client

Signature: [static,const] QAccessible_Role Client

Description: Enum constant QAccessible::Client

Clock

Signature: [static,const] QAccessible_Role Clock

Description: Enum constant QAccessible::Clock

ColorChooser

Signature: [static,const] QAccessible_Role ColorChooser

Description: Enum constant QAccessible::ColorChooser

Column

Signature: [static,const] QAccessible_Role Column

Description: Enum constant QAccessible::Column

ColumnHeader

Signature: [static,const] QAccessible_Role ColumnHeader

Description: Enum constant QAccessible::ColumnHeader

ComboBox

Signature: [static,const] QAccessible_Role ComboBox

Description: Enum constant QAccessible::ComboBox

ComplementaryContent

Signature: [static,const] QAccessible_Role ComplementaryContent

Description: Enum constant QAccessible::ComplementaryContent

Cursor

Signature: [static,const] QAccessible_Role Cursor

Description: Enum constant QAccessible::Cursor

Desktop

Signature: [static,const] QAccessible_Role Desktop

Description: Enum constant QAccessible::Desktop

Dial

Signature: [static,const] QAccessible_Role Dial

Description: Enum constant QAccessible::Dial

Dialog

Signature: [static,const] QAccessible_Role Dialog

Description: Enum constant QAccessible::Dialog

Document

Signature: [static,const] QAccessible_Role Document

Description: Enum constant QAccessible::Document

EditableText

Signature: [static,const] QAccessible_Role EditableText

Description: Enum constant QAccessible::EditableText

Equation

Signature: [static,const] QAccessible_Role Equation

Description: Enum constant QAccessible::Equation

Footer

Signature: [static,const] QAccessible_Role Footer

Description: Enum constant QAccessible::Footer

Form

Signature: [static,const] QAccessible_Role Form

Description: Enum constant QAccessible::Form

Graphic

Signature: [static,const] QAccessible_Role Graphic

Description: Enum constant QAccessible::Graphic

Grip

Signature: [static,const] QAccessible_Role Grip

Description: Enum constant QAccessible::Grip

Grouping

Signature: [static,const] QAccessible_Role Grouping

Description: Enum constant QAccessible::Grouping

Heading

Signature: [static,const] QAccessible_Role Heading

Description: Enum constant QAccessible::Heading

HelpBalloon

Signature: [static,const] QAccessible_Role HelpBalloon

Description: Enum constant QAccessible::HelpBalloon

HotkeyField

Signature: [static,const] QAccessible_Role HotkeyField

Description: Enum constant QAccessible::HotkeyField

Indicator

Signature: [static,const] QAccessible_Role Indicator

Description: Enum constant QAccessible::Indicator

LayeredPane

Signature: [static,const] QAccessible_Role LayeredPane

Description: Enum constant QAccessible::LayeredPane

Link

Signature: [static,const] QAccessible_Role Link

Description: Enum constant QAccessible::Link

List

Signature: [static,const] QAccessible_Role List

Description: Enum constant QAccessible::List

ListItem

Signature: [static,const] QAccessible_Role ListItem

Description: Enum constant QAccessible::ListItem

MenuBar

Signature: [static,const] QAccessible_Role MenuBar

Description: Enum constant QAccessible::MenuBar

MenuItem

Signature: [static,const] QAccessible_Role MenuItem

Description: Enum constant QAccessible::MenuItem

NoRole

Signature: [static,const] QAccessible_Role NoRole

Description: Enum constant QAccessible::NoRole

Note

Signature: [static,const] QAccessible_Role Note

Description: Enum constant QAccessible::Note

PageTab

Signature: [static,const] QAccessible_Role PageTab

Description: Enum constant QAccessible::PageTab

PageTabList

Signature: [static,const] QAccessible_Role PageTabList

Description: Enum constant QAccessible::PageTabList

Pane

Signature: [static,const] QAccessible_Role Pane

Description: Enum constant QAccessible::Pane

Paragraph

Signature: [static,const] QAccessible_Role Paragraph

Description: Enum constant QAccessible::Paragraph

PopupMenu

Signature: [static,const] QAccessible_Role PopupMenu

Description: Enum constant QAccessible::PopupMenu

ProgressBar

Signature: [static,const] QAccessible_Role ProgressBar

Description: Enum constant QAccessible::ProgressBar

PropertyPage

Signature: [static,const] QAccessible_Role PropertyPage

Description: Enum constant QAccessible::PropertyPage

PushButton

Signature: [static,const] QAccessible_Role PushButton

Description: Enum constant QAccessible::PushButton

RadioButton

Signature: [static,const] QAccessible_Role RadioButton

Description: Enum constant QAccessible::RadioButton

Row

Signature: [static,const] QAccessible_Role Row

Description: Enum constant QAccessible::Row

RowHeader

Signature: [static,const] QAccessible_Role RowHeader

Description: Enum constant QAccessible::RowHeader

ScrollBar

Signature: [static,const] QAccessible_Role ScrollBar

Description: Enum constant QAccessible::ScrollBar

Section

Signature: [static,const] QAccessible_Role Section

Description: Enum constant QAccessible::Section

Separator

Signature: [static,const] QAccessible_Role Separator

Description: Enum constant QAccessible::Separator

Slider

Signature: [static,const] QAccessible_Role Slider

Description: Enum constant QAccessible::Slider

Sound

Signature: [static,const] QAccessible_Role Sound

Description: Enum constant QAccessible::Sound

SpinBox

Signature: [static,const] QAccessible_Role SpinBox

Description: Enum constant QAccessible::SpinBox

Splitter

Signature: [static,const] QAccessible_Role Splitter

Description: Enum constant QAccessible::Splitter

StaticText

Signature: [static,const] QAccessible_Role StaticText

Description: Enum constant QAccessible::StaticText

StatusBar

Signature: [static,const] QAccessible_Role StatusBar

Description: Enum constant QAccessible::StatusBar

Table

Signature: [static,const] QAccessible_Role Table

Description: Enum constant QAccessible::Table

Terminal

Signature: [static,const] QAccessible_Role Terminal

Description: Enum constant QAccessible::Terminal

TitleBar

Signature: [static,const] QAccessible_Role TitleBar

Description: Enum constant QAccessible::TitleBar

ToolBar

Signature: [static,const] QAccessible_Role ToolBar

Description: Enum constant QAccessible::ToolBar

ToolTip

Signature: [static,const] QAccessible_Role ToolTip

Description: Enum constant QAccessible::ToolTip

Tree

Signature: [static,const] QAccessible_Role Tree

Description: Enum constant QAccessible::Tree

TreeItem

Signature: [static,const] QAccessible_Role TreeItem

Description: Enum constant QAccessible::TreeItem

UserRole

Signature: [static,const] QAccessible_Role UserRole

Description: Enum constant QAccessible::UserRole

WebDocument

Signature: [static,const] QAccessible_Role WebDocument

Description: Enum constant QAccessible::WebDocument

Whitespace

Signature: [static,const] QAccessible_Role Whitespace

Description: Enum constant QAccessible::Whitespace

Window

Signature: [static,const] QAccessible_Role Window

Description: Enum constant QAccessible::Window

_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

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

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

dup

Signature: [const] new QAccessible_Role ptr dup

Description: Creates a copy of self

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

new

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

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

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

|

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

Description: Creates a flag set by combining the two flags

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

Description: Combines the flag and the flag set