API reference - Class QAccessibleActionInterface

_const_cast

Signature: [const] QAccessibleActionInterface 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.

actionNames

Signature: [const] string[] actionNames

Description: Virtual method QStringList QAccessibleActionInterface::actionNames()

This method can be reimplemented in a derived class.

assign

Signature: void assign (const QAccessibleActionInterface 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.

decreaseAction

Signature: [static] string decreaseAction

Description: Static method const QString &QAccessibleActionInterface::decreaseAction()

This method is static and can be called without an instance.

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.

doAction

Signature: void doAction (string actionName)

Description: Virtual method void QAccessibleActionInterface::doAction(const QString &actionName)

This method can be reimplemented in a derived class.

dup

Signature: [const] new QAccessibleActionInterface ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

increaseAction

Signature: [static] string increaseAction

Description: Static method const QString &QAccessibleActionInterface::increaseAction()

This method is static and can be called without an instance.

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.

keyBindingsForAction

Signature: [const] string[] keyBindingsForAction (string actionName)

Description: Virtual method QStringList QAccessibleActionInterface::keyBindingsForAction(const QString &actionName)

This method can be reimplemented in a derived class.

localizedActionDescription

Signature: [const] string localizedActionDescription (string name)

Description: Virtual method QString QAccessibleActionInterface::localizedActionDescription(const QString &name)

This method can be reimplemented in a derived class.

localizedActionName

Signature: [const] string localizedActionName (string name)

Description: Virtual method QString QAccessibleActionInterface::localizedActionName(const QString &name)

This method can be reimplemented in a derived class.

new

Signature: [static] new QAccessibleActionInterface new

Description: Constructor QAccessibleActionInterface::QAccessibleActionInterface()

This method creates an object of class QAccessibleActionInterface.

Python specific notes:
This method is the default initializer of the object.

nextPageAction

Signature: [static] string nextPageAction

Description: Static method QString QAccessibleActionInterface::nextPageAction()

This method is static and can be called without an instance.

pressAction

Signature: [static] string pressAction

Description: Static method const QString &QAccessibleActionInterface::pressAction()

This method is static and can be called without an instance.

previousPageAction

Signature: [static] string previousPageAction

Description: Static method QString QAccessibleActionInterface::previousPageAction()

This method is static and can be called without an instance.

scrollDownAction

Signature: [static] string scrollDownAction

Description: Static method QString QAccessibleActionInterface::scrollDownAction()

This method is static and can be called without an instance.

scrollLeftAction

Signature: [static] string scrollLeftAction

Description: Static method QString QAccessibleActionInterface::scrollLeftAction()

This method is static and can be called without an instance.

scrollRightAction

Signature: [static] string scrollRightAction

Description: Static method QString QAccessibleActionInterface::scrollRightAction()

This method is static and can be called without an instance.

scrollUpAction

Signature: [static] string scrollUpAction

Description: Static method QString QAccessibleActionInterface::scrollUpAction()

This method is static and can be called without an instance.

setFocusAction

Signature: [static] string setFocusAction

Description: Static method const QString &QAccessibleActionInterface::setFocusAction()

This method is static and can be called without an instance.

showMenuAction

Signature: [static] string showMenuAction

Description: Static method const QString &QAccessibleActionInterface::showMenuAction()

This method is static and can be called without an instance.

toggleAction

Signature: [static] string toggleAction

Description: Static method const QString &QAccessibleActionInterface::toggleAction()

This method is static and can be called without an instance.

tr

Signature: [static] string tr (string sourceText, string disambiguation = nullptr, int n = -1)

Description: Static method QString QAccessibleActionInterface::tr(const char *sourceText, const char *disambiguation, int n)

This method is static and can be called without an instance.

trUtf8

Signature: [static] string trUtf8 (string sourceText, string disambiguation = nullptr, int n = -1)

Description: Static method QString QAccessibleActionInterface::trUtf8(const char *sourceText, const char *disambiguation, int n)

This method is static and can be called without an instance.