gnttextview.h
Go to the documentation of this file.
/*
* GNT - The GLib Ncurses Toolkit
*
* GNT is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* This library 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 program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#ifndef GNT_TEXT_VIEW_H
#define GNT_TEXT_VIEW_H
#include "gntwidget.h"
#include "gnt.h"
#include "gntcolors.h"
#include "gntkeys.h"
#define GNT_TYPE_TEXT_VIEW (gnt_text_view_get_gtype())
#define GNT_TEXT_VIEW(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), GNT_TYPE_TEXT_VIEW, GntTextView))
#define GNT_TEXT_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), GNT_TYPE_TEXT_VIEW, GntTextViewClass))
#define GNT_IS_TEXT_VIEW(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GNT_TYPE_TEXT_VIEW))
#define GNT_IS_TEXT_VIEW_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), GNT_TYPE_TEXT_VIEW))
#define GNT_TEXT_VIEW_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), GNT_TYPE_TEXT_VIEW, GntTextViewClass))
#define GNT_TEXT_VIEW_FLAGS(obj) (GNT_TEXT_VIEW(obj)->priv.flags)
#define GNT_TEXT_VIEW_SET_FLAGS(obj, flags) (GNT_TEXT_VIEW_FLAGS(obj) |= flags)
#define GNT_TEXT_VIEW_UNSET_FLAGS(obj, flags) (GNT_TEXT_VIEW_FLAGS(obj) &= ~(flags))
typedef struct _GntTextView GntTextView;
typedef struct _GntTextViewPriv GntTextViewPriv;
typedef struct _GntTextViewClass GntTextViewClass;
typedef enum
{
GNT_TEXT_VIEW_NO_SCROLL = 1 << 0,
GNT_TEXT_VIEW_WRAP_CHAR = 1 << 1,
GNT_TEXT_VIEW_TOP_ALIGN = 1 << 2,
} GntTextViewFlag;
struct _GntTextView
{
GntWidget parent;
GString *string;
GList *list; /* List of GntTextLine */
GList *tags; /* A list of tags */
GntTextViewFlag flags;
};
typedef enum
{
GNT_TEXT_FLAG_NORMAL = 0,
GNT_TEXT_FLAG_BOLD = 1 << 0,
GNT_TEXT_FLAG_UNDERLINE = 1 << 1,
GNT_TEXT_FLAG_BLINK = 1 << 2,
GNT_TEXT_FLAG_DIM = 1 << 3,
GNT_TEXT_FLAG_HIGHLIGHT = 1 << 4,
} GntTextFormatFlags;
struct _GntTextViewClass
{
GntWidgetClass parent;
void (*gnt_reserved1)(void);
void (*gnt_reserved2)(void);
void (*gnt_reserved3)(void);
void (*gnt_reserved4)(void);
};
G_BEGIN_DECLS
GType gnt_text_view_get_gtype(void);
GntWidget * gnt_text_view_new(void);
void gnt_text_view_scroll(GntTextView *view, int scroll);
void gnt_text_view_append_text_with_flags(GntTextView *view, const char *text, GntTextFormatFlags flags);
void gnt_text_view_append_text_with_tag(GntTextView *view, const char *text, GntTextFormatFlags flags, const char *tag);
void gnt_text_view_next_line(GntTextView *view);
chtype gnt_text_format_flag_to_chtype(GntTextFormatFlags flags);
void gnt_text_view_clear(GntTextView *view);
int gnt_text_view_get_lines_below(GntTextView *view);
int gnt_text_view_get_lines_above(GntTextView *view);
int gnt_text_view_tag_change(GntTextView *view, const char *name, const char *text, gboolean all);
void gnt_text_view_attach_scroll_widget(GntTextView *view, GntWidget *widget);
void gnt_text_view_attach_pager_widget(GntTextView *view, GntWidget *pager);
void gnt_text_view_attach_editor_widget(GntTextView *view, GntWidget *widget);
void gnt_text_view_set_flag(GntTextView *view, GntTextViewFlag flag);
G_END_DECLS
#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