API reference - Class QSyntaxHighlighter

_const_cast

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

childEvent

Signature: void childEvent (QChildEvent ptr event)

Description: Virtual method void QSyntaxHighlighter::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

currentBlock

Signature: [const] QTextBlock currentBlock

Description: Method QTextBlock QSyntaxHighlighter::currentBlock()

This method is protected and can only be called from inside a derived class.

currentBlockState

Signature: [const] int currentBlockState

Description: Method int QSyntaxHighlighter::currentBlockState()

This method is protected and can only be called from inside a derived class.

currentBlockUserData

Signature: [const] QTextBlockUserData ptr currentBlockUserData

Description: Method QTextBlockUserData *QSyntaxHighlighter::currentBlockUserData()

This method is protected and can only be called from inside a derived class.

customEvent

Signature: void customEvent (QEvent ptr event)

Description: Virtual method void QSyntaxHighlighter::customEvent(QEvent *event)

This method can be reimplemented in a derived class.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

Description: Signal declaration for QSyntaxHighlighter::destroyed(QObject *)

You can bind a procedure to this signal.

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

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QSyntaxHighlighter::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

document

Signature: [const] QTextDocument ptr document

Description: Method QTextDocument *QSyntaxHighlighter::document()

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

document=

Signature: void document= (QTextDocument ptr doc)

Description: Method void QSyntaxHighlighter::setDocument(QTextDocument *doc)

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

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QSyntaxHighlighter::destroyed(QObject *)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QSyntaxHighlighter::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QSyntaxHighlighter::event(QEvent *event)

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

Description: Virtual method bool QSyntaxHighlighter::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

format

Signature: [const] QTextCharFormat format (int pos)

Description: Method QTextCharFormat QSyntaxHighlighter::format(int pos)

This method is protected and can only be called from inside a derived class.

highlightBlock

Signature: void highlightBlock (string text)

Description: Virtual method void QSyntaxHighlighter::highlightBlock(const QString &text)

This method can be reimplemented in a derived class.

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QSyntaxHighlighter::isSignalConnected(const QMetaMethod &signal)

This method is protected and can only be called from inside a derived class.

new

(1) Signature: [static] new QSyntaxHighlighter new (QObject ptr parent)

Description: Constructor QSyntaxHighlighter::QSyntaxHighlighter(QObject *parent)

This method creates an object of class QSyntaxHighlighter.

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

(2) Signature: [static] new QSyntaxHighlighter new (QTextDocument ptr parent)

Description: Constructor QSyntaxHighlighter::QSyntaxHighlighter(QTextDocument *parent)

This method creates an object of class QSyntaxHighlighter.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QSyntaxHighlighter::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

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

previousBlockState

Signature: [const] int previousBlockState

Description: Method int QSyntaxHighlighter::previousBlockState()

This method is protected and can only be called from inside a derived class.

receivers

Signature: [const] int receivers (string signal)

Description: Method int QSyntaxHighlighter::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

rehighlight

Signature: void rehighlight

Description: Method void QSyntaxHighlighter::rehighlight()

rehighlightBlock

Signature: void rehighlightBlock (const QTextBlock block)

Description: Method void QSyntaxHighlighter::rehighlightBlock(const QTextBlock &block)

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QSyntaxHighlighter::sender()

This method is protected and can only be called from inside a derived class.

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QSyntaxHighlighter::senderSignalIndex()

This method is protected and can only be called from inside a derived class.

setCurrentBlockState

Signature: void setCurrentBlockState (int newState)

Description: Method void QSyntaxHighlighter::setCurrentBlockState(int newState)

This method is protected and can only be called from inside a derived class.

setCurrentBlockUserData

Signature: void setCurrentBlockUserData (QTextBlockUserData ptr data)

Description: Method void QSyntaxHighlighter::setCurrentBlockUserData(QTextBlockUserData *data)

This method is protected and can only be called from inside a derived class.

setDocument

Signature: void setDocument (QTextDocument ptr doc)

Description: Method void QSyntaxHighlighter::setDocument(QTextDocument *doc)

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

setFormat

(1) Signature: void setFormat (int start, int count, const QTextCharFormat format)

Description: Method void QSyntaxHighlighter::setFormat(int start, int count, const QTextCharFormat &format)

This method is protected and can only be called from inside a derived class.

(2) Signature: void setFormat (int start, int count, const QColor color)

Description: Method void QSyntaxHighlighter::setFormat(int start, int count, const QColor &color)

This method is protected and can only be called from inside a derived class.

(3) Signature: void setFormat (int start, int count, const QFont font)

Description: Method void QSyntaxHighlighter::setFormat(int start, int count, const QFont &font)

This method is protected and can only be called from inside a derived class.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QSyntaxHighlighter::timerEvent(QTimerEvent *event)

This method can be reimplemented in a derived class.

tr

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

Description: Static method QString QSyntaxHighlighter::tr(const char *s, const char *c, int n)

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

trUtf8

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

Description: Static method QString QSyntaxHighlighter::trUtf8(const char *s, const char *c, int n)

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