rockbox/apps/gui/select.h

/***************************************************************************
 *             __________               __   ___.
 *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
 *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
 *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
 *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
 *                     \/            \/     \/    \/            \/
 * $Id$
 *
 * Copyright (C) 2005 by Kevin Ferrare
 *
 * All files in this archive are subject to the GNU General Public License.
 * See the file COPYING in the source tree root for full license agreement.
 *
 * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
 * KIND, either express or implied.
 *
 ****************************************************************************/

#ifndef _GUI_SELECT_H_
#define _GUI_SELECT_H_
#include "screen_access.h"
#include "settings.h"
#include "option_select.h"

#if (CONFIG_KEYPAD == IRIVER_H100_PAD) || \
  (CONFIG_KEYPAD == IRIVER_H300_PAD)
#define SELECT_INC     BUTTON_UP
#define SELECT_DEC     BUTTON_DOWN
#define SELECT_OK      BUTTON_SELECT
#define SELECT_OK2     BUTTON_LEFT
#define SELECT_CANCEL  BUTTON_OFF
#define SELECT_CANCEL2 BUTTON_MODE

#define SELECT_RC_INC      BUTTON_RC_FF
#define SELECT_RC_DEC      BUTTON_RC_REW
#define SELECT_RC_OK       BUTTON_RC_ON
#define SELECT_RC_OK2      BUTTON_RC_MENU
#define SELECT_RC_CANCEL   BUTTON_RC_STOP
#define SELECT_RC_CANCEL2  BUTTON_RC_MODE

#elif CONFIG_KEYPAD == RECORDER_PAD
#define SELECT_INC     BUTTON_UP
#define SELECT_DEC     BUTTON_DOWN
#define SELECT_OK      BUTTON_PLAY
#define SELECT_OK2     BUTTON_LEFT
#define SELECT_CANCEL  BUTTON_OFF
#define SELECT_CANCEL2 BUTTON_F1

#elif CONFIG_KEYPAD == PLAYER_PAD
#define SELECT_INC     BUTTON_RIGHT
#define SELECT_DEC     BUTTON_LEFT
#define SELECT_OK      BUTTON_PLAY
#define SELECT_CANCEL  BUTTON_STOP
#define SELECT_CANCEL2 BUTTON_MENU

#elif (CONFIG_KEYPAD == IPOD_4G_PAD) || \
      (CONFIG_KEYPAD == IPOD_NANO_PAD)
#define SELECT_INC     BUTTON_SCROLL_FWD
#define SELECT_DEC     BUTTON_SCROLL_BACK
#define SELECT_OK      BUTTON_SELECT
#define SELECT_OK2     BUTTON_RIGHT
#define SELECT_CANCEL  BUTTON_MENU

#elif CONFIG_KEYPAD == ONDIO_PAD
#define SELECT_INC     BUTTON_UP
#define SELECT_DEC     BUTTON_DOWN
#define SELECT_OK      BUTTON_RIGHT
#define SELECT_OK2     BUTTON_LEFT
#define SELECT_CANCEL  BUTTON_MENU
#define SELECT_CANCEL2 BUTTON_OFF

#elif CONFIG_KEYPAD == GMINI100_PAD
#define SELECT_INC     BUTTON_UP
#define SELECT_DEC     BUTTON_DOWN
#define SELECT_OK      BUTTON_PLAY
#define SELECT_OK2     BUTTON_LEFT
#define SELECT_CANCEL  BUTTON_OFF
#define SELECT_CANCEL2 BUTTON_MENU

#endif

struct gui_select
{
    bool canceled;
    bool validated;
    struct option_select options;
};

/*
 * Initializes a select that let's you choose between several numeric values
 *  - title : the title of the select
 *  - init_value : the initial value the number will be
 *  - min_value, max_value : bounds to the value
 *  - step : the ammount you want to add / withdraw to the initial number
 *           each time a key is pressed
 *  - unit : the unit in which the value is  (ex "s", "bytes", ...)
 *  - formatter : a callback function that generates a string
 *                from the number it gets
 */
extern void gui_select_init_numeric(struct gui_select * select,
        const char * title,
        int init_value,
        int min_value,
        int max_value,
        int step,
        const char * unit,
        option_formatter *formatter);


/*
 * Initializes a select that let's you choose between options in a list
 *  - title : the title of the select
 *  - selected : the initially selected item
 *  - items : the list of items, defined in settings.h
 *  - nb_items : the number of items in the 'items' list
 */
extern void gui_select_init_items(struct gui_select * select,
        const char * title,
        int selected,
        const struct opt_items * items,
        int nb_items
        );

/*
 * Selects the next value
 *  - select : the select struct
 */
#define gui_select_next(select) \
    option_select_next(&(select->options))

/*
 * Selects the previous value
 *  - select : the select struct
 */
#define gui_select_prev(select) \
    option_select_prev(&(select->options))

/*
 * Draws the select on the given screen
 *  - select : the select struct
 *  - display : the display on which you want to output
 */
extern void gui_select_draw(struct gui_select * select, struct screen * display);

/*
 * Returns the selected value
 *  - select : the select struct
 */
#define gui_select_get_selected(_sel_) \
    option_select_get_selected(&((_sel_)->options))
/*
 * Cancels the select
 *  - select : the select struct
 */
#define gui_select_cancel(select) \
    (select)->canceled=true

/*
 * Tells wether the select has been canceled or not
 *  - select : the select struct
 */
#define gui_select_is_canceled(select) \
    (select)->canceled

/*
 * Validate the select
 *  - select : the select struct
 */
#define gui_select_validate(select) \
    (select)->validated=true

/*
 * Tells wether the select is validated or not
 *  - select : the select struct
 */
#define gui_select_is_validated(select) \
    (select)->validated

/*
 * Tells the select wether it should stop when reaching the min/max value
 * or should continue (by going to max/min)
 *  - select : the select struct
 *  - scroll :
 *    - true : stops when reaching min/max
 *    - false : continues to go to max/min when reaching min/max
 */
#define gui_select_limit_loop(select, loop) \
    option_select_limit_loop(&((select)->options), loop)

/*
 * Draws the select on all the screens
 *  - select : the select struct
 */
extern void gui_syncselect_draw(struct gui_select * select);

/*
 * Handles key events for a synced (drawn on all screens) select
 *  - select : the select struct
 */
extern bool gui_syncselect_do_button(struct gui_select * select, int button);

#endif /* _GUI_SELECT_H_ */