KLayout Manual: Main Index » Class Index » API reference - Class QPlainTextDocumentLayout

API reference - Class QPlainTextDocumentLayout

Notation used in Ruby API documentation

Description: Binding of QPlainTextDocumentLayout

Class hierarchy: QPlainTextDocumentLayout » QAbstractTextDocumentLayout » QObject

• Public constructors
• Public methods
• Public static methods and constants
• Protected methods (static, non-static and constructors)
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

Public constructors

Public methods

Public static methods and constants

Protected methods (static, non-static and constructors)

Deprecated methods (protected, public, static, non-static and constructors)

Detailed description

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.

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.

[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.

[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.

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.

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.

[virtual,const] QRectF blockBoundingRect(const QTextBlock block)

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

This method can be reimplemented in a derived class.

[virtual] void childEvent(QChildEvent ptr arg1)

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

This method can be reimplemented in a derived class.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[const] int cursorWidth

Description: Method int QPlainTextDocumentLayout::cursorWidth()

Python specific notes:

The object exposes a readable attribute 'cursorWidth'. This is the getter.

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.

[virtual] void customEvent(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[event] void destroyed(QObject ptr arg1)

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

You can bind a procedure to this signal.

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

[virtual] void disconnectNotify(string signal)

Description: Virtual method void QPlainTextDocumentLayout::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

[virtual] 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.

[virtual,const] QSizeF documentSize

Description: Virtual method QSizeF QPlainTextDocumentLayout::documentSize()

This method can be reimplemented in a derived class.

[event] void documentSizeChanged(const QSizeF newSize)

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

You can bind a procedure to this signal.

[virtual] 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.

[virtual] 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.

[const] void ensureBlockLayout(const QTextBlock block)

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

[virtual] bool event(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual] bool eventFilter(QObject ptr arg1,QEvent ptr arg2)

Description: Virtual method bool QPlainTextDocumentLayout::eventFilter(QObject *, QEvent *)

This method can be reimplemented in a derived class.

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.

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.

[virtual,const] QRectF frameBoundingRect(QTextFrame ptr arg1)

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

This method can be reimplemented in a derived class.

[virtual,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.

[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

[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

[virtual,const] int pageCount

Description: Virtual method int QPlainTextDocumentLayout::pageCount()

This method can be reimplemented in a derived class.

[event] void pageCountChanged(int newPages)

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

You can bind a procedure to this signal.

[virtual] 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.

[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.

void requestUpdate

Description: Method void QPlainTextDocumentLayout::requestUpdate()

[virtual] 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.

[const] QObject ptr sender

Description: Method QObject *QPlainTextDocumentLayout::sender()

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

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.

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[virtual] void timerEvent(QTimerEvent ptr arg1)

Description: Virtual method void QPlainTextDocumentLayout::timerEvent(QTimerEvent *)

This method can be reimplemented in a derived class.

[static] string tr(string s,string c = 0)

Description: Static method QString QPlainTextDocumentLayout::tr(const char *s, const char *c)

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

[static] string tr(string s,string c,int n)

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.

[static] string trUtf8(string s,string c = 0)

Description: Static method QString QPlainTextDocumentLayout::trUtf8(const char *s, const char *c)

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

[static] string trUtf8(string s,string c,int n)

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.

[event] void update(const QRectF arg1)

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

You can bind a procedure to this signal.

[event] void updateBlock(const QTextBlock block)

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

You can bind a procedure to this signal.