gui/leveledit.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2004, 2006 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief Generic editor for (volume/gain/contrast/...) setting.
  34  *
  35  * \version $Id$
  36  *
  37  * \author Stefano Fedrigo <aleph@develer.com>
  38  */
  39 #ifndef GUI_LEVELEDIT_H
  40 #define GUI_LEVELEDIT_H
  41
  42 //#include <gui/levelbar.h>
  43
  44 /* Type for level_init */
  45 #define LEVELEDIT_NOBAR  0  /**< Edit number only, without bar nor units */
  46 #define LEVELEDIT_SINGLE 1  /**< Single channel editing */
  47 #define LEVELEDIT_DOUBLE 2  /**< Double channel editing */
  48
  49
  50
  51 /* Fwd decl */
  52 struct Bitmap;
  53 struct LevelEdit;
  54
  55 /** Type for callback used to set meter levels */
  56 typedef void level_set_callback(void);
  57
  58 /** Type for callback used to customize display of units */
  59 typedef void display_callback(struct LevelEdit *);
  60
  61 /**
  62  * State of a level meter
  63  */
  64 typedef struct LevelEdit {
  65         int type;           /*<! Type of level edititing mode (see prev defines) */
  66         const char *title;  /*<! Title on top of screen */
  67         const char *unit;   /*<! Unit of quantity changed by this LevelEdit */
  68         int min;            /*<! Minimum level */
  69         int max;            /*<! Maximum level */
  70         int step;           /*<! Value of a single increment/decrement */
  71
  72         level_set_callback *set_hook;     /*<! Callback called when a value is changed  */
  73         display_callback   *display_hook; /*<! Callback for complex unit display */
  74         int *ch1_val;                     /*<! (left) Value edited by this leveledit */
  75         int *ch2_val;                     /*<! Right channel edited */
  76
  77         struct Bitmap   *bitmap;  /*<! Bitmap where the whole thing is rendered */
  78 } LevelEdit;
  79
  80
  81 void level_init(struct LevelEdit *lev,
  82                 int type,
  83                 struct Bitmap *bmp, const char *title, const char *unit,
  84                 int min, int max, int step,
  85                 int *ch1_val, int *ch2_val,
  86                 level_set_callback *change_hook, display_callback *display_hook);
  87 void level_edit(struct LevelEdit *lev);
  88
  89 #endif /* GUI_LEVELEDIT_H */