Class to display a hierarchical menu.
More...
#include <display_menu_base.h>
|
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_item (const MenuItem *item, uint8_t row, bool selected)=0 |
|
virtual void | update () |
|
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 () |
|
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...
|
|
Class to display a hierarchical menu.
Definition at line 22 of file display_menu_base.h.
◆ check_healthy_and_active_()
bool esphome::display_menu_base::DisplayMenuComponent::check_healthy_and_active_ |
( |
| ) |
|
|
protected |
◆ cursor_down_()
bool esphome::display_menu_base::DisplayMenuComponent::cursor_down_ |
( |
| ) |
|
|
protected |
◆ cursor_up_()
bool esphome::display_menu_base::DisplayMenuComponent::cursor_up_ |
( |
| ) |
|
|
protected |
◆ down()
void esphome::display_menu_base::DisplayMenuComponent::down |
( |
| ) |
|
◆ draw()
void esphome::display_menu_base::DisplayMenuComponent::draw |
( |
| ) |
|
◆ draw_and_update()
virtual void esphome::display_menu_base::DisplayMenuComponent::draw_and_update |
( |
| ) |
|
|
inlineprotectedvirtual |
◆ draw_item()
virtual void esphome::display_menu_base::DisplayMenuComponent::draw_item |
( |
const MenuItem * |
item, |
|
|
uint8_t |
row, |
|
|
bool |
selected |
|
) |
| |
|
protectedpure virtual |
◆ draw_menu()
void esphome::display_menu_base::DisplayMenuComponent::draw_menu |
( |
| ) |
|
|
protectedvirtual |
◆ enter()
void esphome::display_menu_base::DisplayMenuComponent::enter |
( |
| ) |
|
◆ enter_menu_()
bool esphome::display_menu_base::DisplayMenuComponent::enter_menu_ |
( |
| ) |
|
|
protected |
◆ finish_editing_()
void esphome::display_menu_base::DisplayMenuComponent::finish_editing_ |
( |
| ) |
|
|
protected |
◆ get_selected_item_()
MenuItem* esphome::display_menu_base::DisplayMenuComponent::get_selected_item_ |
( |
| ) |
|
|
inlineprotected |
◆ get_setup_priority()
float esphome::display_menu_base::DisplayMenuComponent::get_setup_priority |
( |
| ) |
const |
|
inlineoverridevirtual |
◆ hide()
void esphome::display_menu_base::DisplayMenuComponent::hide |
( |
| ) |
|
◆ is_active()
bool esphome::display_menu_base::DisplayMenuComponent::is_active |
( |
| ) |
const |
|
inline |
◆ leave_menu_()
bool esphome::display_menu_base::DisplayMenuComponent::leave_menu_ |
( |
| ) |
|
|
protected |
◆ left()
void esphome::display_menu_base::DisplayMenuComponent::left |
( |
| ) |
|
◆ on_after_hide()
virtual void esphome::display_menu_base::DisplayMenuComponent::on_after_hide |
( |
| ) |
|
|
inlineprotectedvirtual |
◆ on_after_show()
virtual void esphome::display_menu_base::DisplayMenuComponent::on_after_show |
( |
| ) |
|
|
inlineprotectedvirtual |
◆ on_before_hide()
virtual void esphome::display_menu_base::DisplayMenuComponent::on_before_hide |
( |
| ) |
|
|
inlineprotectedvirtual |
◆ on_before_show()
virtual void esphome::display_menu_base::DisplayMenuComponent::on_before_show |
( |
| ) |
|
|
inlineprotectedvirtual |
◆ process_initial_()
void esphome::display_menu_base::DisplayMenuComponent::process_initial_ |
( |
| ) |
|
|
protected |
◆ reset_()
void esphome::display_menu_base::DisplayMenuComponent::reset_ |
( |
| ) |
|
|
protected |
◆ right()
void esphome::display_menu_base::DisplayMenuComponent::right |
( |
| ) |
|
◆ set_active()
void esphome::display_menu_base::DisplayMenuComponent::set_active |
( |
bool |
active | ) |
|
|
inline |
◆ set_mode()
void esphome::display_menu_base::DisplayMenuComponent::set_mode |
( |
MenuMode |
mode | ) |
|
|
inline |
◆ set_root_item()
void esphome::display_menu_base::DisplayMenuComponent::set_root_item |
( |
MenuItemMenu * |
item | ) |
|
|
inline |
◆ set_rows()
void esphome::display_menu_base::DisplayMenuComponent::set_rows |
( |
uint8_t |
rows | ) |
|
|
inline |
◆ show()
void esphome::display_menu_base::DisplayMenuComponent::show |
( |
| ) |
|
◆ show_main()
void esphome::display_menu_base::DisplayMenuComponent::show_main |
( |
| ) |
|
◆ up()
void esphome::display_menu_base::DisplayMenuComponent::up |
( |
| ) |
|
◆ update()
virtual void esphome::display_menu_base::DisplayMenuComponent::update |
( |
| ) |
|
|
inlineprotectedvirtual |
◆ active_
bool esphome::display_menu_base::DisplayMenuComponent::active_ |
|
protected |
◆ cursor_index_
uint8_t esphome::display_menu_base::DisplayMenuComponent::cursor_index_ {0} |
|
protected |
◆ displayed_item_
MenuItemMenu* esphome::display_menu_base::DisplayMenuComponent::displayed_item_ {nullptr} |
|
protected |
◆ editing_
bool esphome::display_menu_base::DisplayMenuComponent::editing_ {false} |
|
protected |
◆ mode_
MenuMode esphome::display_menu_base::DisplayMenuComponent::mode_ |
|
protected |
◆ root_item_
MenuItemMenu* esphome::display_menu_base::DisplayMenuComponent::root_item_ {nullptr} |
|
protected |
◆ root_on_enter_called_
bool esphome::display_menu_base::DisplayMenuComponent::root_on_enter_called_ {false} |
|
protected |
◆ rows_
uint8_t esphome::display_menu_base::DisplayMenuComponent::rows_ |
|
protected |
◆ selection_stack_
std::forward_list<std::pair<uint8_t, uint8_t> > esphome::display_menu_base::DisplayMenuComponent::selection_stack_ {} |
|
protected |
◆ top_index_
uint8_t esphome::display_menu_base::DisplayMenuComponent::top_index_ {0} |
|
protected |
The documentation for this class was generated from the following files: