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

#include <text.h>

Inheritance diagram for esphome::text::Text:

Public Member Functions
void	publish_state (const std::string &state)

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

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)

ESPDEPRECATED("Use get_icon_ref() instead for better performance (avoids string copy). Will be removed in ESPHome 2026.5.0", "2025.11.0") std void	set_icon (const char *icon)

StringRef	get_icon_ref () const

uint32_t	get_device_id () const

void	set_device (Device *device)

bool	has_state () const

void	set_has_state (bool state)

uint32_t	get_preference_hash ()
	Get a unique hash for storing preferences/settings for this entity.

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.

Protected Member Functions inherited from esphome::EntityBase
StringRef	get_object_id_ref_for_api_ () const

void	calc_object_id_ ()

bool	is_object_id_dynamic_ () const
	Check if the object_id is dynamic (changes with MAC suffix)

Protected Attributes
CallbackManager< void(std::string)>	state_callback_

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_ {}

Device *	device_ {}

struct esphome::EntityBase::EntityFlags	flags_

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 26 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

value The value as validated by the TextCall.

Implemented in esphome::copy::CopyText, esphome::demo::DemoText, esphome::lvgl::LVGLText, and esphome::template_::TemplateText.

◆ make_call()

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

inline

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

Definition at line 32 of file text.h.

◆ publish_state()

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

Definition at line 11 of file text.cpp.

Field Documentation

◆ 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 47 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:

esphome/components/text/text.h
esphome/components/text/text.cpp

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes