C语言菜单函数库：功能详解与使用指南

/* 菜单初始化和反初始化 */

extern int Menu_Init(MainMenuCfg_t pMainMenu); /**************************************************************

函数名称：Menu_Init
函数功能：菜单初始化
输入参数：pMainMenu - 主菜单配置结构体指针
输出参数：无
返回值：成功返回0，失败返回错误码 ***************************************************************/

extern int Menu_DeInit(void); /***************************************************************

函数名称：Menu_DeInit
函数功能：菜单反初始化
输入参数：无
输出参数：无
返回值：成功返回0，失败返回错误码 ***************************************************************/

extern int Menu_Bind(MenuList_t pMenuList, menusize_t menuNum, ShowMenuCallFun_f pfnShowMenuFun); /**************************************************************

函数名称：Menu_Bind
函数功能：绑定菜单列表和显示菜单回调函数
输入参数：pMenuList - 菜单列表指针
```
      menuNum - 菜单数量
```

      pfnShowMenuFun - 显示菜单回调函数指针

输出参数：无
返回值：成功返回0，失败返回错误码 ***************************************************************/

/* 菜单功能设置 */

extern int Menu_EnableEnglish(bool isEnable); /***************************************************************

函数名称：Menu_EnableEnglish
函数功能：启用或禁用英文模式
输入参数：isEnable - 是否启用英文模式
输出参数：无
返回值：成功返回0，失败返回错误码 ***************************************************************/

/* 菜单选项显示时需要使用的功能扩展函数 */

extern int Menu_LimitShowListNum(MenuShow_t ptMenuShow, menusize_t pShowNum); /*************************************************************

函数名称：Menu_LimitShowListNum
函数功能：限制菜单选项显示的数量
输入参数：ptMenuShow - 菜单显示结构体指针

      pShowNum - 菜单显示数量指针

输出参数：无
返回值：成功返回0，失败返回错误码 ***************************************************************/

extern int Menu_QueryParentMenu(MenuShow_t ptMenuShow, uint8_t level); /**************************************************************

函数名称：Menu_QueryParentMenu
函数功能：查询父菜单
输入参数：ptMenuShow - 菜单显示结构体指针
```
      level - 菜单级别
```
输出参数：无
返回值：成功返回0，失败返回错误码 ***************************************************************/

/* 菜单状态获取函数 */

extern bool Menu_IsRun(void); /***************************************************************

函数名称：Menu_IsRun
函数功能：判断菜单是否正在运行
输入参数：无
输出参数：无
返回值：正在运行返回true，否则返回false ***************************************************************/

extern bool Menu_IsEnglish(void); /***************************************************************

函数名称：Menu_IsEnglish
函数功能：判断菜单是否处于英文模式
输入参数：无
输出参数：无
返回值：英文模式返回true，否则返回false ***************************************************************/

/* 菜单操作 */

extern int Menu_Reset(void); /***************************************************************

函数名称：Menu_Reset
函数功能：重置菜单
输入参数：无
输出参数：无
返回值：成功返回0，失败返回错误码 ***************************************************************/

extern int Menu_Enter(void); /***************************************************************

函数名称：Menu_Enter
函数功能：进入菜单
输入参数：无
输出参数：无
返回值：成功返回0，失败返回错误码 ***************************************************************/

extern int Menu_Exit(bool isReset); /***************************************************************

函数名称：Menu_Exit
函数功能：退出菜单
输入参数：isReset - 是否重置菜单
输出参数：无
返回值：成功返回0，失败返回错误码 ***************************************************************/

extern int Menu_SelectPrevious(bool isAllowRoll); /***************************************************************

函数名称：Menu_SelectPrevious
函数功能：选择上一个菜单选项
输入参数：isAllowRoll - 是否允许滚动选择
输出参数：无
返回值：成功返回0，失败返回错误码 ***************************************************************/

extern int Menu_SelectNext(bool isAllowRoll); /***************************************************************

函数名称：Menu_SelectNext
函数功能：选择下一个菜单选项
输入参数：isAllowRoll - 是否允许滚动选择
输出参数：无
返回值：成功返回0，失败返回错误码 ***************************************************************/

extern int Menu_ShortcutEnter(bool isAbsolute, uint8_t deep, ...); /***************************************************************

函数名称：Menu_ShortcutEnter
函数功能：快捷进入菜单
输入参数：isAbsolute - 是否绝对定位
```
      deep - 菜单层级
```

      ... - 可变参数，菜单索引

输出参数：无
返回值：成功返回0，失败返回错误码 ***************************************************************/

extern int Menu_ResetItemsNum(menusize_t itemsNum); /***************************************************************

函数名称：Menu_ResetItemsNum
函数功能：重置菜单项数量
输入参数：itemsNum - 菜单项数量
输出参数：无
返回值：成功返回0，失败返回错误码 ***************************************************************/

extern int Menu_SetItemBeginLocation(int relativeLocation); /***************************************************************

函数名称：Menu_SetItemBeginLocation
函数功能：设置菜单项开始位置
输入参数：relativeLocation - 相对位置
输出参数：无
返回值：无 ***************************************************************/

extern void Menu_SetShowBaseItem(uint16_t BaseItem); /***************************************************************

函数名称：Menu_SetShowBaseItem
函数功能：设置显示菜单的基准项
输入参数：BaseItem - 基准项
输出参数：无
返回值：无 ***************************************************************/

/* 菜单轮询处理任务 */

extern int Menu_Task(void); /***************************************************************

函数名称：Menu_Task
函数功能：菜单轮询处理任务
输入参数：无
输出参数：无
返回值：成功返回0，失败返回错误码 ***************************************************************/