gnttextview.h
Go to the documentation of this file.
1
5 /*
6 * GNT - The GLib Ncurses Toolkit
7 *
8 * GNT is the legal property of its developers, whose names are too numerous
9 * to list here. Please refer to the COPYRIGHT file distributed with this
10 * source distribution.
11 *
12 * This library is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, write to the Free Software
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
25 */
26
27 #ifndef GNT_TEXT_VIEW_H
28 #define GNT_TEXT_VIEW_H
29
30 #include "gntwidget.h"
31 #include "gnt.h"
32 #include "gntcolors.h"
33 #include "gntkeys.h"
34
35 #define GNT_TYPE_TEXT_VIEW (gnt_text_view_get_gtype())
36 #define GNT_TEXT_VIEW(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), GNT_TYPE_TEXT_VIEW, GntTextView))
37 #define GNT_TEXT_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), GNT_TYPE_TEXT_VIEW, GntTextViewClass))
38 #define GNT_IS_TEXT_VIEW(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GNT_TYPE_TEXT_VIEW))
39 #define GNT_IS_TEXT_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), GNT_TYPE_TEXT_VIEW))
40 #define GNT_TEXT_VIEW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), GNT_TYPE_TEXT_VIEW, GntTextViewClass))
41
42 #define GNT_TEXT_VIEW_FLAGS(obj) (GNT_TEXT_VIEW(obj)->priv.flags)
43 #define GNT_TEXT_VIEW_SET_FLAGS(obj, flags) (GNT_TEXT_VIEW_FLAGS(obj) |= flags)
44 #define GNT_TEXT_VIEW_UNSET_FLAGS(obj, flags) (GNT_TEXT_VIEW_FLAGS(obj) &= ~(flags))
45
46 typedef struct _GntTextView GntTextView;
47 typedef struct _GntTextViewPriv GntTextViewPriv;
48 typedef struct _GntTextViewClass GntTextViewClass;
49
50 typedef enum
51 {
52 GNT_TEXT_VIEW_NO_SCROLL = 1 << 0,
53 GNT_TEXT_VIEW_WRAP_CHAR = 1 << 1,
54 GNT_TEXT_VIEW_TOP_ALIGN = 1 << 2,
55 } GntTextViewFlag;
56
57 struct _GntTextView
58 {
59 GntWidget parent;
60
61 GString *string;
62 GList *list; /* List of GntTextLine */
63
64 GList *tags; /* A list of tags */
65 GntTextViewFlag flags;
66 };
67
68 typedef enum
69 {
70 GNT_TEXT_FLAG_NORMAL = 0,
71 GNT_TEXT_FLAG_BOLD = 1 << 0,
72 GNT_TEXT_FLAG_UNDERLINE = 1 << 1,
73 GNT_TEXT_FLAG_BLINK = 1 << 2,
74 GNT_TEXT_FLAG_DIM = 1 << 3,
75 GNT_TEXT_FLAG_HIGHLIGHT = 1 << 4,
76 } GntTextFormatFlags;
77
78 struct _GntTextViewClass
79 {
80 GntWidgetClass parent;
81
82 void (*gnt_reserved1)(void);
83 void (*gnt_reserved2)(void);
84 void (*gnt_reserved3)(void);
85 void (*gnt_reserved4)(void);
86 };
87
88 G_BEGIN_DECLS
89
93 GType gnt_text_view_get_gtype(void);
94
100 GntWidget * gnt_text_view_new(void);
101
107 void gnt_text_view_scroll(GntTextView *view, int scroll);
108
116 void gnt_text_view_append_text_with_flags(GntTextView *view, const char *text, GntTextFormatFlags flags);
117
126 void gnt_text_view_append_text_with_tag(GntTextView *view, const char *text, GntTextFormatFlags flags, const char *tag);
127
134 void gnt_text_view_next_line(GntTextView *view);
135
143 chtype gnt_text_format_flag_to_chtype(GntTextFormatFlags flags);
144
150 void gnt_text_view_clear(GntTextView *view);
151
159 int gnt_text_view_get_lines_below(GntTextView *view);
160
168 int gnt_text_view_get_lines_above(GntTextView *view);
169
181 int gnt_text_view_tag_change(GntTextView *view, const char *name, const char *text, gboolean all);
182
190 void gnt_text_view_attach_scroll_widget(GntTextView *view, GntWidget *widget);
191
209 void gnt_text_view_attach_pager_widget(GntTextView *view, GntWidget *pager);
210
228 void gnt_text_view_attach_editor_widget(GntTextView *view, GntWidget *widget);
229
238 void gnt_text_view_set_flag(GntTextView *view, GntTextViewFlag flag);
239
240 G_END_DECLS
241
242 #endif /* GNT_TEXT_VIEW_H */
gnt_text_view_attach_scroll_widget
void gnt_text_view_attach_scroll_widget(GntTextView *view, GntWidget *widget)
Setup hooks so that pressing up/down/page-up/page-down keys when &#39;widget&#39; is in focus scrolls the tex...
_GntTextView
Definition: gnttextview.h:57
gntcolors.h
Colors API.
gnt_text_view_attach_pager_widget
void gnt_text_view_attach_pager_widget(GntTextView *view, GntWidget *pager)
Setup appropriate hooks so that pressing some keys when the &#39;pager&#39; widget is in focus triggers the P...
_GntTextViewClass
Definition: gnttextview.h:78
gnt_text_view_tag_change
int gnt_text_view_tag_change(GntTextView *view, const char *name, const char *text, gboolean all)
Change the text of a tag.
gntwidget.h
Widget API.
gnt_text_view_attach_editor_widget
void gnt_text_view_attach_editor_widget(GntTextView *view, GntWidget *widget)
Setup appropriate hooks so that pressing some keys when &#39;widget&#39; is in focus triggers the EDITOR to p...
gnt_text_view_append_text_with_tag
void gnt_text_view_append_text_with_tag(GntTextView *view, const char *text, GntTextFormatFlags flags, const char *tag)
Append text in the textview, with some identifier (tag) for the added text.
gnt_text_view_get_lines_above
int gnt_text_view_get_lines_above(GntTextView *view)
The number of lines above the topmost visible line.
gnt.h
GNT API.
gnt_text_view_set_flag
void gnt_text_view_set_flag(GntTextView *view, GntTextViewFlag flag)
Set a GntTextViewFlag for the textview widget.
gnt_text_view_new
GntWidget * gnt_text_view_new(void)
Create a new textview.
gntkeys.h
Keys API.
gnt_text_view_clear
void gnt_text_view_clear(GntTextView *view)
Clear the contents of the textview.
gnt_text_view_get_lines_below
int gnt_text_view_get_lines_below(GntTextView *view)
The number of lines below the bottom-most visible line.
gnt_text_view_get_gtype
G_BEGIN_DECLS GType gnt_text_view_get_gtype(void)
gnt_text_format_flag_to_chtype
chtype gnt_text_format_flag_to_chtype(GntTextFormatFlags flags)
Convert GNT-text formats to ncurses-text attributes.
gnt_text_view_next_line
void gnt_text_view_next_line(GntTextView *view)
Move the cursor to the beginning of the next line and resets text-attributes.
gnt_text_view_append_text_with_flags
void gnt_text_view_append_text_with_flags(GntTextView *view, const char *text, GntTextFormatFlags flags)
Append new text in a textview.
_GntWidgetClass
Definition: gntwidget.h:113
gnt_text_view_scroll
void gnt_text_view_scroll(GntTextView *view, int scroll)
Scroll the textview.
_GntWidget
Definition: gntwidget.h:98