Previous topic
Next topic
iterator¶
The iterator class provides an iterator for reading the contents of a QTextFrame . More…
Synopsis¶
Functions¶
def
__eq__(o)def
__iter__()def
__ne__(o)def
__next__()def
atEnd()def
currentBlock()def
currentFrame()def
operator++()def
operator++(arg__1)def
operator--()def
operator--(arg__1)def
parentFrame()
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¶
PySide6.QtGui.QTextFrame.iterator(iterator)
- Parameters
iterator –
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.operator++()
- Return type
Moves the iterator to the next frame or block.
See also
currentBlock()currentFrame()
- PySide6.QtGui.QTextFrame.iterator.operator++(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.operator--()
- Return type
Moves the iterator to the previous frame or block.
See also
currentBlock()currentFrame()
- PySide6.QtGui.QTextFrame.iterator.operator--(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()
© 2022 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.