apps/plugins/text_viewer/tv_display.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2010 Yoshihisa Uchida
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  18  * KIND, either express or implied.
  19  *
  20  ****************************************************************************/
  21 #ifndef PLUGIN_TEXT_VIEWER_DISPLAY_H
  22 #define PLUGIN_TEXT_VIEWER_DISPLAY_H
  23
  24 #include "plugin.h"
  25 #include "tv_screen_pos.h"
  26
  27 /* text viewer layout parts functions */
  28 #ifdef HAVE_LCD_BITMAP
  29
  30 /* show headaer */
  31 void tv_show_header(void);
  32
  33 /*
  34  * show footer
  35  *
  36  * [In] pos
  37  *       the current position
  38  */
  39 void tv_show_footer(const struct tv_screen_pos *pos);
  40
  41 /*
  42  * initialize the scrollbar
  43  *
  44  * [In] total
  45  *          total text size
  46  *
  47  * [In] show_scrollbar
  48  *          true:  show the vertical scrollbar
  49  *          false: does not show the vertical scrollbar
  50  */
  51 void tv_init_scrollbar(off_t total, bool show_scrollbar);
  52
  53 /*
  54  * show horizontal/vertical scrollbar
  55  *
  56  * [In] window
  57  *          the current window
  58  *
  59  * [In] col
  60  *          the current column
  61  *
  62  * [In] cur_pos
  63  *          the current text position
  64  *
  65  * [In] size
  66  *          the size of text in displayed.
  67  */
  68 void tv_show_scrollbar(int window, int col, off_t cur_pos, int size);
  69 #endif
  70
  71 /*
  72  * show bookmark
  73  *
  74  * [In] rows
  75  *          the array of row where the bookmark
  76  *
  77  * [In] count
  78  *          want to show bookmark count
  79  */
  80 void tv_show_bookmarks(const int *rows, int count);
  81
  82 /* common display functons */
  83
  84 /* initialized display functions */
  85 void tv_init_display(void);
  86
  87 /* start the display processing  */
  88 void tv_start_display(void);
  89
  90 /* end the display processing */
  91 void tv_end_display(void);
  92
  93 /*update the display  */
  94 void tv_update_display(void);
  95
  96 /*
  97  * draw the text
  98  *
  99  * [In] row
 100  *          the row that displays the text
 101  *
 102  * [In] text
 103  *          text
 104  *
 105  * [In] offset
 106  *          display the text that is since offset columns
 107  */
 108 void tv_draw_text(int row, const unsigned char *text, int offset);
 109
 110 /* layout functions */
 111 #ifdef HAVE_LCD_BITMAP
 112
 113 /*
 114  * set the layout
 115  *
 116  * [In] col_w
 117  *          width per column
 118  *
 119  * [In] show_scrollbar
 120  *          true:  show the vertical scrollbar
 121  *          false: does not show the vertical scrollbar
 122  */
 123 void tv_set_layout(int col_w, bool show_scrollbar);
 124
 125 #else
 126
 127 /*
 128  * set the layout
 129  *
 130  * [In] col_w
 131  *          width per column
 132  */
 133 void tv_set_layout(int col_w);
 134
 135 #endif
 136
 137 /*
 138  * get the draw area info
 139  *
 140  * [Out] width
 141  *          width of the draw area
 142  *
 143  * [Out] cols
 144  *          column count of the draw area
 145  *
 146  * [Out] width
 147  *          row count of the draw area
 148  */
 149 void tv_get_drawarea_info(int *width, int *cols, int *rows);
 150
 151 /* viewport functions */
 152
 153 /* change the viewport */
 154 void tv_change_viewport(void);
 155
 156 /* undo the viewport */
 157 void tv_undo_viewport(void);
 158
 159 #endif