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

API reference - Class QTextCursor::MoveOperation

Notation used in Ruby API documentation

Module: QtGui

Description: This class represents the QTextCursor::MoveOperation enum

This class is equivalent to the class QTextCursor_MoveOperation

Public constructors

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

Public methods

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

Public static methods and constants

[static,const]QTextCursor_MoveOperationDownEnum constant QTextCursor::Down
[static,const]QTextCursor_MoveOperationEndEnum constant QTextCursor::End
[static,const]QTextCursor_MoveOperationEndOfBlockEnum constant QTextCursor::EndOfBlock
[static,const]QTextCursor_MoveOperationEndOfLineEnum constant QTextCursor::EndOfLine
[static,const]QTextCursor_MoveOperationEndOfWordEnum constant QTextCursor::EndOfWord
[static,const]QTextCursor_MoveOperationLeftEnum constant QTextCursor::Left
[static,const]QTextCursor_MoveOperationNextBlockEnum constant QTextCursor::NextBlock
[static,const]QTextCursor_MoveOperationNextCellEnum constant QTextCursor::NextCell
[static,const]QTextCursor_MoveOperationNextCharacterEnum constant QTextCursor::NextCharacter
[static,const]QTextCursor_MoveOperationNextRowEnum constant QTextCursor::NextRow
[static,const]QTextCursor_MoveOperationNextWordEnum constant QTextCursor::NextWord
[static,const]QTextCursor_MoveOperationNoMoveEnum constant QTextCursor::NoMove
[static,const]QTextCursor_MoveOperationPreviousBlockEnum constant QTextCursor::PreviousBlock
[static,const]QTextCursor_MoveOperationPreviousCellEnum constant QTextCursor::PreviousCell
[static,const]QTextCursor_MoveOperationPreviousCharacterEnum constant QTextCursor::PreviousCharacter
[static,const]QTextCursor_MoveOperationPreviousRowEnum constant QTextCursor::PreviousRow
[static,const]QTextCursor_MoveOperationPreviousWordEnum constant QTextCursor::PreviousWord
[static,const]QTextCursor_MoveOperationRightEnum constant QTextCursor::Right
[static,const]QTextCursor_MoveOperationStartEnum constant QTextCursor::Start
[static,const]QTextCursor_MoveOperationStartOfBlockEnum constant QTextCursor::StartOfBlock
[static,const]QTextCursor_MoveOperationStartOfLineEnum constant QTextCursor::StartOfLine
[static,const]QTextCursor_MoveOperationStartOfWordEnum constant QTextCursor::StartOfWord
[static,const]QTextCursor_MoveOperationUpEnum constant QTextCursor::Up
[static,const]QTextCursor_MoveOperationWordLeftEnum constant QTextCursor::WordLeft
[static,const]QTextCursor_MoveOperationWordRightEnum constant QTextCursor::WordRight

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

Description: Compares two enums

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

Description: Compares an enum with an integer value

Down

Signature: [static,const] QTextCursor_MoveOperation Down

Description: Enum constant QTextCursor::Down

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

End

Signature: [static,const] QTextCursor_MoveOperation End

Description: Enum constant QTextCursor::End

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

EndOfBlock

Signature: [static,const] QTextCursor_MoveOperation EndOfBlock

Description: Enum constant QTextCursor::EndOfBlock

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

EndOfLine

Signature: [static,const] QTextCursor_MoveOperation EndOfLine

Description: Enum constant QTextCursor::EndOfLine

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

EndOfWord

Signature: [static,const] QTextCursor_MoveOperation EndOfWord

Description: Enum constant QTextCursor::EndOfWord

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

Left

Signature: [static,const] QTextCursor_MoveOperation Left

Description: Enum constant QTextCursor::Left

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

NextBlock

Signature: [static,const] QTextCursor_MoveOperation NextBlock

Description: Enum constant QTextCursor::NextBlock

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

NextCell

Signature: [static,const] QTextCursor_MoveOperation NextCell

Description: Enum constant QTextCursor::NextCell

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

NextCharacter

Signature: [static,const] QTextCursor_MoveOperation NextCharacter

Description: Enum constant QTextCursor::NextCharacter

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

NextRow

Signature: [static,const] QTextCursor_MoveOperation NextRow

Description: Enum constant QTextCursor::NextRow

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

NextWord

Signature: [static,const] QTextCursor_MoveOperation NextWord

Description: Enum constant QTextCursor::NextWord

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

NoMove

Signature: [static,const] QTextCursor_MoveOperation NoMove

Description: Enum constant QTextCursor::NoMove

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

PreviousBlock

Signature: [static,const] QTextCursor_MoveOperation PreviousBlock

Description: Enum constant QTextCursor::PreviousBlock

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

PreviousCell

Signature: [static,const] QTextCursor_MoveOperation PreviousCell

Description: Enum constant QTextCursor::PreviousCell

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

PreviousCharacter

Signature: [static,const] QTextCursor_MoveOperation PreviousCharacter

Description: Enum constant QTextCursor::PreviousCharacter

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

PreviousRow

Signature: [static,const] QTextCursor_MoveOperation PreviousRow

Description: Enum constant QTextCursor::PreviousRow

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

PreviousWord

Signature: [static,const] QTextCursor_MoveOperation PreviousWord

Description: Enum constant QTextCursor::PreviousWord

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

Right

Signature: [static,const] QTextCursor_MoveOperation Right

Description: Enum constant QTextCursor::Right

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

Start

Signature: [static,const] QTextCursor_MoveOperation Start

Description: Enum constant QTextCursor::Start

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

StartOfBlock

Signature: [static,const] QTextCursor_MoveOperation StartOfBlock

Description: Enum constant QTextCursor::StartOfBlock

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

StartOfLine

Signature: [static,const] QTextCursor_MoveOperation StartOfLine

Description: Enum constant QTextCursor::StartOfLine

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

StartOfWord

Signature: [static,const] QTextCursor_MoveOperation StartOfWord

Description: Enum constant QTextCursor::StartOfWord

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

Up

Signature: [static,const] QTextCursor_MoveOperation Up

Description: Enum constant QTextCursor::Up

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

WordLeft

Signature: [static,const] QTextCursor_MoveOperation WordLeft

Description: Enum constant QTextCursor::WordLeft

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

WordRight

Signature: [static,const] QTextCursor_MoveOperation WordRight

Description: Enum constant QTextCursor::WordRight

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

_const_cast

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

Description: Creates a flag set by combining the two flags

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

Description: Combines the flag and the flag set