NeoNextion
Arduino library for the Nextion displays.
 All Classes Files Functions Variables Typedefs Enumerations Enumerator
Public Member Functions | List of all members
INextionTouchable Class Reference

Interface for widgets that can be touched. More...

#include <INextionTouchable.h>

Inheritance diagram for INextionTouchable:
Inheritance graph
[legend]
Collaboration diagram for INextionTouchable:
Collaboration graph
[legend]

Public Member Functions

 INextionTouchable (Nextion &nex, uint8_t page, uint8_t component, const char *name)
 Create a new widget adapter. More...
 
bool processEvent (uint8_t pageID, uint8_t componentID, uint8_t eventType)
 Processes a touch event. More...
 
bool attachCallback (NextionCallbackFunctionHandler::NextionFunction cb)
 Attaches a callback function to this widget. More...
 
bool attachCallback (INextionCallback *obj)
 Attaches a callback handler to this widget. More...
 
void detachCallback ()
 Removes the callback handler from this widget. More...
 
- Public Member Functions inherited from INextionWidget
 INextionWidget (Nextion &nex, uint8_t page, uint8_t component, const char *name)
 Create a new widget adapter. More...
 
uint8_t getPageID ()
 Gets the ID of the page this widget resides on. More...
 
uint8_t getComponentID ()
 Gets the component ID of this widget. More...
 
bool setNumberProperty (char *propertyName, uint32_t value)
 Sets the value of a numerical property of this widget. More...
 
uint32_t getNumberProperty (char *propertyName)
 Gets the value of a numerical property of this widget. More...
 
bool setStringProperty (char *propertyName, char *value)
 Sets the value of a string property of this widget. More...
 
size_t getStringProperty (char *propertyName, char *value, size_t len)
 Gets the value of a string property of this widget. More...
 

Additional Inherited Members

- Protected Member Functions inherited from INextionWidget
bool sendCommand (char *commandStr, bool checkComplete=true)
 
- Protected Attributes inherited from INextionWidget
Nextionm_nextion
 Reference to the Nextion driver.
 
uint8_t m_pageID
 ID of page this widget is on.
 
uint8_t m_componentID
 Component ID of this widget.
 
const char * m_name
 Name of this widget.
 

Detailed Description

Interface for widgets that can be touched.

Constructor & Destructor Documentation

INextionTouchable::INextionTouchable ( Nextion nex,
uint8_t  page,
uint8_t  component,
const char *  name 
)

Create a new widget adapter.

Parameters
nexReference to the Nextion driver
pageID of page this widget is on
componentComponent ID of this widget
nameName of this widget

Member Function Documentation

bool INextionTouchable::attachCallback ( NextionCallbackFunctionHandler::NextionFunction  function)

Attaches a callback function to this widget.

Parameters
functionPointer to callback function
Returns
True if successful
See Also
INextionTouchable::detachCallback
bool INextionTouchable::attachCallback ( INextionCallback handler)

Attaches a callback handler to this widget.

Parameters
handlerPointer to handler
Returns
True if successful
See Also
INextionTouchable::detachCallback
void INextionTouchable::detachCallback ( )

Removes the callback handler from this widget.

Memory is not freed.

bool INextionTouchable::processEvent ( uint8_t  pageID,
uint8_t  componentID,
uint8_t  eventType 
)

Processes a touch event.

Parameters
pageIDPage ID of touch event
componentIDComponent ID of touch event
eventTypeType of touch event
Returns
True if the event effects this widget

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