GtkSource.Gutter¶

Subclasses:	None

Methods¶

Inherited:	GObject.Object (37)
Structs:	GObject.ObjectClass (5)

	`get_padding` (xpad, ypad)
	`get_renderer_at_pos` (x, y)
	`get_view` ()
	`get_window` ()
	`get_window_type` ()
	`insert` (renderer, position)
	`queue_draw` ()
	`remove` (renderer)
	`reorder` (renderer, position)
	`set_padding` (xpad, ypad)

Virtual Methods¶

Inherited:	GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`view`	`GtkSource.View`	r/w/co
`window-type`	`Gtk.TextWindowType`	r/w/co	The gutters’ text window type
`xpad`	`int`	d/r/w/c	The x-padding `deprecated`
`ypad`	`int`	d/r/w/c	The y-padding `deprecated`

Signals¶

Inherited:	GObject.Object (1)

Fields¶

Inherited:	GObject.Object (1)

Name	Type	Access	Description
parent	`GObject.Object`	r

Class Details¶

class GtkSource.Gutter(**kwargs)¶

Bases:	`GObject.Object`
Abstract:	No
Structure:	`GtkSource.GutterClass`

get_padding(xpad, ypad)¶

Parameters:	xpad (`int`) – ypad (`int`) –

Deprecated since version 3.12: Use GtkSource.GutterRenderer.get_padding() instead.

get_renderer_at_pos(x, y)¶

Parameters:	x (`int`) – The x position to get identified. y (`int`) – The y position to get identified.
Returns:	the renderer at (x, y) or `None`.
Return type:	`GtkSource.GutterRenderer` or `None`

Finds the GtkSource.GutterRenderer at (x, y).

get_view()¶

Returns:	the associated `GtkSource.View`.
Return type:	`GtkSource.View`

New in version 3.24.

get_window()¶

Returns:	the `Gdk.Window` of the gutter, or `None` if the gutter has no window.
Return type:	`Gdk.Window`

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

New in version 2.8.

Deprecated since version 3.12: Use Gtk.TextView.get_window() instead.

get_window_type()¶

Returns:	the `Gtk.TextWindowType` of self.
Return type:	`Gtk.TextWindowType`

New in version 3.24.

insert(renderer, position)¶

Parameters:	renderer (`GtkSource.GutterRenderer`) – a gutter renderer (must inherit from `GtkSource.GutterRenderer`). position (`int`) – the renderer position.
Returns:	`True` if operation succeeded. Otherwise `False`.
Return type:	`bool`

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.

New in version 3.0.

queue_draw()¶: 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.

New in version 2.8.

remove(renderer)¶

Parameters:	renderer (`GtkSource.GutterRenderer`) – a `GtkSource.GutterRenderer`.

Removes renderer from self.

New in version 2.8.

reorder(renderer, position)¶

Parameters:	renderer (`GtkSource.GutterRenderer`) – a `Gtk.CellRenderer`. position (`int`) – the new renderer position.

Reorders renderer in self to new position.

New in version 2.8.

set_padding(xpad, ypad)¶

Parameters:	xpad (`int`) – ypad (`int`) –

Deprecated since version 3.12: Use GtkSource.GutterRenderer.set_padding() instead.

Property Details¶

GtkSource.Gutter.props.view¶

Name:	`view`
Type:	`GtkSource.View`
Default Value:	`None`
Flags:	`READABLE`, `WRITABLE`, `CONSTRUCT_ONLY`

The GtkSource.View of the gutter.

GtkSource.Gutter.props.window_type¶

Name:	`window-type`
Type:	`Gtk.TextWindowType`
Default Value:	`Gtk.TextWindowType.PRIVATE`
Flags:	`READABLE`, `WRITABLE`, `CONSTRUCT_ONLY`

The text window type on which the window is placed.

GtkSource.Gutter.props.xpad¶

Name:	`xpad`
Type:	`int`
Default Value:	`0`
Flags:	`DEPRECATED`, `READABLE`, `WRITABLE`, `CONSTRUCT`

The x-padding.

Deprecated since version 3.12: Use the GtkSource.GutterRenderer’s GtkSource.GutterRenderer :xpad property instead.

GtkSource.Gutter.props.ypad¶

Name:	`ypad`
Type:	`int`
Default Value:	`0`
Flags:	`DEPRECATED`, `READABLE`, `WRITABLE`, `CONSTRUCT`

The y-padding.

Deprecated since version 3.12: Use the GtkSource.GutterRenderer’s GtkSource.GutterRenderer :ypad property instead.