rockbox/apps/gui/viewport.h

/***************************************************************************
 *             __________               __   ___.
 *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
 *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
 *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
 *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
 *                     \/            \/     \/    \/            \/
 * $Id$
 *
 * Copyright (C) 2008 by Jonathan Gordon
 *
 * 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.
 *
 ****************************************************************************/

#include "config.h"
#include "lcd.h"
#include "screen_access.h"

/* return the number of text lines in the vp viewport */
int viewport_get_nb_lines(struct viewport *vp);

#define VP_ERROR              0
#define VP_DIMENSIONS       0x1
#define VP_COLORS           0x2
#define VP_SELECTIONCOLORS  0x4
/* load a viewport struct from a config string.
   returns a combination of the above to say which were loaded ok from the string */
int viewport_load_config(const char *config, struct viewport *vp);

void viewport_set_defaults(struct viewport *vp, enum screen_type screen);

/* Used to specify which screens the statusbar (SB) should be displayed on.
 *
 * The parameter is a bit OR'ed combination of the following (screen is
 * SCREEN_MAIN or SCREEN_REMOTE from screen_access.h):
 *
 * VP_SB_HIDE_ALL means "hide the SB on all screens"
 * VP_SB_ONSCREEN(screen) means "display the SB on the given screen
 *                              as specified by the SB setting for that screen"
 * VP_SB_IGNORE_SETTING(screen) means "ignore the SB setting for that screen"
 * VP_SB_ALLSCREENS means "VP_SB_ONSCREEN for all screens"
 * 
 * In most cases, VP_SB_ALLSCREENS should be used which means display the SB
 * as specified by the settings.
 * For the WPS (and other possible exceptions) use VP_SB_IGNORE_SETTING() to
 * FORCE the statusbar on for the given screen (i.e it will show regardless
 * of the setting)
 *
 * Returns the status before the call. This value can be used to restore the
 * SB "displaying rules".
 */
#define VP_SB_HIDE_ALL 0
#define VP_SB_ONSCREEN(screen) (1u<<screen)
#define VP_SB_IGNORE_SETTING(screen) (1u<<(4+screen))
#define VP_SB_ALLSCREENS (VP_SB_ONSCREEN(0)|VP_SB_ONSCREEN(1))
int viewportmanager_set_statusbar(int enabled);

/* callbacks for GUI_EVENT_* events */
void viewportmanager_draw_statusbars(void*data);
void viewportmanager_statusbar_changed(void* data);