gtksource.gutter_renderer

Module for [GutterRenderer] class

class GutterRenderer GutterRendererGidBuilder GutterRendererGidBuilderImpl

Types 3

classGutterRenderer : gobject.initially_unowned.InitiallyUnowned

Methods

GType _getGType()

GType _gType() @property

GutterRenderer self()Returns `this`, for use in `with` statements.

GutterRendererGidBuilder builder()Get builder for [gtksource.gutter_renderer.GutterRenderer] Returns: New builder object

gtksource.types.GutterRendererAlignmentMode alignmentMode() @propertyGet `alignmentMode` property. Returns: 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...

void alignmentMode(gtksource.types.GutterRendererAlignmentMode propval) @propertySet `alignmentMode` property. Params: propval = 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 sh...

gdk.rgba.RGBA backgroundRgba() @property

void backgroundRgba(gdk.rgba.RGBA propval) @property

bool backgroundSet() @property

void backgroundSet(bool propval) @property

int size() @property

void size(int propval) @property

gtk.text_view.TextView view() @propertyGet `view` property. Returns: The view on which the renderer is placed.

bool visible() @propertyGet `visible` property. Returns: The visibility of the renderer.

void visible(bool propval) @propertySet `visible` property. Params: propval = The visibility of the renderer.

gtk.types.TextWindowType windowType() @propertyGet `windowType` property. Returns: The window type of the view on which the renderer is placed (left, or right).

float xalign() @propertyGet `xalign` property. Returns: The horizontal alignment of the renderer. Set to 0 for a left alignment. 1 for a right alignment. And 0.5 for centering the cells. A value lower than 0 doesn't modif...

void xalign(float propval) @propertySet `xalign` property. Params: propval = The horizontal alignment of the renderer. Set to 0 for a left alignment. 1 for a right alignment. And 0.5 for centering the cells. A value lower than 0 does...

int xpad() @propertyGet `xpad` property. Returns: The left and right padding of the renderer.

void xpad(int propval) @propertySet `xpad` property. Params: propval = The left and right padding of the renderer.

float yalign() @propertyGet `yalign` property. Returns: The vertical alignment of the renderer. Set to 0 for a top alignment. 1 for a bottom alignment. And 0.5 for centering the cells. A value lower than 0 doesn't modify ...

void yalign(float propval) @propertySet `yalign` property. Params: propval = The vertical alignment of the renderer. Set to 0 for a top alignment. 1 for a bottom alignment. And 0.5 for centering the cells. A value lower than 0 doesn'...

int ypad() @propertyGet `ypad` property. Returns: The top and bottom padding of the renderer.

void ypad(int propval) @propertySet `ypad` property. Params: propval = The top and bottom padding of the renderer.

void activate(gtk.text_iter.TextIter iter, gdk.rectangle.Rectangle area, gdk.event.Event event)Emits the #GtkSourceGutterRenderer::activate signal of the renderer. This is called from #GtkSourceGutter and should never have to be called manually.

void begin(cairo.context.Context cr,  gdk.rectangle.Rectangle backgroundArea,  gdk.rectangle.Rectangle cellArea,  gtk.text_iter.TextIter start,  gtk.text_iter.TextIter 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 e...

void draw(cairo.context.Context cr,  gdk.rectangle.Rectangle backgroundArea,  gdk.rectangle.Rectangle cellArea,  gtk.text_iter.TextIter start,  gtk.text_iter.TextIter end,  gtksource.types.GutterRendererState state)

Main renderering method. Implementations should implement this method to draw onto the cairo context. The backgroundarea indicates the total area of the cell to be drawn. The cellarea indicates the...

void end()Called when drawing a region of lines has ended.

void getAlignment(out float xalign, out float yalign)Get the x-alignment and y-alignment of the gutter renderer.

gtksource.types.GutterRendererAlignmentMode getAlignmentMode()Get the alignment mode. The alignment mode describes the manner in which the renderer is aligned (see :xalign and :yalign). Returns: a #GtkSourceGutterRendererAlignmentMode

bool getBackground(out gdk.rgba.RGBA color)Get the background color of the renderer.

void getPadding(out int xpad, out int ypad)Get the x-padding and y-padding of the gutter renderer.

int getSize()Get the size of the renderer. Returns: the size of the renderer.

gtk.text_view.TextView getView()Get the view associated to the gutter renderer Returns: a #GtkTextView

bool getVisible()Get whether the gutter renderer is visible. Returns: true if the renderer is visible, false otherwise

gtk.types.TextWindowType getWindowType()Get the #GtkTextWindowType associated with the gutter renderer. Returns: a #GtkTextWindowType

bool queryActivatable(gtk.text_iter.TextIter iter, gdk.rectangle.Rectangle area, gdk.event.Event 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.

void queryData(gtk.text_iter.TextIter start, gtk.text_iter.TextIter end, gtksource.types.GutterRendererState state)Emit the #GtkSourceGutterRenderer::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...

bool queryTooltip(gtk.text_iter.TextIter iter,  gdk.rectangle.Rectangle area,  int  x,  int  y,  gtk.tooltip.Tooltip tooltip)

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

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

void setAlignment(float xalign, float 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).

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

void setBackground(gdk.rgba.RGBA color)Set the background color of the renderer. If color is set to null, the renderer will not have a background color.

void setPadding(int xpad, int 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).

void setSize(int size)Sets the size of the renderer. A value of -1 specifies that the size is to be determined dynamically.

void setVisible(bool visible)Set whether the gutter renderer is visible.

gulong connectActivate(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  gtk.text_iter.TextIter)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  gdk.rectangle.Rectangle)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2]  ==  gdk.event.Event)))
   && (Parameters!T.length <  4 || (ParameterStorageClassTuple!T[3]  ==  ParameterStorageClass.none &&  is(Parameters!T[3] :  gtksource.gutter_renderer.GutterRenderer)))
   &&  Parameters!T.length <  5)

Connect to `Activate` signal.

gulong connectQueryActivatable(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  bool)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  gtk.text_iter.TextIter)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  gdk.rectangle.Rectangle)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2]  ==  gdk.event.Event)))
   && (Parameters!T.length <  4 || (ParameterStorageClassTuple!T[3]  ==  ParameterStorageClass.none &&  is(Parameters!T[3] :  gtksource.gutter_renderer.GutterRenderer)))
   &&  Parameters!T.length <  5)

Connect to `QueryActivatable` signal.

gulong connectQueryData(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  gtk.text_iter.TextIter)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  gtk.text_iter.TextIter)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2]  ==  gtksource.types.GutterRendererState)))
   && (Parameters!T.length <  4 || (ParameterStorageClassTuple!T[3]  ==  ParameterStorageClass.none &&  is(Parameters!T[3] :  gtksource.gutter_renderer.GutterRenderer)))
   &&  Parameters!T.length <  5)

Connect to `QueryData` signal.

gulong connectQueryTooltip(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  bool)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0]  ==  gtk.text_iter.TextIter)))
   && (Parameters!T.length <  2 || (ParameterStorageClassTuple!T[1]  ==  ParameterStorageClass.none &&  is(Parameters!T[1]  ==  gdk.rectangle.Rectangle)))
   && (Parameters!T.length <  3 || (ParameterStorageClassTuple!T[2]  ==  ParameterStorageClass.none &&  is(Parameters!T[2]  ==  int)))
   && (Parameters!T.length <  4 || (ParameterStorageClassTuple!T[3]  ==  ParameterStorageClass.none &&  is(Parameters!T[3]  ==  int)))
   && (Parameters!T.length <  5 || (ParameterStorageClassTuple!T[4]  ==  ParameterStorageClass.none &&  is(Parameters!T[4] :  gtk.tooltip.Tooltip)))
   && (Parameters!T.length <  6 || (ParameterStorageClassTuple!T[5]  ==  ParameterStorageClass.none &&  is(Parameters!T[5] :  gtksource.gutter_renderer.GutterRenderer)))
   &&  Parameters!T.length <  7)

Connect to `QueryTooltip` signal.

gulong connectQueueDraw(T)(T callback,  Flag!"After" after =  No.After) if (isCallable!T
    &&  is(ReturnType!T ==  void)
   && (Parameters!T.length <  1 || (ParameterStorageClassTuple!T[0]  ==  ParameterStorageClass.none &&  is(Parameters!T[0] :  gtksource.gutter_renderer.GutterRenderer)))
   &&  Parameters!T.length <  2)

Connect to `QueueDraw` signal.

Constructors

this(void * ptr, Flag!"Take" take)

classGutterRendererGidBuilderImpl(T) : gobject.initially_unowned.InitiallyUnownedGidBuilderImpl!T

Methods

T alignmentMode(gtksource.types.GutterRendererAlignmentMode propval)Set `alignmentMode` property. Params: propval = 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 sh...

T backgroundRgba(gdk.rgba.RGBA propval)

T backgroundSet(bool propval)

T size(int propval)

T visible(bool propval)Set `visible` property. Params: propval = The visibility of the renderer. Returns: Builder instance for fluent chaining

T xalign(float propval)Set `xalign` property. Params: propval = The horizontal alignment of the renderer. Set to 0 for a left alignment. 1 for a right alignment. And 0.5 for centering the cells. A value lower than 0 does...

T xpad(int propval)Set `xpad` property. Params: propval = The left and right padding of the renderer. Returns: Builder instance for fluent chaining

T yalign(float propval)Set `yalign` property. Params: propval = The vertical alignment of the renderer. Set to 0 for a top alignment. 1 for a bottom alignment. And 0.5 for centering the cells. A value lower than 0 doesn'...

T ypad(int propval)Set `ypad` property. Params: propval = The top and bottom padding of the renderer. Returns: Builder instance for fluent chaining

classGutterRendererGidBuilder : GutterRendererGidBuilderImpl!GutterRendererGidBuilder

Fluent builder for [gtksource.gutter_renderer.GutterRenderer]

Methods

GutterRenderer build()