RetroArch/menu/menu_navigation.h
2015-01-12 03:20:21 +01:00

100 lines
2.8 KiB
C

/* RetroArch - A frontend for libretro.
* Copyright (C) 2010-2014 - Hans-Kristian Arntzen
* Copyright (C) 2011-2015 - Daniel De Matteis
*
* RetroArch is free software: you can redistribute it and/or modify it under the terms
* of the GNU General Public License as published by the Free Software Found-
* ation, either version 3 of the License, or (at your option) any later version.
*
* RetroArch is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
* PURPOSE. See the GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along with RetroArch.
* If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef _MENU_NAVIGATION_H
#define _MENU_NAVIGATION_H
#include "menu.h"
#ifdef __cplusplus
extern "C" {
#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);
/**
* menu_navigation_decrement:
* @menu : menu handle
*
* Decrement the navigation pointer.
**/
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);
/**
* 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);
/**
* menu_navigation_set_last:
* @menu : menu handle
*
* Sets navigation pointer to last index.
**/
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
}
#endif
#endif