SensESP 2.7.2
Universal Signal K sensor toolkit ESP32
Loading...
Searching...
No Matches
sensesp::UIButton Class Reference

UIButton implements a button interface on the web UI. More...

#include <sensesp/ui/ui_button.h>

Inheritance diagram for sensesp::UIButton:
[legend]

Public Member Functions

 UIButton (String title, String name, bool must_confirm)
 
const bool get_must_confirm ()
 
const String get_title ()
 
const String get_name ()
 
- Public Member Functions inherited from sensesp::Observable
 Observable ()
 
 Observable (Observable &&other)
 Move constructor.
 
void notify ()
 
void attach (std::function< void()> observer)
 

Static Public Member Functions

static const std::map< String, UIButton * > & get_ui_buttons ()
 
static UIButtonadd (String name, String title, bool must_confirm=true)
 

Protected Attributes

String title_
 
String name_
 
bool must_confirm_
 

Static Protected Attributes

static std::map< String, UIButton * > ui_buttons_
 

Detailed Description

UIButton implements a button interface on the web UI.

Each UIButton object creates a button in the "Control" tab of the web UI. When the button is clicked, the object's observers are notified.

Definition at line 17 of file ui_button.h.

Constructor & Destructor Documentation

◆ UIButton()

sensesp::UIButton::UIButton ( String  title,
String  name,
bool  must_confirm 
)
inline

Definition at line 19 of file ui_button.h.

Member Function Documentation

◆ add()

static UIButton * sensesp::UIButton::add ( String  name,
String  title,
bool  must_confirm = true 
)
inlinestatic

Definition at line 30 of file ui_button.h.

◆ get_must_confirm()

const bool sensesp::UIButton::get_must_confirm ( )
inline

Definition at line 22 of file ui_button.h.

◆ get_name()

const String sensesp::UIButton::get_name ( )
inline

Definition at line 24 of file ui_button.h.

◆ get_title()

const String sensesp::UIButton::get_title ( )
inline

Definition at line 23 of file ui_button.h.

◆ get_ui_buttons()

static const std::map< String, UIButton * > & sensesp::UIButton::get_ui_buttons ( )
inlinestatic

Definition at line 26 of file ui_button.h.

Here is the caller graph for this function:

Member Data Documentation

◆ must_confirm_

bool sensesp::UIButton::must_confirm_
protected

Definition at line 40 of file ui_button.h.

◆ name_

String sensesp::UIButton::name_
protected

Definition at line 39 of file ui_button.h.

◆ title_

String sensesp::UIButton::title_
protected

Definition at line 38 of file ui_button.h.

◆ ui_buttons_

std::map< String, UIButton * > sensesp::UIButton::ui_buttons_
staticprotected

Definition at line 42 of file ui_button.h.


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