doxygen: blender/editors tagged.
[blender.git] / source / blender / editors / space_info / textview.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * Contributor(s): Campbell Barton
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /** \file blender/editors/space_info/textview.h
26  *  \ingroup spinfo
27  */
28
29
30 typedef struct TextViewContext {
31         int lheight;
32         int sel_start, sel_end;
33
34         /* view settings */
35         int cwidth; /* shouldnt be needed! */
36         int console_width; /* shouldnt be needed! */
37
38         int winx;
39         int ymin, ymax;
40         
41         /* callbacks */
42         int (*begin)(struct TextViewContext *tvc);
43         void (*end)(struct TextViewContext *tvc);
44         void *arg1;
45         void *arg2;
46
47         /* iterator */
48         int (*step)(struct TextViewContext *tvc);
49         int (*line_get)(struct TextViewContext *tvc, const char **, int *);
50         int (*line_color)(struct TextViewContext *tvc, unsigned char fg[3], unsigned char bg[3]);
51         void *iter;
52         int iter_index;
53         int iter_char;          /* char intex, used for multi-line report display */
54         int iter_char_next;     /* same as above, next \n */
55         int iter_tmp;           /* internal iterator use */
56
57 } TextViewContext;
58
59 int textview_draw(struct TextViewContext *tvc, int draw, int mval[2], void **mouse_pick, int *pos_pick);
60
61 #define TVC_LINE_FG     (1<<0)
62 #define TVC_LINE_BG     (1<<1)