GtkText

typedef struct _GtkText GtkText;

Most of the GtkText struct members should not be accessed directly. Listed below are a few exceptions and how to use them.

GtkTextFont

typedef struct _GtkTextFont GtkTextFont;

Internal GtkText data type.

GtkPropertyMark

typedef struct {
  /* Position in list. */
  GList* property;

  /* Offset into that property. */
  guint offset;

  /* Current index. */
  guint index;
} GtkPropertyMark;

Internal GtkText data type. Should not be accessed directly.

gtk_text_new ()

GtkWidget*  gtk_text_new                    (GtkAdjustment *hadj,
                                             GtkAdjustment *vadj);

Creates a new GtkText widget, initialized with the given pointers to GtkAdjustments. These pointers can be used to track the viewing position of the GtkText widget. Passing NULL to either or both of them will make the GtkText create its own. You can set these later with the function gtk_text_set_adjustment().

gtk_text_set_editable ()

void        gtk_text_set_editable           (GtkText *text,
                                             gboolean editable);

Sets whether the GtkText widget can be edited by the user or not. This still allows you the programmer to make changes with the various GtkText functions.

gtk_text_set_word_wrap ()

void        gtk_text_set_word_wrap          (GtkText *text,
                                             gboolean word_wrap);

Sets whether the GtkText widget wraps words down to the next line if it can't be completed on the current line.

gtk_text_set_line_wrap ()

void        gtk_text_set_line_wrap          (GtkText *text,
                                             gboolean line_wrap);

Controls how GtkText handles long lines of continuous text. If line wrap is on, the line is broken when it reaches the extent of the GtkText widget viewing area and the rest is displayed on the next line. If it is not set, the line continues regardless size of current viewing area. Similar to word wrap but it disregards word boundaries.

gtk_text_set_adjustments ()

void        gtk_text_set_adjustments        (GtkText *text,
                                             GtkAdjustment *hadj,
                                             GtkAdjustment *vadj);

Allows you to set GtkAdjustment pointers which in turn allows you to keep track of the viewing position of the GtkText widget.

gtk_text_set_point ()

void        gtk_text_set_point              (GtkText *text,
                                             guint index);

Sets the cursor at the given point. In this case a point constitutes the number of characters from the extreme upper left corner of the GtkText widget.

gtk_text_get_point ()

guint       gtk_text_get_point              (GtkText *text);

Gets the current position of the cursor as the number of characters from the upper left corner of the GtkText widget.

gtk_text_get_length ()

guint       gtk_text_get_length             (GtkText *text);

Returns the length of the all the text contained within the GtkText widget; disregards current point position.

gtk_text_freeze ()

void        gtk_text_freeze                 (GtkText *text);

Freezes the GtkText widget which disallows redrawing of the widget until it is thawed. This is useful if a large number of changes are going to made to the text within the widget, reducing the amount of flicker seen by the user.

gtk_text_thaw ()

void        gtk_text_thaw                   (GtkText *text);

Allows the GtkText widget to be redrawn again by GTK.

gtk_text_insert ()

void        gtk_text_insert                 (GtkText *text,
                                             GdkFont *font,
                                             const GdkColor *fore,
                                             const GdkColor *back,
                                             const char *chars,
                                             gint length);

Inserts given text into the GtkText widget with the given properties as outlined below.

gtk_text_backward_delete ()

gboolean    gtk_text_backward_delete        (GtkText *text,
                                             guint nchars);

Deletes from the current point position backward the given number of characters.

gtk_text_forward_delete ()

gboolean    gtk_text_forward_delete         (GtkText *text,
                                             guint nchars);

Deletes from the current point position forward the given number of characters.

GTK_TEXT_INDEX()

#define     GTK_TEXT_INDEX(t, index)

Returns the character at the given index within the GtkText widget.

The "hadjustment" property

  "hadjustment"          GtkAdjustment         : Read / Write

Used by the GtkText widget to keep track of the size of its horizontal text.

The "line-wrap" property

  "line-wrap"            gboolean              : Read / Write

Boolean value indicating whether line wrap is enabled or not.

Default value: TRUE

The "vadjustment" property

  "vadjustment"          GtkAdjustment         : Read / Write

Used by the GtkText widget to keep track of the size of its vertical text.

The "word-wrap" property

  "word-wrap"            gboolean              : Read / Write

Boolean value indicated whether word wrap is enabled or not.

Default value: FALSE

The "set-scroll-adjustments" signal

void        user_function                  (GtkText       *text,
                                            GtkAdjustment *arg1,
                                            GtkAdjustment *arg2,
                                            gpointer       user_data)      : Run last