menu.h

Go to the documentation of this file.

 
#ifndef _MENU_H_
#define _MENU_H_
 
#include <stdint.h>
#include <stdbool.h>
#include "linked_list.h"
#include "hdw-btn.h"
#include "font.h"
#include "settingsManager.h"

typedef bool (*menuCb)(const char* label, bool selected, uint32_t value);
 
typedef struct _menu_t menu_t;

typedef struct
{
    const char* label;          
    const char* const* options; 
    menu_t* subMenu;            
    uint8_t numOptions;         
    int32_t currentOpt;         
    int32_t minSetting;         
    int32_t maxSetting;         
    const int32_t* settingVals; 
    int32_t currentSetting;     
} menuItem_t;

typedef struct _menu_t
{
    const char* title;        
    menuCb cbFunc;            
    list_t* items;            
    node_t* currentItem;      
    menu_t* parentMenu;       
    bool showBattery;         
    int32_t batteryReadTimer; 
    int batteryLevel;         
    uint32_t memCaps;         
} menu_t;

extern const char* mnuBackStr;
 
menu_t* initMenu(const char* title, menuCb cbFunc) __attribute__((warn_unused_result));
menu_t* initMenuRam(const char* title, menuCb cbFunc, uint32_t memCaps) __attribute__((warn_unused_result));
void deinitMenu(menu_t* menu);
menu_t* startSubMenu(menu_t* menu, const char* label) __attribute__((warn_unused_result));
menu_t* endSubMenu(menu_t* menu) __attribute__((warn_unused_result));
menuItem_t* addSingleItemToMenu(menu_t* menu, const char* label);
menuItem_t* insertSingleItemToMenuAfter(menu_t* menu, const char* newLabel, const char* afterLabel);
void removeSingleItemFromMenu(menu_t* menu, const char* label);
menu_t* removeAllItemsFromMenu(menu_t* menu);
void addMultiItemToMenu(menu_t* menu, const char* const* labels, uint8_t numLabels, uint8_t currentLabel);
void removeMultiItemFromMenu(menu_t* menu, const char* const* labels);
void addSettingsItemToMenu(menu_t* menu, const char* label, const settingParam_t* bounds, int32_t val);
void removeSettingsItemFromMenu(menu_t* menu, const char* label);
menuItem_t* addSettingsOptionsItemToMenu(menu_t* menu, const char* settingLabel, const char* const* optionLabels,
                                         const int32_t* optionValues, uint8_t numOptions, const settingParam_t* bounds,
                                         int32_t currentValue);
void removeSettingsOptionsItemFromMenu(menu_t* menu, const char* const* optionLabels);
 
menu_t* menuNavigateToTopItem(menu_t* menu);
menu_t* menuNavigateToItem(menu_t* menu, const char* label);
menu_t* menuNavigateToPrevItem(menu_t* menu);
menu_t* menuNavigateToNextItem(menu_t* menu);
menu_t* menuNavigateToPrevOption(menu_t* menu);
menu_t* menuNavigateToNextOption(menu_t* menu);
menu_t* menuSelectCurrentItem(menu_t* menu);
menu_t* menuSetCurrentOption(menu_t* menu, int32_t value);
 
menu_t* menuButton(menu_t* menu, buttonEvt_t evt) __attribute__((warn_unused_result));
void setShowBattery(menu_t* menu, bool showBattery);
 
#endif