App::Range Class Reference

The Range class is a spreadsheet range iterator. More...

#include <Range.h>

Public Member Functions

std::string address () const
 Current cell as a string. More...
 
int column () const
 Current column. More...
 
CellAddress from () const
 Position of start of range. More...
 
std::string fromCellString () const
 Start of range as a string. More...
 
bool next ()
 
CellAddress operator* () const
 
 Range (const CellAddress &from, const CellAddress &to)
 
 Range (const char *range)
 
 Range (int _row_begin, int _col_begin, int _row_end, int _col_end)
 
std::string rangeString () const
 The raneg as a string. More...
 
int row () const
 Current row. More...
 
int size () const
 Number of elements in range. More...
 
CellAddress to () const
 Position of end of range. More...
 
std::string toCellString () const
 End of range as a string. More...
 

Detailed Description

The Range class is a spreadsheet range iterator.

It takes a starting (row, col) and an ending (row, col). Notice that ranges are always at least one element. The next() functions is therefore used e.g as follows:

do { ... while (range.next());

Constructor & Destructor Documentation

◆ Range() [1/3]

Range::Range ( const char *  range)

◆ Range() [2/3]

Range::Range ( int  _row_begin,
int  _col_begin,
int  _row_end,
int  _col_end 
)

◆ Range() [3/3]

Range::Range ( const CellAddress from,
const CellAddress to 
)

Member Function Documentation

◆ address()

std::string App::Range::address ( ) const

Current cell as a string.

Referenced by Spreadsheet::SheetPy::set().

◆ column()

int App::Range::column ( ) const

Current column.

◆ from()

CellAddress App::Range::from ( ) const

Position of start of range.

Referenced by Range().

◆ fromCellString()

std::string App::Range::fromCellString ( ) const

Start of range as a string.

◆ next()

◆ operator*()

CellAddress App::Range::operator* ( ) const

◆ rangeString()

std::string App::Range::rangeString ( ) const

The raneg as a string.

◆ row()

int App::Range::row ( ) const

Current row.

◆ size()

int App::Range::size ( ) const

Number of elements in range.

Referenced by PathScripts.PostUtils.GCodeEditorDialog::done().

◆ to()

CellAddress App::Range::to ( ) const

Position of end of range.

Referenced by Range().

◆ toCellString()

std::string App::Range::toCellString ( ) const

End of range as a string.


The documentation for this class was generated from the following files:
  • src/App/Range.h
  • src/App/Range.cpp