Class
GtkSourceGutterRenderer
Description [src]
abstract class GtkSource.GutterRenderer : Gtk.Widget {
parent_instance: GtkWidget
}
Gutter cell renderer.
A GtkSourceGutterRenderer
represents a column in a GtkSourceGutter
. The
column contains one cell for each visible line of the GtkTextBuffer
. Due to
text wrapping, a cell can thus span multiple lines of the GtkTextView
. In
this case, GtkSourceGutterRendererAlignmentMode
controls the alignment of
the cell.
The gutter renderer is a GtkWidget
and is measured using the normal widget
measurement facilities. The width of the gutter will be determined by the
measurements of the gutter renderers.
The width of a gutter renderer generally takes into account the entire text
buffer. For instance, to display the line numbers, if the buffer contains 100
lines, the gutter renderer will always set its width such as three digits can
be printed, even if only the first 20 lines are shown. Another strategy is to
take into account only the visible lines. In this case, only two digits are
necessary to display the line numbers of the first 20 lines. To take another
example, the gutter renderer for GtkSourceMark
s doesn’t need to take
into account the text buffer to announce its width. It only depends on the
icons size displayed in the gutter column.
When the available size to render a cell is greater than the required size to
render the cell contents, the cell contents can be aligned horizontally and
vertically with gtk_source_gutter_renderer_set_alignment_mode()
.
The cells rendering occurs using Gtk.WidgetClass.snapshot
. Implementations
should use gtk_source_gutter_renderer_get_lines()
to retrieve information
about the lines to be rendered. To help with aligning content which takes
into account the padding and alignment of a cell, implementations may call
gtk_source_gutter_renderer_align_cell()
for a given line number with the
width and height measurement of the content they width to render.
Instance methods
gtk_source_gutter_renderer_activate
Emits the GtkSourceGutterRenderer::activate
signal of the renderer. This is
called from GtkSourceGutter
and should never have to be called manually.
gtk_source_gutter_renderer_align_cell
Locates where to render content that is width
x height
based on
the renderers alignment and padding.
gtk_source_gutter_renderer_get_alignment_mode
Get the alignment mode.
gtk_source_gutter_renderer_get_buffer
Gets the GtkSourceBuffer
for which the gutter renderer is drawing.
gtk_source_gutter_renderer_get_view
Get the view associated to the gutter renderer.
gtk_source_gutter_renderer_get_xalign
Gets the xalign
property.
gtk_source_gutter_renderer_get_xpad
Gets the xpad
property.
gtk_source_gutter_renderer_get_yalign
Gets the yalign
property.
gtk_source_gutter_renderer_get_ypad
Gets the ypad
property.
gtk_source_gutter_renderer_query_activatable
Get whether the renderer is activatable at the location provided. This is
called from GtkSourceGutter
to determine whether a renderer is activatable
using the mouse pointer.
gtk_source_gutter_renderer_set_alignment_mode
Set the alignment mode. The alignment mode describes the manner in which the
renderer is aligned (see GtkSourceGutterRenderer:xalign
and
GtkSourceGutterRenderer:yalign
).
gtk_source_gutter_renderer_set_xalign
Adjusts the xalign
property.
gtk_source_gutter_renderer_set_xpad
Adjusts the xpad
property.
gtk_source_gutter_renderer_set_yalign
Adjusts the yalign
property.
gtk_source_gutter_renderer_set_ypad
Adjusts the ypad
property.
Methods inherited from GtkAccessible (10)
gtk_accessible_get_accessible_role
Retrieves the GtkAccessibleRole
for the given GtkAccessible
.
gtk_accessible_reset_property
Resets the accessible property
to its default value.
gtk_accessible_reset_relation
Resets the accessible relation
to its default value.
gtk_accessible_reset_state
Resets the accessible state
to its default value.
gtk_accessible_update_property
Updates a list of accessible properties.
gtk_accessible_update_property_value
Updates an array of accessible properties.
gtk_accessible_update_relation
Updates a list of accessible relations.
gtk_accessible_update_relation_value
Updates an array of accessible relations.
gtk_accessible_update_state
Updates a list of accessible states. See the GtkAccessibleState
documentation for the value types of accessible states.
gtk_accessible_update_state_value
Updates an array of accessible states.
Methods inherited from GtkBuildable (1)
gtk_buildable_get_buildable_id
Gets the ID of the buildable
object.
Properties
GtkSource.GutterRenderer:alignment-mode
The alignment mode of the renderer.
GtkSource.GutterRenderer:lines
Contains information about the lines to be rendered.
GtkSource.GutterRenderer:view
The view on which the renderer is placed.
GtkSource.GutterRenderer:xalign
The horizontal alignment of the renderer.
GtkSource.GutterRenderer:xpad
The left and right padding of the renderer.
GtkSource.GutterRenderer:yalign
The vertical alignment of the renderer.
GtkSource.GutterRenderer:ypad
The top and bottom padding of the renderer.
Properties inherited from GtkWidget (34)
Gtk.Widget:can-focus
Whether the widget or any of its descendents can accept the input focus.
Gtk.Widget:can-target
Whether the widget can receive pointer events.
Gtk.Widget:css-classes
A list of css classes applied to this widget.
Gtk.Widget:css-name
The name of this widget in the CSS tree.
Gtk.Widget:cursor
The cursor used by widget
.
Gtk.Widget:focus-on-click
Whether the widget should grab focus when it is clicked with the mouse.
Gtk.Widget:focusable
Whether this widget itself will accept the input focus.
Gtk.Widget:halign
How to distribute horizontal space if widget gets extra space.
Gtk.Widget:has-default
Whether the widget is the default widget.
Gtk.Widget:has-focus
Whether the widget has the input focus.
Gtk.Widget:has-tooltip
Enables or disables the emission of the ::query-tooltip signal on widget
.
Gtk.Widget:height-request
Override for height request of the widget.
Gtk.Widget:hexpand
Whether to expand horizontally.
Gtk.Widget:hexpand-set
Whether to use the hexpand
property.
Gtk.Widget:layout-manager
The GtkLayoutManager
instance to use to compute the preferred size
of the widget, and allocate its children.
Gtk.Widget:margin-bottom
Margin on bottom side of widget.
Gtk.Widget:margin-end
Margin on end of widget, horizontally.
Gtk.Widget:margin-start
Margin on start of widget, horizontally.
Gtk.Widget:margin-top
Margin on top side of widget.
Gtk.Widget:name
The name of the widget.
Gtk.Widget:opacity
The requested opacity of the widget.
Gtk.Widget:overflow
How content outside the widget’s content area is treated.
Gtk.Widget:parent
The parent widget of this widget.
Gtk.Widget:receives-default
Whether the widget will receive the default action when it is focused.
Gtk.Widget:root
The GtkRoot
widget of the widget tree containing this widget.
Gtk.Widget:scale-factor
The scale factor of the widget.
Gtk.Widget:sensitive
Whether the widget responds to input.
Gtk.Widget:tooltip-markup
Sets the text of tooltip to be the given string, which is marked up with Pango markup.
Gtk.Widget:tooltip-text
Sets the text of tooltip to be the given string.
Gtk.Widget:valign
How to distribute vertical space if widget gets extra space.
Gtk.Widget:vexpand
Whether to expand vertically.
Gtk.Widget:vexpand-set
Whether to use the vexpand
property.
Gtk.Widget:visible
Whether the widget is visible.
Gtk.Widget:width-request
Override for width request of the widget.
Properties inherited from GtkAccessible (1)
Gtk.Accessible:accessible-role
The accessible role of the given GtkAccessible
implementation.
Signals
GtkSource.GutterRenderer::activate
The signal is emitted when the renderer is activated.
GtkSource.GutterRenderer::query-activatable
The signal is emitted when the renderer can possibly be activated.
GtkSource.GutterRenderer::query-data
Signals inherited from GtkWidget (13)
Gtk.Widget::destroy
Signals that all holders of a reference to the widget should release the reference that they hold.
Gtk.Widget::direction-changed
Emitted when the text direction of a widget changes.
Gtk.Widget::hide
Emitted when widget
is hidden.
Gtk.Widget::keynav-failed
Emitted if keyboard navigation fails.
Gtk.Widget::map
Emitted when widget
is going to be mapped.
Gtk.Widget::mnemonic-activate
Emitted when a widget is activated via a mnemonic.
Gtk.Widget::move-focus
Emitted when the focus is moved.
Gtk.Widget::query-tooltip
Emitted when the widgets tooltip is about to be shown.
Gtk.Widget::realize
Emitted when widget
is associated with a GdkSurface
.
Gtk.Widget::show
Emitted when widget
is shown.
Gtk.Widget::state-flags-changed
Emitted when the widget state changes.
Gtk.Widget::unmap
Emitted when widget
is going to be unmapped.
Gtk.Widget::unrealize
Emitted when the GdkSurface
associated with widget
is destroyed.
Signals inherited from GObject (1)
GObject.Object::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.
Class structure
struct GtkSourceGutterRendererClass {
GtkWidgetClass parent_class;
void (* query_data) (
GtkSourceGutterRenderer* renderer,
GtkSourceGutterLines* lines,
guint line
);
void (* begin) (
GtkSourceGutterRenderer* renderer,
GtkSourceGutterLines* lines
);
void (* snapshot_line) (
GtkSourceGutterRenderer* renderer,
GtkSnapshot* snapshot,
GtkSourceGutterLines* lines,
guint line
);
void (* end) (
GtkSourceGutterRenderer* renderer
);
void (* change_view) (
GtkSourceGutterRenderer* renderer,
GtkSourceView* old_view
);
void (* change_buffer) (
GtkSourceGutterRenderer* renderer,
GtkSourceBuffer* old_buffer
);
gboolean (* query_activatable) (
GtkSourceGutterRenderer* renderer,
GtkTextIter* iter,
GdkRectangle* area
);
void (* activate) (
GtkSourceGutterRenderer* renderer,
GtkTextIter* iter,
GdkRectangle* area,
guint button,
GdkModifierType state,
gint n_presses
);
}
Class members
parent_class |
|
No description available. | |
query_data |
|
No description available. | |
begin |
|
No description available. | |
snapshot_line |
|
No description available. | |
end |
|
No description available. | |
change_view |
|
No description available. | |
change_buffer |
|
No description available. | |
query_activatable |
|
No description available. | |
activate |
|
No description available. |
Virtual methods
GtkSource.GutterRendererClass.activate
Emits the GtkSourceGutterRenderer::activate
signal of the renderer. This is
called from GtkSourceGutter
and should never have to be called manually.
GtkSource.GutterRendererClass.begin
GtkSource.GutterRendererClass.change_buffer
This is called when the text buffer changes for renderer
.
GtkSource.GutterRendererClass.change_view
This is called when the text view changes for renderer
.
GtkSource.GutterRendererClass.end
GtkSource.GutterRendererClass.query_activatable
Get whether the renderer is activatable at the location provided. This is
called from GtkSourceGutter
to determine whether a renderer is activatable
using the mouse pointer.