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 /* stuff for the screen access */
  28
  29 /*
  30  * initialize the display module
  31  *
  32  * [In/Out] buf
  33  *          the start pointer of the buffer
  34  *
  35  * [In/Out] size
  36  *          buffer size
  37  *
  38  * return
  39  *     true  initialize success
  40  *     false initialize failure
  41  */
  42 bool tv_init_display(unsigned char **buf, size_t *size);
  43
  44 /* finalize the display module */
  45 void tv_finalize_display(void);
  46
  47
  48 /* layout parts accessing functions */
  49
  50 #ifdef HAVE_LCD_BITMAP
  51
  52 /* show headaer */
  53 void tv_show_header(void);
  54
  55 /*
  56  * show footer
  57  *
  58  * [In] pos
  59  *       the current position
  60  */
  61 void tv_show_footer(const struct tv_screen_pos *pos);
  62
  63 /*
  64  * initialize the scrollbar
  65  *
  66  * [In] total
  67  *          total text size
  68  *
  69  * [In] show_scrollbar
  70  *          true:  show the vertical scrollbar
  71  *          false: does not show the vertical scrollbar
  72  */
  73 void tv_init_scrollbar(off_t total, bool show_scrollbar);
  74
  75 /*
  76  * show horizontal/vertical scrollbar
  77  *
  78  * [In] window
  79  *          the current window
  80  *
  81  * [In] col
  82  *          the current column
  83  *
  84  * [In] cur_pos
  85  *          the current text position
  86  *
  87  * [In] size
  88  *          the size of text in displayed.
  89  */
  90 void tv_show_scrollbar(int window, int col, off_t cur_pos, int size);
  91
  92 /*
  93  * show bookmark
  94  *
  95  * [In] rows
  96  *          the array of row where the bookmark
  97  *
  98  * [In] count
  99  *          want to show bookmark count
 100  */
 101 void tv_show_bookmarks(const int *rows, int count);
 102
 103 #endif
 104
 105 /* common display functons */
 106
 107 /* start the display processing  */
 108 void tv_start_display(void);
 109
 110 /* end the display processing */
 111 void tv_end_display(void);
 112
 113 /*update the display  */
 114 void tv_update_display(void);
 115
 116 /*
 117  * draw the text
 118  *
 119  * [In] row
 120  *          the row that displays the text
 121  *
 122  * [In] text
 123  *          text
 124  *
 125  * [In] offset
 126  *          display the text that is since offset columns
 127  */
 128 void tv_draw_text(int row, const unsigned char *text, int offset);
 129
 130
 131 /* layout functions */
 132
 133 /*
 134  * set the layout
 135  *
 136  * [In] show_scrollbar
 137  *          true:  show the vertical scrollbar
 138  *          false: does not show the vertical scrollbar
 139  */
 140 void tv_set_layout(bool show_scrollbar);
 141
 142 /*
 143  * get the draw area info
 144  *
 145  * [Out] width
 146  *          width of the draw area
 147  *
 148  * [Out] cols
 149  *          column count of the draw area
 150  *
 151  * [Out] width
 152  *          row count of the draw area
 153  */
 154 void tv_get_drawarea_info(int *width, int *cols, int *rows);
 155
 156 #endif