LiquidMenu

https://vasilkalchev.github.io/LiquidMenu/
Admin
LiquidMenu is an Arduino library that simplifies menu creation for LCD displays by wrapping...
Tokens:27,124
Snippets:317
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Basic LiquidMenu Setup Example

Source: https://vasilkalchev.github.io/LiquidMenu/index.html

This example demonstrates the basic setup of the LiquidMenu library, including initializing the LCD, creating lines and screens, and updating the menu in the main loop.

```cpp
// ...
// First we need to instantiate the LiquidCrystal object.
LiquidCrystal lcd(LCD_RS, LCD_E, LCD_D4, LCD_D5, LCD_D6, LCD_D7);
// a variable that will be updated periodically somewhere in our code
float temperature = 0.0f;
// ----- WELCOME SCREEN -----
// a line of one string literal
LiquidLine lineHello(2, 0, "Hello world!");
LiquidLine lineRight(7, 1, ">");
// create a screen from the above lines
LiquidScreen screenMain(lineHello, lineRight);
// --------------------------
// ----- STATUS SCREEN ----- 
// a line of two string literals and a float variable
LiquidLine lineTemp(0, 0, "Temp: ", temperature, "C");
LiquidScreen screenStatus(lineTemp);
// -------------------------
// ----- MENU -----
// create a menu from the screens
LiquidMenu menu(lcd, screenMain, screenStatus);
// ----------------
void setup() {
lcd.begin(16, 2);
// ...
}
void loop() {
temperature = readTemperature();
menu.update(); // update the display to show the new information
if (rightButton()) {
menu.next_screen();
}
if (leftButton()) {
menu.previous_screen();
}
// ...
}
```

--------------------------------

### LiquidSystem() Constructor (3 Menus)

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_system.html

Constructor for initializing a LiquidSystem with 3 LiquidMenu objects and an optional starting menu.

```APIDOC
## LiquidSystem() [3/4]

### Description
Constructor for 3 LiquidMenu objects.

### Parameters
- **&liquidMenu1** (LiquidMenu &) - Pointer to a LiquidMenu object.
- **&liquidMenu2** (LiquidMenu &) - Pointer to a LiquidMenu object.
- **&liquidMenu3** (LiquidMenu &) - Pointer to a LiquidMenu object.
- **_startingMenu_** (uint8_t) - Optional, defaults to 1. The number of the menu that will be shown first.
```

--------------------------------

### LiquidSystem() Constructor (4 Menus)

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_system.html

Constructor for initializing a LiquidSystem with 4 LiquidMenu objects and an optional starting menu.

```APIDOC
## LiquidSystem() [4/4]

### Description
Constructor for 4 LiquidMenu objects.

### Parameters
- **&liquidMenu1** (LiquidMenu &) - Pointer to a LiquidMenu object.
- **&liquidMenu2** (LiquidMenu &) - Pointer to a LiquidMenu object.
- **&liquidMenu3** (LiquidMenu &) - Pointer to a LiquidMenu object.
- **&liquidMenu4** (LiquidMenu &) - Pointer to a LiquidMenu object.
- **_startingMenu_** (uint8_t) - Optional, defaults to 1. The number of the menu that will be shown first.
```

--------------------------------

### LiquidSystem Constructors

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_system-members.html

Constructors for initializing the LiquidSystem with one or more LiquidMenu objects and an optional starting menu index.

```APIDOC
## LiquidSystem Constructors

### Description
Initializes the LiquidSystem, which manages multiple LiquidMenu instances and screens.

### Constructors
- `LiquidSystem(uint8_t startingMenu=1)`: Explicit constructor.
- `LiquidSystem(LiquidMenu &liquidMenu1, LiquidMenu &liquidMenu2, uint8_t startingMenu=1)`
- `LiquidSystem(LiquidMenu &liquidMenu1, LiquidMenu &liquidMenu2, LiquidMenu &liquidMenu3, uint8_t startingMenu=1)`
- `LiquidSystem(LiquidMenu &liquidMenu1, LiquidMenu &liquidMenu2, LiquidMenu &liquidMenu3, LiquidMenu &liquidMenu4, uint8_t startingMenu=1)`
```

--------------------------------

### LiquidSystem::get_currentScreen()

Source: https://vasilkalchev.github.io/LiquidMenu/functions.html

Gets the currently displayed screen in the system.

```APIDOC
## LiquidSystem::get_currentScreen()

### Description
Gets the currently displayed screen in the system.

### Method
(Not specified, likely a C++ method call)

### Parameters
(Not specified)

### Request Example
(Not specified)

### Response
(Not specified)
```

--------------------------------

### LiquidMenu::get_currentScreen()

Source: https://vasilkalchev.github.io/LiquidMenu/functions.html

Gets the currently displayed screen.

```APIDOC
## LiquidMenu::get_currentScreen()

### Description
Gets the currently displayed screen.

### Method
(Not specified, likely a C++ method call)

### Parameters
(Not specified)

### Request Example
(Not specified)

### Response
(Not specified)
```

--------------------------------

### get_currentScreen

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_menu-members.html

Gets the currently displayed LiquidScreen.

```APIDOC
## get_currentScreen() const

### Description
Returns a pointer to the currently displayed LiquidScreen.

### Method
const
```

--------------------------------

### LiquidSystem::get_focusedLine()

Source: https://vasilkalchev.github.io/LiquidMenu/functions.html

Gets the currently focused line in the system.

```APIDOC
## LiquidSystem::get_focusedLine()

### Description
Gets the currently focused line in the system.

### Method
(Not specified, likely a C++ method call)

### Parameters
(Not specified)

### Request Example
(Not specified)

### Response
(Not specified)
```

--------------------------------

### LiquidLine Constructor for Four Variables

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_line.html

Initializes a LiquidLine object with a starting column and row, and four variables or constants to be displayed. Use when you need to display exactly four dynamic values on a line.

```cpp
template<typename A , typename B , typename C , typename D >
LiquidLine::LiquidLine( uint8_t _column_ , 
                      uint8_t _row_ , 
                      A & _variableA_ ,
                      B & _variableB_ ,
                      C & _variableC_ ,
                      D & _variableD_ )
```

--------------------------------

### init

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_menu-members.html

Initializes the LiquidMenu system.

```APIDOC
## init() const

### Description
Initializes the LiquidMenu system. This should be called after creating the LiquidMenu object.

### Method
const
```

--------------------------------

### LiquidMenu::init()

Source: https://vasilkalchev.github.io/LiquidMenu/functions.html

Initializes the LiquidMenu.

```APIDOC
## LiquidMenu::init()

### Description
Initializes the LiquidMenu.

### Method
(Not specified, likely a C++ method call)

### Parameters
(Not specified)

### Request Example
(Not specified)

### Response
(Not specified)
```

--------------------------------

### LiquidMenu::get_focusedLine()

Source: https://vasilkalchev.github.io/LiquidMenu/functions.html

Gets the currently focused line on the screen.

```APIDOC
## LiquidMenu::get_focusedLine()

### Description
Gets the currently focused line on the screen.

### Method
(Not specified, likely a C++ method call)

### Parameters
(Not specified)

### Request Example
(Not specified)

### Response
(Not specified)
```

--------------------------------

### init()

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_menu.html

Initializes the menu object. This is needed when using an I2C display library.

```APIDOC
## ◆ init()
void LiquidMenu::init  | ( | | ) |  const  
---|---|---|---
Initializes the menu object. 
Call this method to fully initialize the menu object. 

Note
    Needed when using an I2C display library. 
```

--------------------------------

### get_focusedLine

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_menu-members.html

Gets the index of the currently focused line on the screen.

```APIDOC
## get_focusedLine() const

### Description
Returns the index of the currently focused line on the active screen.

### Method
const
```

--------------------------------

### init()

Source: https://vasilkalchev.github.io/LiquidMenu/functions_func.html

Initializes the LiquidMenu. This function is a member of the LiquidMenu class.

```APIDOC
## init()

### Description
Initializes the LiquidMenu.

### Class
LiquidMenu

### Method Signature
`LiquidMenu.init()`
```

--------------------------------

### get_focusedLine()

Source: https://vasilkalchev.github.io/LiquidMenu/functions_func.html

Gets the currently focused line within a LiquidMenu or LiquidSystem. This function is a member of both classes.

```APIDOC
## get_focusedLine()

### Description
Gets the currently focused line.

### Classes
LiquidMenu, LiquidSystem

### Method Signature
`get_focusedLine()`
```

--------------------------------

### LiquidSystem::LiquidSystem()

Source: https://vasilkalchev.github.io/LiquidMenu/functions.html

Constructor for LiquidSystem.

```APIDOC
## LiquidSystem::LiquidSystem()

### Description
Constructor for LiquidSystem.

### Method
(Not specified, likely a C++ constructor)

### Parameters
(Not specified)

### Request Example
(Not specified)

### Response
(Not specified)
```

--------------------------------

### LiquidMenu::LiquidMenu()

Source: https://vasilkalchev.github.io/LiquidMenu/functions.html

Constructor for LiquidMenu.

```APIDOC
## LiquidMenu::LiquidMenu()

### Description
Constructor for LiquidMenu.

### Method
(Not specified, likely a C++ constructor)

### Parameters
(Not specified)

### Request Example
(Not specified)

### Response
(Not specified)
```

--------------------------------

### next_screen()

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_system.html

Switches the system to the next screen in sequence.

```APIDOC
## next_screen()

### Description
Switches to the next screen.
```

--------------------------------

### LiquidSystem::next_screen()

Source: https://vasilkalchev.github.io/LiquidMenu/functions.html

Navigates to the next screen in the system.

```APIDOC
## LiquidSystem::next_screen()

### Description
Navigates to the next screen in the system.

### Method
(Not specified, likely a C++ method call)

### Parameters
(Not specified)

### Request Example
(Not specified)

### Response
(Not specified)
```

--------------------------------

### LiquidSystem Methods

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_system-members.html

Methods for managing menus, screens, focus, and updating the display.

```APIDOC
## LiquidSystem Methods

### Description
Provides functionality to add menus, navigate between screens, control focus, and update the display.

### Methods
- `add_menu(LiquidMenu &liquidMenu)`: Adds a LiquidMenu instance to the system.
- `call_function(uint8_t number, bool refresh=true) const`: Calls a function associated with a menu item.
- `change_menu(LiquidMenu &p_liquidMenu)`: Changes the currently active LiquidMenu.
- `change_screen(LiquidScreen *p_liquidScreen)`: Changes the current screen to a specific LiquidScreen object.
- `change_screen(uint8_t number)`: Changes the current screen using its index.
- `get_currentScreen() const`: Returns a pointer to the current LiquidScreen.
- `get_focusedLine() const`: Returns the index of the currently focused line within the active menu.
- `is_callable(uint8_t number) const`: Checks if a menu item at the given number is callable.
- `next_screen()`: Advances to the next screen in sequence.
- `previous_screen()`: Goes back to the previous screen in sequence.
- `set_focusedLine(uint8_t lineIndex)`: Sets the index of the focused line.
- `set_focusPosition(Position position)`: Sets the focus symbol position.
- `set_focusSymbol(Position position, uint8_t symbol[8])`: Sets a custom focus symbol.
- `softUpdate() const`: Performs a soft update of the display.
- `switch_focus(bool forward=true)`: Switches focus to the next or previous item.
- `update() const`: Updates the entire display.
```

--------------------------------

### is_callable()

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_menu.html

Checks if a function is attached at the specified number in the menu's function array. Function numbering starts from 1.

```APIDOC
## is_callable()

### Description
Checks if there is an attached function at the specified number.

### Parameters
*   **number** (uint8_t) - Required - The number of the function in the array. Function numbering starts from 1.

### Returns
*   **bool** - true if there is a function at the specified number, false otherwise.

### See Also
*   `LiquidLine::attach_function(uint8_t number, void (*function)(void))`
```

--------------------------------

### change_screen() (by pointer)

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_system.html

Switches the system to a specified LiquidScreen object. Returns true on success, false if the screen is not found.

```APIDOC
## change_screen() [1/2]

### Description
Switches to the specified screen.

### Parameters
- **_p_liquidScreen_** (LiquidScreen *) - Pointer to the LiquidScreen object.

### Returns
- `true` on success.
- `false` if the screen is not found.
```

--------------------------------

### Attach Function to LiquidLine

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_line.html

Attaches a callback function to the LiquidLine, identified by a number. The function can be called later using LiquidMenu::call_function. Returns true on success, or false if the maximum number of functions (MAX_FUNCTIONS, default 8) has been reached. Function numbering starts from 1.

```cpp
bool LiquidLine::attach_function( uint8_t _number_ ,
                                void(* _function)(void) )

```

--------------------------------

### LiquidScreen::LiquidScreen()

Source: https://vasilkalchev.github.io/LiquidMenu/functions.html

Constructor for LiquidScreen.

```APIDOC
## LiquidScreen::LiquidScreen()

### Description
Constructor for LiquidScreen.

### Method
(Not specified, likely a C++ constructor)

### Parameters
(Not specified)

### Request Example
(Not specified)

### Response
(Not specified)
```

--------------------------------

### LiquidMenu::next_screen()

Source: https://vasilkalchev.github.io/LiquidMenu/functions.html

Navigates to the next screen.

```APIDOC
## LiquidMenu::next_screen()

### Description
Navigates to the next screen.

### Method
(Not specified, likely a C++ method call)

### Parameters
(Not specified)

### Request Example
(Not specified)

### Response
(Not specified)
```

--------------------------------

### LiquidSystem Constructors

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_system.html

Constructors for initializing the LiquidSystem with different numbers of LiquidMenu objects.

```APIDOC
## LiquidSystem() [1/4]

explicit LiquidSystem(uint8_t _startingMenu_ = `1`)

### Description
The main constructor. This is the main constructor that gets called every time.

### Parameters
- **startingMenu** (uint8_t) - The number of the menu that will be shown first.

## LiquidSystem() [2/4]

LiquidSystem(
    LiquidMenu & _liquidMenu1_,
    LiquidMenu & _liquidMenu2_,
    uint8_t _startingMenu_ = `1`
)

### Description
Constructor for 2 LiquidMenu objects.

### Parameters
- **liquidMenu1** (LiquidMenu &) - Pointer to a LiquidMenu object.
- **liquidMenu2** (LiquidMenu &) - Pointer to a LiquidMenu object.
- **startingMenu** (uint8_t) - The number of the menu that will be shown first.
```

--------------------------------

### LiquidMenu Constructors

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_menu.html

Constructors for initializing the LiquidMenu object with different numbers of LiquidScreen objects.

```APIDOC
## LiquidMenu Constructor (1 LiquidScreen)

### Description
Initializes the LiquidMenu with a reference to the DisplayClass object and an optional starting screen number.

### Parameters
- **liquidCrystal** (DisplayClass&) - Reference to the DisplayClass object.
- **startingScreen** (uint8_t) - Optional, the starting screen number (defaults to 1).

### Example
```cpp
LiquidMenu menu(lcd, 1);
```
```

```APIDOC
## LiquidMenu Constructor (Multiple LiquidScreens)

### Description
Initializes the LiquidMenu with a reference to the DisplayClass object and one or more LiquidScreen objects, with an optional starting screen number.

### Parameters
- **liquidCrystal** (DisplayClass&) - Reference to the DisplayClass object.
- **liquidScreen1** (LiquidScreen&) - Reference to the first LiquidScreen object.
- **liquidScreen2** (LiquidScreen&) - Reference to the second LiquidScreen object (optional).
- **liquidScreen3** (LiquidScreen&) - Reference to the third LiquidScreen object (optional).
- **liquidScreen4** (LiquidScreen&) - Reference to the fourth LiquidScreen object (optional).
- **startingScreen** (uint8_t) - Optional, the starting screen number (defaults to 1).

### Example
```cpp
LiquidMenu menu(lcd, screen1, screen2);
LiquidMenu menu(lcd, screen1, screen2, screen3, screen4, 2);
```
```

--------------------------------

### LiquidSystem::previous_screen()

Source: https://vasilkalchev.github.io/LiquidMenu/functions.html

Navigates to the previous screen in the system.

```APIDOC
## LiquidSystem::previous_screen()

### Description
Navigates to the previous screen in the system.

### Method
(Not specified, likely a C++ method call)

### Parameters
(Not specified)

### Request Example
(Not specified)

### Response
(Not specified)
```

--------------------------------

### LiquidSystem()

Source: https://vasilkalchev.github.io/LiquidMenu/functions_func.html

Constructor for the LiquidSystem class.

```APIDOC
## LiquidSystem()

### Description
Constructor for the LiquidSystem class.

### Class
LiquidSystem

### Method Signature
`LiquidSystem()`
```

--------------------------------

### LiquidMenu() Constructors

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_menu.html

Constructors for the LiquidMenu class, allowing initialization with different numbers of LiquidScreen objects.

```APIDOC
## ◆ LiquidMenu() [1/5]
LiquidMenu::LiquidMenu  | ( | DisplayClass & | _liquidCrystal_ ,   
---|---|---|---
|  | LiquidScreen & | _liquidScreen_ ,   
|  | uint8_t  | _startingScreen_ = `1`  
| ) | |   
Constructor for 1 LiquidScreen object.  

Parameters
     &liquidCrystal| - pointer to the DisplayClass object   
---|---
&liquidScreen| - pointer to a LiquidScreen object   
startingScreen| - the number of the screen that will be shown first   

## ◆ LiquidMenu() [2/5]
LiquidMenu::LiquidMenu  | ( | DisplayClass & | _liquidCrystal_ ,   
---|---|---|---
|  | LiquidScreen & | _liquidScreen1_ ,   
|  | LiquidScreen & | _liquidScreen2_ ,   
|  | uint8_t  | _startingScreen_ = `1`  
| ) | |   
Constructor for 2 LiquidScreen objects.  

Parameters
     &liquidCrystal| - pointer to the DisplayClass object   
---|---
&liquidScreen1| - pointer to a LiquidScreen object   
&liquidScreen2| - pointer to a LiquidScreen object   
startingScreen| - the number of the screen that will be shown first   

## ◆ LiquidMenu() [3/5]
LiquidMenu::LiquidMenu  | ( | DisplayClass & | _liquidCrystal_ ,   
---|---|---|---
|  | LiquidScreen & | _liquidScreen1_ ,   
|  | LiquidScreen & | _liquidScreen2_ ,   
|  | LiquidScreen & | _liquidScreen3_ ,   
|  | uint8_t  | _startingScreen_ = `1`  
| ) | |   
Constructor for 3 LiquidScreen objects.  

Parameters
     &liquidCrystal| - pointer to the DisplayClass object   
---|---
&liquidScreen1| - pointer to a LiquidScreen object   
&liquidScreen2| - pointer to a LiquidScreen object   
&liquidScreen3| - pointer to a LiquidScreen object   
startingScreen| - the number of the screen that will be shown first   

## ◆ LiquidMenu() [4/5]
LiquidMenu::LiquidMenu  | ( | DisplayClass & | _liquidCrystal_ ,   
---|---|---|---
|  | LiquidScreen & | _liquidScreen1_ ,   
|  | LiquidScreen & | _liquidScreen2_ ,   
|  | LiquidScreen & | _liquidScreen3_ ,   
|  | LiquidScreen & | _liquidScreen4_ ,   
|  | uint8_t  | _startingScreen_ = `1`  
| ) | |   
Constructor for 4 LiquidScreen objects.  

Parameters
     &liquidCrystal| - pointer to the DisplayClass object   
---|---
&liquidScreen1| - pointer to a LiquidScreen object   
&liquidScreen2| - pointer to a LiquidScreen object   
&liquidScreen3| - pointer to a LiquidScreen object   
&liquidScreen4| - pointer to a LiquidScreen object   
startingScreen| - the number of the screen that will be shown first   
```

--------------------------------

### LiquidSystem::add_menu()

Source: https://vasilkalchev.github.io/LiquidMenu/functions.html

Adds a menu to the system.

```APIDOC
## LiquidSystem::add_menu()

### Description
Adds a menu to the system.

### Method
(Not specified, likely a C++ method call)

### Parameters
(Not specified)

### Request Example
(Not specified)

### Response
(Not specified)
```

--------------------------------

### LiquidMenu()

Source: https://vasilkalchev.github.io/LiquidMenu/functions_func.html

Constructor for the LiquidMenu class.

```APIDOC
## LiquidMenu()

### Description
Constructor for the LiquidMenu class.

### Class
LiquidMenu

### Method Signature
`LiquidMenu()`
```

--------------------------------

### change_menu()

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_system.html

Switches the system to a specified LiquidMenu object. Returns true on success, false if the menu is not found.

```APIDOC
## change_menu()

### Description
Switches to the specified menu.

### Parameters
- **_p_liquidMenu_** (LiquidMenu &) - Pointer to the LiquidMenu object.

### Returns
- `true` on success.
- `false` if the menu is not found.
```

--------------------------------

### LiquidScreen()

Source: https://vasilkalchev.github.io/LiquidMenu/functions_func.html

Constructor for the LiquidScreen class.

```APIDOC
## LiquidScreen()

### Description
Constructor for the LiquidScreen class.

### Class
LiquidScreen

### Method Signature
`LiquidScreen()`
```

--------------------------------

### LiquidMenu::previous_screen()

Source: https://vasilkalchev.github.io/LiquidMenu/functions.html

Navigates to the previous screen.

```APIDOC
## LiquidMenu::previous_screen()

### Description
Navigates to the previous screen.

### Method
(Not specified, likely a C++ method call)

### Parameters
(Not specified)

### Request Example
(Not specified)

### Response
(Not specified)
```

--------------------------------

### update

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_system.html

Prints the current screen to the display.

```APIDOC
## update

void update() const

### Description
Prints the current screen to the display.
```

--------------------------------

### LiquidSystem::switch_focus()

Source: https://vasilkalchev.github.io/LiquidMenu/functions.html

Switches the focus within the system.

```APIDOC
## LiquidSystem::switch_focus()

### Description
Switches the focus within the system.

### Method
(Not specified, likely a C++ method call)

### Parameters
(Not specified)

### Request Example
(Not specified)

### Response
(Not specified)
```

--------------------------------

### softUpdate

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_system.html

Prints the current screen to the display without clearing it first.

```APIDOC
## softUpdate

void softUpdate() const

### Description
Prints the current screen to the display (without clearing).
```

--------------------------------

### change_screen() (by number)

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_system.html

Switches the system to a specified screen by its number. Returns true on success, false if the screen number is invalid.

```APIDOC
## change_screen() [2/2]

### Description
Switches to the specified screen.

### Parameters
- **_number_** (uint8_t) - The number of the screen.

### Returns
- `true` on success.
- `false` if the number of the screen is invalid.
```

--------------------------------

### LiquidMenu Constructors

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_menu-members.html

Constructors for the LiquidMenu class.

```APIDOC
## LiquidMenu(DisplayClass &liquidCrystal, uint8_t startingScreen=1)

### Description
Constructor for LiquidMenu. Initializes the menu with a LiquidCrystal object and a starting screen number.

### Parameters
#### Path Parameters
- **liquidCrystal** (DisplayClass &) - Required - A reference to the LiquidCrystal object.
- **startingScreen** (uint8_t) - Optional - The number of the screen to start with. Defaults to 1.
```

```APIDOC
## LiquidMenu(DisplayClass &liquidCrystal, LiquidScreen &liquidScreen, uint8_t startingScreen=1)

### Description
Constructor for LiquidMenu. Initializes the menu with a LiquidCrystal object, a starting LiquidScreen, and a starting screen number.

### Parameters
#### Path Parameters
- **liquidCrystal** (DisplayClass &) - Required - A reference to the LiquidCrystal object.
- **liquidScreen** (LiquidScreen &) - Required - The initial LiquidScreen.
- **startingScreen** (uint8_t) - Optional - The number of the screen to start with. Defaults to 1.
```

```APIDOC
## LiquidMenu(DisplayClass &liquidCrystal, LiquidScreen &liquidScreen1, LiquidScreen &liquidScreen2, uint8_t startingScreen=1)

### Description
Constructor for LiquidMenu. Initializes the menu with a LiquidCrystal object and two LiquidScreens.

### Parameters
#### Path Parameters
- **liquidCrystal** (DisplayClass &) - Required - A reference to the LiquidCrystal object.
- **liquidScreen1** (LiquidScreen &) - Required - The first LiquidScreen.
- **liquidScreen2** (LiquidScreen &) - Required - The second LiquidScreen.
- **startingScreen** (uint8_t) - Optional - The number of the screen to start with. Defaults to 1.
```

```APIDOC
## LiquidMenu(DisplayClass &liquidCrystal, LiquidScreen &liquidScreen1, LiquidScreen &liquidScreen2, LiquidScreen &liquidScreen3, uint8_t startingScreen=1)

### Description
Constructor for LiquidMenu. Initializes the menu with a LiquidCrystal object and three LiquidScreens.

### Parameters
#### Path Parameters
- **liquidCrystal** (DisplayClass &) - Required - A reference to the LiquidCrystal object.
- **liquidScreen1** (LiquidScreen &) - Required - The first LiquidScreen.
- **liquidScreen2** (LiquidScreen &) - Required - The second LiquidScreen.
- **liquidScreen3** (LiquidScreen &) - Required - The third LiquidScreen.
- **startingScreen** (uint8_t) - Optional - The number of the screen to start with. Defaults to 1.
```

```APIDOC
## LiquidMenu(DisplayClass &liquidCrystal, LiquidScreen &liquidScreen1, LiquidScreen &liquidScreen2, LiquidScreen &liquidScreen3, LiquidScreen &liquidScreen4, uint8_t startingScreen=1)

### Description
Constructor for LiquidMenu. Initializes the menu with a LiquidCrystal object and four LiquidScreens.

### Parameters
#### Path Parameters
- **liquidCrystal** (DisplayClass &) - Required - A reference to the LiquidCrystal object.
- **liquidScreen1** (LiquidScreen &) - Required - The first LiquidScreen.
- **liquidScreen2** (LiquidScreen &) - Required - The second LiquidScreen.
- **liquidScreen3** (LiquidScreen &) - Required - The third LiquidScreen.
- **liquidScreen4** (LiquidScreen &) - Required - The fourth LiquidScreen.
- **startingScreen** (uint8_t) - Optional - The number of the screen to start with. Defaults to 1.
```

--------------------------------

### LiquidLine::LiquidLine()

Source: https://vasilkalchev.github.io/LiquidMenu/functions.html

Constructor for LiquidLine.

```APIDOC
## LiquidLine::LiquidLine()

### Description
Constructor for LiquidLine.

### Method
(Not specified, likely a C++ constructor)

### Parameters
(Not specified)

### Request Example
(Not specified)

### Response
(Not specified)
```

--------------------------------

### change_menu

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_system.html

Switches to the specified menu.

```APIDOC
## change_menu

bool change_menu(LiquidMenu &p_liquidMenu)

### Description
Switches to the specified menu.

### Parameters
- **p_liquidMenu** (LiquidMenu &) - The LiquidMenu object to switch to.
```

--------------------------------

### LiquidMenu_config.h Header File

Source: https://vasilkalchev.github.io/LiquidMenu/dir_68267d1309a1af8e8297ef4c3efbcdba.html

Configuration header file for LiquidMenu, allowing customization of library behavior and settings.

```c++
#include "LiquidMenu_const.h"

```

--------------------------------

### change_screen

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_system.html

Switches to a specific screen by object reference or number.

```APIDOC
## change_screen

bool change_screen(LiquidScreen *p_liquidScreen)

bool change_screen(uint8_t number)

### Description
Switches to the specified screen.

### Parameters
- **p_liquidScreen** (LiquidScreen *) - Pointer to the LiquidScreen object to switch to.
- **number** (uint8_t) - The number of the screen to switch to.
```

--------------------------------

### LiquidSystem::change_menu()

Source: https://vasilkalchev.github.io/LiquidMenu/functions.html

Changes the current menu in the system.

```APIDOC
## LiquidSystem::change_menu()

### Description
Changes the current menu in the system.

### Method
(Not specified, likely a C++ method call)

### Parameters
(Not specified)

### Request Example
(Not specified)

### Response
(Not specified)
```

--------------------------------

### LiquidMenu Navigation Functions

Source: https://vasilkalchev.github.io/LiquidMenu/index.html

Provides functions for navigating through menu screens. Use these to cycle between screens or jump to a specific one.

```c++
void LiquidMenu::next_screen();
void LiquidMenu::previous_screen();
bool LiquidMenu::change_screen(LiquidScreen &liquidScreen);
```

--------------------------------

### LiquidScreen Constructors

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_screen.html

Constructors for creating LiquidScreen objects with varying numbers of LiquidLine objects.

```APIDOC
## LiquidScreen()

The main constructor. This is the main constructor that gets called every time.
```

```APIDOC
## LiquidScreen(LiquidLine &liquidLine)

explicit
Constructor for 1 LiquidLine object.

Parameters:
     &liquidLine| - pointer to a LiquidLine object
```

```APIDOC
## LiquidScreen(LiquidLine &liquidLine1, LiquidLine &liquidLine2)

Constructor for 2 LiquidLine object.

Parameters:
     &liquidLine1| - pointer to a LiquidLine object
     &liquidLine2| - pointer to a LiquidLine object
```

```APIDOC
## LiquidScreen(LiquidLine &liquidLine1, LiquidLine &liquidLine2, LiquidLine &liquidLine3)

Constructor for 3 LiquidLine object.

Parameters:
     &liquidLine1| - pointer to a LiquidLine object
     &liquidLine2| - pointer to a LiquidLine object
     &liquidLine3| - pointer to a LiquidLine object
```

```APIDOC
## LiquidScreen(LiquidLine &liquidLine1, LiquidLine &liquidLine2, LiquidLine &liquidLine3, LiquidLine &liquidLine4)

Constructor for 4 LiquidLine object.

Parameters:
     &liquidLine1| - pointer to a LiquidLine object
     &liquidLine2| - pointer to a LiquidLine object
     &liquidLine3| - pointer to a LiquidLine object
     &liquidLine4| - pointer to a LiquidLine object
```

--------------------------------

### LiquidSystem::change_screen()

Source: https://vasilkalchev.github.io/LiquidMenu/functions.html

Changes the current screen within the system.

```APIDOC
## LiquidSystem::change_screen()

### Description
Changes the current screen within the system.

### Method
(Not specified, likely a C++ method call)

### Parameters
(Not specified)

### Request Example
(Not specified)

### Response
(Not specified)
```

--------------------------------

### LiquidMenu::add_screen()

Source: https://vasilkalchev.github.io/LiquidMenu/functions.html

Adds a screen to the menu.

```APIDOC
## LiquidMenu::add_screen()

### Description
Adds a screen to the menu.

### Method
(Not specified, likely a C++ method call)

### Parameters
(Not specified)

### Request Example
(Not specified)

### Response
(Not specified)
```

--------------------------------

### next_screen()

Source: https://vasilkalchev.github.io/LiquidMenu/functions_func.html

Navigates to the next screen in the menu sequence. This function is a member of both LiquidMenu and LiquidSystem classes.

```APIDOC
## next_screen()

### Description
Navigates to the next screen.

### Classes
LiquidMenu, LiquidSystem

### Method Signature
`next_screen()`
```

--------------------------------

### LiquidScreen Constructors

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_screen-members.html

Constructors for creating LiquidScreen objects.

```APIDOC
## LiquidScreen()

### Description
Default constructor for LiquidScreen.

### Method
(Constructor of LiquidScreen)
```

```APIDOC
## LiquidScreen(LiquidLine &liquidLine)

### Description
Constructor for LiquidScreen that takes a single LiquidLine.

### Method
(Constructor of LiquidScreen)

### Parameters
- **liquidLine** (LiquidLine &) - Required - Explicit constructor. Description not fully provided in source.
```

```APIDOC
## LiquidScreen(LiquidLine &liquidLine1, LiquidLine &liquidLine2)

### Description
Constructor for LiquidScreen that takes two LiquidLine objects.

### Method
(Constructor of LiquidScreen)

### Parameters
- **liquidLine1** (LiquidLine &) - Description not provided in source.
- **liquidLine2** (LiquidLine &) - Description not provided in source.
```

```APIDOC
## LiquidScreen(LiquidLine &liquidLine1, LiquidLine &liquidLine2, LiquidLine &liquidLine3)

### Description
Constructor for LiquidScreen that takes three LiquidLine objects.

### Method
(Constructor of LiquidScreen)

### Parameters
- **liquidLine1** (LiquidLine &) - Description not provided in source.
- **liquidLine2** (LiquidLine &) - Description not provided in source.
- **liquidLine3** (LiquidLine &) - Description not provided in source.
```

```APIDOC
## LiquidScreen(LiquidLine &liquidLine1, LiquidLine &liquidLine2, LiquidLine &liquidLine3, LiquidLine &liquidLine4)

### Description
Constructor for LiquidScreen that takes four LiquidLine objects.

### Method
(Constructor of LiquidScreen)

### Parameters
- **liquidLine1** (LiquidLine &) - Description not provided in source.
- **liquidLine2** (LiquidLine &) - Description not provided in source.
- **liquidLine3** (LiquidLine &) - Description not provided in source.
- **liquidLine4** (LiquidLine &) - Description not provided in source.
```

--------------------------------

### LiquidLine Constructor

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_line.html

Initializes a LiquidLine object with up to four variables or constants, specifying its position on the screen.

```APIDOC
## LiquidLine() [Constructor]

### Description
Constructor for four variables/constants.

### Parameters
- **_column_** (uint8_t) - The column at which the line starts.
- **_row_** (uint8_t) - The row at which the line is printed.
- **_variableA_** (A &) - Variable/constant to be printed.
- **_variableB_** (B &) - Variable/constant to be printed.
- **_variableC_** (C &) - Variable/constant to be printed.
- **_variableD_** (D &) - Variable/constant to be printed.
```

--------------------------------

### Screen Management

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_menu.html

Methods for adding, navigating, and changing screens within the menu.

```APIDOC
## add_screen()

### Description
Adds a LiquidScreen object to the menu.

### Parameters
- **liquidScreen** (LiquidScreen&) - Reference to the LiquidScreen object to add.

### Returns
- `true` if the screen was added successfully, `false` otherwise.

### Example
```cpp
menu.add_screen(myScreen);
```
```

```APIDOC
## get_currentScreen()

### Description
Returns a reference to the currently active screen.

### Returns
- A pointer to the current LiquidScreen object.

### Example
```cpp
LiquidScreen* current = menu.get_currentScreen();
```
```

```APIDOC
## next_screen() / operator++()

### Description
Switches the menu to the next screen in sequence.

### Example
```cpp
menu.next_screen();
++menu;
menu++;
```
```

```APIDOC
## previous_screen() / operator--()

### Description
Switches the menu to the previous screen in sequence.

### Example
```cpp
menu.previous_screen();
--menu;
menu--;
```
```

```APIDOC
## change_screen(LiquidScreen*)

### Description
Switches the menu to a specified LiquidScreen object.

### Parameters
- **p_liquidScreen** (LiquidScreen*) - Pointer to the LiquidScreen object to switch to.

### Returns
- `true` if the screen was changed successfully, `false` otherwise.

### Example
```cpp
menu.change_screen(&anotherScreen);
```
```

```APIDOC
## change_screen(uint8_t)

### Description
Switches the menu to a screen specified by its number.

### Parameters
- **number** (uint8_t) - The number of the screen to switch to.

### Returns
- `true` if the screen was changed successfully, `false` otherwise.

### Example
```cpp
menu.change_screen(3);
```
```

```APIDOC
## operator=(LiquidScreen*)

### Description
Assigns and switches the menu to a specified LiquidScreen object.

### Parameters
- **p_liquidScreen** (LiquidScreen*) - Pointer to the LiquidScreen object to switch to.

### Returns
- `true` if the screen was changed successfully, `false` otherwise.

### Example
```cpp
menu = &specificScreen;
```
```

```APIDOC
## operator=(uint8_t)

### Description
Assigns and switches the menu to a screen specified by its number.

### Parameters
- **number** (uint8_t) - The number of the screen to switch to.

### Returns
- `true` if the screen was changed successfully, `false` otherwise.

### Example
```cpp
menu = 5;
```
```

--------------------------------

### Focus and Input Handling

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_menu.html

Methods for managing focus within a screen and setting input behavior.

```APIDOC
## switch_focus()

### Description
Switches the focus to the next or previous interactive element on the current screen.

### Parameters
- **forward** (bool) - `true` to move focus forward, `false` to move backward (defaults to `true`).

### Example
```cpp
menu.switch_focus(); // Move focus forward
menu.switch_focus(false); // Move focus backward
```
```

```APIDOC
## set_focusedLine()

### Description
Directly sets the currently focused line (menu item) on the screen.

### Parameters
- **lineIndex** (uint8_t) - The index of the line to focus on.

### Returns
- `true` if the line was set successfully, `false` otherwise.

### Example
```cpp
menu.set_focusedLine(2);
```
```

```APIDOC
## get_focusedLine()

### Description
Gets the index of the currently focused line (menu item) on the screen.

### Returns
- The index of the focused line.

### Example
```cpp
uint8_t focused = menu.get_focusedLine();
```
```

```APIDOC
## set_focusPosition()

### Description
Sets the focus indicator's position for the entire menu.

### Parameters
- **position** (Position) - The desired position for the focus indicator.

### Returns
- `true` if the position was set successfully, `false` otherwise.

### Example
```cpp
menu.set_focusPosition(Position::LEFT);
```
```

```APIDOC
## set_focusSymbol()

### Description
Changes the custom symbol used for the focus indicator.

### Parameters
- **position** (Position) - The position where the symbol should be displayed.
- **symbol** (uint8_t[8]) - An array representing the 8x8 custom symbol.

### Returns
- `true` if the symbol was set successfully, `false` otherwise.

### Example
```cpp
uint8_t customSymbol[8] = {0x0, 0x1, 0x3, 0x7, 0xF, 0x1F, 0x3F, 0x7F};
menu.set_focusSymbol(Position::RIGHT, customSymbol);
```
```

--------------------------------

### previous_screen

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_menu-members.html

Goes to the previous screen in the menu.

```APIDOC
## previous_screen()

### Description
Navigates the menu to the previous screen.

### Method
(Implicitly a method of LiquidMenu)
```

--------------------------------

### add_menu

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_system.html

Adds a LiquidMenu object to the menu system.

```APIDOC
## add_menu

bool add_menu(LiquidMenu &liquidMenu)

### Description
Adds a LiquidMenu object to the menu system.

### Parameters
- **liquidMenu** (LiquidMenu &) - The LiquidMenu object to add.
```

--------------------------------

### next_screen() / operator++()

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_menu.html

Switches to the next screen. This can be achieved using the `next_screen()` method or the overloaded prefix increment operator `++`.

```APIDOC
## next_screen() / operator++()

### Description
Switches to the next screen.

### Method
*   `void next_screen()`
*   `void operator++()` (Prefix increment)
*   `void operator++(int)` (Postfix increment)

### Note
*   Prefix and postfix increment operator overloading are supported for switching to the next screen.
```

--------------------------------

### LiquidLine()

Source: https://vasilkalchev.github.io/LiquidMenu/functions_func.html

Constructor for the LiquidLine class.

```APIDOC
## LiquidLine()

### Description
Constructor for the LiquidLine class.

### Class
LiquidLine

### Method Signature
`LiquidLine()`
```

--------------------------------

### next_screen

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_menu-members.html

Advances to the next screen in the menu.

```APIDOC
## next_screen()

### Description
Advances the menu to the next screen.

### Method
(Implicitly a method of LiquidMenu)
```

--------------------------------

### previous_screen / operator--

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_system.html

Switches to the previous screen in the menu system.

```APIDOC
## previous_screen

void previous_screen()

## operator--

void operator--()

void operator--(int)

### Description
Switches to the previous screen.

### Usage
`previous_screen();` or `--system;` or `system--;`
```

--------------------------------

### next_screen / operator++

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_system.html

Switches to the next screen in the menu system.

```APIDOC
## next_screen

void next_screen()

## operator++

void operator++()

void operator++(int)

### Description
Switches to the next screen.

### Usage
`next_screen();` or `++system;` or `system++;`
```

--------------------------------

### previous_screen()

Source: https://vasilkalchev.github.io/LiquidMenu/functions_func.html

Navigates to the previous screen in the menu sequence. This function is a member of both LiquidMenu and LiquidSystem classes.

```APIDOC
## previous_screen()

### Description
Navigates to the previous screen.

### Classes
LiquidMenu, LiquidSystem

### Method Signature
`previous_screen()`
```

--------------------------------

### update()

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_menu.html

Prints the current screen to the display. Call this when attached variables change.

```APIDOC
## update()

### Description
Prints the current screen to the display.

### Note
*   Call this method when there is a change in some of the attached variables.
```

--------------------------------

### LiquidMenu.h Header File

Source: https://vasilkalchev.github.io/LiquidMenu/dir_68267d1309a1af8e8297ef4c3efbcdba.html

The main header file for the LiquidMenu library, providing core functionalities for menu creation and management.

```c++
#include "LiquidMenu_config.h"

```

--------------------------------

### add_screen

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_menu-members.html

Adds a LiquidScreen to the LiquidMenu.

```APIDOC
## add_screen(LiquidScreen &liquidScreen)

### Description
Adds a LiquidScreen object to the LiquidMenu.

### Method
(Implicitly a method of LiquidMenu)

### Parameters
#### Path Parameters
- **liquidScreen** (LiquidScreen &) - Required - A reference to the LiquidScreen object to add.
```

--------------------------------

### change_screen()

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_menu.html

Switches to a specified screen, either by providing a pointer to the LiquidScreen object or by its number.

```APIDOC
## ◆ change_screen() [1/2]
bool LiquidMenu::change_screen  | ( | LiquidScreen *  | _p_liquidScreen_| ) |   
---|---|---|---|---|---
Switches to the specified screen.  

Parameters
     *p_liquidScreen| - pointer to the LiquidScreen object   
---|---

Returns
    true on success and false if the screen is not found   

## ◆ change_screen() [2/2]
bool LiquidMenu::change_screen  | ( | uint8_t  | _number_| ) |   
---|---|---|---|---
Switches to the specified screen.  

Parameters
     number| - the number of the screen   
---|---

Returns
    true on success and false if the number of the screen is invalid.   
```

--------------------------------

### LiquidMenu Class Constructors

Source: https://vasilkalchev.github.io/LiquidMenu/index.html

Defines the constructors for LiquidLine, LiquidScreen, LiquidMenu, and LiquidSystem classes. These are used to instantiate and configure menu elements.

```c++
// Takes column and row for the position and 1 to 4 variable references. These variable
// references are what is going to be printed on the display. They can be integers,
// string literals or char[] arrays for dynamic text.
LiquidLine(byte column, byte row, A &variableA...);
// Takes 0 to 4 LiquidLine objects.
LiquidScreen(LiquidLine &liquidLine1...);
// Takes a reference to the LiquidCrystal object, 0 to 4 LiquidScreen objects and
// optionally the number of the screen that will be shown first.
LiquidMenu(LiquidCrystal &liquidCrystal, LiquidScreen &liquidScreen1..., byte startingScreen = 1);
// Takes 0 to 4 LiquidMenu objects and optionally the number of the menu that will be shown first.
LiquidSystem(LiquidMenu &liquidMenu1..., byte startingMenu = 1);
```

--------------------------------

### get_currentScreen

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_system.html

Returns a reference to the current screen.

```APIDOC
## get_currentScreen

LiquidScreen * get_currentScreen() const

### Description
Returns a reference to the current screen.

### Returns
- LiquidScreen * - A pointer to the current LiquidScreen object.
```

--------------------------------

### add_menu()

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_system.html

Adds a LiquidMenu object to the menu system. Returns true on success, false if the maximum number of menus is reached.

```APIDOC
## add_menu()

### Description
Adds a LiquidMenu object to the menu system.

### Parameters
- **&liquidMenu** (LiquidMenu &) - Pointer to a LiquidMenu object.

### Returns
- `true` on success.
- `false` if the maximum amount of menus has been reached.

### Note
The maximum amount of menus per menu system is specified in LiquidMenu_config.h as `MAX_MENUS`. The default is 12.
```

--------------------------------

### LiquidLine Public Methods

Source: https://vasilkalchev.github.io/LiquidMenu/class_liquid_line.html

Methods for configuring LiquidLine objects, including adding variables, attaching functions, and setting display properties.

```APIDOC
## bool add_variable(T &variable)

### Description
Adds a variable to the line to be displayed.

### Parameters
- **variable** (T&) - Required - The variable to add to the line.

### Returns
- **bool** - True if the variable was added successfully, false otherwise.

## bool attach_function(uint8_t number, void(*function)(void))

### Description
Attaches a callback function to be executed for a specific function number on the line.

### Parameters
- **number** (uint8_t) - Required - The number identifying the function to attach.
- **function** (void(*)(void)) - Required - A pointer to the callback function.

### Returns
- **bool** - True if the function was attached successfully, false otherwise.

## void set_decimalPlaces(uint8_t decimalPlaces)

### Description
Sets the number of decimal places to display for floating-point variables.

### Parameters
- **decimalPlaces** (uint8_t) - Required - The number of decimal places.

## bool set_focusPosition(Position position, uint8_t column=0, uint8_t row=0)

### Description
Configures the position of the focus indicator for this line.

### Parameters
- **position** (Position) - Required - The desired position of the focus indicator.
- **column** (uint8_t) - Optional - The column for the focus indicator (defaults to 0).
- **row** (uint8_t) - Optional - The row for the focus indicator (defaults to 0).

### Returns
- **bool** - True if the focus position was set successfully, false otherwise.

## bool set_asGlyph(uint8_t number)

### Description
Converts a byte variable associated with a given number into a glyph index for display.

### Parameters
- **number** (uint8_t) - Required - The identifier of the variable to convert.

### Returns
- **bool** - True if the conversion was successful, false otherwise.

## bool set_asProgmem(uint8_t number)

### Description
Converts a const char pointer variable associated with a given number into a PROGMEM const char pointer.

### Parameters
- **number** (uint8_t) - Required - The identifier of the variable to convert.

### Returns
- **bool** - True if the conversion was successful, false otherwise.
```
Tokens:
Raw