API
For Arduino developers
Public Member Functions | List of all members
NexButton Class Reference

NexButton,subclass of NexTouch,provides simple methods to control button component. More...

#include <NexButton.h>

Inheritance diagram for NexButton:
NexTouch

Public Member Functions

 NexButton (NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL)
 Constructor,inherited NexTouch's constructor function.
 
void attachPop (NexTouchEventCb pop, void *ptr=NULL)
 Register button pop callback function. More...
 
void detachPop (void)
 Unload button pop callback function.
 
uint16_t getText (char *buffer, uint16_t len)
 Get text value from button component. More...
 
bool setText (const char *buffer)
 Set text value of button component. More...
 
- Public Member Functions inherited from NexTouch
 NexTouch (NexPid pid, NexCid cid, char *name, NexTouchEventCb pop=NULL, void *pop_ptr=NULL, NexTouchEventCb push=NULL, void *push_ptr=NULL)
 Constructor of Nextouch. More...
 
NexPid getPid (void)
 Get page id. More...
 
NexCid getCid (void)
 Get component id. More...
 
const char * getObjName (void)
 Get component name. More...
 
void print (void)
 Print current object address,page id,component id, component name,pop event function address,push event function address.
 

Additional Inherited Members

- Static Public Member Functions inherited from NexTouch
static uint8_t mainEventLoop (NexTouch **list)
 Watting for Nextion's touch event. More...
 
static void sendCommand (const char *cmd)
 Send command to Nextion. More...
 
static bool recvRetCommandFinished (uint32_t timeout=100)
 Command is executed successfully. More...
 
static uint16_t recvRetString (char *buffer, uint16_t len, uint32_t timeout=500)
 Receive string data. More...
 
static bool recvRetNumber (uint32_t *number, uint32_t timeout=500)
 Receive uint32_t data. More...
 

Detailed Description

NexButton,subclass of NexTouch,provides simple methods to control button component.

Examples:
CompButton.ino, CompPointer.ino, CompProgressBar.ino, and CompText.ino.

Definition at line 25 of file NexButton.h.

Member Function Documentation

void NexButton::attachPop ( NexTouchEventCb  pop,
void *  ptr = NULL 
)

Register button pop callback function.

Parameters
pop- the pointer to button pop callback function.
ptr- the parameter to be transmitted to button pop callback function.
Examples:
CompButton.ino, CompPointer.ino, and CompProgressBar.ino.

Definition at line 70 of file NexButton.cpp.

uint16_t NexButton::getText ( char *  buffer,
uint16_t  len 
)

Get text value from button component.

Parameters
buffer- text buffer.
len- text buffer length.
Returns
the text buffer length
Examples:
CompButton.ino.

Definition at line 35 of file NexButton.cpp.

bool NexButton::setText ( const char *  buffer)

Set text value of button component.

Parameters
buffer- text buffer.
Return values
true- success.
false- failed.
Examples:
CompButton.ino.

Definition at line 53 of file NexButton.cpp.


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