Arduino menU-Ui magic 1.0
Arduino menu user interface library
Public Member Functions | Public Attributes | List of all members
menuOptionOnOff Class Reference

#include <menu.h>

Inheritance diagram for menuOptionOnOff:
menuOption

Public Member Functions

 menuOptionOnOff ()
 
 menuOptionOnOff (const char *text, bool initValue=false)
 menuOptionOnOff constructor More...
 
virtual bool refresh ()
 
virtual bool pushRt ()
 
virtual bool pushLt ()
 
- Public Member Functions inherited from menuOption
 menuOption ()
 
 menuOption (const char *text)
 
virtual void run ()
 
virtual bool refresh ()
 
virtual bool pushRt ()
 
virtual bool pushLt ()
 

Public Attributes

bool state
 
bool statePrinted
 
- Public Attributes inherited from menuOption
char text [menuTextArrayLength]
 
bool autoRefresh = true
 

Detailed Description

Switch menuOptionOnOff base class is to be inherited, put your custom code at run(), read state at state Uses ':'(menu.cpp menuOptionDelimiter) as separator

Constructor & Destructor Documentation

◆ menuOptionOnOff() [1/2]

menuOptionOnOff::menuOptionOnOff ( )

for compiler puposes, better not to use it

◆ menuOptionOnOff() [2/2]

menuOptionOnOff::menuOptionOnOff ( const char *  text,
bool  initValue = false 
)

menuOptionOnOff constructor

constructor, sets the caption text, do not use ':', might set init value

might set initial values

Parameters
[in]textstring char * used as caoption
[in]initValueoptional initial value

Member Function Documentation

◆ pushLt()

bool menuOptionOnOff::pushLt ( )
virtual

switches state, if inherit, call base menuOptionOnOff::pushLt()

Reimplemented from menuOption.

◆ pushRt()

bool menuOptionOnOff::pushRt ( )
virtual

switches state, if inherit, call base menuOptionOnOff::pushRt()

Reimplemented from menuOption.

◆ refresh()

bool menuOptionOnOff::refresh ( )
virtual

inherit to do your thing

Reimplemented from menuOption.


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