Struct Iterator

#[repr(C)]
pub struct Iterator { /* private fields */ }

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

C++ class: QTextFrame::iterator.

C++ documentation:

The 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.

Implementations

impl Iterator

pub unsafe fn at_end(&self) -> bool

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

Calls C++ function: bool QTextFrame::iterator::atEnd() const.

C++ documentation:

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

pub unsafe fn copy_from(&self, o: impl CastInto<Ref<Iterator>>) -> Ref<Iterator>

Assigns other to this iterator and returns a reference to this iterator.

Calls C++ function: QTextFrame::iterator& QTextFrame::iterator::operator=(const QTextFrame::iterator& o).

C++ documentation:

Assigns other to this iterator and returns a reference to this iterator.

pub unsafe fn current_block(&self) -> CppBox<QTextBlock>

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

Calls C++ function: QTextBlock QTextFrame::iterator::currentBlock() const.

C++ documentation:

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

See also currentFrame().

pub unsafe fn current_frame(&self) -> QPtr<QTextFrame>

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

Calls C++ function: QTextFrame* QTextFrame::iterator::currentFrame() const.

C++ documentation:

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

See also currentBlock().

pub unsafe fn dec(&self) -> Ref<Iterator>

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

Calls C++ function: QTextFrame::iterator& QTextFrame::iterator::operator--().

C++ documentation:

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

pub unsafe fn dec_postfix(&self, arg1: c_int) -> CppBox<Iterator>

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

Calls C++ function: QTextFrame::iterator QTextFrame::iterator::operator--(int arg1).

C++ documentation:

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

pub unsafe fn inc(&self) -> Ref<Iterator>

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

Calls C++ function: QTextFrame::iterator& QTextFrame::iterator::operator++().

C++ documentation:

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

pub unsafe fn inc_postfix(&self, arg1: c_int) -> CppBox<Iterator>

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

Calls C++ function: QTextFrame::iterator QTextFrame::iterator::operator++(int arg1).

C++ documentation:

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

pub unsafe fn new() -> CppBox<Iterator>

Constructs an invalid iterator.

Calls C++ function: [constructor] void QTextFrame::iterator::iterator().

C++ documentation:

Constructs an invalid iterator.

pub unsafe fn new_copy(o: impl CastInto<Ref<Iterator>>) -> CppBox<Iterator>

Copy constructor. Constructs a copy of the other iterator.

Calls C++ function: [constructor] void QTextFrame::iterator::iterator(const QTextFrame::iterator& o).

C++ documentation:

Copy constructor. Constructs a copy of the other iterator.

pub unsafe fn parent_frame(&self) -> QPtr<QTextFrame>

Returns the parent frame of the current frame.

Calls C++ function: QTextFrame* QTextFrame::iterator::parentFrame() const.

C++ documentation:

Returns the parent frame of the current frame.

See also currentFrame() and QTextFrame::parentFrame().

Trait Implementations

impl CppDeletable for Iterator

unsafe fn delete(&self)

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

Calls C++ function: [destructor] void QTextFrame::iterator::~iterator().

C++ documentation:

The 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.

impl Decrement for Iterator

unsafe fn dec(&self) -> Ref<Iterator>

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

Calls C++ function: QTextFrame::iterator& QTextFrame::iterator::operator--().

C++ documentation:

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

type Output = Ref<Iterator>

Output type.

impl Increment for Iterator

unsafe fn inc(&self) -> Ref<Iterator>

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

Calls C++ function: QTextFrame::iterator& QTextFrame::iterator::operator++().

C++ documentation:

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

type Output = Ref<Iterator>

Output type.

impl PartialEq<Ref<Iterator>> for Iterator

fn eq(&self, o: &Ref<Iterator>) -> bool

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

Calls C++ function: bool QTextFrame::iterator::operator==(const QTextFrame::iterator& o) const.

C++ documentation:

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

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.