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

Interface for widgets that can have their fonts styled. More...

#include <INextionFontStyleable.h>

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

Public Member Functions

 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...
 
- 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 have their fonts styled.

Constructor & Destructor Documentation

INextionFontStyleable::INextionFontStyleable ( 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 INextionFontStyleable::afterSet ( bool  result,
bool  refresh 
)

Handles refreshing the page after a style has been changed.

Parameters
resultSuccess of style change
refreshIf the widget should be refreshed
Returns
True if successful
uint8_t INextionFontStyleable::getFont ( )

Gets the active font for the text.

Returns
Font ID (may return 0 in event of error)
See Also
INextionFontStyleable::setFont
NextionFontAlignment INextionFontStyleable::getHAlignment ( )

Gets the horizontal alignment of the text.

Returns
Alignment
See Also
INextionFontStyleable::setHAlignment
NextionFontAlignment INextionFontStyleable::getVAlignment ( )

Gets the vertical alignment of the text.

Returns
Alignment
See Also
INextionFontStyleable::setVAlignment
bool INextionFontStyleable::setFont ( uint8_t  id,
bool  refresh = true 
)

Sets the active font for the text.

Parameters
idFont ID
refreshIf the widget should be refreshed
Returns
True if successful
See Also
INextionFontStyleable::getFont
bool INextionFontStyleable::setHAlignment ( NextionFontAlignment  align,
bool  refresh = true 
)

Sets the horizontal alignment of the text.

Parameters
alignAlignment
refreshIf the widget should be refreshed
Returns
True if successful
See Also
INextionFontStyleable::getHAlignment
bool INextionFontStyleable::setVAlignment ( NextionFontAlignment  align,
bool  refresh = true 
)

Sets the vertical alignment of the text.

Parameters
alignAlignment
refreshIf the widget should be refreshed
Returns
True if successful
See Also
INextionFontStyleable::getVAlignment

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