# memberdef

refid: a5ba1f74aa94b41b98172e42583ee13d6
name: getText
definition: uint16_t NexButton::getText
type: uint16_t
argsstring: (char *buffer, uint16_t len)
scope: NexButton
briefdescription: Get text attribute of component.
detaileddescription:
@param buffer - buffer storing text returned. 
@param len - length of buffer. 
@return The real length of text returned. 


refid: a19f824bea045bab4cc1afc5950259247
name: Get_background_crop_picc
definition: bool NexCrop::Get_background_crop_picc
type: bool
argsstring: (uint32_t *number)
scope: NexCrop
briefdescription: Get the number of picture.
detaileddescription:
@param number - an output parameter to save the number of picture. 

@retval true - success. 
@retval false - failed. 


refid: aeea8933513ebba11584ad97f8c8b5e69
name: getValue
definition: bool NexGauge::getValue
type: bool
argsstring: (uint32_t *number)
scope: NexGauge
briefdescription: Get the value of gauge.
detaileddescription:
@param number - an output parameter to save gauge's value.

@retval true - success. 
@retval false - failed. 


refid: ab15aadb9c91d9690786d8d25d12d94e1
name: NexObject
definition: NexObject::NexObject
argsstring: (uint8_t pid, uint8_t cid, const char *name)
scope: NexObject
briefdescription: Constructor.
detaileddescription:
@param pid - page id. 
@param cid - component id.    
@param name - pointer to an unique name in range of all components. 


refid: a0297c4a9544df9b0c37db0ea894d699f
name: Get_background_image_pic
definition: bool NexPicture::Get_background_image_pic
type: bool
argsstring: (uint32_t *number)
scope: NexPicture
briefdescription: Get picture's number.
detaileddescription:
@param number - an output parameter to save picture number.  

@retval true - success. 
@retval false - failed. 


refid: a3e5eb13b2aa014c8f6a9e16439917bf2
name: getValue
definition: bool NexProgressBar::getValue
type: bool
argsstring: (uint32_t *number)
scope: NexProgressBar
briefdescription: Get the value of progress bar.
detaileddescription:
@param number - an output parameter to save the value of porgress bar.  

@retval true - success. 
@retval false - failed. 


refid: a384d5488b421efd6affbfd32f45bb107
name: getValue
definition: bool NexSlider::getValue
type: bool
argsstring: (uint32_t *number)
scope: NexSlider
briefdescription: Get the value of slider.
detaileddescription:
@param number - an output parameter to save the value of slider.  

@retval true - success. 
@retval false - failed. 


refid: ae6f1ae95ef40b8bc6f482185b1ec5175
name: attachTimer
definition: void NexTimer::attachTimer
type: void
argsstring: (NexTouchEventCb timer, void *ptr=NULL)
scope: NexTimer
briefdescription: Attach an callback function of timer respond event.
detaileddescription:
@param timer - callback called with ptr when a timer respond event occurs. 
@param ptr - parameter passed into push[default:NULL]. 
@return none. 

@note If calling this method multiply, the last call is valid. 


refid: afd95e7490e28e2a36437be608f26b40e
name: getCycle
definition: bool NexTimer::getCycle
type: bool
argsstring: (uint32_t *number)
scope: NexTimer
briefdescription: Get the value of timer cycle val.
detaileddescription:
@param number - an output parameter to save the value of timer cycle.  

@retval true - success. 
@retval false - failed. 


refid: acf20f76949ed43f05b1c33613dabcb01
name: setCycle
definition: bool NexTimer::setCycle
type: bool
argsstring: (uint32_t number)
scope: NexTimer
briefdescription: Set the value of timer cycle val.
detaileddescription:
@param number - the value of timer cycle.  

@retval true - success. 
@retval false - failed. 

@warning  the cycle value must be greater than 50.


refid: a685a753aae5eb9fb9866a7807a310132
name: attachPush
definition: void NexTouch::attachPush
type: void
argsstring: (NexTouchEventCb push, void *ptr=NULL)
scope: NexTouch
briefdescription: Attach an callback function of push touch event.
detaileddescription:
@param push - callback called with ptr when a push touch event occurs. 
@param ptr - parameter passed into push[default:NULL]. 
@return none. 

@note If calling this method multiply, the last call is valid. 


refid: a4da1c4fcdfadb7eabfb9ccaba9ecad11
name: attachPop
definition: void NexTouch::attachPop
type: void
argsstring: (NexTouchEventCb pop, void *ptr=NULL)
scope: NexTouch
briefdescription: Attach an callback function of pop touch event.
detaileddescription:
@param pop - callback called with ptr when a pop touch event occurs. 
@param ptr - parameter passed into pop[default:NULL]. 
@return none. 

@note If calling this method multiply, the last call is valid. 


refid: a017c25b02bc9a674ab5beb447a3511a0
name: NexUpload
definition: NexUpload::NexUpload
argsstring: (const char *file_name, const uint8_t SD_chip_select, uint32_t download_baudrate)
scope: NexUpload
briefdescription: Constructor.
detaileddescription:
@param file_name - tft file name. 
@param SD_chip_select - sd chip select pin.
@download_baudrate - set download baudrate.


refid: a5b04ea7397b784947b845e2a03fc77e4
name: addValue
definition: bool NexWaveform::addValue
type: bool
argsstring: (uint8_t ch, uint8_t number)
scope: NexWaveform
briefdescription: Add value to show.
detaileddescription:
@param ch - channel of waveform(0-3). 
@param number - the value of waveform.  

@retval true - success. 
@retval false - failed. 


refid: ga91c549e696b0ca035cf18901e6a50d5a
name: nexLoop
definition: void nexLoop
type: void
argsstring: (NexTouch *nex_listen_list[])
briefdescription: Listen touch event and calling callbacks attached before.
detaileddescription:
Supports push and pop at present. 

@param nex_listen_list - index to Nextion Components list. 
@return none. 

@warning This function must be called repeatedly to response touch events
 from Nextion touch panel. Actually, you should place it in your loop function. 


