OpenXLSX::XLRowDataIterator Class Reference

This class encapsulates a (non-const) iterator, for iterating over the cells in a row. More...

#include <XLRowData.hpp>

Public Types
using	iterator_category = std::forward_iterator_tag
using	value_type = XLCell
using	difference_type = int64_t
using	pointer = XLCell *
using	reference = XLCell &

Public Member Functions
	~XLRowDataIterator ()
	Destructor.
	XLRowDataIterator (const XLRowDataIterator &other)
	Copy constructor.
	XLRowDataIterator (XLRowDataIterator &&other) noexcept
	Move constructor.
XLRowDataIterator &	operator= (const XLRowDataIterator &other)
	Copy assignment operator.
XLRowDataIterator &	operator= (XLRowDataIterator &&other) noexcept
	Move assignment operator.
XLRowDataIterator &	operator++ ()
	Pre-increment of the iterator.
XLRowDataIterator	operator++ (int)
	Post-increment of the iterator.
reference	operator* ()
	Dereferencing operator.
pointer	operator-> ()
	Arrow operator.
bool	operator== (const XLRowDataIterator &rhs) const
	Equality operator.
bool	operator!= (const XLRowDataIterator &rhs) const
	Non-equality operator.

Friends
class	XLRowDataRange

Detailed Description

This class encapsulates a (non-const) iterator, for iterating over the cells in a row.

Todo:

Consider implementing a const iterator also

Member Typedef Documentation

difference_type

using OpenXLSX::XLRowDataIterator::difference_type = int64_t

iterator_category

using OpenXLSX::XLRowDataIterator::iterator_category = std::forward_iterator_tag

pointer

using OpenXLSX::XLRowDataIterator::pointer = XLCell*

reference

using OpenXLSX::XLRowDataIterator::reference = XLCell&

value_type

using OpenXLSX::XLRowDataIterator::value_type = XLCell

Constructor & Destructor Documentation

~XLRowDataIterator()

OpenXLSX::XLRowDataIterator::~XLRowDataIterator ( )

default

Destructor.

XLRowDataIterator() [1/2]

OpenXLSX::XLRowDataIterator::XLRowDataIterator

(

const XLRowDataIterator &

other

)

Copy constructor.

Parameters

other

Object to be copied.

XLRowDataIterator() [2/2]

OpenXLSX::XLRowDataIterator::XLRowDataIterator ( XLRowDataIterator &&  other )

defaultnoexcept

Move constructor.

Parameters

other

Object to be moved.

Member Function Documentation

operator!=()

bool OpenXLSX::XLRowDataIterator::operator!=

(

const XLRowDataIterator &

rhs

)

const

Non-equality operator.

Parameters

rhs	XLRowDataIterator to compare to.

Returns

false if equal, otherwise true.

operator*()

XLCell & OpenXLSX::XLRowDataIterator::operator*

(

)

Dereferencing operator.

Returns

Reference to the object pointed to by the iterator.

operator++() [1/2]

XLRowDataIterator & OpenXLSX::XLRowDataIterator::operator++

(

)

Pre-increment of the iterator.

Returns

Reference to the iterator object.

operator++() [2/2]

XLRowDataIterator OpenXLSX::XLRowDataIterator::operator++

(

int

)

Post-increment of the iterator.

Returns

Reference to the iterator object.

operator->()

XLRowDataIterator::pointer OpenXLSX::XLRowDataIterator::operator->

(

)

Arrow operator.

Returns

Pointer to the object pointed to by the iterator.

operator=() [1/2]

XLRowDataIterator & OpenXLSX::XLRowDataIterator::operator=

(

const XLRowDataIterator &

other

)

Copy assignment operator.

Parameters

other

Object to be copied.

Returns

Reference to the copied-to object.

operator=() [2/2]

XLRowDataIterator & OpenXLSX::XLRowDataIterator::operator= ( XLRowDataIterator &&  other )

defaultnoexcept

Move assignment operator.

Parameters

other

Object to be moved.

Returns

Reference to the moved-to object.

operator==()

bool OpenXLSX::XLRowDataIterator::operator==

(

const XLRowDataIterator &

rhs

)

const

Equality operator.

Parameters

rhs	XLRowDataIterator to compare to.

Returns

true if equal, otherwise false.

Friends And Related Symbol Documentation

XLRowDataRange

friend class XLRowDataRange

friend

---

The documentation for this class was generated from the following files:

• /home/runner/work/OpenXLSX-NX/OpenXLSX-NX/OpenXLSX/headers/XLRowData.hpp
• /home/runner/work/OpenXLSX-NX/OpenXLSX-NX/OpenXLSX/sources/XLRowData.cpp