ESPHome
2026.11.0b6
Loading...
Searching...
No Matches
esphome
components
display_menu_base
menu_item.h
Go to the documentation of this file.
1
#pragma once
2
3
#include "
esphome/core/defines.h
"
4
#include "
esphome/core/automation.h
"
5
6
#ifdef USE_NUMBER
7
#include "
esphome/components/number/number.h
"
8
#endif
9
#ifdef USE_SELECT
10
#include "
esphome/components/select/select.h
"
11
#endif
12
#ifdef USE_SWITCH
13
#include "
esphome/components/switch/switch.h
"
14
#endif
15
16
#include <vector>
17
#include "
esphome/core/log.h
"
18
19
namespace
esphome::display_menu_base
{
20
21
enum
MenuItemType
{
22
MENU_ITEM_LABEL
,
23
MENU_ITEM_MENU
,
24
MENU_ITEM_BACK
,
25
MENU_ITEM_SELECT
,
26
MENU_ITEM_NUMBER
,
27
MENU_ITEM_SWITCH
,
28
MENU_ITEM_COMMAND
,
29
MENU_ITEM_CUSTOM
,
30
};
31
33
const
LogString *
menu_item_type_to_string
(
MenuItemType
type
);
34
35
class
MenuItem;
36
class
MenuItemMenu;
37
using
value_getter_t
= std::function<std::string(
const
MenuItem
*)>;
38
39
class
MenuItem
{
40
public
:
41
explicit
MenuItem
(
MenuItemType
t) :
item_type_
(t) {}
42
void
set_parent
(
MenuItemMenu
*parent) { this->
parent_
= parent; }
43
MenuItemMenu
*
get_parent
() {
return
this->
parent_
; }
44
MenuItemType
get_type
()
const
{
return
this->
item_type_
; }
45
template
<
typename
V>
void
set_text
(V
val
) { this->
text_
=
val
; }
46
template
<
typename
F>
void
add_on_enter_callback
(F &&cb) { this->
on_enter_callbacks_
.add(std::forward<F>(cb)); }
47
template
<
typename
F>
void
add_on_leave_callback
(F &&cb) { this->
on_leave_callbacks_
.add(std::forward<F>(cb)); }
48
template
<
typename
F>
void
add_on_value_callback
(F &&cb) { this->
on_value_callbacks_
.add(std::forward<F>(cb)); }
49
50
std::string
get_text
()
const
{
return
const_cast<
MenuItem
*
>
(
this
)->
text_
.value(
this
); }
51
virtual
bool
get_immediate_edit
()
const
{
return
false
; }
52
virtual
bool
has_value
()
const
{
return
false
; }
53
virtual
std::string
get_value_text
()
const
{
return
""
; }
54
55
virtual
bool
select_next
() {
return
false
; }
56
virtual
bool
select_prev
() {
return
false
; }
57
58
void
on_enter
();
59
void
on_leave
();
60
61
protected
:
62
void
on_value_
();
63
64
MenuItemType
item_type_
;
65
MenuItemMenu
*
parent_
{
nullptr
};
66
TemplatableValue<std::string, const MenuItem *>
text_
;
67
68
CallbackManager
<void()>
on_enter_callbacks_
{};
69
CallbackManager
<void()>
on_leave_callbacks_
{};
70
CallbackManager
<void()>
on_value_callbacks_
{};
71
};
72
73
class
MenuItemMenu
final :
public
MenuItem
{
74
public
:
75
explicit
MenuItemMenu
() :
MenuItem
(
MENU_ITEM_MENU
) {}
76
void
add_item
(
MenuItem
*item) {
77
item->
set_parent
(
this
);
78
this->
items_
.push_back(item);
79
}
80
size_t
items_size
()
const
{
return
this->
items_
.size(); }
81
MenuItem
*
get_item
(
size_t
i) {
return
this->
items_
[i]; }
82
83
protected
:
84
std::vector<MenuItem *>
items_
;
85
};
86
87
class
MenuItemEditable
:
public
MenuItem
{
88
public
:
89
explicit
MenuItemEditable
(
MenuItemType
t) :
MenuItem
(t) {}
90
void
set_immediate_edit
(
bool
val
) { this->
immediate_edit_
=
val
; }
91
bool
get_immediate_edit
()
const override
{
return
this->
immediate_edit_
; }
92
void
set_value_lambda
(
value_getter_t
&&getter) { this->
value_getter_
= getter; }
93
94
protected
:
95
bool
immediate_edit_
{
false
};
96
optional<value_getter_t>
value_getter_
{};
97
};
98
99
#ifdef USE_SELECT
100
class
MenuItemSelect
final :
public
MenuItemEditable
{
101
SUB_SELECT(variable)
102
103
public
:
104
explicit
MenuItemSelect
() :
MenuItemEditable
(
MENU_ITEM_SELECT
) {}
105
106
bool
has_value()
const override
{
return
true
; }
107
std::string get_value_text()
const override
;
108
109
bool
select_next()
override
;
110
bool
select_prev()
override
;
111
};
112
#endif
113
114
#ifdef USE_NUMBER
115
class
MenuItemNumber
final :
public
MenuItemEditable
{
116
SUB_NUMBER(variable)
117
118
public
:
119
explicit
MenuItemNumber
() :
MenuItemEditable
(
MENU_ITEM_NUMBER
) {}
120
// Keeps the pointer; the string must outlive the item (codegen passes a literal)
121
void
set_format(
const
char
*
fmt
) { this->
format_
=
fmt
; }
122
123
bool
has_value()
const override
{
return
true
; }
124
std::string get_value_text()
const override
;
125
126
bool
select_next()
override
;
127
bool
select_prev()
override
;
128
129
protected
:
130
float
get_number_value_
()
const
;
131
132
const
char
*
format_
{
""
};
133
};
134
#endif
135
136
#ifdef USE_SWITCH
137
class
MenuItemSwitch
final :
public
MenuItemEditable
{
138
SUB_SWITCH(variable)
139
140
public
:
141
explicit
MenuItemSwitch
() :
MenuItemEditable
(
MENU_ITEM_SWITCH
) {}
142
// Both keep the pointer; the strings must outlive the item (codegen passes literals)
143
void
set_on_text(
const
char
*t) { this->
switch_on_text_
= t; }
144
void
set_off_text(
const
char
*t) { this->
switch_off_text_
= t; }
145
146
bool
has_value()
const override
{
return
true
; }
147
std::string get_value_text()
const override
;
148
149
bool
select_next()
override
;
150
bool
select_prev()
override
;
151
152
protected
:
153
bool
get_switch_state_
()
const
;
154
bool
toggle_switch_
();
155
156
const
char
*
switch_on_text_
{
""
};
157
const
char
*
switch_off_text_
{
""
};
158
};
159
#endif
160
161
class
MenuItemCommand
final :
public
MenuItem
{
162
public
:
163
explicit
MenuItemCommand
() :
MenuItem
(
MENU_ITEM_COMMAND
) {}
164
165
bool
select_next
()
override
;
166
bool
select_prev
()
override
;
167
};
168
169
class
MenuItemCustom
final :
public
MenuItemEditable
{
170
public
:
171
explicit
MenuItemCustom
() :
MenuItemEditable
(
MENU_ITEM_CUSTOM
) {}
172
template
<
typename
F>
void
add_on_next_callback
(F &&cb) { this->
on_next_callbacks_
.add(std::forward<F>(cb)); }
173
template
<
typename
F>
void
add_on_prev_callback
(F &&cb) { this->
on_prev_callbacks_
.add(std::forward<F>(cb)); }
174
175
bool
has_value
()
const override
{
return
this->
value_getter_
.has_value(); }
176
std::string
get_value_text
()
const override
;
177
178
bool
select_next
()
override
;
179
bool
select_prev
()
override
;
180
181
protected
:
182
void
on_next_
();
183
void
on_prev_
();
184
185
CallbackManager
<void()>
on_next_callbacks_
{};
186
CallbackManager
<void()>
on_prev_callbacks_
{};
187
};
188
189
}
// namespace esphome::display_menu_base
esphome::CallbackManager
Definition
helpers.h:1969
esphome::TemplatableValue
Primary TemplatableValue: stores either a constant value or a function pointer.
Definition
automation.h:169
esphome::display_menu_base::MenuItemCommand
Definition
menu_item.h:161
esphome::display_menu_base::MenuItemCommand::select_next
bool select_next() override
Definition
menu_item.cpp:180
esphome::display_menu_base::MenuItemCommand::select_prev
bool select_prev() override
Definition
menu_item.cpp:185
esphome::display_menu_base::MenuItemCommand::MenuItemCommand
MenuItemCommand()
Definition
menu_item.h:163
esphome::display_menu_base::MenuItemCustom
Definition
menu_item.h:169
esphome::display_menu_base::MenuItemCustom::on_next_callbacks_
CallbackManager< void()> on_next_callbacks_
Definition
menu_item.h:185
esphome::display_menu_base::MenuItemCustom::has_value
bool has_value() const override
Definition
menu_item.h:175
esphome::display_menu_base::MenuItemCustom::add_on_prev_callback
void add_on_prev_callback(F &&cb)
Definition
menu_item.h:173
esphome::display_menu_base::MenuItemCustom::get_value_text
std::string get_value_text() const override
Definition
menu_item.cpp:176
esphome::display_menu_base::MenuItemCustom::MenuItemCustom
MenuItemCustom()
Definition
menu_item.h:171
esphome::display_menu_base::MenuItemCustom::select_prev
bool select_prev() override
Definition
menu_item.cpp:196
esphome::display_menu_base::MenuItemCustom::select_next
bool select_next() override
Definition
menu_item.cpp:190
esphome::display_menu_base::MenuItemCustom::on_prev_
void on_prev_()
Definition
menu_item.cpp:204
esphome::display_menu_base::MenuItemCustom::on_next_
void on_next_()
Definition
menu_item.cpp:202
esphome::display_menu_base::MenuItemCustom::add_on_next_callback
void add_on_next_callback(F &&cb)
Definition
menu_item.h:172
esphome::display_menu_base::MenuItemCustom::on_prev_callbacks_
CallbackManager< void()> on_prev_callbacks_
Definition
menu_item.h:186
esphome::display_menu_base::MenuItemEditable
Definition
menu_item.h:87
esphome::display_menu_base::MenuItemEditable::set_value_lambda
void set_value_lambda(value_getter_t &&getter)
Definition
menu_item.h:92
esphome::display_menu_base::MenuItemEditable::MenuItemEditable
MenuItemEditable(MenuItemType t)
Definition
menu_item.h:89
esphome::display_menu_base::MenuItemEditable::immediate_edit_
bool immediate_edit_
Definition
menu_item.h:95
esphome::display_menu_base::MenuItemEditable::set_immediate_edit
void set_immediate_edit(bool val)
Definition
menu_item.h:90
esphome::display_menu_base::MenuItemEditable::value_getter_
optional< value_getter_t > value_getter_
Definition
menu_item.h:96
esphome::display_menu_base::MenuItemEditable::get_immediate_edit
bool get_immediate_edit() const override
Definition
menu_item.h:91
esphome::display_menu_base::MenuItem
Definition
menu_item.h:39
esphome::display_menu_base::MenuItem::on_value_
void on_value_()
Definition
menu_item.cpp:34
esphome::display_menu_base::MenuItem::get_value_text
virtual std::string get_value_text() const
Definition
menu_item.h:53
esphome::display_menu_base::MenuItem::set_text
void set_text(V val)
Definition
menu_item.h:45
esphome::display_menu_base::MenuItem::MenuItem
MenuItem(MenuItemType t)
Definition
menu_item.h:41
esphome::display_menu_base::MenuItem::set_parent
void set_parent(MenuItemMenu *parent)
Definition
menu_item.h:42
esphome::display_menu_base::MenuItem::on_leave_callbacks_
CallbackManager< void()> on_leave_callbacks_
Definition
menu_item.h:69
esphome::display_menu_base::MenuItem::on_leave
void on_leave()
Definition
menu_item.cpp:32
esphome::display_menu_base::MenuItem::get_text
std::string get_text() const
Definition
menu_item.h:50
esphome::display_menu_base::MenuItem::add_on_value_callback
void add_on_value_callback(F &&cb)
Definition
menu_item.h:48
esphome::display_menu_base::MenuItem::select_prev
virtual bool select_prev()
Definition
menu_item.h:56
esphome::display_menu_base::MenuItem::on_value_callbacks_
CallbackManager< void()> on_value_callbacks_
Definition
menu_item.h:70
esphome::display_menu_base::MenuItem::parent_
MenuItemMenu * parent_
Definition
menu_item.h:65
esphome::display_menu_base::MenuItem::get_parent
MenuItemMenu * get_parent()
Definition
menu_item.h:43
esphome::display_menu_base::MenuItem::on_enter
void on_enter()
Definition
menu_item.cpp:30
esphome::display_menu_base::MenuItem::on_enter_callbacks_
CallbackManager< void()> on_enter_callbacks_
Definition
menu_item.h:68
esphome::display_menu_base::MenuItem::has_value
virtual bool has_value() const
Definition
menu_item.h:52
esphome::display_menu_base::MenuItem::select_next
virtual bool select_next()
Definition
menu_item.h:55
esphome::display_menu_base::MenuItem::add_on_leave_callback
void add_on_leave_callback(F &&cb)
Definition
menu_item.h:47
esphome::display_menu_base::MenuItem::get_type
MenuItemType get_type() const
Definition
menu_item.h:44
esphome::display_menu_base::MenuItem::item_type_
MenuItemType item_type_
Definition
menu_item.h:64
esphome::display_menu_base::MenuItem::text_
TemplatableValue< std::string, const MenuItem * > text_
Definition
menu_item.h:66
esphome::display_menu_base::MenuItem::get_immediate_edit
virtual bool get_immediate_edit() const
Definition
menu_item.h:51
esphome::display_menu_base::MenuItem::add_on_enter_callback
void add_on_enter_callback(F &&cb)
Definition
menu_item.h:46
esphome::display_menu_base::MenuItemMenu
Definition
menu_item.h:73
esphome::display_menu_base::MenuItemMenu::items_
std::vector< MenuItem * > items_
Definition
menu_item.h:84
esphome::display_menu_base::MenuItemMenu::items_size
size_t items_size() const
Definition
menu_item.h:80
esphome::display_menu_base::MenuItemMenu::MenuItemMenu
MenuItemMenu()
Definition
menu_item.h:75
esphome::display_menu_base::MenuItemMenu::add_item
void add_item(MenuItem *item)
Definition
menu_item.h:76
esphome::display_menu_base::MenuItemMenu::get_item
MenuItem * get_item(size_t i)
Definition
menu_item.h:81
esphome::display_menu_base::MenuItemNumber
Definition
menu_item.h:115
esphome::display_menu_base::MenuItemNumber::get_number_value_
float get_number_value_() const
Definition
menu_item.cpp:124
esphome::display_menu_base::MenuItemNumber::format_
const char * format_
Definition
menu_item.h:132
esphome::display_menu_base::MenuItemSelect
Definition
menu_item.h:100
esphome::display_menu_base::MenuItemSwitch
Definition
menu_item.h:137
esphome::display_menu_base::MenuItemSwitch::toggle_switch_
bool toggle_switch_()
Definition
menu_item.cpp:163
esphome::display_menu_base::MenuItemSwitch::switch_off_text_
const char * switch_off_text_
Definition
menu_item.h:157
esphome::display_menu_base::MenuItemSwitch::switch_on_text_
const char * switch_on_text_
Definition
menu_item.h:156
esphome::display_menu_base::MenuItemSwitch::get_switch_state_
bool get_switch_state_() const
Definition
menu_item.cpp:159
automation.h
defines.h
type
uint8_t type
Definition
e131_packet.cpp:21
log.h
val
mopeka_std_values val[3]
Definition
mopeka_std_check.h:8
esphome::display_menu_base
Definition
display_menu_base.cpp:4
esphome::display_menu_base::value_getter_t
std::function< std::string(const MenuItem *)> value_getter_t
Definition
menu_item.h:37
esphome::display_menu_base::MenuItemType
MenuItemType
Definition
menu_item.h:21
esphome::display_menu_base::MENU_ITEM_COMMAND
@ MENU_ITEM_COMMAND
Definition
menu_item.h:28
esphome::display_menu_base::MENU_ITEM_CUSTOM
@ MENU_ITEM_CUSTOM
Definition
menu_item.h:29
esphome::display_menu_base::MENU_ITEM_SWITCH
@ MENU_ITEM_SWITCH
Definition
menu_item.h:27
esphome::display_menu_base::MENU_ITEM_BACK
@ MENU_ITEM_BACK
Definition
menu_item.h:24
esphome::display_menu_base::MENU_ITEM_SELECT
@ MENU_ITEM_SELECT
Definition
menu_item.h:25
esphome::display_menu_base::MENU_ITEM_NUMBER
@ MENU_ITEM_NUMBER
Definition
menu_item.h:26
esphome::display_menu_base::MENU_ITEM_MENU
@ MENU_ITEM_MENU
Definition
menu_item.h:23
esphome::display_menu_base::MENU_ITEM_LABEL
@ MENU_ITEM_LABEL
Definition
menu_item.h:22
esphome::display_menu_base::menu_item_type_to_string
const LogString * menu_item_type_to_string(MenuItemType type)
Returns a string representation of a menu item type suitable for logging.
Definition
menu_item.cpp:7
esphome::fmt
size_t size_t const char * fmt
Definition
helpers.h:1334
number.h
select.h
switch.h
Generated by
1.12.0