GtkSourceView 3 Reference Manual: GtkSourceGutter

## GtkSourceGutter GtkSourceGutter — Gutter object for GtkSourceView |

## Synopsis

    #include <gtksourceview/gtksource.h>

                        GtkSourceGutter;
    GdkWindow *         gtk_source_gutter_get_window        (GtkSourceGutter *gutter);
    gboolean            gtk_source_gutter_insert            (GtkSourceGutter *gutter,
                                                             GtkSourceGutterRenderer *renderer,
                                                             gint position);
    void                gtk_source_gutter_reorder           (GtkSourceGutter *gutter,
                                                             GtkSourceGutterRenderer *renderer,
                                                             gint position);
    void                gtk_source_gutter_remove            (GtkSourceGutter *gutter,
                                                             GtkSourceGutterRenderer *renderer);
    void                gtk_source_gutter_queue_draw        (GtkSourceGutter *gutter);
    void                gtk_source_gutter_get_padding       (GtkSourceGutter *gutter,
                                                             gint *xpad,
                                                             gint *ypad);
    void                gtk_source_gutter_set_padding       (GtkSourceGutter *gutter,
                                                             gint xpad,
                                                             gint ypad);
    GtkSourceGutterRenderer * gtk_source_gutter_get_renderer_at_pos
                                                            (GtkSourceGutter *gutter,
                                                             gint x,
                                                             gint y);

## Object Hierarchy

      GObject
       +----GtkSourceGutter

## Properties

      "view"                     GtkSourceView*        : Read / Write / Construct Only
      "window-type"              GtkTextWindowType     : Read / Write / Construct Only
      "xpad"                     gint                  : Read / Write / Construct
      "ypad"                     gint                  : Read / Write / Construct

## Description

The GtkSourceGutter object represents the left and right gutters of the text view. It is used by GtkSourceView to draw the line numbers and category marks that might be present on a line. By packing additional GtkSourceGutterRenderer objects in the gutter, you can extend the gutter with your own custom drawings.

The gutter works very much the same way as cells rendered in a GtkTreeView. The concept is similar, with the exception that the gutter does not have an underlying GtkTreeModel. The builtin line number renderer is at position GTK_SOURCE_VIEW_GUTTER_POSITION_LINES (-30) and the marks renderer is at GTK_SOURCE_VIEW_GUTTER_POSITION_MARKS (-20). You can use these values to position custom renderers accordingly.

## Details

### GtkSourceGutter

    typedef struct _GtkSourceGutter GtkSourceGutter;

### gtk_source_gutter_get_window ()

    GdkWindow *         gtk_source_gutter_get_window        (GtkSourceGutter *gutter);

Get the GdkWindow of the gutter. The window will only be available when the gutter has at least one, non-zero width, cell renderer packed.

`gutter` : | a GtkSourceGutter.
Returns : | the GdkWindow of the gutter, or `NULL` if the gutter has no window. [transfer none]

Since 2.8

### gtk_source_gutter_insert ()

    gboolean            gtk_source_gutter_insert            (GtkSourceGutter *gutter,
                                                             GtkSourceGutterRenderer *renderer,
                                                             gint position);

Insert `renderer` into the gutter. If `renderer` is yet unowned then gutter claims its ownership. Otherwise just increases renderer's reference count. `renderer` cannot be already inserted to another gutter.

`gutter` : | a GtkSourceGutter.
`renderer` : | a gutter renderer (must inherit from GtkSourceGutterRenderer).
`position` : | the renderer position.
Returns : | `TRUE` if operation succeeded. Otherwise `FALSE`.

Since 3.0

### gtk_source_gutter_reorder ()

    void                gtk_source_gutter_reorder           (GtkSourceGutter *gutter,
                                                             GtkSourceGutterRenderer *renderer,
                                                             gint position);

Reorders `renderer` in `gutter` to new `position`.

`gutter` : | a GtkSourceGutterRenderer.
`renderer` : | a GtkCellRenderer.
`position` : | the new renderer position.

Since 2.8

### gtk_source_gutter_remove ()

    void                gtk_source_gutter_remove            (GtkSourceGutter *gutter,
                                                             GtkSourceGutterRenderer *renderer);

Removes `renderer` from `gutter`.

`gutter` : | a GtkSourceGutter.
`renderer` : | a GtkSourceGutterRenderer.

Since 2.8

### gtk_source_gutter_queue_draw ()

    void                gtk_source_gutter_queue_draw        (GtkSourceGutter *gutter);

Invalidates the drawable area of the gutter. You can use this to force a redraw of the gutter if something has changed and needs to be redrawn.

`gutter` : | a GtkSourceGutter.

Since 2.8

### gtk_source_gutter_get_padding ()

    void                gtk_source_gutter_get_padding       (GtkSourceGutter *gutter,
                                                             gint *xpad,
                                                             gint *ypad);

### gtk_source_gutter_set_padding ()

    void                gtk_source_gutter_set_padding       (GtkSourceGutter *gutter,
                                                             gint xpad,
                                                             gint ypad);

### gtk_source_gutter_get_renderer_at_pos ()

    GtkSourceGutterRenderer * gtk_source_gutter_get_renderer_at_pos
                                                            (GtkSourceGutter *gutter,
                                                             gint x,
                                                             gint y);

Finds the GtkSourceGutterRenderer at (x, y).

`gutter` : | A GtkSourceGutter.
`x` : | The x position to get identified.
`y` : | The y position to get identified.
Returns : | the renderer at (x, y) or `NULL`. [transfer none]

## Property Details

### The `"view"` property

      "view"                     GtkSourceView*        : Read / Write / Construct Only

The GtkSourceView of the gutter

### The `"window-type"` property

      "window-type"              GtkTextWindowType     : Read / Write / Construct Only

The text window type on which the window is placed

Default value: GTK_TEXT_WINDOW_PRIVATE

### The `"xpad"` property

      "xpad"                     gint                  : Read / Write / Construct

The x-padding.

Allowed values: >= -1

Default value: 0

### The `"ypad"` property

      "ypad"                     gint                  : Read / Write / Construct

The y-padding.

Allowed values: >= -1

Default value: 0

## See Also

GtkSourceView