Top | Description | Object Hierarchy | Properties | Signals | ![]() |
![]() |
![]() |
![]() |
#include <gtksourceview/gtksource.h> GtkSourceGutterRenderer; enum GtkSourceGutterRendererState; enum GtkSourceGutterRendererAlignmentMode; void gtk_source_gutter_renderer_begin (GtkSourceGutterRenderer *renderer
,cairo_t *cr
,GdkRectangle *background_area
,GdkRectangle *cell_area
,GtkTextIter *start
,GtkTextIter *end
); void gtk_source_gutter_renderer_draw (GtkSourceGutterRenderer *renderer
,cairo_t *cr
,GdkRectangle *background_area
,GdkRectangle *cell_area
,GtkTextIter *start
,GtkTextIter *end
,GtkSourceGutterRendererState state
); void gtk_source_gutter_renderer_end (GtkSourceGutterRenderer *renderer
); gint gtk_source_gutter_renderer_get_size (GtkSourceGutterRenderer *renderer
); void gtk_source_gutter_renderer_set_size (GtkSourceGutterRenderer *renderer
,gint size
); void gtk_source_gutter_renderer_set_visible (GtkSourceGutterRenderer *renderer
,gboolean visible
); gboolean gtk_source_gutter_renderer_get_visible (GtkSourceGutterRenderer *renderer
); void gtk_source_gutter_renderer_get_padding (GtkSourceGutterRenderer *renderer
,gint *xpad
,gint *ypad
); void gtk_source_gutter_renderer_set_padding (GtkSourceGutterRenderer *renderer
,gint xpad
,gint ypad
); void gtk_source_gutter_renderer_get_alignment (GtkSourceGutterRenderer *renderer
,gfloat *xalign
,gfloat *yalign
); void gtk_source_gutter_renderer_set_alignment (GtkSourceGutterRenderer *renderer
,gfloat xalign
,gfloat yalign
); void gtk_source_gutter_renderer_set_alignment_mode (GtkSourceGutterRenderer *renderer
,GtkSourceGutterRendererAlignmentMode mode
); GtkTextWindowType gtk_source_gutter_renderer_get_window_type (GtkSourceGutterRenderer *renderer
); GtkTextView * gtk_source_gutter_renderer_get_view (GtkSourceGutterRenderer *renderer
); GtkSourceGutterRendererAlignmentMode gtk_source_gutter_renderer_get_alignment_mode (GtkSourceGutterRenderer *renderer
); gboolean gtk_source_gutter_renderer_get_background (GtkSourceGutterRenderer *renderer
,GdkRGBA *color
); void gtk_source_gutter_renderer_set_background (GtkSourceGutterRenderer *renderer
,const GdkRGBA *color
); void gtk_source_gutter_renderer_activate (GtkSourceGutterRenderer *renderer
,GtkTextIter *iter
,GdkRectangle *area
,GdkEvent *event
); gboolean gtk_source_gutter_renderer_query_activatable (GtkSourceGutterRenderer *renderer
,GtkTextIter *iter
,GdkRectangle *area
,GdkEvent *event
); void gtk_source_gutter_renderer_queue_draw (GtkSourceGutterRenderer *renderer
); gboolean gtk_source_gutter_renderer_query_tooltip (GtkSourceGutterRenderer *renderer
,GtkTextIter *iter
,GdkRectangle *area
,gint x
,gint y
,GtkTooltip *tooltip
); void gtk_source_gutter_renderer_query_data (GtkSourceGutterRenderer *renderer
,GtkTextIter *start
,GtkTextIter *end
,GtkSourceGutterRendererState state
);
GObject +----GInitiallyUnowned +----GtkSourceGutterRenderer +----GtkSourceGutterRendererPixbuf +----GtkSourceGutterRendererText
"alignment-mode" GtkSourceGutterRendererAlignmentMode : Read / Write / Construct "background-rgba" GdkRGBA* : Read / Write "background-set" gboolean : Read / Write / Construct "size" gint : Read / Write / Construct "view" GtkTextView* : Read "visible" gboolean : Read / Write / Construct "window-type" GtkTextWindowType : Read "xalign" gfloat : Read / Write / Construct "xpad" gint : Read / Write / Construct "yalign" gfloat : Read / Write / Construct "ypad" gint : Read / Write / Construct
"activate" :Run Last
"query-activatable" :Run Last
"query-data" :Run Last
"query-tooltip" :Run Last
"queue-draw" :Run Last
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;
normal state | |
area in the renderer represents the line on which the insert cursor is currently positioned | |
the mouse pointer is currently over the activatable area of the renderer | |
area in the renderer represents a line in the buffer which contains part of the selection |
typedef enum { GTK_SOURCE_GUTTER_RENDERER_ALIGNMENT_MODE_CELL, GTK_SOURCE_GUTTER_RENDERER_ALIGNMENT_MODE_FIRST, GTK_SOURCE_GUTTER_RENDERER_ALIGNMENT_MODE_LAST } GtkSourceGutterRendererAlignmentMode;
The alignment mode of the renderer, when a cell spans multiple lines (due to text wrapping).
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.
|
a GtkSourceGutterRenderer |
|
a cairo_t |
|
a GdkRectangle |
|
a GdkRectangle |
|
a GtkTextIter |
|
a GtkTextIter |
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.
|
a GtkSourceGutterRenderer |
|
the cairo render context |
|
a GdkRectangle indicating the total area to be drawn |
|
a GdkRectangle indicating the area to draw content |
|
a GtkTextIter |
|
a GtkTextIter |
|
a GtkSourceGutterRendererState |
void gtk_source_gutter_renderer_end (GtkSourceGutterRenderer *renderer
);
Called when drawing a region of lines has ended.
|
a GtkSourceGutterRenderer |
gint gtk_source_gutter_renderer_get_size (GtkSourceGutterRenderer *renderer
);
Get the size of the renderer.
|
a GtkSourceGutterRenderer |
Returns : |
the size of the renderer. |
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.
|
a GtkSourceGutterRenderer |
|
the size |
void gtk_source_gutter_renderer_set_visible (GtkSourceGutterRenderer *renderer
,gboolean visible
);
Set whether the gutter renderer is visible.
|
a GtkSourceGutterRenderer |
|
the visibility |
gboolean gtk_source_gutter_renderer_get_visible
(GtkSourceGutterRenderer *renderer
);
Get whether the gutter renderer is visible.
|
a GtkSourceGutterRenderer |
Returns : |
TRUE if the renderer is visible, FALSE otherwise |
void gtk_source_gutter_renderer_get_padding (GtkSourceGutterRenderer *renderer
,gint *xpad
,gint *ypad
);
Get the x-padding and y-padding of the gutter renderer.
|
a GtkSourceGutterRenderer |
|
return location for the x-padding (can be NULL ). [out caller-allocates][allow-none]
|
|
return location for the y-padding (can be NULL ). [out caller-allocates][allow-none]
|
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).
|
a GtkSourceGutterRenderer |
|
the x-padding |
|
the y-padding |
void gtk_source_gutter_renderer_get_alignment (GtkSourceGutterRenderer *renderer
,gfloat *xalign
,gfloat *yalign
);
Get the x-alignment and y-alignment of the gutter renderer.
|
a GtkSourceGutterRenderer |
|
return location for the x-alignment (can be NULL ). [out caller-allocates][allow-none]
|
|
return location for the y-alignment (can be NULL ). [out caller-allocates][allow-none]
|
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).
|
a GtkSourceGutterRenderer |
|
the x-alignment |
|
the y-alignment |
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).
|
a GtkSourceGutterRenderer |
|
a GtkSourceGutterRendererAlignmentMode |
GtkTextWindowType gtk_source_gutter_renderer_get_window_type
(GtkSourceGutterRenderer *renderer
);
Get the GtkTextWindowType associated with the gutter renderer.
|
a GtkSourceGutterRenderer |
Returns : |
a GtkTextWindowType |
GtkTextView * gtk_source_gutter_renderer_get_view (GtkSourceGutterRenderer *renderer
);
Get the view associated to the gutter renderer
|
a GtkSourceGutterRenderer |
Returns : |
a GtkTextView. [transfer none] |
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).
|
a GtkSourceGutterRenderer |
Returns : |
a GtkSourceGutterRendererAlignmentMode |
gboolean gtk_source_gutter_renderer_get_background (GtkSourceGutterRenderer *renderer
,GdkRGBA *color
);
Get the background color of the renderer.
|
a GtkSourceGutterRenderer |
|
return value for a GdkRGBA. [out caller-allocates][allow-none] |
Returns : |
TRUE if the background color is set, FALSE otherwise |
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.
|
a GtkSourceGutterRenderer |
|
a GdkRGBA or NULL . [allow-none]
|
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.
|
a GtkSourceGutterRenderer |
|
a GtkTextIter at the start of the line where the renderer is activated |
|
a GdkRectangle of the cell area where the renderer is activated |
|
the event that triggered the activation |
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.
|
a GtkSourceGutterRenderer |
|
a GtkTextIter at the start of the line to be activated |
|
a GdkRectangle of the cell area to be activated |
|
the event that triggered the query |
Returns : |
TRUE if the renderer can be activated, FALSE otherwise |
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.
|
a GtkSourceGutterRenderer |
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.
|
a GtkSourceGutterRenderer. |
|
a GtkTextIter. |
|
a GdkRectangle. |
|
The x position of the tooltip. |
|
The y position of the tooltip. |
|
a GtkTooltip. |
Returns : |
TRUE if the tooltip has been set, FALSE otherwise |
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.
|
a GtkSourceGutterRenderer. |
|
a GtkTextIter. |
|
a GtkTextIter. |
|
a GtkSourceGutterRendererState. |
"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
"background-set"
property"background-set" gboolean : Read / Write / Construct
Whether the background color is set.
Default value: FALSE
"size"
property"size" gint : Read / Write / Construct
The size.
Allowed values: >= 0
Default value: 0
"visible"
property"visible" gboolean : Read / Write / Construct
The visibility of the renderer.
Default value: TRUE
"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
"xalign"
property"xalign" gfloat : Read / Write / Construct
The x-alignment of the renderer.
Allowed values: [-1,1]
Default value: 0
"xpad"
property"xpad" gint : Read / Write / Construct
The x-padding of the renderer.
Allowed values: >= -1
Default value: 0
"yalign"
property"yalign" gfloat : Read / Write / Construct
The y-alignment of the renderer.
Allowed values: [-1,1]
Default value: 0
"ypad"
property"ypad" gint : Read / Write / Construct
The y-padding of the renderer.
Allowed values: >= -1
Default value: 0
"activate"
signalvoid 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 GtkSourceGutterRenderer who emits the signal |
|
a GtkTextIter |
|
a GdkRectangle |
|
the event that caused the activation |
|
user data set when the signal handler was connected. |
"query-activatable"
signalgboolean 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 GtkSourceGutterRenderer who emits the signal |
|
a GtkTextIter |
|
a GdkRectangle |
|
the GdkEvent that is causing the activatable query |
|
user data set when the signal handler was connected. |
"query-data"
signalvoid 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 GtkSourceGutterRenderer who emits the signal |
|
a GtkTextIter |
|
a GtkTextIter |
|
the renderer state |
|
user data set when the signal handler was connected. |
"query-tooltip"
signalgboolean 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 GtkSourceGutterRenderer who emits the signal |
|
a GtkTextIter |
|
a GdkRectangle |
|
the x position (in window coordinates) |
|
the y position (in window coordinates) |
|
a GtkTooltip |
|
user data set when the signal handler was connected. |
"queue-draw"
signalvoid 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.
|
the GtkSourceGutterRenderer who emits the signal |
|
user data set when the signal handler was connected. |