summaryrefslogtreecommitdiff
path: root/apps/plugins/text_viewer/tv_display.h
blob: 005011c756e625794187fc10394e56fc4431ef6c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
/***************************************************************************
 *             __________               __   ___.
 *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
 *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
 *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
 *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
 *                     \/            \/     \/    \/            \/
 * $Id$
 *
 * Copyright (C) 2010 Yoshihisa Uchida
 *
 * 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.
 *
 ****************************************************************************/
#ifndef PLUGIN_TEXT_VIEWER_DISPLAY_H
#define PLUGIN_TEXT_VIEWER_DISPLAY_H

#include "plugin.h"
#include "tv_screen_pos.h"

/* text viewer layout parts functions */
#ifdef HAVE_LCD_BITMAP

/* show headaer */
void tv_show_header(void);

/*
 * show footer
 *
 * [In] pos
 *       the current position
 */
void tv_show_footer(const struct tv_screen_pos *pos);

/*
 * initialize the scrollbar
 *
 * [In] total
 *          total text size
 *
 * [In] show_scrollbar
 *          true:  show the vertical scrollbar
 *          false: does not show the vertical scrollbar
 */
void tv_init_scrollbar(off_t total, bool show_scrollbar);

/*
 * show horizontal/vertical scrollbar
 *
 * [In] window
 *          the current window
 *
 * [In] col
 *          the current column
 *
 * [In] cur_pos
 *          the current text position
 *
 * [In] size
 *          the size of text in displayed.
 */
void tv_show_scrollbar(int window, int col, off_t cur_pos, int size);

#else

/*
 * put the bookmark icon
 *
 * [In] row
 *          the row where the bookmark icon is put
 */
void tv_put_bookmark_icon(int row);

#endif

/* common display functons */

/* initialized display functions */
void tv_init_display(void);

/* start the display processing  */
void tv_start_display(void);

/* end the display processing */
void tv_end_display(void);

/* clear the display */
void tv_clear_display(void);

/*update the display  */
void tv_update_display(void);

#ifdef HAVE_LCD_BITMAP

/*
 * set the drawmode
 *
 * [In] mode
 *          new drawmode
 */
void tv_set_drawmode(int mode);

/*
 * draw the rectangle that paints out inside
 *
 * [In] col
 *          the column of the upper left
 *
 * [In] row
 *          the row of the upper left
 *
 * [In] row
 *          draw rows
 */
void tv_fillrect(int col, int row, int rows);

#endif

/*
 * draw the text
 *
 * [In] row
 *          the row that displays the text
 *
 * [In] text
 *          text
 *
 * [In] offset
 *          display the text that is since offset columns
 */
void tv_draw_text(int row, const unsigned char *text, int offset);

/* layout functions */
#ifdef HAVE_LCD_BITMAP

/*
 * set the layout
 *
 * [In] col_w
 *          width per column
 *
 * [In] show_scrollbar
 *          true:  show the vertical scrollbar
 *          false: does not show the vertical scrollbar
 */
void tv_set_layout(int col_w, bool show_scrollbar);

#else

/*
 * set the layout
 *
 * [In] col_w
 *          width per column
 */
void tv_set_layout(int col_w);

#endif
void tv_get_drawarea_info(int *width, int *cols, int *rows);

/* viewport functions */

/* change the viewport */
void tv_change_viewport(void);

/* undo the viewport */
void tv_undo_viewport(void);

#endif