A checkable (option) button. More...

#include <EmbAJAX.h>

Inheritance diagram for EmbAJAXCheckButton:

Collaboration diagram for EmbAJAXCheckButton:

[legend]

Public Member Functions
	EmbAJAXCheckButton (const char id, const char label, bool checked=false)

void	print () const override

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

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

void	setChecked (bool checked)

bool	isChecked () const

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
void	setVisible (bool visible)

void	setEnabled (bool enabled)

virtual EmbAJAXElement *	findChild (const char *id) const

Friends
template<size_t NUM>
class	EmbAJAXRadioGroup

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)

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 inherited from EmbAJAXElement
byte	_flags

const char *	_id

Static Protected Attributes inherited from EmbAJAXBase
static EmbAJAXOutputDriverBase *	_driver

static char	itoa_buf [8]

constexpr static const char	null_string [1]

Detailed Description

A checkable (option) button.

A checkable button / box (NOTE: Internally this is also used for radio buttons, however please do not rely on this implementation detail.

Member Function Documentation

◆ updateFromDriverArg()

void EmbAJAXCheckButton::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 * EmbAJAXCheckButton::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 * EmbAJAXCheckButton::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

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ updateFromDriverArg()

◆ value()

◆ valueProperty()