From 339a27579d966394dc450f8bf918029e3f3be218 Mon Sep 17 00:00:00 2001 From: voed Date: Tue, 10 Jul 2018 12:59:53 +0300 Subject: [PATCH] Improved mprop description (#478) --- plugins/include/newmenus.inc | 85 +++++++++++++++++++++++++++++------- 1 file changed, 70 insertions(+), 15 deletions(-) diff --git a/plugins/include/newmenus.inc b/plugins/include/newmenus.inc index 5d42cb19..4ded31d9 100644 --- a/plugins/include/newmenus.inc +++ b/plugins/include/newmenus.inc @@ -12,31 +12,86 @@ #endif #define _newmenus_included -#define MEXIT_ALL 1 /* Menu will have an exit option (default)*/ -#define MEXIT_FORCE 2 /* Menu will have an exit option, even when pagination is disabled. +/** + * @section Menu properties for using in menu_setprop + */ + +/** + * Menu will have an exit option (default) + */ +#define MEXIT_ALL 1 + +/** + * Menu will have an exit option, even when pagination is disabled. * There have to be less than 10 items in the menu or it won't appear. The exit * option will be appended to the last item with no extra slot padding. If you - * want it in the 10th slot you have to pad it manually with menu_addblank2 */ -#define MEXIT_NEVER -1 /* Menu will not have an exit option */ + * want it in the 10th slot you have to pad it manually with menu_addblank2 + */ +#define MEXIT_FORCE 2 -#define MPROP_PERPAGE 1 /* Number of items per page (param1 = number, 0=no paginating, 7=default) */ -#define MPROP_BACKNAME 2 /* Name of the back button (param1 = string) */ -#define MPROP_NEXTNAME 3 /* Name of the next button (param1 = string) */ -#define MPROP_EXITNAME 4 /* Name of the exit button (param1 = string) */ -#define MPROP_TITLE 5 /* Menu title text (param1 = string) */ -#define MPROP_EXIT 6 /* Exit functionality (param1 = number, see MEXIT constants) */ -#define MPROP_NOCOLORS 8 /* Sets whether colors are not auto (param1 = number, 0=default) */ -#define MPROP_NUMBER_COLOR 10 /* Color indicator to use for numbers (param1 = string, "\r"=default) */ -#define MPROP_PAGE_CALLBACK 11 /* Function to be called on Back and Next (param1 = string) */ - /* public function(id, status); where status is either MENU_BACK or MENU_MORE */ - /* Pass NULL_STRING to disable the callback */ +/** + * Menu will not have an exit option + */ +#define MEXIT_NEVER -1 +/** + * Number of items per page (param1 = number, 0=no paginating, 7=default) + */ +#define MPROP_PERPAGE 1 + +/** + * Name of the back button (param1 = string) + */ +#define MPROP_BACKNAME 2 + +/** + * Name of the next button (param1 = string) + */ +#define MPROP_NEXTNAME 3 + +/** + * Name of the exit button (param1 = string) + */ +#define MPROP_EXITNAME 4 + +/** + * Menu title text (param1 = string) + */ +#define MPROP_TITLE 5 + +/** + * Exit functionality (param1 = number, see MEXIT constants) + */ +#define MPROP_EXIT 6 + +/** + * Sets whether colors are not auto (param1 = number, 0=default) + */ +#define MPROP_NOCOLORS 8 + +/** + * Color indicator to use for numbers (param1 = string, "\r"=default) + */ +#define MPROP_NUMBER_COLOR 10 + +/** + * Function to be called on Back and Next (param1 = string) + * public function(id, status); where status is either MENU_BACK or MENU_MORE + * Pass NULL_STRING to disable the callback + */ +#define MPROP_PAGE_CALLBACK 11 + +/** + * @deprecated + */ #define MEXIT_NORMAL 0 /* DEPRECATED, do not use (has no effect) */ #define MENUPAD_NONE 0 /* DEPRECATED, do not use (has no effect) */ #define MENUPAD_PAGE 1 /* DEPRECATED, do not use (has no effect) */ #define MPROP_ORDER 7 /* DEPRECATED, do not use (has no effect) */ #define MPROP_PADMENU 9 /* DEPRECATED, do not use (has no effect) */ +/** @endsection */ + /** * @brief Creates a new menu object. *