API reference - Class QTextObjectInterface

Notation used in Ruby API documentation

Description: Binding of QTextObjectInterface

Class hierarchy: QTextObjectInterface

Public constructors

new QTextObjectInterfacenewConstructor QTextObjectInterface::QTextObjectInterface()

Public methods

[const]voidassign(const QTextObjectInterface other)Assign the contents of another object to self
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[virtual]voiddrawObject(QPainter ptr painter,
const QRectF rect,
QTextDocument ptr doc,
int posInDocument,
const QTextFormat format)
Virtual method void QTextObjectInterface::drawObject(QPainter *painter, const QRectF &rect, QTextDocument *doc, int posInDocument, const QTextFormat &format)
[const]QTextObjectInterfacedupCreates a copy of self
[virtual]QSizeFintrinsicSize(QTextDocument ptr doc,
int posInDocument,
const QTextFormat format)
Virtual method QSizeF QTextObjectInterface::intrinsicSize(QTextDocument *doc, int posInDocument, const QTextFormat &format)
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference

Detailed description

[const] void assign(const QTextObjectInterface other)

Description: Assign the contents of another object to self

This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.

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

[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 drawObject(QPainter ptr painter,const QRectF rect,QTextDocument ptr doc,int posInDocument,const QTextFormat format)

Description: Virtual method void QTextObjectInterface::drawObject(QPainter *painter, const QRectF &rect, QTextDocument *doc, int posInDocument, const QTextFormat &format)

This method can be reimplemented in a derived class.

[const] QTextObjectInterface dup

Description: Creates a copy of self

[virtual] QSizeF intrinsicSize(QTextDocument ptr doc,int posInDocument,const QTextFormat format)

Description: Virtual method QSizeF QTextObjectInterface::intrinsicSize(QTextDocument *doc, int posInDocument, const QTextFormat &format)

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 QTextObjectInterface new

Description: Constructor QTextObjectInterface::QTextObjectInterface()

This method creates an object of class QTextObjectInterface.