Sming Framework API
Sming - Open Source framework for high efficiency WiFi SoC ESP8266 native development with C++ language.
Public Member Functions | Protected Member Functions | List of all members
NexProgressBar Class Reference
Nextion Component

#include <NexProgressBar.h>

Inheritance diagram for NexProgressBar:
NexObject

Public Member Functions

 NexProgressBar (uint8_t pid, uint8_t cid, const char *name)
 
bool getValue (uint32_t *number)
 
bool setValue (uint32_t number)
 
uint32_t Get_background_color_bco (uint32_t *number)
 
bool Set_background_color_bco (uint32_t number)
 
uint32_t Get_font_color_pco (uint32_t *number)
 
bool Set_font_color_pco (uint32_t number)
 
void printObjInfo (void)
 

Protected Member Functions

uint8_t getObjPid (void)
 
uint8_t getObjCid (void)
 
const char * getObjName (void)
 

Detailed Description

NexProgressBar component.

Constructor & Destructor Documentation

NexProgressBar::NexProgressBar ( uint8_t  pid,
uint8_t  cid,
const char *  name 
)

Constructor.

Parameters
pid- page id.
cid- component id.
name- pointer to an unique name in range of all components.

Member Function Documentation

uint32_t NexProgressBar::Get_background_color_bco ( uint32_t *  number)

Get bco attribute of component

Parameters
number- buffer storing data retur
Returns
the length of the data
uint32_t NexProgressBar::Get_font_color_pco ( uint32_t *  number)

Get pco attribute of component

Parameters
number- buffer storing data retur
Returns
the length of the data
bool NexProgressBar::getValue ( uint32_t *  number)

Get the value of progress bar.

Parameters
number- an output parameter to save the value of porgress bar.
Return values
true- success.
false- failed.
void NexObject::printObjInfo ( void  )
inherited

Print current object'address, page id, component id and name.

Warning
this method does nothing, unless debug message enabled.
bool NexProgressBar::Set_background_color_bco ( uint32_t  number)

Set bco attribute of component

Parameters
number- To set up the data
Returns
true if success, false for failure
bool NexProgressBar::Set_font_color_pco ( uint32_t  number)

Set pco attribute of component

Parameters
number- To set up the data
Returns
true if success, false for failure
bool NexProgressBar::setValue ( uint32_t  number)

Set the value of progress bar.

Parameters
number- the value of progress bar.
Return values
true- success.
false- failed.