#include <graphical_display_menu.h>

Inheritance diagram for esphome::graphical_display_menu::GraphicalDisplayMenu:

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.

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.

bool	is_idle () const
	Check if this component is idle.

virtual void	mark_failed ()
	Mark this component as failed.

void	mark_failed (const char *message)

void	disable_loop ()
	Disable this component's loop.

void	enable_loop ()
	Enable this component's loop.

void	enable_loop_soon_any_context ()
	Thread and ISR-safe version of enable_loop() that can be called from any context.

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=nullptr)

void	status_set_warning (const LogString *message)

void	status_set_error (const char *message=nullptr)

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 LogString *source)
	Set where this component was loaded from for some debug messages.

const LogString *	get_component_log_str () const
	Get the integration where this component was declared as a LogString for logging.

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

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	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_component_state_ (uint8_t state)
	Helper to set component state (clears state bits and sets new state)

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 (const char *name, uint32_t interval, std::function< void()> &&f)
	Set an interval function with a const char* name.

void	set_interval (uint32_t interval, std::function< void()> &&f)

bool	cancel_interval (const std::string &name)
	Cancel an interval function.

bool	cancel_interval (const char *name)

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 (const char *name, uint32_t timeout, std::function< void()> &&f)
	Set a timeout function with a const char* name.

void	set_timeout (uint32_t timeout, std::function< void()> &&f)

bool	cancel_timeout (const std::string &name)
	Cancel a timeout function.

bool	cancel_timeout (const char *name)

void	defer (const std::string &name, std::function< void()> &&f)
	Defer a callback to the next loop() call.

void	defer (const char *name, std::function< void()> &&f)
	Defer a callback to the next loop() call with a const char* name.

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_ {}

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
const LogString *	component_source_ {nullptr}

uint16_t	warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
	Warn if blocked for this many ms (max 65.5s)

uint8_t	component_state_ {0x00}
	State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bits 5-7: Unused - reserved for future expansion.

volatile bool	pending_enable_loop_ {false}
	ISR-safe flag for enable_loop_soon_any_context.

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 106 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 87 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

Implements esphome::display_menu_base::DisplayMenuComponent.

Definition at line 242 of file graphical_display_menu.cpp.

◆ 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 222 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 97 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 110 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 193 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 76 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 66 of file graphical_display_menu.cpp.

◆ set_background_color()

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

Definition at line 64 of file graphical_display_menu.cpp.

◆ set_display()

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

Definition at line 59 of file graphical_display_menu.cpp.

◆ set_font()

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

Definition at line 61 of file graphical_display_menu.cpp.

◆ set_foreground_color()

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

Definition at line 63 of file graphical_display_menu.cpp.

◆ set_menu_item_value()

template<typename V >

void esphome::graphical_display_menu::GraphicalDisplayMenu::set_menu_item_value ( V 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 247 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:

esphome/components/graphical_display_menu/graphical_display_menu.h
esphome/components/graphical_display_menu/graphical_display_menu.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ add_on_redraw_callback()

◆ draw()

◆ draw_and_update()

◆ draw_item() [1/2]

◆ draw_item() [2/2]

◆ draw_menu()

◆ draw_menu_internal_()

◆ dump_config()

◆ measure_item()

◆ on_before_hide()

◆ on_before_show()

◆ set_background_color()

◆ set_display()

◆ set_font()

◆ set_foreground_color()

◆ set_menu_item_value()

◆ setup()

◆ update()

Field Documentation

◆ background_color_

◆ display_

◆ display_page_

◆ font_

◆ foreground_color_

◆ menu_item_value_

◆ on_redraw_callbacks_

◆ previous_display_page_