API reference - Class QAccessibleTextInterface

_const_cast

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

addSelection

Signature: void addSelection (int startOffset, int endOffset)

Description: Virtual method void QAccessibleTextInterface::addSelection(int startOffset, int endOffset)

This method can be reimplemented in a derived class.

assign

Signature: void assign (const QAccessibleTextInterface other)

Description: Assigns another object to self

attributes

Signature: [const] string attributes (int offset, int ptr startOffset, int ptr endOffset)

Description: Virtual method QString QAccessibleTextInterface::attributes(int offset, int *startOffset, int *endOffset)

This method can be reimplemented in a derived class.

characterCount

Signature: [const] int characterCount

Description: Virtual method int QAccessibleTextInterface::characterCount()

This method can be reimplemented in a derived class.

characterRect

Signature: [const] QRect characterRect (int offset)

Description: Virtual method QRect QAccessibleTextInterface::characterRect(int offset)

This method can be reimplemented in a derived class.

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.

cursorPosition

Signature: [const] int cursorPosition

Description: Virtual method int QAccessibleTextInterface::cursorPosition()

This method can be reimplemented in a derived class.

cursorPosition=

Signature: void cursorPosition= (int position)

Description: Method void QAccessibleTextInterface::setCursorPosition(int position)

Python specific notes:
The object exposes a writable attribute 'cursorPosition'. This is the setter.

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 QAccessibleTextInterface ptr dup

Description: Creates a copy of self

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

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

Signature: [static] new QAccessibleTextInterface new

Description: Constructor QAccessibleTextInterface::QAccessibleTextInterface()

This method creates an object of class QAccessibleTextInterface.

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

offsetAtPoint

Signature: [const] int offsetAtPoint (const QPoint point)

Description: Virtual method int QAccessibleTextInterface::offsetAtPoint(const QPoint &point)

This method can be reimplemented in a derived class.

removeSelection

Signature: void removeSelection (int selectionIndex)

Description: Virtual method void QAccessibleTextInterface::removeSelection(int selectionIndex)

This method can be reimplemented in a derived class.

scrollToSubstring

Signature: void scrollToSubstring (int startIndex, int endIndex)

Description: Virtual method void QAccessibleTextInterface::scrollToSubstring(int startIndex, int endIndex)

This method can be reimplemented in a derived class.

selection

Signature: [const] void selection (int selectionIndex, int ptr startOffset, int ptr endOffset)

Description: Virtual method void QAccessibleTextInterface::selection(int selectionIndex, int *startOffset, int *endOffset)

This method can be reimplemented in a derived class.

selectionCount

Signature: [const] int selectionCount

Description: Virtual method int QAccessibleTextInterface::selectionCount()

This method can be reimplemented in a derived class.

setCursorPosition

Signature: void setCursorPosition (int position)

Description: Virtual method void QAccessibleTextInterface::setCursorPosition(int position)

This method can be reimplemented in a derived class.

setSelection

Signature: void setSelection (int selectionIndex, int startOffset, int endOffset)

Description: Virtual method void QAccessibleTextInterface::setSelection(int selectionIndex, int startOffset, int endOffset)

This method can be reimplemented in a derived class.

text

Signature: [const] string text (int startOffset, int endOffset)

Description: Virtual method QString QAccessibleTextInterface::text(int startOffset, int endOffset)

This method can be reimplemented in a derived class.

textAfterOffset

Signature: [const] string textAfterOffset (int offset, const QAccessible_TextBoundaryType boundaryType, int ptr startOffset, int ptr endOffset)

Description: Virtual method QString QAccessibleTextInterface::textAfterOffset(int offset, QAccessible::TextBoundaryType boundaryType, int *startOffset, int *endOffset)

This method can be reimplemented in a derived class.

textAtOffset

Signature: [const] string textAtOffset (int offset, const QAccessible_TextBoundaryType boundaryType, int ptr startOffset, int ptr endOffset)

Description: Virtual method QString QAccessibleTextInterface::textAtOffset(int offset, QAccessible::TextBoundaryType boundaryType, int *startOffset, int *endOffset)

This method can be reimplemented in a derived class.

textBeforeOffset

Signature: [const] string textBeforeOffset (int offset, const QAccessible_TextBoundaryType boundaryType, int ptr startOffset, int ptr endOffset)

Description: Virtual method QString QAccessibleTextInterface::textBeforeOffset(int offset, QAccessible::TextBoundaryType boundaryType, int *startOffset, int *endOffset)

This method can be reimplemented in a derived class.