iterator#
The iterator class provides an iterator for reading the contents of a QTextFrame . More…
Synopsis#
Functions#
def
__iter__()def
__next__()def
atEnd()def
currentBlock()def
currentFrame()def
__ne__(o)def
__iadd__()def
__iadd__(arg__1)def
__isub__()def
__isub__(arg__1)def
__eq__(o)def
parentFrame()
Note
This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE
Detailed Description#
A frame consists of an arbitrary sequence of QTextBlock s and child 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 PySide6.QtGui.QTextFrame.iterator#
Constructs an invalid iterator.
- PySide6.QtGui.QTextFrame.iterator.__iter__()#
- Return type:
object
- PySide6.QtGui.QTextFrame.iterator.__next__()#
- Return type:
object
- PySide6.QtGui.QTextFrame.iterator.atEnd()#
- Return type:
bool
Returns true if the current item is the last item in the text frame.
- PySide6.QtGui.QTextFrame.iterator.currentBlock()#
- Return type:
Returns the current block the iterator points to. If the iterator points to a child frame, the returned block is invalid.
See also
currentFrame()
- PySide6.QtGui.QTextFrame.iterator.currentFrame()#
- Return type:
Returns the current frame pointed to by the iterator, or None if the iterator currently points to a block.
See also
currentBlock()
- PySide6.QtGui.QTextFrame.iterator.__ne__(o)#
- Parameters:
- Return type:
bool
Returns true if the iterator is different from the other iterator; otherwise returns false.
- PySide6.QtGui.QTextFrame.iterator.__iadd__()#
- Return type:
Moves the iterator to the next frame or block.
See also
currentBlock()currentFrame()
- PySide6.QtGui.QTextFrame.iterator.__iadd__(arg__1)
- Parameters:
arg__1 – int
- Return type:
The postfix ++ operator (i++) advances the iterator to the next item in the text frame, and returns an iterator to the old item.
- PySide6.QtGui.QTextFrame.iterator.__isub__()#
- Return type:
Moves the iterator to the previous frame or block.
See also
currentBlock()currentFrame()
- PySide6.QtGui.QTextFrame.iterator.__isub__(arg__1)
- Parameters:
arg__1 – int
- Return type:
The postfix -- operator (i--) makes the preceding item in the current frame, and returns an iterator to the old item.
- PySide6.QtGui.QTextFrame.iterator.__eq__(o)#
- Parameters:
- Return type:
bool
Returns true if the iterator is the same as the other iterator; otherwise returns false.
- PySide6.QtGui.QTextFrame.iterator.parentFrame()#
- Return type:
Returns the parent frame of the current frame.
See also
currentFrame()parentFrame()