summaryrefslogtreecommitdiff
path: root/apps/plugins/text_viewer/tv_display.h
blob: 9dfe17d9008d25d654007f93e3dcd9dd1a6e8b12 (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
/***************************************************************************
 *             __________               __   ___.
 *   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 "tv_screen_pos.h"

/* stuff for the screen access */

/*
 * initialize the display module
 *
 * [In/Out] buf
 *          the start pointer of the buffer
 *
 * [In/Out] size
 *          buffer size
 *
 * return
 *     true  initialize success
 *     false initialize failure
 */
bool tv_init_display(unsigned char **buf, size_t *size);

/* finalize the display module */
void tv_finalize_display(void);

/*
 * 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);

/*
 * show bookmark
 *
 * [In] rows
 *          the array of row where the bookmark
 *
 * [In] count
 *          want to show bookmark count
 */
void tv_show_bookmarks(const int *rows, int count);

/*
 * update extra parts (header, footer, scrollbar, etc.)
 *
 * [In] window
 *          current window
 *
 * [In] col
 *          current column
 *
 * [In] pos
 *          current screen position (file position, page, line)
 *
 * [In] size
 *          the size of text which is displayed.
 */
void tv_update_extra(int window, int col, const struct tv_screen_pos *pos, int size);

/*
 * 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);

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

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

/*change color scheme*/
void tv_night_mode(void);


/* layout functions */

/*
 * set the layout
 *
 * [In] show_scrollbar
 *          true:  show the vertical scrollbar
 *          false: does not show the vertical scrollbar
 */
void tv_set_layout(bool show_scrollbar);

/*
 * get the draw area info
 *
 * [Out] width
 *          width of the draw area
 *
 * [Out] cols
 *          column count of the draw area
 *
 * [Out] width
 *          row count of the draw area
 */
void tv_get_drawarea_info(int *width, int *cols, int *rows);

/*
 * whether exist scrollbar
 *
 * return
 *     true  exist scrollbar
 *     false does not exist scrollbar
 */
bool tv_exist_scrollbar(void);

#endif