GtkSourceGutterRenderer

typedef struct _GtkSourceGutterRenderer GtkSourceGutterRenderer;

enum GtkSourceGutterRendererState

typedef enum {
	GTK_SOURCE_GUTTER_RENDERER_STATE_NORMAL = 0,
	GTK_SOURCE_GUTTER_RENDERER_STATE_CURSOR = 1 << 0,
	GTK_SOURCE_GUTTER_RENDERER_STATE_PRELIT = 1 << 1,
	GTK_SOURCE_GUTTER_RENDERER_STATE_SELECTED = 1 << 2
} GtkSourceGutterRendererState;

enum GtkSourceGutterRendererAlignmentMode

typedef enum {
	GTK_SOURCE_GUTTER_RENDERER_ALIGNMENT_MODE_CELL,
	GTK_SOURCE_GUTTER_RENDERER_ALIGNMENT_MODE_FIRST,
	GTK_SOURCE_GUTTER_RENDERER_ALIGNMENT_MODE_LAST
} GtkSourceGutterRendererAlignmentMode;

gtk_source_gutter_renderer_begin ()

void                gtk_source_gutter_renderer_begin    (GtkSourceGutterRenderer *renderer,
                                                         cairo_t *cr,
                                                         GdkRectangle *background_area,
                                                         GdkRectangle *cell_area,
                                                         GtkTextIter *start,
                                                         GtkTextIter *end);

Called when drawing a region begins. The region to be drawn is indicated by start and end. The purpose is to allow the implementation to precompute some state before the ::draw method is called for each cell.

gtk_source_gutter_renderer_draw ()

void                gtk_source_gutter_renderer_draw     (GtkSourceGutterRenderer *renderer,
                                                         cairo_t *cr,
                                                         GdkRectangle *background_area,
                                                         GdkRectangle *cell_area,
                                                         GtkTextIter *start,
                                                         GtkTextIter *end,
                                                         GtkSourceGutterRendererState state);

Main renderering method. Implementations should implement this method to draw onto the cairo context. The background_area indicates total area of the cell (without padding or margin) to be drawn. The cell_area indicates the area where content can be drawn (text, images, etc).

The state argument indicates the current state of the renderer and should be taken into account to properly draw the different possible states (cursor, prelit, selected) if appropriate.

gtk_source_gutter_renderer_end ()

void                gtk_source_gutter_renderer_end      (GtkSourceGutterRenderer *renderer);

Called when drawing a region of lines has ended.

gtk_source_gutter_renderer_get_size ()

gint                gtk_source_gutter_renderer_get_size (GtkSourceGutterRenderer *renderer);

Get the size of the renderer.

gtk_source_gutter_renderer_set_size ()

void                gtk_source_gutter_renderer_set_size (GtkSourceGutterRenderer *renderer,
                                                         gint size);

Sets the size of the renderer. A value of -1 specifies that the size is to be determined dynamically.

gtk_source_gutter_renderer_set_visible ()

void                gtk_source_gutter_renderer_set_visible
                                                        (GtkSourceGutterRenderer *renderer,
                                                         gboolean visible);

Set whether the gutter renderer is visible.

gtk_source_gutter_renderer_get_visible ()

gboolean            gtk_source_gutter_renderer_get_visible
                                                        (GtkSourceGutterRenderer *renderer);

Get whether the gutter renderer is visible.

gtk_source_gutter_renderer_get_padding ()

void                gtk_source_gutter_renderer_get_padding
                                                        (GtkSourceGutterRenderer *renderer,
                                                         gint *xpad,
                                                         gint *ypad);

Get the x-padding and y-padding of the gutter renderer.

gtk_source_gutter_renderer_set_padding ()

void                gtk_source_gutter_renderer_set_padding
                                                        (GtkSourceGutterRenderer *renderer,
                                                         gint xpad,
                                                         gint ypad);

Set the padding of the gutter renderer. Both xpad and ypad can be -1, which means the values will not be changed (this allows changing only one of the values).

gtk_source_gutter_renderer_get_alignment ()

void                gtk_source_gutter_renderer_get_alignment
                                                        (GtkSourceGutterRenderer *renderer,
                                                         gfloat *xalign,
                                                         gfloat *yalign);

Get the x-alignment and y-alignment of the gutter renderer.

gtk_source_gutter_renderer_set_alignment ()

void                gtk_source_gutter_renderer_set_alignment
                                                        (GtkSourceGutterRenderer *renderer,
                                                         gfloat xalign,
                                                         gfloat yalign);

Set the alignment of the gutter renderer. Both xalign and yalign can be -1, which means the values will not be changed (this allows changing only one of the values).

gtk_source_gutter_renderer_set_alignment_mode ()

void                gtk_source_gutter_renderer_set_alignment_mode
                                                        (GtkSourceGutterRenderer *renderer,
                                                         GtkSourceGutterRendererAlignmentMode mode);

Set the alignment mode. The alignment mode describes the manner in which the renderer is aligned (see :xalign and :yalign).

gtk_source_gutter_renderer_get_window_type ()

GtkTextWindowType   gtk_source_gutter_renderer_get_window_type
                                                        (GtkSourceGutterRenderer *renderer);

Get the GtkTextWindowType associated with the gutter renderer.

gtk_source_gutter_renderer_get_view ()

GtkTextView *       gtk_source_gutter_renderer_get_view (GtkSourceGutterRenderer *renderer);

Get the view associated to the gutter renderer

gtk_source_gutter_renderer_get_alignment_mode ()

GtkSourceGutterRendererAlignmentMode gtk_source_gutter_renderer_get_alignment_mode
                                                        (GtkSourceGutterRenderer *renderer);

Get the alignment mode. The alignment mode describes the manner in which the renderer is aligned (see :xalign and :yalign).

gtk_source_gutter_renderer_get_background ()

gboolean            gtk_source_gutter_renderer_get_background
                                                        (GtkSourceGutterRenderer *renderer,
                                                         GdkRGBA *color);

Get the background color of the renderer.

gtk_source_gutter_renderer_set_background ()

void                gtk_source_gutter_renderer_set_background
                                                        (GtkSourceGutterRenderer *renderer,
                                                         const GdkRGBA *color);

Set the background color of the renderer. If color is set to NULL, the renderer will not have a background color.

gtk_source_gutter_renderer_activate ()

void                gtk_source_gutter_renderer_activate (GtkSourceGutterRenderer *renderer,
                                                         GtkTextIter *iter,
                                                         GdkRectangle *area,
                                                         GdkEvent *event);

Emits the ::activate signal of the renderer. This is called from GtkSourceGutter and should never have to be called manually.

gtk_source_gutter_renderer_query_activatable ()

gboolean            gtk_source_gutter_renderer_query_activatable
                                                        (GtkSourceGutterRenderer *renderer,
                                                         GtkTextIter *iter,
                                                         GdkRectangle *area,
                                                         GdkEvent *event);

Get whether the renderer is activatable at the location in event. This is called from GtkSourceGutter to determine whether a renderer is activatable using the mouse pointer.

gtk_source_gutter_renderer_queue_draw ()

void                gtk_source_gutter_renderer_queue_draw
                                                        (GtkSourceGutterRenderer *renderer);

Emits the ::queue-draw signal of the renderer. Call this from an implementation to inform that the renderer has changed such that it needs to redraw.

gtk_source_gutter_renderer_query_tooltip ()

gboolean            gtk_source_gutter_renderer_query_tooltip
                                                        (GtkSourceGutterRenderer *renderer,
                                                         GtkTextIter *iter,
                                                         GdkRectangle *area,
                                                         gint x,
                                                         gint y,
                                                         GtkTooltip *tooltip);

Emits the ::query-tooltip signal. This function is called from GtkSourceGutter. Implementations can override the default signal handler or can connect to the signal externally.

gtk_source_gutter_renderer_query_data ()

void                gtk_source_gutter_renderer_query_data
                                                        (GtkSourceGutterRenderer *renderer,
                                                         GtkTextIter *start,
                                                         GtkTextIter *end,
                                                         GtkSourceGutterRendererState state);

Emit the ::query-data signal. This function is called to query for data just before rendering a cell. This is called from the GtkSourceGutter. Implementations can override the default signal handler or can connect a signal handler externally to the ::query-data signal.

The "alignment-mode" property

  "alignment-mode"           GtkSourceGutterRendererAlignmentMode  : Read / Write / Construct

The alignment mode of the renderer. This can be used to indicate that in the case a cell spans multiple lines (due to text wrapping) the alignment should work on either the full cell, the first line or the last line.

Default value: GTK_SOURCE_GUTTER_RENDERER_ALIGNMENT_MODE_CELL

The "background-rgba" property

  "background-rgba"          GdkRGBA*              : Read / Write

The background color.

The "background-set" property

  "background-set"           gboolean              : Read / Write / Construct

Whether the background color is set.

Default value: FALSE

The "size" property

  "size"                     gint                  : Read / Write / Construct

The size.

Allowed values: >= 0

Default value: 0

The "view" property

  "view"                     GtkTextView*          : Read

The view on which the renderer is placed.

The "visible" property

  "visible"                  gboolean              : Read / Write / Construct

The visibility of the renderer.

Default value: TRUE

The "window-type" property

  "window-type"              GtkTextWindowType     : Read

The window type of the view on which the renderer is placed (left, or right).

Default value: GTK_TEXT_WINDOW_PRIVATE

The "xalign" property

  "xalign"                   gfloat                : Read / Write / Construct

The x-alignment of the renderer.

Allowed values: [-1,1]

Default value: 0

The "xpad" property

  "xpad"                     gint                  : Read / Write / Construct

The x-padding of the renderer.

Allowed values: >= -1

Default value: 0

The "yalign" property

  "yalign"                   gfloat                : Read / Write / Construct

The y-alignment of the renderer.

Allowed values: [-1,1]

Default value: 0

The "ypad" property

  "ypad"                     gint                  : Read / Write / Construct

The y-padding of the renderer.

Allowed values: >= -1

Default value: 0

The "activate" signal

void                user_function                      (GtkSourceGutterRenderer *renderer,
                                                        GtkTextIter             *iter,
                                                        GdkRectangle            *area,
                                                        GdkEvent                *event,
                                                        gpointer                 user_data)      : Run Last

The ::activate signal is emitted when the renderer is activated.

The "query-activatable" signal

gboolean            user_function                      (GtkSourceGutterRenderer *renderer,
                                                        GtkTextIter             *iter,
                                                        GdkRectangle            *area,
                                                        GdkEvent                *event,
                                                        gpointer                 user_data)      : Run Last

The ::query-activatable signal is emitted when the renderer can possibly be activated.

The "query-data" signal

void                user_function                      (GtkSourceGutterRenderer     *renderer,
                                                        GtkTextIter                 *start,
                                                        GtkTextIter                 *end,
                                                        GtkSourceGutterRendererState state,
                                                        gpointer                     user_data)      : Run Last

The ::query-data signal is emitted when the renderer needs to be filled with data just before a cell is drawn. This can be used by general renderer implementations to allow render data to be filled in externally.

The "query-tooltip" signal

gboolean            user_function                      (GtkSourceGutterRenderer *renderer,
                                                        GtkTextIter             *iter,
                                                        GdkRectangle            *area,
                                                        gint                     x,
                                                        gint                     y,
                                                        GtkTooltip              *tooltip,
                                                        gpointer                 user_data)      : Run Last

The ::query-tooltip signal is emitted when the renderer can show a tooltip.

The "queue-draw" signal

void                user_function                      (GtkSourceGutterRenderer *renderer,
                                                        gpointer                 user_data)      : Run Last

The ::queue-draw signal is emitted when the renderer needs to be redrawn. Use gtk_source_gutter_renderer_queue_draw() to emit this signal from an implementation of the GtkSourceGutterRenderer interface.