Super-2024-Swadge-FW/menu__utils_8h_source.html

#ifndef _MENU_UTILS_H_

#define _MENU_UTILS_H_


#include "menu.h"


const char* getMenuItemLabelText(char* buffer, int buflen, const menuItem_t* item);

bool menuItemIsSetting(const menuItem_t* item);

bool menuItemHasOptions(const menuItem_t* item);

bool menuItemHasPrev(const menuItem_t* item);

bool menuItemHasNext(const menuItem_t* item);

bool menuItemIsBack(const menuItem_t* item);

bool menuItemHasSubMenu(const menuItem_t* item);

void menuSavePosition(const char** out, int len, const menu_t* menu);

menu_t* menuRestorePosition(const char** in, int len, menu_t* menu);


#endif

menu.h

_menu_t
The underlying data for a menu. This fundamentally is a list of menuItem_t.
Definition menu.h:173

menuItem_t
The underlying data for an item in a menu. The item may be a single-select, multi-select,...
Definition menu.h:157

menuSavePosition
void menuSavePosition(const char **out, int len, const menu_t *menu)
Stores the current menu position in a buffer.
Definition menu_utils.c:145

getMenuItemLabelText
const char * getMenuItemLabelText(char *buffer, int buflen, const menuItem_t *item)
Write and return the proper text label to use for the given menu item.
Definition menu_utils.c:21

menuItemIsSetting
bool menuItemIsSetting(const menuItem_t *item)
Returns whether a menu item is a settings item.
Definition menu_utils.c:66

menuRestorePosition
menu_t * menuRestorePosition(const char **in, int len, menu_t *menu)
Restores the menu position from the given buffer.
Definition menu_utils.c:189

menuItemIsBack
bool menuItemIsBack(const menuItem_t *item)
Returns true if this item is the "Back" button on a sub-menu.
Definition menu_utils.c:119

menuItemHasPrev
bool menuItemHasPrev(const menuItem_t *item)
Returns true if this item has any previous option.
Definition menu_utils.c:93

menuItemHasNext
bool menuItemHasNext(const menuItem_t *item)
Returns true if this item has any next option.
Definition menu_utils.c:106

menuItemHasOptions
bool menuItemHasOptions(const menuItem_t *item)
Returns whether this menu item has options.
Definition menu_utils.c:81

menuItemHasSubMenu
bool menuItemHasSubMenu(const menuItem_t *item)
Returns true if this item will enter a sub-menu when selected.
Definition menu_utils.c:131