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

Represents a sliding text widget. More...

#include <NextionSlidingText.h>

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

Public Member Functions

 NextionSlidingText (Nextion &nex, uint8_t page, uint8_t component, const char *name)
 Create a new widget adapter. More...
 
bool setScrolling (bool scroll)
 
bool isScrolling ()
 
bool setScrollDirection (NextionScrollDirection direction)
 
NextionScrollDirection getScrollDirection ()
 
bool setScrollDistance (uint32_t distance)
 
uint32_t getScrollDistance ()
 
bool setScrollDelay (uint32_t delay)
 
uint32_t getScrollDelay ()
 
- Public Member Functions inherited from INextionTouchable
 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...
 
- Public Member Functions inherited from INextionColourable
 INextionColourable (Nextion &nex, uint8_t page, uint8_t component, const char *name)
 Create a new widget adapter. More...
 
bool setForegroundColour (uint32_t colour, bool refresh=true)
 Sets the normal foreground colour. More...
 
uint32_t getForegroundColour ()
 Gets the normal foreground colour. More...
 
bool setEventForegroundColour (uint32_t colour, bool refresh=true)
 Sets the foreground colour when a touch event is active. More...
 
uint32_t getEventForegroundColour ()
 Gets the foreground colour when a touch event is active. More...
 
bool setBackgroundColour (uint32_t colour, bool refresh=true)
 Sets the normal background colour. More...
 
uint32_t getBackgroundColour ()
 Gets the normal background colour. More...
 
bool setEventBackgroundColour (uint32_t colour, bool refresh=true)
 Sets the background colour when a touch event is active. More...
 
uint32_t getEventBackgroundColour ()
 Sets the background colour when a touch event is active. More...
 
bool setColour (char *type, uint32_t colour, bool refresh)
 Sets a colour by its property name. More...
 
uint32_t getColour (char *type)
 Gets a colour by its property name. More...
 
bool afterSet (bool result, bool refresh)
 Handles refreshing the page after a colour has been changed. More...
 
- Public Member Functions inherited from INextionStringValued
 INextionStringValued (Nextion &nex, uint8_t page, uint8_t component, const char *name)
 Create a new widget adapter. More...
 
size_t getText (char *buffer, size_t len)
 Gets the value of the string. More...
 
bool setText (char *buffer)
 Sets the value of the string. More...
 
bool setTextAsNumber (uint32_t value)
 Sets the text by a numercal value. More...
 
uint32_t getTextAsNumber ()
 Gets the text parsed as a number. More...
 
- Public Member Functions inherited from INextionFontStyleable
 INextionFontStyleable (Nextion &nex, uint8_t page, uint8_t component, const char *name)
 Create a new widget adapter. More...
 
bool setFont (uint8_t id, bool refresh=true)
 Sets the active font for the text. More...
 
uint8_t getFont ()
 Gets the active font for the text. More...
 
bool setHAlignment (NextionFontAlignment align, bool refresh=true)
 Sets the horizontal alignment of the text. More...
 
NextionFontAlignment getHAlignment ()
 Gets the horizontal alignment of the text. More...
 
bool setVAlignment (NextionFontAlignment align, bool refresh=true)
 Sets the vertical alignment of the text. More...
 
NextionFontAlignment getVAlignment ()
 Gets the vertical alignment of the text. More...
 
bool afterSet (bool result, bool refresh)
 Handles refreshing the page after a style has been changed. 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

Represents a sliding text widget.

Constructor & Destructor Documentation

NextionSlidingText::NextionSlidingText ( 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

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