ESPHome
2024.11.0
|
Base-class for all text inputs. More...
#include <text.h>
Public Member Functions | |
void | publish_state (const std::string &state) |
bool | has_state () const |
Return whether this text input has gotten a full state yet. More... | |
TextCall | make_call () |
Instantiate a TextCall object to modify this text component's state. More... | |
void | add_on_state_callback (std::function< void(std::string)> &&callback) |
Public Member Functions inherited from esphome::EntityBase | |
const StringRef & | get_name () const |
void | set_name (const char *name) |
bool | has_own_name () const |
std::string | get_object_id () const |
void | set_object_id (const char *object_id) |
uint32_t | get_object_id_hash () |
bool | is_internal () const |
void | set_internal (bool internal) |
bool | is_disabled_by_default () const |
void | set_disabled_by_default (bool disabled_by_default) |
EntityCategory | get_entity_category () const |
void | set_entity_category (EntityCategory entity_category) |
std::string | get_icon () const |
void | set_icon (const char *icon) |
Data Fields | |
std::string | state |
TextTraits | traits |
Protected Member Functions | |
virtual void | control (const std::string &value)=0 |
Set the value of the text input, this is a virtual method that each text input integration must implement. More... | |
Protected Member Functions inherited from esphome::EntityBase | |
virtual uint32_t | hash_base () |
The hash_base() function has been deprecated. More... | |
void | calc_object_id_ () |
Protected Attributes | |
CallbackManager< void(std::string)> | state_callback_ |
bool | has_state_ {false} |
Protected Attributes inherited from esphome::EntityBase | |
StringRef | name_ |
const char * | object_id_c_str_ {nullptr} |
const char * | icon_c_str_ {nullptr} |
uint32_t | object_id_hash_ |
bool | has_own_name_ {false} |
bool | internal_ {false} |
bool | disabled_by_default_ {false} |
EntityCategory | entity_category_ {ENTITY_CATEGORY_NONE} |
Base-class for all text inputs.
A text input can use publish_state to send out a new value.
void esphome::text::Text::add_on_state_callback | ( | std::function< void(std::string)> && | callback | ) |
|
protectedpure virtual |
Set the value of the text input, this is a virtual method that each text input integration must implement.
This method is called by the TextCall.
value | The value as validated by the TextCall. |
Implemented in esphome::template_::TemplateText, esphome::lvgl::LVGLText, and esphome::copy::CopyText.
|
inline |
|
inline |
void esphome::text::Text::publish_state | ( | const std::string & | state | ) |
|
protected |
TextTraits esphome::text::Text::traits |