SmoothProgress 1.0.0
Displays smooth progress bars on a character based LCD displays for Arduino
BarPos Class Reference

Class defining the position and the size of the progress bar on the display More...

#include <SmoothProgress.h>

Inheritance diagram for BarPos:
ProgressBar< DISP >

Classes

struct  ProgBarPar
 

Public Member Functions

 BarPos (byte _len, byte _col, byte _row, byte _id=0)
 Constructs the BarPos object representing the position and the size of the progress bar on the display More...
 
void setLength (int _len)
 Sets the length of the progress bar More...
 
int getLength () const
 Gets the length of the progress bar (in characters) More...
 
void setPosition (byte _col, byte _row)
 Sets the position of the progress bar on the display the row and the column represents the position of the start character of the progress bar (leftmost of the horizontal progress bar and the bottom one on a vertical progress bar) More...
 
uint8_t col () const
 Returns the position of the progress bar on the display More...
 
uint8_t row () const
 Returns the position of the progress bar on the display More...
 

Protected Attributes

struct BarPos::ProgBarPar par
 

Detailed Description

Class defining the position and the size of the progress bar on the display

Constructor & Destructor Documentation

◆ BarPos()

BarPos::BarPos ( byte  _len,
byte  _col,
byte  _row,
byte  _id = 0 
)
inline

Constructs the BarPos object representing the position and the size of the progress bar on the display

Parameters
_lenlength of the progress bar in characters
_rowthe row in which the progress bar starts
_colthe column in which the progress bar starts
_idid of the progress bar 0-4 (as at most 4 can be supported simultaneously)

Member Function Documentation

◆ col()

uint8_t BarPos::col ( ) const
inline

Returns the position of the progress bar on the display

Returns
the column of the progress bar

◆ getLength()

int BarPos::getLength ( ) const
inline

Gets the length of the progress bar (in characters)

Returns
the length of the progress bar in characters

◆ row()

uint8_t BarPos::row ( ) const
inline

Returns the position of the progress bar on the display

Returns
the row of the progress bar

◆ setLength()

void BarPos::setLength ( int  _len)
inline

Sets the length of the progress bar

Parameters
_lenlength of the progress bar in characters

◆ setPosition()

void BarPos::setPosition ( byte  _col,
byte  _row 
)
inline

Sets the position of the progress bar on the display the row and the column represents the position of the start character of the progress bar (leftmost of the horizontal progress bar and the bottom one on a vertical progress bar)

Parameters
_rowthe row in which the progress bar starts
_colthe column in which the progress bar starts

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