EmbAJAXOptionSelectBase Class Reference

Abstract base class for EmbAJAXOptionSelect. More...

#include <EmbAJAX.h>

Inheritance diagram for EmbAJAXOptionSelectBase:

Collaboration diagram for EmbAJAXOptionSelectBase:

Public Member Functions
void	selectOption (uint8_t num)
uint8_t	selectedOption () const
const char *	value (uint8_t which=EmbAJAXBase::Value) const override
const char *	valueProperty (uint8_t which=EmbAJAXBase::Value) const override
void	updateFromDriverArg (const char *argname) override
Public Member Functions inherited from EmbAJAXElement
	EmbAJAXElement (const char *id)
const char *	id () const
bool	sendUpdates (uint16_t since, bool first) override
virtual bool	valueNeedsEscaping (uint8_t which=EmbAJAXBase::Value) const
EmbAJAXElement *	toElement () override final
Public Member Functions inherited from EmbAJAXBase
virtual void	print () const =0
void	setVisible (bool visible)
void	setEnabled (bool enabled)
virtual EmbAJAXElement *	findChild (const char *id) const

Protected Member Functions
	EmbAJAXOptionSelectBase (const char *id, uint8_t current_option)
void	print (const char *const *_labels, uint8_t NUM) const
Protected Member Functions inherited from EmbAJAXElement
void	setBasicProperty (uint8_t num, bool status) override
bool	basicProperty (uint8_t num) const
void	setChanged ()
bool	changed (uint16_t since)
void	printTextInput (size_t size, const char *value) const
Protected Member Functions inherited from EmbAJAXBase
void	printChildren (EmbAJAXBase **children, size_t num) const
bool	sendUpdates (EmbAJAXBase **children, size_t num, uint16_t since, bool first)
EmbAJAXElement *	findChild (EmbAJAXBase **children, size_t num, const char *id) const
void	printPage (EmbAJAXBase **children, size_t num, const char *_title, const char *_header, uint16_t _min_interval) const
void	handleRequest (EmbAJAXBase **children, size_t num, void(*change_callback)())

Protected Attributes
uint8_t	_current_option
Protected Attributes inherited from EmbAJAXElement
byte	_flags
const char *	_id

Additional Inherited Members
Public Types inherited from EmbAJAXBase
enum	Property {   Visibility , Enabledness , Value , FirstElementSpecificProperty ,   HTMLAllowed }
Static Public Member Functions inherited from EmbAJAXBase
static void	setDriver (EmbAJAXOutputDriverBase *driver)
Static Protected Attributes inherited from EmbAJAXBase
static EmbAJAXOutputDriverBase *	_driver
static char	itoa_buf [8]
constexpr static const char	null_string [1]

Detailed Description

Abstract base class for EmbAJAXOptionSelect.

Member Function Documentation

selectedOption()

uint8_t EmbAJAXOptionSelectBase::selectedOption

(

)

const

Returns

the index of the currently selected option

selectOption()

void EmbAJAXOptionSelectBase::selectOption

(

uint8_t

num

)

Select the option specified by index.

updateFromDriverArg()

void EmbAJAXOptionSelectBase::updateFromDriverArg ( const char *  argname )

overridevirtual

override this in your derived class to allow updates to be propagated from client to server (if wanted). The implementation need not call setChanged().

Reimplemented from EmbAJAXElement.

value()

const char * EmbAJAXOptionSelectBase::value ( uint8_t  which = EmbAJAXBase::Value ) const

overridevirtual

const char representation of the current server side value. Must be implemented in derived class. This base class handles visibility and enabledness, only. Do call the base implementation for any "which" that is not handled in your derived class.

Reimplemented from EmbAJAXElement.

valueProperty()

const char * EmbAJAXOptionSelectBase::valueProperty ( uint8_t  which = EmbAJAXBase::Value ) const

overridevirtual

The JS property that will have to be set on the client. Must be implemented in derived class. This base class handles visibility and enabledness, only. Do call the base implementation for any "which" that is not handled in your derived class.

Reimplemented from EmbAJAXElement.

---

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

• EmbAJAX.h
• EmbAJAX.cpp