iterator Class
class QTextFrame::iteratorThe iterator class provides an iterator for reading the contents of a QTextFrame. More...
- List of all members, including inherited members
- iterator is part of Rich Text Processing APIs.
Public Functions
| iterator() | |
| bool | atEnd() const |
| QTextBlock | currentBlock() const |
| QTextFrame * | currentFrame() const |
| QTextFrame * | parentFrame() const |
| bool | operator!=(const QTextFrame::iterator &other) const |
| QTextFrame::iterator & | operator++() |
| QTextFrame::iterator | operator++(int) |
| QTextFrame::iterator & | operator--() |
| QTextFrame::iterator | operator--(int) |
| bool | operator==(const QTextFrame::iterator &other) const |
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
[constexpr noexcept] iterator::iterator()
Constructs an invalid iterator.
bool iterator::atEnd() const
Returns true if the current item is the last item in the text frame.
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().
QTextFrame *iterator::parentFrame() const
Returns the parent frame of the current frame.
See also currentFrame() and QTextFrame::parentFrame().
bool iterator::operator!=(const QTextFrame::iterator &other) const
Returns true if the iterator is different from the other iterator; otherwise returns false.
QTextFrame::iterator &iterator::operator++()
Moves the iterator to the next frame or block.
See also currentBlock() and currentFrame().
QTextFrame::iterator iterator::operator++(int)
The postfix ++ operator (i++) advances the iterator to the next item in the text frame, and returns an iterator to the old item.
QTextFrame::iterator &iterator::operator--()
Moves the iterator to the previous frame or block.
See also currentBlock() and currentFrame().
QTextFrame::iterator iterator::operator--(int)
The postfix -- operator (i--) makes the preceding item in the current frame, and returns an iterator to the old item.
bool iterator::operator==(const QTextFrame::iterator &other) const
Returns true if the iterator is the same as the other iterator; otherwise returns false.