GtkSourceView

typedef struct _GtkSourceView GtkSourceView;

enum GtkSourceSmartHomeEndType

typedef enum {
	GTK_SOURCE_SMART_HOME_END_DISABLED,
	GTK_SOURCE_SMART_HOME_END_BEFORE,
	GTK_SOURCE_SMART_HOME_END_AFTER,
	GTK_SOURCE_SMART_HOME_END_ALWAYS
} GtkSourceSmartHomeEndType;

enum GtkSourceDrawSpacesFlags

typedef enum {
	GTK_SOURCE_DRAW_SPACES_SPACE      = 1 << 0,
	GTK_SOURCE_DRAW_SPACES_TAB        = 1 << 1,
	GTK_SOURCE_DRAW_SPACES_NEWLINE    = 1 << 2,
	GTK_SOURCE_DRAW_SPACES_NBSP       = 1 << 3,
	GTK_SOURCE_DRAW_SPACES_LEADING    = 1 << 4,
	GTK_SOURCE_DRAW_SPACES_TEXT       = 1 << 5,
	GTK_SOURCE_DRAW_SPACES_TRAILING   = 1 << 6,
	GTK_SOURCE_DRAW_SPACES_ALL        = 0x7f
} GtkSourceDrawSpacesFlags;

GtkSourceDrawSpacesFlags determine what kind of spaces whould be drawn. If none of GTK_SOURCE_DRAW_SPACES_LEADING, GTK_SOURCE_DRAW_SPACES_TEXT or GTK_SOURCE_DRAW_SPACES_TRAILING is specified, whitespaces at any position in the line will be drawn (i.e. it has the same effect as specifying all of them).

enum GtkSourceViewGutterPosition

typedef enum {
	GTK_SOURCE_VIEW_GUTTER_POSITION_LINES = -30,
	GTK_SOURCE_VIEW_GUTTER_POSITION_MARKS = -20
} GtkSourceViewGutterPosition;

gtk_source_view_new ()

GtkWidget *         gtk_source_view_new                 (void);

Creates a new GtkSourceView. An empty default buffer will be created for you. If you want to specify your own buffer, consider gtk_source_view_new_with_buffer().

gtk_source_view_new_with_buffer ()

GtkWidget *         gtk_source_view_new_with_buffer     (GtkSourceBuffer *buffer);

Creates a new GtkSourceView widget displaying the buffer buffer. One buffer can be shared among many widgets.

gtk_source_view_set_auto_indent ()

void                gtk_source_view_set_auto_indent     (GtkSourceView *view,
                                                         gboolean enable);

If TRUE auto indentation of text is enabled.

gtk_source_view_get_auto_indent ()

gboolean            gtk_source_view_get_auto_indent     (GtkSourceView *view);

Returns whether auto indentation of text is enabled.

gtk_source_view_set_indent_on_tab ()

void                gtk_source_view_set_indent_on_tab   (GtkSourceView *view,
                                                         gboolean enable);

If TRUE, when the tab key is pressed and there is a selection, the selected text is indented of one level instead of being replaced with the \t characters. Shift+Tab unindents the selection.

Since 1.8

gtk_source_view_get_indent_on_tab ()

gboolean            gtk_source_view_get_indent_on_tab   (GtkSourceView *view);

Returns whether when the tab key is pressed the current selection should get indented instead of replaced with the \t character.

Since 1.8

gtk_source_view_set_indent_width ()

void                gtk_source_view_set_indent_width    (GtkSourceView *view,
                                                         gint width);

Sets the number of spaces to use for each step of indent. If width is -1, the value of the GtkSourceView::tab-width property will be used.

gtk_source_view_get_indent_width ()

gint                gtk_source_view_get_indent_width    (GtkSourceView *view);

Returns the number of spaces to use for each step of indent. See gtk_source_view_set_indent_width() for details.

gtk_source_view_set_insert_spaces_instead_of_tabs ()

void                gtk_source_view_set_insert_spaces_instead_of_tabs
                                                        (GtkSourceView *view,
                                                         gboolean enable);

If TRUE any tabulator character inserted is replaced by a group of space characters.

gtk_source_view_get_insert_spaces_instead_of_tabs ()

gboolean            gtk_source_view_get_insert_spaces_instead_of_tabs
                                                        (GtkSourceView *view);

Returns whether when inserting a tabulator character it should be replaced by a group of space characters.

gtk_source_view_set_smart_home_end ()

void                gtk_source_view_set_smart_home_end  (GtkSourceView *view,
                                                         GtkSourceSmartHomeEndType smart_he);

Set the desired movement of the cursor when HOME and END keys are pressed.

gtk_source_view_get_smart_home_end ()

GtkSourceSmartHomeEndType gtk_source_view_get_smart_home_end
                                                        (GtkSourceView *view);

Returns a GtkSourceSmartHomeEndType end value specifying how the cursor will move when HOME and END keys are pressed.

gtk_source_view_set_mark_attributes ()

void                gtk_source_view_set_mark_attributes (GtkSourceView *view,
                                                         const gchar *category,
                                                         GtkSourceMarkAttributes *attributes,
                                                         gint priority);

Sets attributes and priority for the category.

gtk_source_view_get_mark_attributes ()

GtkSourceMarkAttributes * gtk_source_view_get_mark_attributes
                                                        (GtkSourceView *view,
                                                         const gchar *category,
                                                         gint *priority);

Gets attributes and priority for the category.

gtk_source_view_set_highlight_current_line ()

void                gtk_source_view_set_highlight_current_line
                                                        (GtkSourceView *view,
                                                         gboolean hl);

If hl is TRUE the current line is highlighted.

gtk_source_view_get_highlight_current_line ()

gboolean            gtk_source_view_get_highlight_current_line
                                                        (GtkSourceView *view);

Returns whether the current line is highlighted.

gtk_source_view_set_show_line_marks ()

void                gtk_source_view_set_show_line_marks (GtkSourceView *view,
                                                         gboolean show);

If TRUE line marks will be displayed beside the text.

Since 2.2

gtk_source_view_get_show_line_marks ()

gboolean            gtk_source_view_get_show_line_marks (GtkSourceView *view);

Returns whether line marks are displayed beside the text.

Since 2.2

gtk_source_view_set_show_line_numbers ()

void                gtk_source_view_set_show_line_numbers
                                                        (GtkSourceView *view,
                                                         gboolean show);

If TRUE line numbers will be displayed beside the text.

gtk_source_view_get_show_line_numbers ()

gboolean            gtk_source_view_get_show_line_numbers
                                                        (GtkSourceView *view);

Returns whether line numbers are displayed beside the text.

gtk_source_view_set_show_right_margin ()

void                gtk_source_view_set_show_right_margin
                                                        (GtkSourceView *view,
                                                         gboolean show);

If TRUE a right margin is displayed.

gtk_source_view_get_show_right_margin ()

gboolean            gtk_source_view_get_show_right_margin
                                                        (GtkSourceView *view);

Returns whether a right margin is displayed.

gtk_source_view_set_right_margin_position ()

void                gtk_source_view_set_right_margin_position
                                                        (GtkSourceView *view,
                                                         guint pos);

Sets the position of the right margin in the given view.

gtk_source_view_get_right_margin_position ()

guint               gtk_source_view_get_right_margin_position
                                                        (GtkSourceView *view);

Gets the position of the right margin in the given view.

gtk_source_view_set_tab_width ()

void                gtk_source_view_set_tab_width       (GtkSourceView *view,
                                                         guint width);

Sets the width of tabulation in characters.

gtk_source_view_get_tab_width ()

guint               gtk_source_view_get_tab_width       (GtkSourceView *view);

Returns the width of tabulation in characters.

gtk_source_view_set_draw_spaces ()

void                gtk_source_view_set_draw_spaces     (GtkSourceView *view,
                                                         GtkSourceDrawSpacesFlags flags);

Set if and how the spaces should be visualized. Specifying flags as 0 will disable display of spaces.

gtk_source_view_get_draw_spaces ()

GtkSourceDrawSpacesFlags gtk_source_view_get_draw_spaces
                                                        (GtkSourceView *view);

Returns the GtkSourceDrawSpacesFlags specifying if and how spaces should be displayed for this view.

gtk_source_view_get_completion ()

GtkSourceCompletion * gtk_source_view_get_completion    (GtkSourceView *view);

Gets the GtkSourceCompletion associated with view.

gtk_source_view_get_gutter ()

GtkSourceGutter *   gtk_source_view_get_gutter          (GtkSourceView *view,
                                                         GtkTextWindowType window_type);

Returns the GtkSourceGutter object associated with window_type for view. Only GTK_TEXT_WINDOW_LEFT and GTK_TEXT_WINDOW_RIGHT are supported, respectively corresponding to the left and right gutter. The line numbers and mark category icons are rendered in the gutter corresponding to GTK_TEXT_WINDOW_LEFT.

Since 2.8

gtk_source_view_get_visual_column ()

guint               gtk_source_view_get_visual_column   (GtkSourceView *view,
                                                         const GtkTextIter *iter);

Determines the visual column at iter taking into consideration the indent width of view.

The "auto-indent" property

  "auto-indent"              gboolean              : Read / Write

Whether to enable auto indentation.

Default value: FALSE

The "completion" property

  "completion"               GtkSourceCompletion*  : Read

The completion object associated with the view

The "draw-spaces" property

  "draw-spaces"              GtkSourceDrawSpacesFlags  : Read / Write

Set if and how the spaces should be visualized.

Since 2.4

The "highlight-current-line" property

  "highlight-current-line"   gboolean              : Read / Write

Whether to highlight the current line.

Default value: FALSE

The "indent-on-tab" property

  "indent-on-tab"            gboolean              : Read / Write

Whether to indent the selected text when the tab key is pressed.

Default value: TRUE

The "indent-width" property

  "indent-width"             gint                  : Read / Write

Width of an indentation step expressed in number of spaces.

Allowed values: [-1,32]

Default value: -1

The "insert-spaces-instead-of-tabs" property

  "insert-spaces-instead-of-tabs" gboolean              : Read / Write

Whether to insert spaces instead of tabs.

Default value: FALSE

The "right-margin-position" property

  "right-margin-position"    guint                 : Read / Write

Position of the right margin.

Allowed values: [1,1000]

Default value: 80

The "show-line-marks" property

  "show-line-marks"          gboolean              : Read / Write

Whether to display line mark pixbufs

Default value: FALSE

The "show-line-numbers" property

  "show-line-numbers"        gboolean              : Read / Write

Whether to display line numbers

Default value: FALSE

The "show-right-margin" property

  "show-right-margin"        gboolean              : Read / Write

Whether to display the right margin.

Default value: FALSE

The "smart-home-end" property

  "smart-home-end"           GtkSourceSmartHomeEndType  : Read / Write

Set the behavior of the HOME and END keys.

Default value: GTK_SOURCE_SMART_HOME_END_DISABLED

Since 2.0

The "tab-width" property

  "tab-width"                guint                 : Read / Write

Width of an tab character expressed in number of spaces.

Allowed values: [1,32]

Default value: 8

The "line-mark-activated" signal

void                user_function                      (GtkSourceView *view,
                                                        GtkTextIter   *iter,
                                                        GdkEvent      *event,
                                                        gpointer       user_data)      : Run Last

Emitted when a line mark has been activated (for instance when there was a button press in the line marks gutter). You can use iter to determine on which line the activation took place.

The "move-lines" signal

void                user_function                      (GtkSourceView *view,
                                                        gboolean       copy,
                                                        gint           count,
                                                        gpointer       user_data)      : Action

The ::move-lines signal is a keybinding which gets emitted when the user initiates moving a line. The default binding key is Alt+Up/Down arrow. And moves the currently selected lines, or the current line by count. For the moment, only count of -1 or 1 is valid.

Since 2.10

The "move-words" signal

void                user_function                      (GtkSourceView *view,
                                                        gint           count,
                                                        gpointer       user_data)      : Action

The ::move-words signal is a keybinding which gets emitted when the user initiates moving a word. The default binding key is Alt+Left/Right Arrow and moves the current selection, or the current word by one word.

Since 3.0

The "redo" signal

void                user_function                      (GtkSourceView *sourceview,
                                                        gpointer       user_data)       : Action

The "show-completion" signal

void                user_function                      (GtkSourceView *view,
                                                        gpointer       user_data)      : Action

The ::show-completion signal is a key binding signal which gets emitted when the user requests a completion, by pressing Control+space.

This will create a GtkSourceCompletionContext with the activation type as GTK_SOURCE_COMPLETION_ACTIVATION_USER_REQUESTED.

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to activate the completion by another means, for example with another key binding or a menu entry.

The "smart-home-end" signal

void                user_function                      (GtkSourceView *view,
                                                        GtkTextIter   *iter,
                                                        gint           count,
                                                        gpointer       user_data)      : Run Last

Emitted when a the cursor was moved according to the smart home end setting. The signal is emitted after the cursor is moved, but during the GtkTextView::move-cursor action. This can be used to find out whether the cursor was moved by a normal home/end or by a smart home/end.

Since 3.0

The "undo" signal

void                user_function                      (GtkSourceView *sourceview,
                                                        gpointer       user_data)       : Action