gnttextview.h File Reference

Textview API. More...

#include "gntwidget.h"
#include "gnt.h"
#include "gntcolors.h"
#include "gntkeys.h"

Include dependency graph for gnttextview.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  _GntTextView
struct  _GntTextViewClass

Defines

#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))

Typedefs

typedef _GntTextView GntTextView
typedef _GntTextViewPriv GntTextViewPriv
typedef _GntTextViewClass GntTextViewClass

Enumerations

enum  GntTextViewFlag { GNT_TEXT_VIEW_NO_SCROLL = 1 << 0, GNT_TEXT_VIEW_WRAP_CHAR = 1 << 1, GNT_TEXT_VIEW_TOP_ALIGN = 1 << 2 }
enum  GntTextFormatFlags {
  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
}

Functions

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 *pager)
void gnt_text_view_set_flag (GntTextView *view, GntTextViewFlag flag)
 Set a GntTextViewFlag for the textview widget.


Detailed Description

Textview API.


Function Documentation

chtype gnt_text_format_flag_to_chtype GntTextFormatFlags  flags  ) 
 

Parameters:
flags 
Returns:

void gnt_text_view_append_text_with_flags GntTextView *  view,
const char *  text,
GntTextFormatFlags  flags
 

Parameters:
view 
text 
flags 

void gnt_text_view_append_text_with_tag GntTextView *  view,
const char *  text,
GntTextFormatFlags  flags,
const char *  tag
 

Parameters:
view 
text 
flags 
tag 

void gnt_text_view_attach_editor_widget GntTextView *  view,
GntWidget *  pager
 

Parameters:
view 
widget 

void gnt_text_view_attach_pager_widget GntTextView *  view,
GntWidget *  pager
 

Parameters:
view 
widget 

void gnt_text_view_attach_scroll_widget GntTextView *  view,
GntWidget *  widget
 

Parameters:
view 
widget 

void gnt_text_view_clear GntTextView *  view  ) 
 

Parameters:
view 

G_BEGIN_DECLS GType gnt_text_view_get_gtype void   ) 
 

Returns:

int gnt_text_view_get_lines_above GntTextView *  view  ) 
 

Parameters:
view 
Returns:

int gnt_text_view_get_lines_below GntTextView *  view  ) 
 

Parameters:
view 
Returns:

GntWidget* gnt_text_view_new void   ) 
 

Returns:

void gnt_text_view_next_line GntTextView *  view  ) 
 

Parameters:
view 

void gnt_text_view_scroll GntTextView *  view,
int  scroll
 

Parameters:
view 
scroll 

void gnt_text_view_set_flag GntTextView *  view,
GntTextViewFlag  flag
 

Set a GntTextViewFlag for the textview widget.

Parameters:
view The textview widget
flag The flag to set

int gnt_text_view_tag_change GntTextView *  view,
const char *  name,
const char *  text,
gboolean  all
 

Parameters:
view 
name 
text 
all 
Returns: