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

API reference - Class QAbstractTextDocumentLayout

Notation used in Ruby API documentation

Description: Binding of QAbstractTextDocumentLayout

Class hierarchy: QAbstractTextDocumentLayout » QObject

Public constructors

new QAbstractTextDocumentLayoutnew(QTextDocument ptr doc)Constructor QAbstractTextDocumentLayout::QAbstractTextDocumentLayout(QTextDocument *doc)

Public methods

[const]stringanchorAt(const QPointF pos)Method QString QAbstractTextDocumentLayout::anchorAt(const QPointF &pos)
[virtual,const]QRectFblockBoundingRect(const QTextBlock block)Virtual method QRectF QAbstractTextDocumentLayout::blockBoundingRect(const QTextBlock &block)
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[event]voiddestroyed(QObject ptr arg1)Signal declaration for QAbstractTextDocumentLayout::destroyed(QObject *)
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]QTextDocument ptrdocumentMethod QTextDocument * QAbstractTextDocumentLayout::document()
[virtual,const]QSizeFdocumentSizeVirtual method QSizeF QAbstractTextDocumentLayout::documentSize()
[event]voiddocumentSizeChanged(const QSizeF newSize)Signal declaration for QAbstractTextDocumentLayout::documentSizeChanged(const QSizeF &newSize)
[virtual]voiddraw(QPainter ptr painter,
const QAbstractTextDocumentLayout_PaintContext context)
Virtual method void QAbstractTextDocumentLayout::draw(QPainter *painter, const QAbstractTextDocumentLayout::PaintContext &context)
[virtual]boolevent(QEvent ptr arg1)Virtual method bool QAbstractTextDocumentLayout::event(QEvent *)
[virtual]booleventFilter(QObject ptr arg1,
QEvent ptr arg2)
Virtual method bool QAbstractTextDocumentLayout::eventFilter(QObject *, QEvent *)
[virtual,const]QRectFframeBoundingRect(QTextFrame ptr frame)Virtual method QRectF QAbstractTextDocumentLayout::frameBoundingRect(QTextFrame *frame)
[const]QTextObjectInterface ptrhandlerForObject(int objectType)Method QTextObjectInterface * QAbstractTextDocumentLayout::handlerForObject(int objectType)
[virtual,const]inthitTest(const QPointF point,
const Qt_HitTestAccuracy accuracy)
Virtual method int QAbstractTextDocumentLayout::hitTest(const QPointF &point, Qt::HitTestAccuracy accuracy)
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[virtual,const]intpageCountVirtual method int QAbstractTextDocumentLayout::pageCount()
[event]voidpageCountChanged(int newPages)Signal declaration for QAbstractTextDocumentLayout::pageCountChanged(int newPages)
[const]QPaintDevice ptrpaintDeviceMethod QPaintDevice * QAbstractTextDocumentLayout::paintDevice()
voidpaintDevice=(QPaintDevice ptr device)Method void QAbstractTextDocumentLayout::setPaintDevice(QPaintDevice *device)
voidregisterHandler(int objectType,
QObject ptr component)
Method void QAbstractTextDocumentLayout::registerHandler(int objectType, QObject *component)
voidsetPaintDevice(QPaintDevice ptr device)Method void QAbstractTextDocumentLayout::setPaintDevice(QPaintDevice *device)
[event]voidupdate(const QRectF arg1)Signal declaration for QAbstractTextDocumentLayout::update(const QRectF &)
[event]voidupdateBlock(const QTextBlock block)Signal declaration for QAbstractTextDocumentLayout::updateBlock(const QTextBlock &block)

Public static methods and constants

QMetaObjectstaticMetaObjectObtains the static MetaObject for this class.
stringtr(string s)Static method QString QAbstractTextDocumentLayout::tr(const char *s, const char *c)
stringtr(string s,
string c)
Static method QString QAbstractTextDocumentLayout::tr(const char *s, const char *c)
stringtr(string s,
string c,
int n)
Static method QString QAbstractTextDocumentLayout::tr(const char *s, const char *c, int n)
stringtrUtf8(string s)Static method QString QAbstractTextDocumentLayout::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c)
Static method QString QAbstractTextDocumentLayout::trUtf8(const char *s, const char *c)
stringtrUtf8(string s,
string c,
int n)
Static method QString QAbstractTextDocumentLayout::trUtf8(const char *s, const char *c, int n)

Protected methods (static, non-static and constructors)

[virtual]voidchildEvent(QChildEvent ptr arg1)Virtual method void QAbstractTextDocumentLayout::childEvent(QChildEvent *)
[virtual]voidcustomEvent(QEvent ptr arg1)Virtual method void QAbstractTextDocumentLayout::customEvent(QEvent *)
[virtual]voiddisconnectNotify(string signal)Virtual method void QAbstractTextDocumentLayout::disconnectNotify(const char *signal)
[virtual]voiddocumentChanged(int from,
int charsRemoved,
int charsAdded)
Virtual method void QAbstractTextDocumentLayout::documentChanged(int from, int charsRemoved, int charsAdded)
[virtual]voiddrawInlineObject(QPainter ptr painter,
const QRectF rect,
QTextInlineObject object,
int posInDocument,
const QTextFormat format)
Virtual method void QAbstractTextDocumentLayout::drawInlineObject(QPainter *painter, const QRectF &rect, QTextInlineObject object, int posInDocument, const QTextFormat &format)
QTextCharFormatformat(int pos)Method QTextCharFormat QAbstractTextDocumentLayout::format(int pos)
intformatIndex(int pos)Method int QAbstractTextDocumentLayout::formatIndex(int pos)
[virtual]voidpositionInlineObject(QTextInlineObject item,
int posInDocument,
const QTextFormat format)
Virtual method void QAbstractTextDocumentLayout::positionInlineObject(QTextInlineObject item, int posInDocument, const QTextFormat &format)
[const]intreceivers(string signal)Method int QAbstractTextDocumentLayout::receivers(const char *signal)
[virtual]voidresizeInlineObject(QTextInlineObject item,
int posInDocument,
const QTextFormat format)
Virtual method void QAbstractTextDocumentLayout::resizeInlineObject(QTextInlineObject item, int posInDocument, const QTextFormat &format)
[const]QObject ptrsenderMethod QObject * QAbstractTextDocumentLayout::sender()
[virtual]voidtimerEvent(QTimerEvent ptr arg1)Virtual method void QAbstractTextDocumentLayout::timerEvent(QTimerEvent *)

Detailed description

[const] string anchorAt(const QPointF pos)

Description: Method QString QAbstractTextDocumentLayout::anchorAt(const QPointF &pos)

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

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

This method can be reimplemented in a derived class.

[virtual] void childEvent(QChildEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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.

[virtual] void customEvent(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

void destroy

Description: Explicitly destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, this method will do nothing.

[event] void destroyed(QObject ptr arg1)

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

You can bind a procedure to this signal.

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

[virtual] void disconnectNotify(string signal)

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

This method can be reimplemented in a derived class.

[const] QTextDocument ptr document

Description: Method QTextDocument * QAbstractTextDocumentLayout::document()

[virtual] void documentChanged(int from,int charsRemoved,int charsAdded)

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

This method can be reimplemented in a derived class.

[virtual,const] QSizeF documentSize

Description: Virtual method QSizeF QAbstractTextDocumentLayout::documentSize()

This method can be reimplemented in a derived class.

[event] void documentSizeChanged(const QSizeF newSize)

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

You can bind a procedure to this signal.

[virtual] void draw(QPainter ptr painter,const QAbstractTextDocumentLayout_PaintContext context)

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

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 QAbstractTextDocumentLayout::drawInlineObject(QPainter *painter, const QRectF &rect, QTextInlineObject object, int posInDocument, const QTextFormat &format)

This method can be reimplemented in a derived class.

[virtual] bool event(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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

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

This method can be reimplemented in a derived class.

QTextCharFormat format(int pos)

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

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

int formatIndex(int pos)

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

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

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

Description: Virtual method QRectF QAbstractTextDocumentLayout::frameBoundingRect(QTextFrame *frame)

This method can be reimplemented in a derived class.

[const] QTextObjectInterface ptr handlerForObject(int objectType)

Description: Method QTextObjectInterface * QAbstractTextDocumentLayout::handlerForObject(int objectType)

[virtual,const] int hitTest(const QPointF point,const Qt_HitTestAccuracy accuracy)

Description: Virtual method int QAbstractTextDocumentLayout::hitTest(const QPointF &point, Qt::HitTestAccuracy accuracy)

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

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

[static] new QAbstractTextDocumentLayout new(QTextDocument ptr doc)

Description: Constructor QAbstractTextDocumentLayout::QAbstractTextDocumentLayout(QTextDocument *doc)

This method creates an object of class QAbstractTextDocumentLayout.

[virtual,const] int pageCount

Description: Virtual method int QAbstractTextDocumentLayout::pageCount()

This method can be reimplemented in a derived class.

[event] void pageCountChanged(int newPages)

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

You can bind a procedure to this signal.

[const] QPaintDevice ptr paintDevice

Description: Method QPaintDevice * QAbstractTextDocumentLayout::paintDevice()

void paintDevice=(QPaintDevice ptr device)

Description: Method void QAbstractTextDocumentLayout::setPaintDevice(QPaintDevice *device)

[virtual] void positionInlineObject(QTextInlineObject item,int posInDocument,const QTextFormat format)

Description: Virtual method void QAbstractTextDocumentLayout::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 QAbstractTextDocumentLayout::receivers(const char *signal)

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

void registerHandler(int objectType,QObject ptr component)

Description: Method void QAbstractTextDocumentLayout::registerHandler(int objectType, QObject *component)

[virtual] void resizeInlineObject(QTextInlineObject item,int posInDocument,const QTextFormat format)

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

This method can be reimplemented in a derived class.

[const] QObject ptr sender

Description: Method QObject * QAbstractTextDocumentLayout::sender()

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

void setPaintDevice(QPaintDevice ptr device)

Description: Method void QAbstractTextDocumentLayout::setPaintDevice(QPaintDevice *device)

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[virtual] void timerEvent(QTimerEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[static] string tr(string s)

Description: Static method QString QAbstractTextDocumentLayout::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)

Description: Static method QString QAbstractTextDocumentLayout::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 QAbstractTextDocumentLayout::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)

Description: Static method QString QAbstractTextDocumentLayout::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)

Description: Static method QString QAbstractTextDocumentLayout::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 QAbstractTextDocumentLayout::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 QAbstractTextDocumentLayout::update(const QRectF &)

You can bind a procedure to this signal.

[event] void updateBlock(const QTextBlock block)

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

You can bind a procedure to this signal.