Class representing a smooth progress bar
More...
#include <SmoothProgress.h>
|
| ProgressBar (DISP &disp, byte _width, byte _col, byte _row, byte _pbn=0) |
| Creates horizontal ProgressBar object More...
|
|
unsigned int | size () const |
| Returns the size of the progress bar in pixels (height for vertical, width for horizontal) More...
|
|
void | showProgress (int val) |
| Draws the progress bar on the LCD display More...
|
|
void | showProgressPct (int val) |
| Draws the progress bar on the LCD display More...
|
|
| 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...
|
|
|
void | showProg (int val, byte n) |
| Draws the horizontal progress bar on the LCD display More...
|
|
template<class DISP>
class ProgressBar< DISP >
Class representing a smooth progress bar
- Template Parameters
-
◆ ProgressBar()
Creates horizontal ProgressBar object
- Template Parameters
-
DISP | the display on which it will be shown |
len | the length of the progress bar in characters, has to be 2 or more |
row | position: the row of the start end of the progress bar |
col | position: the column of the start end of the progress bar |
id | the id of the progress bar (4 supported: 0-3) |
◆ showProg()
Draws the horizontal progress bar on the LCD display
- Parameters
-
val | at what extent it is filled in pixels |
n | the id of the progress bar : 0-3 |
◆ showProgress()
Draws the progress bar on the LCD display
- Parameters
-
val | at what extent it is filled (left to right) in pixels : 0 to (including) size() |
The progress bar is "drawn" printing over all the characters occupied by the progress bar on every call< / remarks>
◆ showProgressPct()
Draws the progress bar on the LCD display
- Parameters
-
val | at what extent it is filled (left to right) in percents : 0 to 100 |
The progress bar is "drawn" printing over all the characters occupied by the progress bar on every call< / remarks>
◆ size()
Returns the size of the progress bar in pixels (height for vertical, width for horizontal)
- Returns
- the size of the progress bar in pixels (to be filled - without the possible frame and he margin)
The documentation for this class was generated from the following file: