API reference - Class QTextBoundaryFinder

BreakOpportunity

Signature: [static,const] QTextBoundaryFinder_BoundaryReason BreakOpportunity

Description: Enum constant QTextBoundaryFinder::BreakOpportunity

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

EndOfItem

Signature: [static,const] QTextBoundaryFinder_BoundaryReason EndOfItem

Description: Enum constant QTextBoundaryFinder::EndOfItem

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

Grapheme

Signature: [static,const] QTextBoundaryFinder_BoundaryType Grapheme

Description: Enum constant QTextBoundaryFinder::Grapheme

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

Line

Signature: [static,const] QTextBoundaryFinder_BoundaryType Line

Description: Enum constant QTextBoundaryFinder::Line

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

MandatoryBreak

Signature: [static,const] QTextBoundaryFinder_BoundaryReason MandatoryBreak

Description: Enum constant QTextBoundaryFinder::MandatoryBreak

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

NotAtBoundary

Signature: [static,const] QTextBoundaryFinder_BoundaryReason NotAtBoundary

Description: Enum constant QTextBoundaryFinder::NotAtBoundary

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

Sentence

Signature: [static,const] QTextBoundaryFinder_BoundaryType Sentence

Description: Enum constant QTextBoundaryFinder::Sentence

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

SoftHyphen

Signature: [static,const] QTextBoundaryFinder_BoundaryReason SoftHyphen

Description: Enum constant QTextBoundaryFinder::SoftHyphen

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

StartOfItem

Signature: [static,const] QTextBoundaryFinder_BoundaryReason StartOfItem

Description: Enum constant QTextBoundaryFinder::StartOfItem

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

Word

Signature: [static,const] QTextBoundaryFinder_BoundaryType Word

Description: Enum constant QTextBoundaryFinder::Word

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

_assign

Signature: void _assign (const QTextBoundaryFinder other)

Description: Assigns another object to self

_const_cast

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

Description: Method QTextBoundaryFinder &QTextBoundaryFinder::operator=(const QTextBoundaryFinder &other)

boundaryReasons

Signature: [const] QTextBoundaryFinder_QFlags_BoundaryReason boundaryReasons

Description: Method QFlags<QTextBoundaryFinder::BoundaryReason> QTextBoundaryFinder::boundaryReasons()

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

Description: Creates a copy of self

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

isAtBoundary?

Signature: [const] bool isAtBoundary?

Description: Method bool QTextBoundaryFinder::isAtBoundary()

isValid?

Signature: [const] bool isValid?

Description: Method bool QTextBoundaryFinder::isValid()

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 QTextBoundaryFinder new

Description: Constructor QTextBoundaryFinder::QTextBoundaryFinder()

This method creates an object of class QTextBoundaryFinder.

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

(2) Signature: [static] new QTextBoundaryFinder new (const QTextBoundaryFinder other)

Description: Constructor QTextBoundaryFinder::QTextBoundaryFinder(const QTextBoundaryFinder &other)

This method creates an object of class QTextBoundaryFinder.

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

(3) Signature: [static] new QTextBoundaryFinder new (const QTextBoundaryFinder_BoundaryType type, string string)

Description: Constructor QTextBoundaryFinder::QTextBoundaryFinder(QTextBoundaryFinder::BoundaryType type, const QString &string)

This method creates an object of class QTextBoundaryFinder.

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

position

Signature: [const] int position

Description: Method int QTextBoundaryFinder::position()

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

position=

Signature: void position= (int position)

Description: Method void QTextBoundaryFinder::setPosition(int position)

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

setPosition

Signature: void setPosition (int position)

Description: Method void QTextBoundaryFinder::setPosition(int position)

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

string

Signature: [const] string string

Description: Method QString QTextBoundaryFinder::string()

toEnd

Signature: void toEnd

Description: Method void QTextBoundaryFinder::toEnd()

toNextBoundary

Signature: int toNextBoundary

Description: Method int QTextBoundaryFinder::toNextBoundary()

toPreviousBoundary

Signature: int toPreviousBoundary

Description: Method int QTextBoundaryFinder::toPreviousBoundary()

toStart

Signature: void toStart

Description: Method void QTextBoundaryFinder::toStart()

type

Signature: [const] QTextBoundaryFinder_BoundaryType type

Description: Method QTextBoundaryFinder::BoundaryType QTextBoundaryFinder::type()