rockbox/apps/gui/statusbar.h

116 lines
3.3 KiB
C
Raw Normal View History

/***************************************************************************
* __________ __ ___.
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
* \/ \/ \/ \/ \/
* $Id$
*
* Copyright (C) 2005 by Kevin Ferrare
*
* This program 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 Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
* KIND, either express or implied.
*
****************************************************************************/
#ifndef _GUI_STATUSBAR_H_
#define _GUI_STATUSBAR_H_
#include "status.h"
#include "screen_access.h"
#include "events.h"
#define STATUSBAR_X_POS 0
#define STATUSBAR_Y_POS 0 /* MUST be a multiple of 8 */
#define STATUSBAR_HEIGHT 8
struct status_info {
int battlevel;
int batt_charge_step;
int volume;
int playmode;
int repeat;
#if CONFIG_CHARGING
bool inserted;
#endif
#ifdef HAVE_USB_POWER
bool usb_inserted;
#endif
bool battery_state;
bool shuffle;
bool keylock;
#ifdef HAS_REMOTE_BUTTON_HOLD
bool keylockremote;
#endif
#if (CONFIG_LED == LED_VIRTUAL) || defined(HAVE_REMOTE_LCD)
bool led; /* disk LED simulation in the status bar */
#endif
};
/* statusbar visibility/position, used for settings also */
Initial custom statusbar commit. The custom statusbar can be used as a WPS for the main UI, using .(r)sbs files. It's using the skin engine and knows all tags the WPS also knows. The default folder for .sbs is the wps folder to reuse images used in the WPS. As it can be shown in the WPS also, it's useful to move shared parts to the custom statusbar in order to save skin buffer space. There are a few restrictions/TODOs: *) Peak meter doesn't redraw nicely(not frequent enough), as very frequent updates would slow the UI down as hell (some targets fight with it in the WPS already: FS#10686) *) No touchregion support as the statusbar doesn't have any action handling (it won't fail to parse though). *) Drawing stuff into the default VP is forbidden (loading images in it is not). You *need* to use viewports for the displaying stuff (parsing fails if no viewport is used). *) Themes that don't use a custom ui viewport can be fixed up using the new %Vi tag to avoid nasty redraw effectts (you must not draw into it as well, it's used to fix up the ui viewport). %Vi describes the viewport that the lists can use without getting in the way of the statusbar. Otherwise, it behaves like the classic statusbar, it can be configured in the theme settings, and can be turned off in the wps using %wd. Note to translaters: When translating LANG_STATUSBAR_CUSTOM, please consider using the same translation as for LANG_CHANNEL_CUSTOM if it's compatible. They could be combined later then. Flyspray: FS#10566 Author: myself git-svn-id: svn://svn.rockbox.org/rockbox/trunk@23258 a1c6a512-1295-4272-9138-f99709370657
2009-10-19 15:28:15 +00:00
enum statusbar_values { STATUSBAR_OFF = 0, STATUSBAR_TOP, STATUSBAR_BOTTOM,
STATUSBAR_CUSTOM };
struct gui_statusbar
{
long battery_icon_switch_tick;
long volume_icon_switch_tick;
int last_volume;
bool redraw_volume; /* true if the volume gauge needs updating */
struct status_info info;
struct status_info lastinfo;
#if CONFIG_RTC
struct tm *time;
int last_tm_min;
#endif
struct screen * display;
};
extern struct gui_syncstatusbar statusbars;
/*
* Attach the status bar to a screen
* (The previous screen attachement is lost)
* - bar : the statusbar structure
* - display : the screen to attach
*/
#define gui_statusbar_set_screen(gui_statusbar, _display) \
(gui_statusbar)->display = (_display);
/*
* Draws the status bar on the attached screen
* - bar : the statusbar structure
*/
extern void gui_statusbar_draw(struct gui_statusbar * bar, bool force_redraw);
struct gui_syncstatusbar
{
struct gui_statusbar statusbars[NB_SCREENS];
};
extern void gui_syncstatusbar_init(struct gui_syncstatusbar * bars);
extern void gui_syncstatusbar_draw(struct gui_syncstatusbar * bars,
bool force_redraw);
void gui_statusbar_changed(enum screen_type screen,
enum statusbar_values old);
#if !defined(HAVE_REMOTE_LCD) || defined(__PCTOOL__)
#include "settings.h"
#define statusbar_position(a) (global_settings.statusbar)
#else
enum statusbar_values statusbar_position(int screen);
#endif
#endif /*_GUI_STATUSBAR_H_*/