|
xlnt - community edition
|
A cell vector is a linear (1D) range of cells, either vertical or horizontal depending on the major order specified in the constructor. More...
#include <cell_vector.hpp>
Public Types | |
| using | iterator = cell_iterator |
| Iterate over cells in a cell_vector with an iterator of this type. More... | |
| using | const_iterator = const_cell_iterator |
| Iterate over const cells in a const cell_vector with an iterator of this type. More... | |
| using | reverse_iterator = std::reverse_iterator< iterator > |
| Iterate over cells in a cell_vector in reverse oreder with an iterator of this type. More... | |
| using | const_reverse_iterator = std::reverse_iterator< const_iterator > |
| Iterate over const cells in a const cell_vector in reverse order with an iterator of this type. More... | |
Public Member Functions | |
| cell_vector (worksheet ws, const cell_reference &cursor, const range_reference &ref, major_order order, bool skip_null, bool wrap) | |
| Constructs a cell vector pointing to a given range in a given worksheet. order determines whether this vector is a row or a column. If skip_null is true, iterating over this vector will skip empty cells. More... | |
| bool | empty () const |
| Returns true if every cell in this vector is null (i.e. the cell doesn't exist in the worksheet). More... | |
| cell | front () |
| Returns a wrapper pointing to the first cell in this vector. More... | |
| const cell | front () const |
| Returns a wrapper pointing to the first cell in this vector. More... | |
| cell | back () |
| Returns a wrapper pointing to the last cell in this vector. More... | |
| const cell | back () const |
| Returns a wrapper pointing to the last cell in this vector. More... | |
| std::size_t | length () const |
| Returns the distance between the first and last cells in this vector. More... | |
| iterator | begin () |
| Returns an iterator to the first cell in this vector. More... | |
| iterator | end () |
| Returns an iterator to a cell one-past-the-end of this vector. More... | |
| const_iterator | begin () const |
| Returns an iterator to the first cell in this vector. More... | |
| const_iterator | cbegin () const |
| Returns an iterator to the first cell in this vector. More... | |
| const_iterator | end () const |
| Returns an iterator to a cell one-past-the-end of this vector. More... | |
| const_iterator | cend () const |
| Returns an iterator to a cell one-past-the-end of this vector. More... | |
| reverse_iterator | rbegin () |
| Returns a reverse iterator to the first cell of this reversed vector. More... | |
| reverse_iterator | rend () |
| Returns a reverse iterator to to a cell one-past-the-end of this reversed vector. More... | |
| const_reverse_iterator | rbegin () const |
| Returns a reverse iterator to the first cell of this reversed vector. More... | |
| const_reverse_iterator | rend () const |
| Returns a reverse iterator to to a cell one-past-the-end of this reversed vector. More... | |
| const_reverse_iterator | crbegin () const |
| Returns a reverse iterator to the first cell of this reversed vector. More... | |
| const_reverse_iterator | crend () const |
| Returns a reverse iterator to to a cell one-past-the-end of this reversed vector. More... | |
| cell | operator[] (std::size_t column_index) |
| Returns a wrapper pointing to the cell column_index distance away from the first cell in this vector. If the cell at the given column index doesn't exist (please call length() to check), an empty cell will be created, added to the worksheet, and returned. More... | |
| const cell | operator[] (std::size_t column_index) const |
| Returns a wrapper pointing to the cell column_index distance away from the first cell in this vector. Assumes that the cell at the given column index exists (please call length() to check). If the cell doesn't exist, an invalid_parameter exception will be thrown. More... | |
A cell vector is a linear (1D) range of cells, either vertical or horizontal depending on the major order specified in the constructor.
Iterate over const cells in a const cell_vector with an iterator of this type.
| using xlnt::cell_vector::const_reverse_iterator = std::reverse_iterator<const_iterator> |
Iterate over const cells in a const cell_vector in reverse order with an iterator of this type.
Iterate over cells in a cell_vector with an iterator of this type.
| using xlnt::cell_vector::reverse_iterator = std::reverse_iterator<iterator> |
Iterate over cells in a cell_vector in reverse oreder with an iterator of this type.
| xlnt::cell_vector::cell_vector | ( | worksheet | ws, |
| const cell_reference & | cursor, | ||
| const range_reference & | ref, | ||
| major_order | order, | ||
| bool | skip_null, | ||
| bool | wrap | ||
| ) |
Constructs a cell vector pointing to a given range in a given worksheet. order determines whether this vector is a row or a column. If skip_null is true, iterating over this vector will skip empty cells.
| cell xlnt::cell_vector::back | ( | ) |
Returns a wrapper pointing to the last cell in this vector.
| const cell xlnt::cell_vector::back | ( | ) | const |
Returns a wrapper pointing to the last cell in this vector.
| iterator xlnt::cell_vector::begin | ( | ) |
Returns an iterator to the first cell in this vector.
| const_iterator xlnt::cell_vector::begin | ( | ) | const |
Returns an iterator to the first cell in this vector.
| const_iterator xlnt::cell_vector::cbegin | ( | ) | const |
Returns an iterator to the first cell in this vector.
| const_iterator xlnt::cell_vector::cend | ( | ) | const |
Returns an iterator to a cell one-past-the-end of this vector.
| const_reverse_iterator xlnt::cell_vector::crbegin | ( | ) | const |
Returns a reverse iterator to the first cell of this reversed vector.
| const_reverse_iterator xlnt::cell_vector::crend | ( | ) | const |
Returns a reverse iterator to to a cell one-past-the-end of this reversed vector.
| bool xlnt::cell_vector::empty | ( | ) | const |
Returns true if every cell in this vector is null (i.e. the cell doesn't exist in the worksheet).
| iterator xlnt::cell_vector::end | ( | ) |
Returns an iterator to a cell one-past-the-end of this vector.
| const_iterator xlnt::cell_vector::end | ( | ) | const |
Returns an iterator to a cell one-past-the-end of this vector.
| cell xlnt::cell_vector::front | ( | ) |
Returns a wrapper pointing to the first cell in this vector.
| const cell xlnt::cell_vector::front | ( | ) | const |
Returns a wrapper pointing to the first cell in this vector.
| std::size_t xlnt::cell_vector::length | ( | ) | const |
Returns the distance between the first and last cells in this vector.
| cell xlnt::cell_vector::operator[] | ( | std::size_t | column_index | ) |
Returns a wrapper pointing to the cell column_index distance away from the first cell in this vector. If the cell at the given column index doesn't exist (please call length() to check), an empty cell will be created, added to the worksheet, and returned.
| const cell xlnt::cell_vector::operator[] | ( | std::size_t | column_index | ) | const |
Returns a wrapper pointing to the cell column_index distance away from the first cell in this vector. Assumes that the cell at the given column index exists (please call length() to check). If the cell doesn't exist, an invalid_parameter exception will be thrown.
| reverse_iterator xlnt::cell_vector::rbegin | ( | ) |
Returns a reverse iterator to the first cell of this reversed vector.
| const_reverse_iterator xlnt::cell_vector::rbegin | ( | ) | const |
Returns a reverse iterator to the first cell of this reversed vector.
| reverse_iterator xlnt::cell_vector::rend | ( | ) |
Returns a reverse iterator to to a cell one-past-the-end of this reversed vector.
| const_reverse_iterator xlnt::cell_vector::rend | ( | ) | const |
Returns a reverse iterator to to a cell one-past-the-end of this reversed vector.
1.8.13