ESPHome 2025.6.3
|
#include <graphical_display_menu.h>
Public Member Functions | |
void | setup () override |
void | dump_config () override |
void | set_display (display::Display *display) |
void | set_font (display::BaseFont *font) |
template<typename V > | |
void | set_menu_item_value (V menu_item_value) |
void | set_foreground_color (Color foreground_color) |
void | set_background_color (Color background_color) |
void | add_on_redraw_callback (std::function< void()> &&cb) |
void | draw (display::Display *display, const display::Rect *bounds) |
![]() | |
void | set_root_item (MenuItemMenu *item) |
void | set_active (bool active) |
void | set_mode (MenuMode mode) |
void | set_rows (uint8_t rows) |
float | get_setup_priority () const override |
void | up () |
void | down () |
void | left () |
void | right () |
void | enter () |
void | show_main () |
void | show () |
void | hide () |
void | draw () |
bool | is_active () const |
![]() | |
virtual void | loop () |
This method will be called repeatedly. | |
float | get_actual_setup_priority () const |
void | set_setup_priority (float priority) |
virtual float | get_loop_priority () const |
priority of loop(). | |
void | call () |
virtual void | on_shutdown () |
virtual void | on_safe_shutdown () |
virtual bool | teardown () |
Called during teardown to allow component to gracefully finish operations. | |
virtual void | on_powerdown () |
Called after teardown is complete to power down hardware. | |
uint8_t | get_component_state () const |
void | reset_to_construction_state () |
Reset this component back to the construction state to allow setup to run again. | |
bool | is_in_loop_state () const |
Check if this component has completed setup and is in the loop state. | |
virtual void | mark_failed () |
Mark this component as failed. | |
void | mark_failed (const char *message) |
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. | |
const char * | get_component_source () const |
Get the integration where this component was declared as a string. | |
bool | should_warn_of_blocking (uint32_t blocking_time) |
Protected Member Functions | |
void | draw_and_update () override |
void | draw_menu () override |
void | draw_menu_internal_ (display::Display *display, const display::Rect *bounds) |
void | draw_item (const display_menu_base::MenuItem *item, uint8_t row, bool selected) override |
virtual display::Rect | measure_item (display::Display *display, const display_menu_base::MenuItem *item, const display::Rect *bounds, bool selected) |
virtual void | draw_item (display::Display *display, const display_menu_base::MenuItem *item, const display::Rect *bounds, bool selected) |
void | update () override |
void | on_before_show () override |
void | on_before_hide () override |
![]() | |
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 | on_after_show () |
virtual void | on_after_hide () |
![]() | |
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. | |
void | set_interval (uint32_t interval, std::function< void()> &&f) |
bool | cancel_interval (const std::string &name) |
Cancel an interval function. | |
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. | |
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. | |
void | set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f) |
Set a timeout function with a unique name. | |
void | set_timeout (uint32_t timeout, std::function< void()> &&f) |
bool | cancel_timeout (const std::string &name) |
Cancel a timeout function. | |
void | defer (const std::string &name, std::function< void()> &&f) |
Defer a callback to the next loop() call. | |
void | defer (std::function< void()> &&f) |
Defer a callback to the next loop() call. | |
bool | cancel_defer (const std::string &name) |
Cancel a defer callback using the specified name, name must not be empty. | |
Protected Attributes | |
std::unique_ptr< display::DisplayPage > | display_page_ {nullptr} |
const display::DisplayPage * | previous_display_page_ {nullptr} |
display::Display * | display_ {nullptr} |
display::BaseFont * | font_ {nullptr} |
TemplatableValue< std::string, const MenuItemValueArguments * > | menu_item_value_ |
Color | foreground_color_ {COLOR_ON} |
Color | background_color_ {COLOR_OFF} |
CallbackManager< void()> | on_redraw_callbacks_ {} |
![]() | |
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} |
![]() | |
uint8_t | component_state_ {0x00} |
State of this component - each bit has a purpose: Bits 0-1: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED) Bit 2: STATUS_LED_WARNING Bit 3: STATUS_LED_ERROR Bits 4-7: Unused - reserved for future expansion (50% of the bits are free) | |
float | setup_priority_override_ {NAN} |
const char * | component_source_ {nullptr} |
uint16_t | warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS} |
Warn if blocked for this many ms (max 65.5s) | |
std::string | error_message_ {} |
Definition at line 36 of file graphical_display_menu.h.
|
inline |
Definition at line 47 of file graphical_display_menu.h.
void esphome::graphical_display_menu::GraphicalDisplayMenu::draw | ( | display::Display * | display, |
const display::Rect * | bounds ) |
Definition at line 106 of file graphical_display_menu.cpp.
|
overrideprotectedvirtual |
Reimplemented from esphome::display_menu_base::DisplayMenuComponent.
Definition at line 87 of file graphical_display_menu.cpp.
|
overrideprotectedvirtual |
Implements esphome::display_menu_base::DisplayMenuComponent.
Definition at line 241 of file graphical_display_menu.cpp.
|
inlineprotectedvirtual |
Definition at line 221 of file graphical_display_menu.cpp.
|
overrideprotectedvirtual |
Reimplemented from esphome::display_menu_base::DisplayMenuComponent.
Definition at line 97 of file graphical_display_menu.cpp.
|
protected |
Definition at line 110 of file graphical_display_menu.cpp.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 38 of file graphical_display_menu.cpp.
|
protectedvirtual |
Definition at line 192 of file graphical_display_menu.cpp.
|
overrideprotectedvirtual |
Reimplemented from esphome::display_menu_base::DisplayMenuComponent.
Definition at line 76 of file graphical_display_menu.cpp.
|
overrideprotectedvirtual |
Reimplemented from esphome::display_menu_base::DisplayMenuComponent.
Definition at line 66 of file graphical_display_menu.cpp.
void esphome::graphical_display_menu::GraphicalDisplayMenu::set_background_color | ( | Color | background_color | ) |
Definition at line 64 of file graphical_display_menu.cpp.
void esphome::graphical_display_menu::GraphicalDisplayMenu::set_display | ( | display::Display * | display | ) |
Definition at line 59 of file graphical_display_menu.cpp.
void esphome::graphical_display_menu::GraphicalDisplayMenu::set_font | ( | display::BaseFont * | font | ) |
Definition at line 61 of file graphical_display_menu.cpp.
void esphome::graphical_display_menu::GraphicalDisplayMenu::set_foreground_color | ( | Color | foreground_color | ) |
Definition at line 63 of file graphical_display_menu.cpp.
|
inline |
Definition at line 43 of file graphical_display_menu.h.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 13 of file graphical_display_menu.cpp.
|
overrideprotectedvirtual |
Reimplemented from esphome::display_menu_base::DisplayMenuComponent.
Definition at line 246 of file graphical_display_menu.cpp.
|
protected |
Definition at line 71 of file graphical_display_menu.h.
|
protected |
Definition at line 67 of file graphical_display_menu.h.
|
protected |
Definition at line 65 of file graphical_display_menu.h.
|
protected |
Definition at line 68 of file graphical_display_menu.h.
Definition at line 70 of file graphical_display_menu.h.
|
protected |
Definition at line 69 of file graphical_display_menu.h.
|
protected |
Definition at line 73 of file graphical_display_menu.h.
|
protected |
Definition at line 66 of file graphical_display_menu.h.