API reference - Class QPlainTextDocumentLayout

_const_cast

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

blockBoundingRect

Signature: [const] QRectF blockBoundingRect (const QTextBlock block)

Description: Virtual method QRectF QPlainTextDocumentLayout::blockBoundingRect(const QTextBlock &block)

This method can be reimplemented in a derived class.

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

cursorWidth

Signature: [const] int cursorWidth

Description: Method int QPlainTextDocumentLayout::cursorWidth()

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

cursorWidth=

Signature: void cursorWidth= (int width)

Description: Method void QPlainTextDocumentLayout::setCursorWidth(int width)

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

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

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

Description: Signal declaration for QPlainTextDocumentLayout::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 QPlainTextDocumentLayout::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

documentChanged

Signature: void documentChanged (int from, int arg2, int charsAdded)

Description: Virtual method void QPlainTextDocumentLayout::documentChanged(int from, int, int charsAdded)

This method can be reimplemented in a derived class.

documentSize

Signature: [const] QSizeF documentSize

Description: Virtual method QSizeF QPlainTextDocumentLayout::documentSize()

This method can be reimplemented in a derived class.

documentSizeChanged

Signature: [signal] void documentSizeChanged (const QSizeF newSize)

Description: Signal declaration for QPlainTextDocumentLayout::documentSizeChanged(const QSizeF &newSize)

You can bind a procedure to this signal.

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

draw

Signature: void draw (QPainter ptr arg1, const QAbstractTextDocumentLayout_PaintContext arg2)

Description: Virtual method void QPlainTextDocumentLayout::draw(QPainter *, const QAbstractTextDocumentLayout::PaintContext &)

This method can be reimplemented in a derived class.

drawInlineObject

Signature: void drawInlineObject (QPainter ptr painter, const QRectF rect, QTextInlineObject object, int posInDocument, const QTextFormat format)

Description: Virtual method void QPlainTextDocumentLayout::drawInlineObject(QPainter *painter, const QRectF &rect, QTextInlineObject object, int posInDocument, const QTextFormat &format)

This method can be reimplemented in a derived class.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

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

Call this method to emit this signal.

emit_documentSizeChanged

Signature: void emit_documentSizeChanged (const QSizeF newSize)

Description: Emitter for signal void QPlainTextDocumentLayout::documentSizeChanged(const QSizeF &newSize)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

emit_pageCountChanged

Signature: void emit_pageCountChanged (int newPages)

Description: Emitter for signal void QPlainTextDocumentLayout::pageCountChanged(int newPages)

Call this method to emit this signal.

emit_update

Signature: void emit_update (const QRectF arg1 = QRectF(0., 0., 1000000000., 1000000000.))

Description: Emitter for signal void QPlainTextDocumentLayout::update(const QRectF &)

Call this method to emit this signal.

emit_updateBlock

Signature: void emit_updateBlock (const QTextBlock block)

Description: Emitter for signal void QPlainTextDocumentLayout::updateBlock(const QTextBlock &block)

Call this method to emit this signal.

ensureBlockLayout

Signature: [const] void ensureBlockLayout (const QTextBlock block)

Description: Method void QPlainTextDocumentLayout::ensureBlockLayout(const QTextBlock &block)

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QPlainTextDocumentLayout::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 QPlainTextDocumentLayout::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

format

Signature: QTextCharFormat format (int pos)

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

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

formatIndex

Signature: int formatIndex (int pos)

Description: Method int QPlainTextDocumentLayout::formatIndex(int pos)

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

frameBoundingRect

Signature: [const] QRectF frameBoundingRect (QTextFrame ptr arg1)

Description: Virtual method QRectF QPlainTextDocumentLayout::frameBoundingRect(QTextFrame *)

This method can be reimplemented in a derived class.

hitTest

Signature: [const] int hitTest (const QPointF arg1, const Qt_HitTestAccuracy arg2)

Description: Virtual method int QPlainTextDocumentLayout::hitTest(const QPointF &, Qt::HitTestAccuracy)

This method can be reimplemented in a derived class.

isSignalConnected

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

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

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

new

Signature: [static] new QPlainTextDocumentLayout new (QTextDocument ptr document)

Description: Constructor QPlainTextDocumentLayout::QPlainTextDocumentLayout(QTextDocument *document)

This method creates an object of class QPlainTextDocumentLayout.

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

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QPlainTextDocumentLayout::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.

pageCount

Signature: [const] int pageCount

Description: Virtual method int QPlainTextDocumentLayout::pageCount()

This method can be reimplemented in a derived class.

pageCountChanged

Signature: [signal] void pageCountChanged (int newPages)

Description: Signal declaration for QPlainTextDocumentLayout::pageCountChanged(int newPages)

You can bind a procedure to this signal.

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

positionInlineObject

Signature: void positionInlineObject (QTextInlineObject item, int posInDocument, const QTextFormat format)

Description: Virtual method void QPlainTextDocumentLayout::positionInlineObject(QTextInlineObject item, int posInDocument, const QTextFormat &format)

This method can be reimplemented in a derived class.

receivers

Signature: [const] int receivers (string signal)

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

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

requestUpdate

Signature: void requestUpdate

Description: Method void QPlainTextDocumentLayout::requestUpdate()

resizeInlineObject

Signature: void resizeInlineObject (QTextInlineObject item, int posInDocument, const QTextFormat format)

Description: Virtual method void QPlainTextDocumentLayout::resizeInlineObject(QTextInlineObject item, int posInDocument, const QTextFormat &format)

This method can be reimplemented in a derived class.

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QPlainTextDocumentLayout::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QPlainTextDocumentLayout::senderSignalIndex()

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

setCursorWidth

Signature: void setCursorWidth (int width)

Description: Method void QPlainTextDocumentLayout::setCursorWidth(int width)

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

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QPlainTextDocumentLayout::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 QPlainTextDocumentLayout::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 QPlainTextDocumentLayout::trUtf8(const char *s, const char *c, int n)

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

update

Signature: [signal] void update (const QRectF arg1)

Description: Signal declaration for QPlainTextDocumentLayout::update(const QRectF &)

You can bind a procedure to this signal.

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

updateBlock

Signature: [signal] void updateBlock (const QTextBlock block)

Description: Signal declaration for QPlainTextDocumentLayout::updateBlock(const QTextBlock &block)

You can bind a procedure to this signal.

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