iterator Class

Class iterator is declared in class QTextFrame.

The iterator class provides an iterator for reading the contents of a QTextFrame. More...

Public Functions

iterator(const iterator &other)
iterator()
iterator &operator=(const iterator &other)
QTextBlock currentBlock() const
QTextFrame *currentFrame() const
iterator &operator++()
iterator &operator--()

Detailed Description

A frame consists of an arbitrary sequence of QTextBlocks and child QTextFrames. This class provides a way to iterate over the child objects of a frame, and read their contents. It does not provide a way to modify the contents of the frame.

Member Function Documentation

iterator::iterator(const iterator &other)

Copy constructor. Constructs a copy of the other iterator.

iterator::iterator()

Constructs an invalid iterator.

iterator &iterator::operator=(const iterator &other)

Assigns other to this iterator and returns a reference to this iterator.

QTextBlock iterator::currentBlock() const

Returns the current block the iterator points to. If the iterator points to a child frame, the returned block is invalid.

See also currentFrame().

QTextFrame *iterator::currentFrame() const

Returns the current frame pointed to by the iterator, or nullptr if the iterator currently points to a block.

See also currentBlock().

iterator &iterator::operator++()

Moves the iterator to the next frame or block.

See also currentBlock() and currentFrame().

iterator &iterator::operator--()

Moves the iterator to the previous frame or block.

See also currentBlock() and currentFrame().