ESPHome
2024.11.0
|
Class to display a hierarchical menu. More...
#include <lcd_menu.h>
Public Member Functions | |
void | set_display (lcd_base::LCDDisplay *display) |
void | set_dimensions (uint8_t columns, uint8_t rows) |
void | set_mark_selected (uint8_t c) |
void | set_mark_editing (uint8_t c) |
void | set_mark_submenu (uint8_t c) |
void | set_mark_back (uint8_t c) |
void | setup () override |
float | get_setup_priority () const override |
void | dump_config () override |
Public Member Functions inherited from esphome::display_menu_base::DisplayMenuComponent | |
void | set_root_item (MenuItemMenu *item) |
void | set_active (bool active) |
void | set_mode (MenuMode mode) |
void | set_rows (uint8_t rows) |
void | up () |
void | down () |
void | left () |
void | right () |
void | enter () |
void | show_main () |
void | show () |
void | hide () |
void | draw () |
bool | is_active () const |
Public Member Functions inherited from esphome::Component | |
virtual void | loop () |
This method will be called repeatedly. More... | |
float | get_actual_setup_priority () const |
void | set_setup_priority (float priority) |
virtual float | get_loop_priority () const |
priority of loop(). More... | |
void | call () |
virtual void | on_shutdown () |
virtual void | on_safe_shutdown () |
uint32_t | get_component_state () const |
virtual void | mark_failed () |
Mark this component as failed. More... | |
bool | is_failed () const |
bool | is_ready () const |
virtual bool | can_proceed () |
bool | status_has_warning () const |
bool | status_has_error () const |
void | status_set_warning (const char *message="unspecified") |
void | status_set_error (const char *message="unspecified") |
void | status_clear_warning () |
void | status_clear_error () |
void | status_momentary_warning (const std::string &name, uint32_t length=5000) |
void | status_momentary_error (const std::string &name, uint32_t length=5000) |
bool | has_overridden_loop () const |
void | set_component_source (const char *source) |
Set where this component was loaded from for some debug messages. More... | |
const char * | get_component_source () const |
Get the integration where this component was declared as a string. More... | |
Protected Member Functions | |
void | draw_item (const display_menu_base::MenuItem *item, uint8_t row, bool selected) override |
void | update () override |
Protected Member Functions inherited from esphome::display_menu_base::DisplayMenuComponent | |
void | reset_ () |
void | process_initial_ () |
bool | check_healthy_and_active_ () |
MenuItem * | get_selected_item_ () |
bool | cursor_up_ () |
bool | cursor_down_ () |
bool | enter_menu_ () |
bool | leave_menu_ () |
void | finish_editing_ () |
virtual void | draw_menu () |
virtual void | draw_and_update () |
virtual void | on_before_show () |
virtual void | on_after_show () |
virtual void | on_before_hide () |
virtual void | on_after_hide () |
Protected Member Functions inherited from esphome::Component | |
virtual void | call_loop () |
virtual void | call_setup () |
virtual void | call_dump_config () |
void | set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f) |
Set an interval function with a unique name. More... | |
void | set_interval (uint32_t interval, std::function< void()> &&f) |
bool | cancel_interval (const std::string &name) |
Cancel an interval function. More... | |
void | set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f) |
Set an retry function with a unique name. More... | |
void | set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f) |
bool | cancel_retry (const std::string &name) |
Cancel a retry function. More... | |
void | set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f) |
Set a timeout function with a unique name. More... | |
void | set_timeout (uint32_t timeout, std::function< void()> &&f) |
bool | cancel_timeout (const std::string &name) |
Cancel a timeout function. More... | |
void | defer (const std::string &name, std::function< void()> &&f) |
Defer a callback to the next loop() call. More... | |
void | defer (std::function< void()> &&f) |
Defer a callback to the next loop() call. More... | |
bool | cancel_defer (const std::string &name) |
Cancel a defer callback using the specified name, name must not be empty. More... | |
Protected Attributes | |
lcd_base::LCDDisplay * | display_ |
uint8_t | columns_ |
char | mark_selected_ |
char | mark_editing_ |
char | mark_submenu_ |
char | mark_back_ |
Protected Attributes inherited from esphome::display_menu_base::DisplayMenuComponent | |
uint8_t | rows_ |
bool | active_ |
MenuMode | mode_ |
MenuItemMenu * | root_item_ {nullptr} |
MenuItemMenu * | displayed_item_ {nullptr} |
uint8_t | top_index_ {0} |
uint8_t | cursor_index_ {0} |
std::forward_list< std::pair< uint8_t, uint8_t > > | selection_stack_ {} |
bool | editing_ {false} |
bool | root_on_enter_called_ {false} |
Protected Attributes inherited from esphome::Component | |
uint32_t | component_state_ {0x0000} |
State of this component. More... | |
float | setup_priority_override_ {NAN} |
const char * | component_source_ {nullptr} |
Class to display a hierarchical menu.
Definition at line 15 of file lcd_menu.h.
|
overrideprotectedvirtual |
Implements esphome::display_menu_base::DisplayMenuComponent.
Definition at line 31 of file lcd_menu.cpp.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 21 of file lcd_menu.cpp.
|
overridevirtual |
Reimplemented from esphome::display_menu_base::DisplayMenuComponent.
Definition at line 19 of file lcd_menu.cpp.
|
inline |
Definition at line 18 of file lcd_menu.h.
|
inline |
Definition at line 17 of file lcd_menu.h.
|
inline |
Definition at line 25 of file lcd_menu.h.
|
inline |
Definition at line 23 of file lcd_menu.h.
|
inline |
Definition at line 22 of file lcd_menu.h.
|
inline |
Definition at line 24 of file lcd_menu.h.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 10 of file lcd_menu.cpp.
|
inlineoverrideprotectedvirtual |
Reimplemented from esphome::display_menu_base::DisplayMenuComponent.
Definition at line 34 of file lcd_menu.h.
|
protected |
Definition at line 37 of file lcd_menu.h.
|
protected |
Definition at line 36 of file lcd_menu.h.
|
protected |
Definition at line 41 of file lcd_menu.h.
|
protected |
Definition at line 39 of file lcd_menu.h.
|
protected |
Definition at line 38 of file lcd_menu.h.
|
protected |
Definition at line 40 of file lcd_menu.h.