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

API reference - Class QTextFrame

Notation used in Ruby API documentation

Description: Binding of QTextFrame

Class hierarchy: QTextFrame » QTextObject » QObject

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

Public constructors

Public methods

Public static methods and constants

Protected methods (static, non-static and constructors)

Detailed description

[virtual] void childEvent(QChildEvent ptr arg1)

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

This method can be reimplemented in a derived class.

[const] QTextFrame ptr[] childFrames

Description: Method QList<QTextFrame *> QTextFrame::childFrames()

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 QTextFrame::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 QTextFrame::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 QTextFrame::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

[virtual] bool event(QEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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

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

This method can be reimplemented in a derived class.

[const] QTextCursor firstCursorPosition

Description: Method QTextCursor QTextFrame::firstCursorPosition()

[const] int firstPosition

Description: Method int QTextFrame::firstPosition()

[const] QTextFrameFormat frameFormat

Description: Method QTextFrameFormat QTextFrame::frameFormat()

void frameFormat=(const QTextFrameFormat format)

Description: Method void QTextFrame::setFrameFormat(const QTextFrameFormat &format)

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

[const] QTextCursor lastCursorPosition

Description: Method QTextCursor QTextFrame::lastCursorPosition()

[const] int lastPosition

Description: Method int QTextFrame::lastPosition()

[static] new QTextFrame new(QTextDocument ptr doc)

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

This method creates an object of class QTextFrame.

[const] QTextFrame ptr parentFrame

Description: Method QTextFrame *QTextFrame::parentFrame()

[const] int receivers(string signal)

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

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

[const] QObject ptr sender

Description: Method QObject *QTextFrame::sender()

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

void setFormat(const QTextFormat format)

Description: Method void QTextFrame::setFormat(const QTextFormat &format)

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

void setFrameFormat(const QTextFrameFormat format)

Description: Method void QTextFrame::setFrameFormat(const QTextFrameFormat &format)

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[virtual] void timerEvent(QTimerEvent ptr arg1)

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

This method can be reimplemented in a derived class.

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

Description: Static method QString QTextFrame::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 QTextFrame::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 QTextFrame::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 QTextFrame::trUtf8(const char *s, const char *c, int n)

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