CopperSpice API  1.9.2
Public Methods | Friends | List of all members
QTextBlock::iterator Class Reference
CsGui

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

Public Methods

 iterator ()
 
 iterator (const iterator &other) = default
 
bool atEnd () const
 
QTextFragment fragment () const
 
bool operator!= (const iterator &other) const
 
iterator & operator++ ()
 
iterator operator++ (int)
 
iterator & operator-- ()
 
iterator operator-- (int)
 
bool operator== (const iterator &other) const
 

Friends

class QTextBlock
 

Detailed Description

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

A block consists of a sequence of text fragments. This class provides a way to iterate over these, and read their contents. It does not provide a way to modify the internal structure or contents of the block.

An iterator can be constructed and used to access the fragments within a text block in the following way:

QTextBlock::iterator it;
for (it = currentBlock.begin(); !(it.atEnd()); ++it) {
QTextFragment currentFragment = it.fragment();
if (currentFragment.isValid())
processFragment(currentFragment);
}
See also
QTextFragment

Constructor & Destructor Documentation

QTextBlock::iterator::iterator ( )
inline

Constructs an iterator for this text block.

QTextBlock::iterator::iterator ( const iterator &  other)
default

Copy constructs a new QTextBlock::iterator from other.

Method Documentation

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

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

QTextFragment QTextBlock::iterator::fragment ( ) const

Returns the text fragment the iterator currently points to.

bool QTextBlock::iterator::operator!= ( const iterator &  other) const
inline

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

iterator & QTextBlock::iterator::operator++ ( )

The prefix ++ operator (++i) advances the iterator to the next item in the hash and returns an iterator to the new current item.

iterator QTextBlock::iterator::operator++ ( int  )
inline

The postfix ++ operator (i++) advances the iterator to the next item in the text block and returns an iterator to the old current item.

iterator & QTextBlock::iterator::operator-- ( )

The prefix – operator (–i) makes the preceding item current and returns an iterator pointing to the new current item.

iterator QTextBlock::iterator::operator-- ( int  )
inline

The postfix – operator (i–) makes the preceding item current and returns an iterator to the old current item.

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

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