mirror/RetroArch
1
0
Fork 0
mirror of https://github.com/libretro/RetroArch synced 2025-03-01 16:13:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

(menu_navigation.c) Start documenting menu_navigation.c

Browse Source
This commit is contained in:
twinaphex 2015-01-10 04:32:10 +01:00
parent 27d9441ffa
commit 1eb844ca53
2 changed files with 68 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
menu/menu_navigation.c
View File

@ -22,6 +22,13 @@
#include <ctype.h> #include <ctype.h>
#include "menu_navigation.h" #include "menu_navigation.h"
/**
* menu_navigation_clear:
* @menu : menu handle
* @pending_push : pending push ?
*
* Clears the navigation pointer.
**/
void menu_navigation_clear(menu_handle_t *menu, bool pending_push) void menu_navigation_clear(menu_handle_t *menu, bool pending_push)
{ {
menu->selection_ptr = 0; menu->selection_ptr = 0;
@ -30,6 +37,12 @@ void menu_navigation_clear(menu_handle_t *menu, bool pending_push)
driver.menu_ctx->navigation_clear(menu, pending_push); driver.menu_ctx->navigation_clear(menu, pending_push);
} }
/**
* menu_navigation_decrement:
* @menu : menu handle
*
* Decrement the navigation pointer.
**/
void menu_navigation_decrement(menu_handle_t *menu) void menu_navigation_decrement(menu_handle_t *menu)
{ {
menu->selection_ptr--; menu->selection_ptr--;
@ -38,6 +51,12 @@ void menu_navigation_decrement(menu_handle_t *menu)
driver.menu_ctx->navigation_decrement(menu); driver.menu_ctx->navigation_decrement(menu);
} }
/**
* menu_navigation_increment:
* @menu : menu handle
*
* Increment the navigation pointer.
**/
void menu_navigation_increment(menu_handle_t *menu) void menu_navigation_increment(menu_handle_t *menu)
{ {
menu->selection_ptr++; menu->selection_ptr++;
@ -46,14 +65,28 @@ void menu_navigation_increment(menu_handle_t *menu)
driver.menu_ctx->navigation_increment(menu); driver.menu_ctx->navigation_increment(menu);
} }
void menu_navigation_set(menu_handle_t *menu, size_t i, bool scroll) /**
* menu_navigation_set:
* @menu : menu handle
* @idx : index to set navigation pointer to.
* @scroll : should we scroll when needed?
*
* Sets navigation pointer to index @idx.
**/
void menu_navigation_set(menu_handle_t *menu, size_t idx, bool scroll)
{ {
menu->selection_ptr = i; menu->selection_ptr = idx;
if (driver.menu_ctx && driver.menu_ctx->navigation_set) if (driver.menu_ctx && driver.menu_ctx->navigation_set)
driver.menu_ctx->navigation_set(menu, scroll); driver.menu_ctx->navigation_set(menu, scroll);
} }
/**
* menu_navigation_set_last:
* @menu : menu handle
*
* Sets navigation pointer to last index.
**/
void menu_navigation_set_last(menu_handle_t *menu) void menu_navigation_set_last(menu_handle_t *menu)
{ {
menu->selection_ptr = menu_list_get_size(driver.menu->menu_list) - 1; menu->selection_ptr = menu_list_get_size(driver.menu->menu_list) - 1;

33
menu/menu_navigation.h
View File

@ -23,14 +23,47 @@
extern "C" { extern "C" {
#endif #endif
/**
* menu_navigation_clear:
* @menu : menu handle
* @pending_push : pending push ?
*
* Clears the navigation pointer.
**/
void menu_navigation_clear(menu_handle_t *menu, bool pending_push); void menu_navigation_clear(menu_handle_t *menu, bool pending_push);
/**
* menu_navigation_decrement:
* @menu : menu handle
*
* Decrement the navigation pointer.
**/
void menu_navigation_decrement(menu_handle_t *menu); void menu_navigation_decrement(menu_handle_t *menu);
/**
* menu_navigation_increment:
* @menu : menu handle
*
* Increment the navigation pointer.
**/
void menu_navigation_increment(menu_handle_t *menu); void menu_navigation_increment(menu_handle_t *menu);
/**
* menu_navigation_set:
* @menu : menu handle
* @idx : index to set navigation pointer to.
* @scroll : should we scroll when needed?
*
* Sets navigation pointer to index @idx.
**/
void menu_navigation_set(menu_handle_t *menu, size_t i, bool scroll); void menu_navigation_set(menu_handle_t *menu, size_t i, bool scroll);
/**
* menu_navigation_set_last:
* @menu : menu handle
*
* Sets navigation pointer to last index.
**/
void menu_navigation_set_last(menu_handle_t *menu); void menu_navigation_set_last(menu_handle_t *menu);
void menu_navigation_descend_alphabet(menu_handle_t *menu, size_t *ptr_out); void menu_navigation_descend_alphabet(menu_handle_t *menu, size_t *ptr_out);