QTextFrame.iterator

Synopsis

Functions

• def __eq__ (o)
• def __iter__ ()
• def __ne__ (o)
• def __next__ ()
• def atEnd ()
• def currentBlock ()
• def currentFrame ()
• def operator++ (arg__1)
• def operator-- (arg__1)
• def parentFrame ()

Detailed Description

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

A frame consists of an arbitrary sequence of PySide.QtGui.QTextBlock s and child PySide.QtGui.QTextFrame s. 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.

class PySide.QtGui.QTextFrame.iterator

class PySide.QtGui.QTextFrame.iterator(o)

Parameters:o – PySide.QtGui.QTextFrame::iterator

Constructs an invalid iterator.

Copy constructor. Constructs a copy of the other iterator.

PySide.QtGui.QTextFrame.iterator.__iter__()

Return type:PyObject

PySide.QtGui.QTextFrame.iterator.__next__()

Return type:PyObject

PySide.QtGui.QTextFrame.iterator.atEnd()

Return type:PySide.QtCore.bool

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

PySide.QtGui.QTextFrame.iterator.currentBlock()

Return type:PySide.QtGui.QTextBlock

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

See also

currentFrame()

PySide.QtGui.QTextFrame.iterator.currentFrame()

Return type:PySide.QtGui.QTextFrame

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

See also

currentBlock()

PySide.QtGui.QTextFrame.iterator.__ne__(o)

Parameters:o – PySide.QtGui.QTextFrame::iterator Return type:PySide.QtCore.bool

Retuns true if the iterator is different from the other iterator; otherwise returns false.

PySide.QtGui.QTextFrame.iterator.operator++(arg__1)

Parameters:arg__1 – PySide.QtCore.int Return type:PySide.QtGui.QTextFrame::iterator

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

PySide.QtGui.QTextFrame.iterator.operator--(arg__1)

Parameters:arg__1 – PySide.QtCore.int Return type:PySide.QtGui.QTextFrame::iterator

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

PySide.QtGui.QTextFrame.iterator.__eq__(o)

Parameters:o – PySide.QtGui.QTextFrame::iterator Return type:PySide.QtCore.bool

Retuns true if the iterator is the same as the other iterator; otherwise returns false.

PySide.QtGui.QTextFrame.iterator.parentFrame()

Return type:PySide.QtGui.QTextFrame

Returns the parent frame of the current frame.

See also

currentFrame() QTextFrame.parentFrame()