ESPHome  2024.5.5
Data Structures | Typedefs | Enumerations | Functions
esphome::display_menu_base Namespace Reference

Data Structures

class  DisplayMenuComponent
 Class to display a hierarchical menu. More...
 
class  DisplayMenuOnEnterTrigger
 
class  DisplayMenuOnLeaveTrigger
 
class  DisplayMenuOnNextTrigger
 
class  DisplayMenuOnPrevTrigger
 
class  DisplayMenuOnValueTrigger
 
class  DownAction
 
class  EnterAction
 
class  HideAction
 
class  IsActiveCondition
 
class  LeftAction
 
class  MenuItem
 
class  MenuItemCommand
 
class  MenuItemCustom
 
class  MenuItemEditable
 
class  MenuItemMenu
 
class  MenuItemNumber
 
class  MenuItemSelect
 
class  MenuItemSwitch
 
class  RightAction
 
class  ShowAction
 
class  ShowMainAction
 
class  UpAction
 

Typedefs

using value_getter_t = std::function< std::string(const MenuItem *)>
 

Enumerations

enum  MenuMode { MENU_MODE_ROTARY, MENU_MODE_JOYSTICK }
 
enum  MenuItemType {
  MENU_ITEM_LABEL, MENU_ITEM_MENU, MENU_ITEM_BACK, MENU_ITEM_SELECT,
  MENU_ITEM_NUMBER, MENU_ITEM_SWITCH, MENU_ITEM_COMMAND, MENU_ITEM_CUSTOM
}
 

Functions

const LogString * menu_item_type_to_string (MenuItemType type)
 Returns a string representation of a menu item type suitable for logging. More...
 

Typedef Documentation

◆ value_getter_t

using esphome::display_menu_base::value_getter_t = typedef std::function<std::string(const MenuItem *)>

Definition at line 38 of file menu_item.h.

Enumeration Type Documentation

◆ MenuItemType

Enumerator
MENU_ITEM_LABEL 
MENU_ITEM_MENU 
MENU_ITEM_BACK 
MENU_ITEM_SELECT 
MENU_ITEM_NUMBER 
MENU_ITEM_SWITCH 
MENU_ITEM_COMMAND 
MENU_ITEM_CUSTOM 

Definition at line 22 of file menu_item.h.

◆ MenuMode

Enumerator
MENU_MODE_ROTARY 
MENU_MODE_JOYSTICK 

Definition at line 12 of file display_menu_base.h.

Function Documentation

◆ menu_item_type_to_string()

const LogString * esphome::display_menu_base::menu_item_type_to_string ( MenuItemType  type)

Returns a string representation of a menu item type suitable for logging.

Definition at line 8 of file menu_item.cpp.