GXK Interface Reference

/opt/src/beast/beast-gtk/gxk/gxktexttools.h

SYNOPSIS

void  gxk_scroll_text_advance  (sctext, uri);
void  gxk_scroll_text_append  (sctext, string);
void  gxk_scroll_text_append_file  (sctext, file_name);
void  gxk_scroll_text_append_file_tsm  (sctext, file_name);
void  gxk_scroll_text_append_tsm  (sctext, string);
void  gxk_scroll_text_aprintf  (sctext, text_fmt, ...);
void  gxk_scroll_text_clear  (sctext);
GtkWidget*  gxk_scroll_text_create  (flags, string);
GtkWidget*  gxk_scroll_text_create_for  (flags, parent);
void  gxk_scroll_text_display  (sctext, uri);
void  gxk_scroll_text_enter  (sctext, uri);
GtkTextView*  gxk_scroll_text_get_text_view  (sctext);
void void  gxk_scroll_text_pop_indent  (sctext);
void  gxk_scroll_text_push_indent  (sctext);
void  gxk_scroll_text_rewind  (sctext);
void  gxk_scroll_text_set  (sctext, string);
void  gxk_scroll_text_set_index  (sctext, uri);
void  gxk_scroll_text_set_tsm  (sctext, string);
void  gxk_text_add_tsm_path  (path);
void  gxk_text_buffer_add_textgets_to_view  (tbuffer, tview);
void  gxk_text_buffer_append_from_file  (tbuffer, parse_tsm, indent_margin, file_name);
void  gxk_text_buffer_append_from_string  (tbuffer, parse_tsm, indent_margin, text_length, text);
void  gxk_text_buffer_cursor_to_end  (tbuffer);
void  gxk_text_buffer_cursor_to_start  (tbuffer);
void  gxk_text_buffer_init_custom  ();
void  gxk_text_register_textget_handler  (element_name, handler, user_data);
void  gxk_text_view_cursor_busy  (tview);
void  gxk_text_view_cursor_normal  (tview);
void  gxk_text_view_cursor_to_end  (tview);
void  gxk_text_view_cursor_to_start  (tview);
void  gxk_text_view_enter_browse_mode  (tview);
void  gxk_text_view_leave_browse_mode  (tview);

DESCRIPTION

gxk_scroll_text_advance

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:59
void  gxk_scroll_text_advance  
(GtkWidget   *sctext,
 const gchar *uri);
Relative to the url currently being displayed load and display the possibly partial (relative) url uri. Navigation history is affected.
sctext: a scroll text widget as returned from gxk_scroll_text_create()
uri: resource locator

gxk_scroll_text_append

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:68
void  gxk_scroll_text_append  
(GtkWidget   *sctext,
 const gchar *string);
Append string to the textual contents of this sctext.
sctext: a scroll text widget as returned from gxk_scroll_text_create()
string: the text to be displayed

gxk_scroll_text_append_file

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:72
void  gxk_scroll_text_append_file  
(GtkWidget   *sctext,
 const gchar *file_name);
Append the contents of file_name to the textual contents of this sctext.
sctext: a scroll text widget as returned from gxk_scroll_text_create()
file_name: file holding the text to be displayed

gxk_scroll_text_append_file_tsm

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:74
void  gxk_scroll_text_append_file_tsm  
(GtkWidget   *sctext,
 const gchar *file_name);
Append the contents of file_name to the textual contents of this sctext, where those contents are marked up with tag-span-markup.
sctext: a scroll text widget as returned from gxk_scroll_text_create()
file_name: file holding the text to be displayed in tag-span-markup

gxk_scroll_text_append_tsm

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:70
void  gxk_scroll_text_append_tsm  
(GtkWidget   *sctext,
 const gchar *string);
Append string to the textual contents of this sctext, where string is marked up with tag-span-markup.
sctext: a scroll text widget as returned from gxk_scroll_text_create()
string: the text to be displayed in tag-span-markup

gxk_scroll_text_aprintf

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:77
void  gxk_scroll_text_aprintf  
(GtkWidget   *sctext,
 const gchar *text_fmt,
 ...);

gxk_scroll_text_clear

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:65
void  gxk_scroll_text_clear  
(GtkWidget *sctext);
Clear the textual contents of this sctext and reset the indentation level.
sctext: a scroll text widget as returned from gxk_scroll_text_create()

gxk_scroll_text_create

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:49
GtkWidget*  gxk_scroll_text_create  
(GxkScrollTextFlags flags,
 const gchar       *string);
Create a scrollable text view. Behaviour and apperance can be tweaked by specifying various flags:
  • GXK_SCROLL_TEXT_MONO - use a fixed width font;
  • GXK_SCROLL_TEXT_SANS - use a sans serif font;
  • GXK_SCROLL_TEXT_SERIF - use a serif font;
  • GXK_SCROLL_TEXT_WRAP - allow word wrapping of string;
  • GXK_SCROLL_TEXT_CENTER - center string;
  • GXK_SCROLL_TEXT_WIDGET_BG - do not use white as background, but keep the usual (grey) widget background;
  • GXK_SCROLL_TEXT_NAVIGATABLE - add a navigation bar and allow the user to navigate through clickable links;
  • GXK_SCROLL_TEXT_EDITABLE - permit modifications of the text;
  • GXK_SCROLL_TEXT_HFIXED - make horizontal dimension unscrollable
  • GXK_SCROLL_TEXT_VFIXED - make vertical dimension unscrollable
  • GXK_SCROLL_TEXT_WIDGET_LOOK - this is a combination of flags to adjust the scroll text to look like an ordinary GtkLabel, which amounts to using a sans serif font, normal widget background and allowing word wrapping.
flags: scroll text flags
string: default contents

gxk_scroll_text_create_for

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:51
GtkWidget*  gxk_scroll_text_create_for  
(GxkScrollTextFlags flags,
 GtkWidget         *parent);

gxk_scroll_text_display

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:55
void  gxk_scroll_text_display  
(GtkWidget   *sctext,
 const gchar *uri);
Load and display the resource from uri without altering the navigation history.
sctext: a scroll text widget as returned from gxk_scroll_text_create()
uri: resource locator

gxk_scroll_text_enter

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:57
void  gxk_scroll_text_enter  
(GtkWidget   *sctext,
 const gchar *uri);
Load and display the url uri. Navigation history is affected.
sctext: a scroll text widget as returned from gxk_scroll_text_create()
uri: resource locator

gxk_scroll_text_get_text_view

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:79
GtkTextView*  gxk_scroll_text_get_text_view  
(GtkWidget *sctext);
Return the internally used GtkTextView of this sctext.
sctext: a scroll text widget as returned from gxk_scroll_text_create()
RETURNS: a GtkTextView widget

gxk_scroll_text_pop_indent

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:78
void void  gxk_scroll_text_pop_indent  
(GtkWidget *sctext);
Decrement the global indentation level after a previous increment with gxk_scroll_text_push_indent().
sctext: a scroll text widget as returned from gxk_scroll_text_create()

gxk_scroll_text_push_indent

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:66
void  gxk_scroll_text_push_indent  
(GtkWidget *sctext);
Increment the global indentation level, which affects overall indentation of text added with gxk_scroll_text_append() and friends.
sctext: a scroll text widget as returned from gxk_scroll_text_create()

gxk_scroll_text_rewind

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:60
void  gxk_scroll_text_rewind  
(GtkWidget *sctext);
Go back in navigation history as far as possible.
sctext: a scroll text widget as returned from gxk_scroll_text_create()

gxk_scroll_text_set

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:62
void  gxk_scroll_text_set  
(GtkWidget   *sctext,
 const gchar *string);
Replace the textual contents of this sctext with string.
sctext: a scroll text widget as returned from gxk_scroll_text_create()
string: the new text to be displayed

gxk_scroll_text_set_index

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:53
void  gxk_scroll_text_set_index  
(GtkWidget   *sctext,
 const gchar *uri);
Affect what uri is being displayed by pressing on the "Index" navigation button.
sctext: a scroll text widget as returned from gxk_scroll_text_create()
uri: resource locator

gxk_scroll_text_set_tsm

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:64
void  gxk_scroll_text_set_tsm  
(GtkWidget   *sctext,
 const gchar *string);
Replace the textual contents of this sctext with string, where string is marked up with tag-span-markup.
sctext: a scroll text widget as returned from gxk_scroll_text_create()
string: the new text to be displayed in tag-span-markup

gxk_text_add_tsm_path

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:80
void  gxk_text_add_tsm_path  
(const gchar *path);

gxk_text_buffer_add_textgets_to_view

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:104
void  gxk_text_buffer_add_textgets_to_view  
(GtkTextBuffer *tbuffer,
 GtkTextView   *tview);

gxk_text_buffer_append_from_file

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:92
void  gxk_text_buffer_append_from_file  
(GtkTextBuffer *tbuffer,
 gboolean       parse_tsm,
 guint          indent_margin,
 const gchar   *file_name);

gxk_text_buffer_append_from_string

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:88
void  gxk_text_buffer_append_from_string  
(GtkTextBuffer *tbuffer,
 gboolean       parse_tsm,
 guint          indent_margin,
 guint          text_length,
 const gchar   *text);

gxk_text_buffer_cursor_to_end

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:83
void  gxk_text_buffer_cursor_to_end  
(GtkTextBuffer *tbuffer);

gxk_text_buffer_cursor_to_start

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:82
void  gxk_text_buffer_cursor_to_start  
(GtkTextBuffer *tbuffer);

gxk_text_buffer_init_custom

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:81
void  gxk_text_buffer_init_custom  
();

gxk_text_register_textget_handler

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:102
void  gxk_text_register_textget_handler  
(const gchar          *element_name,
 GxkTextTextgetHandler handler,
 gpointer              user_data);

gxk_text_view_cursor_busy

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:47
void  gxk_text_view_cursor_busy  
(GtkTextView *tview);

gxk_text_view_cursor_normal

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:46
void  gxk_text_view_cursor_normal  
(GtkTextView *tview);

gxk_text_view_cursor_to_end

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:45
void  gxk_text_view_cursor_to_end  
(GtkTextView *tview);
Move the insertion and selection bound mark to the end of the text view's buffer and keep the cursor on screen.
tview: a GtkTextView object

gxk_text_view_cursor_to_start

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:44
void  gxk_text_view_cursor_to_start  
(GtkTextView *tview);
Move the insertion and selection bound mark to the start of the text view's buffer and keep the cursor on screen.
tview: a GtkTextView object

gxk_text_view_enter_browse_mode

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:42
void  gxk_text_view_enter_browse_mode  
(GtkTextView *tview);
Install key press handlers on a text view which allow scrolling its contents into any direction.
tview: a GtkTextView object

gxk_text_view_leave_browse_mode

 /opt/src/beast/beast-gtk/gxk/gxktexttools.h:43
void  gxk_text_view_leave_browse_mode  
(GtkTextView *tview);
Deinstall key press handlers previously installed with gxk_text_view_enter_browse_mode().
tview: a GtkTextView object