API reference - Class QAccessible_Role

Notation used in Ruby API documentation

Description: This class represents the QAccessible::Role enum

Class hierarchy: QAccessible_Role » QAccessible_QFlags_Role

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

Public constructors

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

Public methods

[const]bool==(QAccessible_Role 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_Role other)Assigns another object to self
[const]new QAccessible_Role 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_Role ptrAlertMessageEnum constant QAccessible::AlertMessage
[static,const]new QAccessible_Role ptrAnimationEnum constant QAccessible::Animation
[static,const]new QAccessible_Role ptrApplicationEnum constant QAccessible::Application
[static,const]new QAccessible_Role ptrAssistantEnum constant QAccessible::Assistant
[static,const]new QAccessible_Role ptrBorderEnum constant QAccessible::Border
[static,const]new QAccessible_Role ptrButtonDropDownEnum constant QAccessible::ButtonDropDown
[static,const]new QAccessible_Role ptrButtonDropGridEnum constant QAccessible::ButtonDropGrid
[static,const]new QAccessible_Role ptrButtonMenuEnum constant QAccessible::ButtonMenu
[static,const]new QAccessible_Role ptrCanvasEnum constant QAccessible::Canvas
[static,const]new QAccessible_Role ptrCaretEnum constant QAccessible::Caret
[static,const]new QAccessible_Role ptrCellEnum constant QAccessible::Cell
[static,const]new QAccessible_Role ptrChartEnum constant QAccessible::Chart
[static,const]new QAccessible_Role ptrCheckBoxEnum constant QAccessible::CheckBox
[static,const]new QAccessible_Role ptrClientEnum constant QAccessible::Client
[static,const]new QAccessible_Role ptrClockEnum constant QAccessible::Clock
[static,const]new QAccessible_Role ptrColumnEnum constant QAccessible::Column
[static,const]new QAccessible_Role ptrColumnHeaderEnum constant QAccessible::ColumnHeader
[static,const]new QAccessible_Role ptrComboBoxEnum constant QAccessible::ComboBox
[static,const]new QAccessible_Role ptrCursorEnum constant QAccessible::Cursor
[static,const]new QAccessible_Role ptrDialEnum constant QAccessible::Dial
[static,const]new QAccessible_Role ptrDialogEnum constant QAccessible::Dialog
[static,const]new QAccessible_Role ptrDocumentEnum constant QAccessible::Document
[static,const]new QAccessible_Role ptrEditableTextEnum constant QAccessible::EditableText
[static,const]new QAccessible_Role ptrEquationEnum constant QAccessible::Equation
[static,const]new QAccessible_Role ptrGraphicEnum constant QAccessible::Graphic
[static,const]new QAccessible_Role ptrGripEnum constant QAccessible::Grip
[static,const]new QAccessible_Role ptrGroupingEnum constant QAccessible::Grouping
[static,const]new QAccessible_Role ptrHelpBalloonEnum constant QAccessible::HelpBalloon
[static,const]new QAccessible_Role ptrHotkeyFieldEnum constant QAccessible::HotkeyField
[static,const]new QAccessible_Role ptrIndicatorEnum constant QAccessible::Indicator
[static,const]new QAccessible_Role ptrLayeredPaneEnum constant QAccessible::LayeredPane
[static,const]new QAccessible_Role ptrLinkEnum constant QAccessible::Link
[static,const]new QAccessible_Role ptrListEnum constant QAccessible::List
[static,const]new QAccessible_Role ptrListItemEnum constant QAccessible::ListItem
[static,const]new QAccessible_Role ptrMenuBarEnum constant QAccessible::MenuBar
[static,const]new QAccessible_Role ptrMenuItemEnum constant QAccessible::MenuItem
[static,const]new QAccessible_Role ptrNoRoleEnum constant QAccessible::NoRole
[static,const]new QAccessible_Role ptrPageTabEnum constant QAccessible::PageTab
[static,const]new QAccessible_Role ptrPageTabListEnum constant QAccessible::PageTabList
[static,const]new QAccessible_Role ptrPaneEnum constant QAccessible::Pane
[static,const]new QAccessible_Role ptrPopupMenuEnum constant QAccessible::PopupMenu
[static,const]new QAccessible_Role ptrProgressBarEnum constant QAccessible::ProgressBar
[static,const]new QAccessible_Role ptrPropertyPageEnum constant QAccessible::PropertyPage
[static,const]new QAccessible_Role ptrPushButtonEnum constant QAccessible::PushButton
[static,const]new QAccessible_Role ptrRadioButtonEnum constant QAccessible::RadioButton
[static,const]new QAccessible_Role ptrRowEnum constant QAccessible::Row
[static,const]new QAccessible_Role ptrRowHeaderEnum constant QAccessible::RowHeader
[static,const]new QAccessible_Role ptrScrollBarEnum constant QAccessible::ScrollBar
[static,const]new QAccessible_Role ptrSeparatorEnum constant QAccessible::Separator
[static,const]new QAccessible_Role ptrSliderEnum constant QAccessible::Slider
[static,const]new QAccessible_Role ptrSoundEnum constant QAccessible::Sound
[static,const]new QAccessible_Role ptrSpinBoxEnum constant QAccessible::SpinBox
[static,const]new QAccessible_Role ptrSplitterEnum constant QAccessible::Splitter
[static,const]new QAccessible_Role ptrStaticTextEnum constant QAccessible::StaticText
[static,const]new QAccessible_Role ptrStatusBarEnum constant QAccessible::StatusBar
[static,const]new QAccessible_Role ptrTableEnum constant QAccessible::Table
[static,const]new QAccessible_Role ptrTitleBarEnum constant QAccessible::TitleBar
[static,const]new QAccessible_Role ptrToolBarEnum constant QAccessible::ToolBar
[static,const]new QAccessible_Role ptrToolTipEnum constant QAccessible::ToolTip
[static,const]new QAccessible_Role ptrTreeEnum constant QAccessible::Tree
[static,const]new QAccessible_Role ptrTreeItemEnum constant QAccessible::TreeItem
[static,const]new QAccessible_Role ptrUserRoleEnum constant QAccessible::UserRole
[static,const]new QAccessible_Role ptrWhitespaceEnum constant QAccessible::Whitespace
[static,const]new QAccessible_Role ptrWindowEnum 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

[const] bool ==(QAccessible_Role 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_Role ptr AlertMessage

Description: Enum constant QAccessible::AlertMessage

[static,const] new QAccessible_Role ptr Animation

Description: Enum constant QAccessible::Animation

[static,const] new QAccessible_Role ptr Application

Description: Enum constant QAccessible::Application

[static,const] new QAccessible_Role ptr Assistant

Description: Enum constant QAccessible::Assistant

[static,const] new QAccessible_Role ptr Border

Description: Enum constant QAccessible::Border

[static,const] new QAccessible_Role ptr ButtonDropDown

Description: Enum constant QAccessible::ButtonDropDown

[static,const] new QAccessible_Role ptr ButtonDropGrid

Description: Enum constant QAccessible::ButtonDropGrid

[static,const] new QAccessible_Role ptr ButtonMenu

Description: Enum constant QAccessible::ButtonMenu

[static,const] new QAccessible_Role ptr Canvas

Description: Enum constant QAccessible::Canvas

[static,const] new QAccessible_Role ptr Caret

Description: Enum constant QAccessible::Caret

[static,const] new QAccessible_Role ptr Cell

Description: Enum constant QAccessible::Cell

[static,const] new QAccessible_Role ptr Chart

Description: Enum constant QAccessible::Chart

[static,const] new QAccessible_Role ptr CheckBox

Description: Enum constant QAccessible::CheckBox

[static,const] new QAccessible_Role ptr Client

Description: Enum constant QAccessible::Client

[static,const] new QAccessible_Role ptr Clock

Description: Enum constant QAccessible::Clock

[static,const] new QAccessible_Role ptr Column

Description: Enum constant QAccessible::Column

[static,const] new QAccessible_Role ptr ColumnHeader

Description: Enum constant QAccessible::ColumnHeader

[static,const] new QAccessible_Role ptr ComboBox

Description: Enum constant QAccessible::ComboBox

[static,const] new QAccessible_Role ptr Cursor

Description: Enum constant QAccessible::Cursor

[static,const] new QAccessible_Role ptr Dial

Description: Enum constant QAccessible::Dial

[static,const] new QAccessible_Role ptr Dialog

Description: Enum constant QAccessible::Dialog

[static,const] new QAccessible_Role ptr Document

Description: Enum constant QAccessible::Document

[static,const] new QAccessible_Role ptr EditableText

Description: Enum constant QAccessible::EditableText

[static,const] new QAccessible_Role ptr Equation

Description: Enum constant QAccessible::Equation

[static,const] new QAccessible_Role ptr Graphic

Description: Enum constant QAccessible::Graphic

[static,const] new QAccessible_Role ptr Grip

Description: Enum constant QAccessible::Grip

[static,const] new QAccessible_Role ptr Grouping

Description: Enum constant QAccessible::Grouping

[static,const] new QAccessible_Role ptr HelpBalloon

Description: Enum constant QAccessible::HelpBalloon

[static,const] new QAccessible_Role ptr HotkeyField

Description: Enum constant QAccessible::HotkeyField

[static,const] new QAccessible_Role ptr Indicator

Description: Enum constant QAccessible::Indicator

[static,const] new QAccessible_Role ptr LayeredPane

Description: Enum constant QAccessible::LayeredPane

[static,const] new QAccessible_Role ptr Link

Description: Enum constant QAccessible::Link

[static,const] new QAccessible_Role ptr List

Description: Enum constant QAccessible::List

[static,const] new QAccessible_Role ptr ListItem

Description: Enum constant QAccessible::ListItem

[static,const] new QAccessible_Role ptr MenuBar

Description: Enum constant QAccessible::MenuBar

[static,const] new QAccessible_Role ptr MenuItem

Description: Enum constant QAccessible::MenuItem

[static,const] new QAccessible_Role ptr NoRole

Description: Enum constant QAccessible::NoRole

[static,const] new QAccessible_Role ptr PageTab

Description: Enum constant QAccessible::PageTab

[static,const] new QAccessible_Role ptr PageTabList

Description: Enum constant QAccessible::PageTabList

[static,const] new QAccessible_Role ptr Pane

Description: Enum constant QAccessible::Pane

[static,const] new QAccessible_Role ptr PopupMenu

Description: Enum constant QAccessible::PopupMenu

[static,const] new QAccessible_Role ptr ProgressBar

Description: Enum constant QAccessible::ProgressBar

[static,const] new QAccessible_Role ptr PropertyPage

Description: Enum constant QAccessible::PropertyPage

[static,const] new QAccessible_Role ptr PushButton

Description: Enum constant QAccessible::PushButton

[static,const] new QAccessible_Role ptr RadioButton

Description: Enum constant QAccessible::RadioButton

[static,const] new QAccessible_Role ptr Row

Description: Enum constant QAccessible::Row

[static,const] new QAccessible_Role ptr RowHeader

Description: Enum constant QAccessible::RowHeader

[static,const] new QAccessible_Role ptr ScrollBar

Description: Enum constant QAccessible::ScrollBar

[static,const] new QAccessible_Role ptr Separator

Description: Enum constant QAccessible::Separator

[static,const] new QAccessible_Role ptr Slider

Description: Enum constant QAccessible::Slider

[static,const] new QAccessible_Role ptr Sound

Description: Enum constant QAccessible::Sound

[static,const] new QAccessible_Role ptr SpinBox

Description: Enum constant QAccessible::SpinBox

[static,const] new QAccessible_Role ptr Splitter

Description: Enum constant QAccessible::Splitter

[static,const] new QAccessible_Role ptr StaticText

Description: Enum constant QAccessible::StaticText

[static,const] new QAccessible_Role ptr StatusBar

Description: Enum constant QAccessible::StatusBar

[static,const] new QAccessible_Role ptr Table

Description: Enum constant QAccessible::Table

[static,const] new QAccessible_Role ptr TitleBar

Description: Enum constant QAccessible::TitleBar

[static,const] new QAccessible_Role ptr ToolBar

Description: Enum constant QAccessible::ToolBar

[static,const] new QAccessible_Role ptr ToolTip

Description: Enum constant QAccessible::ToolTip

[static,const] new QAccessible_Role ptr Tree

Description: Enum constant QAccessible::Tree

[static,const] new QAccessible_Role ptr TreeItem

Description: Enum constant QAccessible::TreeItem

[static,const] new QAccessible_Role ptr UserRole

Description: Enum constant QAccessible::UserRole

[static,const] new QAccessible_Role ptr Whitespace

Description: Enum constant QAccessible::Whitespace

[static,const] new QAccessible_Role ptr Window

Description: Enum constant QAccessible::Window

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