ESPHome  2024.11.0
Public Member Functions | Protected Member Functions | Protected Attributes
esphome::graphical_display_menu::GraphicalDisplayMenu Class Reference

#include <graphical_display_menu.h>

Inheritance diagram for esphome::graphical_display_menu::GraphicalDisplayMenu:
esphome::display_menu_base::DisplayMenuComponent esphome::Component

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)
 
- 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)
 
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
 
- 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_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
 
- Protected Member Functions inherited from esphome::display_menu_base::DisplayMenuComponent
void reset_ ()
 
void process_initial_ ()
 
bool check_healthy_and_active_ ()
 
MenuItemget_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 ()
 
- 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

std::unique_ptr< display::DisplayPagedisplay_page_ {nullptr}
 
const display::DisplayPageprevious_display_page_ {nullptr}
 
display::Displaydisplay_ {nullptr}
 
display::BaseFontfont_ {nullptr}
 
TemplatableValue< std::string, const MenuItemValueArguments * > menu_item_value_
 
Color foreground_color_ {COLOR_ON}
 
Color background_color_ {COLOR_OFF}
 
CallbackManager< void()> on_redraw_callbacks_ {}
 
- Protected Attributes inherited from esphome::display_menu_base::DisplayMenuComponent
uint8_t rows_
 
bool active_
 
MenuMode mode_
 
MenuItemMenuroot_item_ {nullptr}
 
MenuItemMenudisplayed_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}
 

Detailed Description

Definition at line 36 of file graphical_display_menu.h.

Member Function Documentation

◆ add_on_redraw_callback()

void esphome::graphical_display_menu::GraphicalDisplayMenu::add_on_redraw_callback ( std::function< void()> &&  cb)
inline

Definition at line 47 of file graphical_display_menu.h.

◆ draw()

void esphome::graphical_display_menu::GraphicalDisplayMenu::draw ( display::Display display,
const display::Rect bounds 
)

Definition at line 102 of file graphical_display_menu.cpp.

◆ draw_and_update()

void esphome::graphical_display_menu::GraphicalDisplayMenu::draw_and_update ( )
overrideprotectedvirtual

Reimplemented from esphome::display_menu_base::DisplayMenuComponent.

Definition at line 83 of file graphical_display_menu.cpp.

◆ draw_item() [1/2]

void esphome::graphical_display_menu::GraphicalDisplayMenu::draw_item ( const display_menu_base::MenuItem item,
uint8_t  row,
bool  selected 
)
overrideprotectedvirtual

◆ draw_item() [2/2]

void esphome::graphical_display_menu::GraphicalDisplayMenu::draw_item ( display::Display display,
const display_menu_base::MenuItem item,
const display::Rect bounds,
bool  selected 
)
inlineprotectedvirtual

Definition at line 217 of file graphical_display_menu.cpp.

◆ draw_menu()

void esphome::graphical_display_menu::GraphicalDisplayMenu::draw_menu ( )
overrideprotectedvirtual

Reimplemented from esphome::display_menu_base::DisplayMenuComponent.

Definition at line 93 of file graphical_display_menu.cpp.

◆ draw_menu_internal_()

void esphome::graphical_display_menu::GraphicalDisplayMenu::draw_menu_internal_ ( display::Display display,
const display::Rect bounds 
)
protected

Definition at line 106 of file graphical_display_menu.cpp.

◆ dump_config()

void esphome::graphical_display_menu::GraphicalDisplayMenu::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 38 of file graphical_display_menu.cpp.

◆ measure_item()

display::Rect esphome::graphical_display_menu::GraphicalDisplayMenu::measure_item ( display::Display display,
const display_menu_base::MenuItem item,
const display::Rect bounds,
bool  selected 
)
protectedvirtual

Definition at line 188 of file graphical_display_menu.cpp.

◆ on_before_hide()

void esphome::graphical_display_menu::GraphicalDisplayMenu::on_before_hide ( )
overrideprotectedvirtual

Reimplemented from esphome::display_menu_base::DisplayMenuComponent.

Definition at line 72 of file graphical_display_menu.cpp.

◆ on_before_show()

void esphome::graphical_display_menu::GraphicalDisplayMenu::on_before_show ( )
overrideprotectedvirtual

Reimplemented from esphome::display_menu_base::DisplayMenuComponent.

Definition at line 62 of file graphical_display_menu.cpp.

◆ set_background_color()

void esphome::graphical_display_menu::GraphicalDisplayMenu::set_background_color ( Color  background_color)

Definition at line 60 of file graphical_display_menu.cpp.

◆ set_display()

void esphome::graphical_display_menu::GraphicalDisplayMenu::set_display ( display::Display display)

Definition at line 55 of file graphical_display_menu.cpp.

◆ set_font()

void esphome::graphical_display_menu::GraphicalDisplayMenu::set_font ( display::BaseFont font)

Definition at line 57 of file graphical_display_menu.cpp.

◆ set_foreground_color()

void esphome::graphical_display_menu::GraphicalDisplayMenu::set_foreground_color ( Color  foreground_color)

Definition at line 59 of file graphical_display_menu.cpp.

◆ set_menu_item_value()

template<typename V >
void esphome::graphical_display_menu::GraphicalDisplayMenu::set_menu_item_value ( menu_item_value)
inline

Definition at line 43 of file graphical_display_menu.h.

◆ setup()

void esphome::graphical_display_menu::GraphicalDisplayMenu::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 13 of file graphical_display_menu.cpp.

◆ update()

void esphome::graphical_display_menu::GraphicalDisplayMenu::update ( )
overrideprotectedvirtual

Reimplemented from esphome::display_menu_base::DisplayMenuComponent.

Definition at line 242 of file graphical_display_menu.cpp.

Field Documentation

◆ background_color_

Color esphome::graphical_display_menu::GraphicalDisplayMenu::background_color_ {COLOR_OFF}
protected

Definition at line 71 of file graphical_display_menu.h.

◆ display_

display::Display* esphome::graphical_display_menu::GraphicalDisplayMenu::display_ {nullptr}
protected

Definition at line 67 of file graphical_display_menu.h.

◆ display_page_

std::unique_ptr<display::DisplayPage> esphome::graphical_display_menu::GraphicalDisplayMenu::display_page_ {nullptr}
protected

Definition at line 65 of file graphical_display_menu.h.

◆ font_

display::BaseFont* esphome::graphical_display_menu::GraphicalDisplayMenu::font_ {nullptr}
protected

Definition at line 68 of file graphical_display_menu.h.

◆ foreground_color_

Color esphome::graphical_display_menu::GraphicalDisplayMenu::foreground_color_ {COLOR_ON}
protected

Definition at line 70 of file graphical_display_menu.h.

◆ menu_item_value_

TemplatableValue<std::string, const MenuItemValueArguments *> esphome::graphical_display_menu::GraphicalDisplayMenu::menu_item_value_
protected

Definition at line 69 of file graphical_display_menu.h.

◆ on_redraw_callbacks_

CallbackManager<void()> esphome::graphical_display_menu::GraphicalDisplayMenu::on_redraw_callbacks_ {}
protected

Definition at line 73 of file graphical_display_menu.h.

◆ previous_display_page_

const display::DisplayPage* esphome::graphical_display_menu::GraphicalDisplayMenu::previous_display_page_ {nullptr}
protected

Definition at line 66 of file graphical_display_menu.h.


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