apps/gui/textarea.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2005 by Kevin Ferrare
  11  *
  12  * All files in this archive are subject to the GNU General Public License.
  13  * See the file COPYING in the source tree root for full license agreement.
  14  *
  15  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  16  * KIND, either express or implied.
  17  *
  18  ****************************************************************************/
  19
  20 #ifndef _GUI_TEXTAREA_H_
  21 #define _GUI_TEXTAREA_H_
  22 #include "screen_access.h"
  23 #include "settings.h"
  24 #include "statusbar.h"
  25
  26 struct text_message
  27 {
  28     char **message_lines;
  29     int nb_lines;
  30 };
  31
  32 /*
  33  * Clears the area in the screen in which text can be displayed
  34  * and sets the y margin properly
  35  *  - display : the screen structure
  36  */
  37 extern void gui_textarea_clear(struct screen * display);
  38
  39 /*
  40  * Updates the area in the screen in which text can be displayed
  41  *  - display : the screen structure
  42  */
  43 extern void gui_textarea_update(struct screen * display);
  44
  45 /*
  46  * Displays message lines on the given screen
  47  *  - display : the screen structure
  48  *  - message : the lines to display
  49  *  - ystart : the lineon which we start displaying
  50  * returns : the number of lines effectively displayed
  51  */
  52 extern int gui_textarea_put_message(struct screen * display,
  53                                     struct text_message * message,
  54                                     int ystart);
  55 /*
  56  * Compute the number of text lines the display can draw with the current font
  57  * Also updates the char height and width
  58  * - display : the screen structure
  59  */
  60 extern void gui_textarea_update_nblines(struct screen * display);
  61
  62 /*
  63  * Speak a text_message. The message's lines may be virtual pointers
  64  * representing language / voicefont IDs (see settings.h).
  65  */
  66 extern void talk_text_message(struct text_message * message, bool enqueue);
  67
  68 #ifdef HAVE_LCD_BITMAP
  69 /*
  70  * Compute the number of pixels from which text can be displayed
  71  * - display : the screen structure
  72  * Returns the number of pixels
  73  */
  74 #define gui_textarea_get_ystart(display) \
  75     ( (global_settings.statusbar)? STATUSBAR_HEIGHT : 0)
  76
  77 /*
  78  * Compute the number of pixels below which text can't be displayed
  79  * - display : the screen structure
  80  * Returns the number of pixels
  81  */
  82 #ifdef HAS_BUTTONBAR
  83 #define gui_textarea_get_yend(display) \
  84     ( (display)->height - ( (global_settings.buttonbar && \
  85                             (display)->has_buttonbar)? \
  86                             BUTTONBAR_HEIGHT : 0) )
  87 #else
  88 #define gui_textarea_get_yend(display) \
  89     ( (display)->height )
  90 #endif /* HAS_BUTTONBAR */
  91
  92 #endif /* HAVE_LCD_BITMAP */
  93
  94 #endif /* _GUI_TEXTAREA_H_ */