CopperSpice API  2.0.0
Public Methods | Friends | List of all members
QTextFrame::iterator Class Reference
CsGui

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

Public Methods

 iterator ()
 
 iterator (const iterator &other)
 
bool atEnd () const
 
QTextBlock currentBlock () const
 
QTextFrame * currentFrame () const
 
bool operator!= (const iterator &other) const
 
iterator & operator++ ()
 
iterator operator++ (int)
 
iterator & operator-- ()
 
iterator operator-- (int)
 
iterator & operator= (const iterator &other)
 
bool operator== (const iterator &other) const
 
QTextFrame * parentFrame () const
 

Friends

class QTextFrame
 
class QTextTableCell
 

Detailed Description

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

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.

See also
currentFrame()

Constructor & Destructor Documentation

QTextFrame::iterator::iterator ( )

Constructs an invalid iterator.

QTextFrame::iterator::iterator ( const iterator &  other)

Copy constructor. Constructs a copy of the other iterator.

Method Documentation

bool QTextFrame::iterator::atEnd ( ) const
inline

Returns true if the current item is the last item in the text frame.

QTextBlock QTextFrame::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 * QTextFrame::iterator::currentFrame ( ) const

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

See also
currentBlock()
bool QTextFrame::iterator::operator!= ( const iterator &  other) const
inline

Returns true if the iterator is different from the other iterator, otherwise returns false.

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

The prefix ++ operator advances the iterator to the next item in the text frame and returns an iterator to the new current item.

++iter;
See also
currentBlock(), currentFrame()
iterator QTextFrame::iterator::operator++ ( int  )
inline

The postfix ++ operator advances the iterator to the next item in the text frame and returns an iterator to the old item.

iter++;
iterator & QTextFrame::iterator::operator-- ( )

The prefix -- operator decrements the iterator to the previous item in the text frame and returns an iterator to the new current item.

--iter;
See also
currentBlock(), currentFrame()
iterator QTextFrame::iterator::operator-- ( int  )
inline

The postfix -- operator decrements the iterator to the previous item in the text frame and returns an iterator to the old current item.

iter--;
iterator & QTextFrame::iterator::operator= ( const iterator &  other)

Copy assigns from other and returns a reference to this object.

bool QTextFrame::iterator::operator== ( const iterator &  other) const
inline

Returns true if the iterator is the same as the other iterator, otherwise returns false.

QTextFrame * QTextFrame::iterator::parentFrame ( ) const
inline

Returns the parent frame of the current frame.

See also
currentFrame(), QTextFrame::parentFrame()