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

API reference - Class QAccessible::Event

Notation used in Ruby API documentation

Module: QtGui

Description: This class represents the QAccessible::Event enum

This class is equivalent to the class QAccessible_Event

Public constructors

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

Public methods

[const]bool!=(const QAccessible_Event other)Compares two enums for inequality
[const]bool!=(int other)Compares an enum with an integer for inequality
[const]bool<(const QAccessible_Event 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_Event other)Compares two enums
[const]bool==(int other)Compares an enum with an integer value
[const]QAccessible_Event 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_Event other)Assigns another object to self
[const]new QAccessible_Event 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_Event|(const QAccessible_Event other)Creates a flag set by combining the two flags
[const]QAccessible_QFlags_Event|(const QAccessible_QFlags_Event other)Combines the flag and the flag set

Public static methods and constants

[static,const]QAccessible_EventAcceleratorChangedEnum constant QAccessible::AcceleratorChanged
[static,const]QAccessible_EventAlertEnum constant QAccessible::Alert
[static,const]QAccessible_EventContextHelpEndEnum constant QAccessible::ContextHelpEnd
[static,const]QAccessible_EventContextHelpStartEnum constant QAccessible::ContextHelpStart
[static,const]QAccessible_EventDefaultActionChangedEnum constant QAccessible::DefaultActionChanged
[static,const]QAccessible_EventDescriptionChangedEnum constant QAccessible::DescriptionChanged
[static,const]QAccessible_EventDialogEndEnum constant QAccessible::DialogEnd
[static,const]QAccessible_EventDialogStartEnum constant QAccessible::DialogStart
[static,const]QAccessible_EventDragDropEndEnum constant QAccessible::DragDropEnd
[static,const]QAccessible_EventDragDropStartEnum constant QAccessible::DragDropStart
[static,const]QAccessible_EventFocusEnum constant QAccessible::Focus
[static,const]QAccessible_EventForegroundChangedEnum constant QAccessible::ForegroundChanged
[static,const]QAccessible_EventHelpChangedEnum constant QAccessible::HelpChanged
[static,const]QAccessible_EventLocationChangedEnum constant QAccessible::LocationChanged
[static,const]QAccessible_EventMenuCommandEnum constant QAccessible::MenuCommand
[static,const]QAccessible_EventMenuEndEnum constant QAccessible::MenuEnd
[static,const]QAccessible_EventMenuStartEnum constant QAccessible::MenuStart
[static,const]QAccessible_EventNameChangedEnum constant QAccessible::NameChanged
[static,const]QAccessible_EventObjectCreatedEnum constant QAccessible::ObjectCreated
[static,const]QAccessible_EventObjectDestroyedEnum constant QAccessible::ObjectDestroyed
[static,const]QAccessible_EventObjectHideEnum constant QAccessible::ObjectHide
[static,const]QAccessible_EventObjectReorderEnum constant QAccessible::ObjectReorder
[static,const]QAccessible_EventObjectShowEnum constant QAccessible::ObjectShow
[static,const]QAccessible_EventParentChangedEnum constant QAccessible::ParentChanged
[static,const]QAccessible_EventPopupMenuEndEnum constant QAccessible::PopupMenuEnd
[static,const]QAccessible_EventPopupMenuStartEnum constant QAccessible::PopupMenuStart
[static,const]QAccessible_EventScrollingEndEnum constant QAccessible::ScrollingEnd
[static,const]QAccessible_EventScrollingStartEnum constant QAccessible::ScrollingStart
[static,const]QAccessible_EventSelectionEnum constant QAccessible::Selection
[static,const]QAccessible_EventSelectionAddEnum constant QAccessible::SelectionAdd
[static,const]QAccessible_EventSelectionRemoveEnum constant QAccessible::SelectionRemove
[static,const]QAccessible_EventSelectionWithinEnum constant QAccessible::SelectionWithin
[static,const]QAccessible_EventSoundPlayedEnum constant QAccessible::SoundPlayed
[static,const]QAccessible_EventStateChangedEnum constant QAccessible::StateChanged
[static,const]QAccessible_EventValueChangedEnum constant QAccessible::ValueChanged

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_Event 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_Event 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_Event other)

Description: Compares two enums

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

Description: Compares an enum with an integer value

AcceleratorChanged

Signature: [static,const] QAccessible_Event AcceleratorChanged

Description: Enum constant QAccessible::AcceleratorChanged

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

Alert

Signature: [static,const] QAccessible_Event Alert

Description: Enum constant QAccessible::Alert

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

ContextHelpEnd

Signature: [static,const] QAccessible_Event ContextHelpEnd

Description: Enum constant QAccessible::ContextHelpEnd

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

ContextHelpStart

Signature: [static,const] QAccessible_Event ContextHelpStart

Description: Enum constant QAccessible::ContextHelpStart

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

DefaultActionChanged

Signature: [static,const] QAccessible_Event DefaultActionChanged

Description: Enum constant QAccessible::DefaultActionChanged

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

DescriptionChanged

Signature: [static,const] QAccessible_Event DescriptionChanged

Description: Enum constant QAccessible::DescriptionChanged

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

DialogEnd

Signature: [static,const] QAccessible_Event DialogEnd

Description: Enum constant QAccessible::DialogEnd

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

DialogStart

Signature: [static,const] QAccessible_Event DialogStart

Description: Enum constant QAccessible::DialogStart

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

DragDropEnd

Signature: [static,const] QAccessible_Event DragDropEnd

Description: Enum constant QAccessible::DragDropEnd

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

DragDropStart

Signature: [static,const] QAccessible_Event DragDropStart

Description: Enum constant QAccessible::DragDropStart

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

Focus

Signature: [static,const] QAccessible_Event Focus

Description: Enum constant QAccessible::Focus

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

ForegroundChanged

Signature: [static,const] QAccessible_Event ForegroundChanged

Description: Enum constant QAccessible::ForegroundChanged

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

HelpChanged

Signature: [static,const] QAccessible_Event HelpChanged

Description: Enum constant QAccessible::HelpChanged

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

LocationChanged

Signature: [static,const] QAccessible_Event LocationChanged

Description: Enum constant QAccessible::LocationChanged

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

MenuCommand

Signature: [static,const] QAccessible_Event MenuCommand

Description: Enum constant QAccessible::MenuCommand

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

MenuEnd

Signature: [static,const] QAccessible_Event MenuEnd

Description: Enum constant QAccessible::MenuEnd

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

MenuStart

Signature: [static,const] QAccessible_Event MenuStart

Description: Enum constant QAccessible::MenuStart

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

NameChanged

Signature: [static,const] QAccessible_Event NameChanged

Description: Enum constant QAccessible::NameChanged

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

ObjectCreated

Signature: [static,const] QAccessible_Event ObjectCreated

Description: Enum constant QAccessible::ObjectCreated

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

ObjectDestroyed

Signature: [static,const] QAccessible_Event ObjectDestroyed

Description: Enum constant QAccessible::ObjectDestroyed

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

ObjectHide

Signature: [static,const] QAccessible_Event ObjectHide

Description: Enum constant QAccessible::ObjectHide

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

ObjectReorder

Signature: [static,const] QAccessible_Event ObjectReorder

Description: Enum constant QAccessible::ObjectReorder

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

ObjectShow

Signature: [static,const] QAccessible_Event ObjectShow

Description: Enum constant QAccessible::ObjectShow

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

ParentChanged

Signature: [static,const] QAccessible_Event ParentChanged

Description: Enum constant QAccessible::ParentChanged

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

PopupMenuEnd

Signature: [static,const] QAccessible_Event PopupMenuEnd

Description: Enum constant QAccessible::PopupMenuEnd

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

PopupMenuStart

Signature: [static,const] QAccessible_Event PopupMenuStart

Description: Enum constant QAccessible::PopupMenuStart

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

ScrollingEnd

Signature: [static,const] QAccessible_Event ScrollingEnd

Description: Enum constant QAccessible::ScrollingEnd

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

ScrollingStart

Signature: [static,const] QAccessible_Event ScrollingStart

Description: Enum constant QAccessible::ScrollingStart

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

Selection

Signature: [static,const] QAccessible_Event Selection

Description: Enum constant QAccessible::Selection

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

SelectionAdd

Signature: [static,const] QAccessible_Event SelectionAdd

Description: Enum constant QAccessible::SelectionAdd

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

SelectionRemove

Signature: [static,const] QAccessible_Event SelectionRemove

Description: Enum constant QAccessible::SelectionRemove

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

SelectionWithin

Signature: [static,const] QAccessible_Event SelectionWithin

Description: Enum constant QAccessible::SelectionWithin

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

SoundPlayed

Signature: [static,const] QAccessible_Event SoundPlayed

Description: Enum constant QAccessible::SoundPlayed

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

StateChanged

Signature: [static,const] QAccessible_Event StateChanged

Description: Enum constant QAccessible::StateChanged

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

ValueChanged

Signature: [static,const] QAccessible_Event ValueChanged

Description: Enum constant QAccessible::ValueChanged

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

_const_cast

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

Description: Creates a flag set by combining the two flags

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

Description: Combines the flag and the flag set