Documents descend_alphabet/ascend_alphabet

This commit is contained in:
twinaphex 2015-01-12 03:20:21 +01:00
parent b86022ed15
commit cef086988d
2 changed files with 44 additions and 0 deletions

View File

@ -95,6 +95,17 @@ void menu_navigation_set_last(menu_handle_t *menu)
driver.menu_ctx->navigation_set_last(menu);
}
/**
* menu_navigation_descend_alphabet:
* @menu : menu handle
* @ptr_out : Amount of indices to 'scroll' to get
* to the next entry.
*
* Descends alphabet.
* E.g.:
* If navigation points to an entry called 'Beta',
* navigation pointer will be set to an entry called 'Alpha'.
**/
void menu_navigation_descend_alphabet(menu_handle_t *menu, size_t *ptr_out)
{
size_t i = 0;
@ -116,6 +127,17 @@ void menu_navigation_descend_alphabet(menu_handle_t *menu, size_t *ptr_out)
driver.menu_ctx->navigation_descend_alphabet(menu, ptr_out);
}
/**
* menu_navigation_ascends_alphabet:
* @menu : menu handle
* @ptr_out : Amount of indices to 'scroll' to get
* to the next entry.
*
* Ascends alphabet.
* E.g.:
* If navigation points to an entry called 'Alpha',
* navigation pointer will be set to an entry called 'Beta'.
**/
void menu_navigation_ascend_alphabet(menu_handle_t *menu, size_t *ptr_out)
{
size_t i = 0;

View File

@ -66,8 +66,30 @@ void menu_navigation_set(menu_handle_t *menu, size_t i, bool scroll);
**/
void menu_navigation_set_last(menu_handle_t *menu);
/**
* menu_navigation_descend_alphabet:
* @menu : menu handle
* @ptr_out : Amount of indices to 'scroll' to get
* to the next entry.
*
* Descends alphabet.
* E.g.:
* If navigation points to an entry called 'Beta',
* navigation pointer will be set to an entry called 'Alpha'.
**/
void menu_navigation_descend_alphabet(menu_handle_t *menu, size_t *ptr_out);
/**
* menu_navigation_ascends_alphabet:
* @menu : menu handle
* @ptr_out : Amount of indices to 'scroll' to get
* to the next entry.
*
* Ascends alphabet.
* E.g.:
* If navigation points to an entry called 'Alpha',
* navigation pointer will be set to an entry called 'Beta'.
**/
void menu_navigation_ascend_alphabet(menu_handle_t *menu, size_t *ptr_out);
#ifdef __cplusplus