ESPHome  2024.2.0
Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
esphome::text::Text Class Referenceabstract

Base-class for all text inputs. More...

#include <text.h>

Inheritance diagram for esphome::text::Text:
esphome::EntityBase esphome::copy::CopyText esphome::template_::TemplateText

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 StringRefget_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}
 

Detailed Description

Base-class for all text inputs.

A text input can use publish_state to send out a new value.

Definition at line 24 of file text.h.

Member Function Documentation

◆ add_on_state_callback()

void esphome::text::Text::add_on_state_callback ( std::function< void(std::string)> &&  callback)

Definition at line 21 of file text.cpp.

◆ control()

virtual void esphome::text::Text::control ( const std::string &  value)
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.

Parameters
valueThe value as validated by the TextCall.

Implemented in esphome::template_::TemplateText, and esphome::copy::CopyText.

◆ has_state()

bool esphome::text::Text::has_state ( ) const
inline

Return whether this text input has gotten a full state yet.

Definition at line 32 of file text.h.

◆ make_call()

TextCall esphome::text::Text::make_call ( )
inline

Instantiate a TextCall object to modify this text component's state.

Definition at line 35 of file text.h.

◆ publish_state()

void esphome::text::Text::publish_state ( const std::string &  state)

Definition at line 9 of file text.cpp.

Field Documentation

◆ has_state_

bool esphome::text::Text::has_state_ {false}
protected

Definition at line 51 of file text.h.

◆ state

std::string esphome::text::Text::state

Definition at line 26 of file text.h.

◆ state_callback_

CallbackManager<void(std::string)> esphome::text::Text::state_callback_
protected

Definition at line 50 of file text.h.

◆ traits

TextTraits esphome::text::Text::traits

Definition at line 27 of file text.h.


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