API reference - Class QTextFrame_iterator

Notation used in Ruby API documentation

Description: Binding of QTextFrame::iterator

Public constructors

new QTextFrame_iteratornewConstructor QTextFrame::iterator::iterator()
new QTextFrame_iteratornew(const QTextFrame_iterator o)Constructor QTextFrame::iterator::iterator(const QTextFrame::iterator &o)

Public methods

[const]bool!=(const QTextFrame_iterator o)Method bool QTextFrame::iterator::operator!=(const QTextFrame::iterator &o)
QTextFrame_iterator++Method QTextFrame::iterator &QTextFrame::iterator::operator++()
QTextFrame_iterator++(int arg1)Method QTextFrame::iterator QTextFrame::iterator::operator++(int)
QTextFrame_iterator--Method QTextFrame::iterator &QTextFrame::iterator::operator--()
QTextFrame_iterator--(int arg1)Method QTextFrame::iterator QTextFrame::iterator::operator--(int)
[const]bool==(const QTextFrame_iterator o)Method bool QTextFrame::iterator::operator==(const QTextFrame::iterator &o)
QTextFrame_iteratorassign(const QTextFrame_iterator o)Method QTextFrame::iterator &QTextFrame::iterator::operator=(const QTextFrame::iterator &o)
[const]voidassign(const QTextFrame_iterator other)Assign the contents of another object to self
[const]boolatEndMethod bool QTextFrame::iterator::atEnd()
voidcreateEnsures the C++ object is created
[const]QTextBlockcurrentBlockMethod QTextBlock QTextFrame::iterator::currentBlock()
[const]QTextFrame ptrcurrentFrameMethod QTextFrame *QTextFrame::iterator::currentFrame()
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]QTextFrame_iteratordupCreates a copy of self
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]QTextFrame ptrparentFrameMethod QTextFrame *QTextFrame::iterator::parentFrame()

Detailed description

[const] bool !=(const QTextFrame_iterator o)

Description: Method bool QTextFrame::iterator::operator!=(const QTextFrame::iterator &o)

QTextFrame_iterator ++

Description: Method QTextFrame::iterator &QTextFrame::iterator::operator++()

QTextFrame_iterator ++(int arg1)

Description: Method QTextFrame::iterator QTextFrame::iterator::operator++(int)

QTextFrame_iterator --

Description: Method QTextFrame::iterator &QTextFrame::iterator::operator--()

QTextFrame_iterator --(int arg1)

Description: Method QTextFrame::iterator QTextFrame::iterator::operator--(int)

[const] bool ==(const QTextFrame_iterator o)

Description: Method bool QTextFrame::iterator::operator==(const QTextFrame::iterator &o)

QTextFrame_iterator assign(const QTextFrame_iterator o)

Description: Method QTextFrame::iterator &QTextFrame::iterator::operator=(const QTextFrame::iterator &o)

[const] void assign(const QTextFrame_iterator 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.

[const] bool atEnd

Description: Method bool QTextFrame::iterator::atEnd()

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.

[const] QTextBlock currentBlock

Description: Method QTextBlock QTextFrame::iterator::currentBlock()

[const] QTextFrame ptr currentFrame

Description: Method QTextFrame *QTextFrame::iterator::currentFrame()

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.

[const] QTextFrame_iterator dup

Description: Creates a copy of self

[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 QTextFrame_iterator new

Description: Constructor QTextFrame::iterator::iterator()

This method creates an object of class QTextFrame::iterator.

[static] new QTextFrame_iterator new(const QTextFrame_iterator o)

Description: Constructor QTextFrame::iterator::iterator(const QTextFrame::iterator &o)

This method creates an object of class QTextFrame::iterator.

[const] QTextFrame ptr parentFrame

Description: Method QTextFrame *QTextFrame::iterator::parentFrame()