Class: GtkSource::GutterRenderer

Inherits:
Gtk::Widget
  • Object
show all
Defined in:
(unknown)

Direct Known Subclasses

GutterRendererPixbuf, GutterRendererText

Instance Method Summary collapse

Methods inherited from Gtk::Widget

#accessible_role, #accessible_role=, #action_set_enabled, #activate_action, #activate_action_variant, #activate_default, #activate_signal, #activate_signal=, #activate_signal_from_name=, #add_binding, #add_binding_action, #add_binding_signal, #add_controller, #add_css_class, #add_mnemonic_label, #add_shortcut, #add_tick_callback, #allocate, #allocated_baseline, #allocated_height, #allocated_width, #baseline, #bind_template_callback_full, #bind_template_child_full, #can_focus, #can_focus=, #can_focus?, #can_target, #can_target=, #can_target?, #child_focus, #child_visible, #child_visible=, #clipboard, #compute_bounds, #compute_expand, #compute_point, #compute_transform, #contains, #create_pango_context, #create_pango_layout, #css_classes, #css_classes=, #css_name, #css_name=, #cursor, #cursor=, #cursor_from_name=, default_direction, default_direction=, #direction, #direction=, #display, #dispose_template, #drag_check_threshold, #error_bell, #first_child, #focus_child, #focus_child=, #focus_on_click, #focus_on_click=, #focus_on_click?, #focusable, #focusable=, #focusable?, #font_map, #font_map=, #font_options, #font_options=, #frame_clock, #get_allocation, #get_ancestor, #get_color, #get_preferred_size, #get_size, #get_size_request, #get_template_child, #grab_focus, #halign, #halign=, #has_css_class, #has_default, #has_default=, #has_default?, #has_focus, #has_focus=, #has_focus?, #has_tooltip, #has_tooltip=, #has_tooltip?, #has_visible_focus, #height, #height_request, #height_request=, #hexpand, #hexpand=, #hexpand?, #hexpand_set, #hexpand_set=, #hexpand_set?, #hide, #in_destruction, #init_template, #insert_action_group, #insert_after, #insert_before, #install_action, #install_property_action, #is_ancestor, #is_drawable, #is_focus, #is_sensitive, #is_visible, #keynav_failed, #last_child, #layout_manager, #layout_manager=, #layout_manager_type, #layout_manager_type=, #list_mnemonic_labels, #map, #mapped, #margin_bottom, #margin_bottom=, #margin_end, #margin_end=, #margin_start, #margin_start=, #margin_top, #margin_top=, #measure, #mnemonic_activate, #name, #name=, #native, #next_sibling, #observe_children, #observe_controllers, #opacity, #opacity=, #overflow, #overflow=, #pango_context, #parent, #parent=, #pick, #prev_sibling, #primary_clipboard, #query_action, #queue_allocate, #queue_draw, #queue_resize, #realize, #realized, #receives_default, #receives_default=, #receives_default?, #remove_controller, #remove_css_class, #remove_mnemonic_label, #remove_tick_callback, #request_mode, #root, #root=, #scale_factor, #scale_factor=, #sensitive, #sensitive=, #sensitive?, #set_size_request, #set_state_flags, #settings, #should_layout, #show, #size_allocate, #snapshot_child, #state_flags, #style_context, #template=, #template_from_resource=, #template_scope=, #tooltip_markup, #tooltip_markup=, #tooltip_text, #tooltip_text=, #translate_coordinates, #trigger_tooltip_query, #unmap, #unparent, #unrealize, #unset_state_flags, #valign, #valign=, #vexpand, #vexpand=, #vexpand?, #vexpand_set, #vexpand_set=, #vexpand_set?, #visible, #visible=, #visible?, #width, #width_request, #width_request=

Instance Method Details

#activate(iter, area, button, state, n_presses) ⇒ nil

Emits the [signalGutterRenderer::activate] signal of the renderer. This is called from [classGutter] and should never have to be called manually.

Parameters:

  • iter (Gtk::TextIter) —

    a Gtk::TextIter at the start of the line where the renderer is activated

  • area (Gdk::Rectangle) —

    a Gdk::Rectangle of the cell area where the renderer is activated

  • button (Integer) —

    the button that was pressed

  • state (Gdk::ModifierType) —

    a Gdk::ModifierType

  • n_presses (Integer) —

    the number of button presses

Returns:

  • (nil)

#align_cell(line, width, height, x, y) ⇒ nil

Locates where to render content that is width x height based on the renderers alignment and padding.

The location will be placed into x and y and is relative to the renderer's coordinates.

It is encouraged that renderers use this function when snappshotting to ensure consistent placement of their contents.

Parameters:

  • line (Integer) —

    the line number for content

  • width (GtkSource::gfloat) —

    the width of the content to draw

  • height (GtkSource::gfloat) —

    the height of the content to draw

  • x (GtkSource::gfloat) —

    the X position to render the content

  • y (GtkSource::gfloat) —

    the Y position to render the content

Returns:

  • (nil)

#alignment_mode ⇒ GtkSource::GutterRendererAlignmentMode

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.

Returns:

#alignment_mode=(alignment_mode) ⇒ GtkSource::GutterRendererAlignmentMode

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.

Parameters:

Returns:

#buffer ⇒ GtkSource::Buffer

Gets the [classBuffer] for which the gutter renderer is drawing.

Returns:

#lines ⇒ GtkSource::GutterLines

Contains information about the lines to be rendered.

It should be used by Gtk::SourceGutterRenderer implementations from [vfuncGtk.Widget.snapshot].

Returns:

#lines=(lines) ⇒ GtkSource::GutterLines

Contains information about the lines to be rendered.

It should be used by Gtk::SourceGutterRenderer implementations from [vfuncGtk.Widget.snapshot].

Parameters:

Returns:

#query_activatable(iter, area) ⇒ Boolean

Get whether the renderer is activatable at the location provided. This is called from [classGutter] to determine whether a renderer is activatable using the mouse pointer.

Parameters:

  • iter (Gtk::TextIter) —

    a Gtk::TextIter at the start of the line to be activated

  • area (Gdk::Rectangle) —

    a Gdk::Rectangle of the cell area to be activated

Returns:

  • (Boolean) —

    true if the renderer can be activated, false otherwise

#view ⇒ Gtk::TextView

The view on which the renderer is placed.

Returns:

#view=(view) ⇒ Gtk::TextView

The view on which the renderer is placed.

Parameters:

Returns:

#xalign ⇒ GtkSource::gfloat

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 modify the alignment.

Returns:

  • (GtkSource::gfloat) —

    xalign

#xalign=(xalign) ⇒ GtkSource::gfloat

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 modify the alignment.

Parameters:

  • xalign (GtkSource::gfloat)

Returns:

  • (GtkSource::gfloat) —

    xalign

  • (GtkSource::gfloat) —

    xalign

#xpad ⇒ Integer

The left and right padding of the renderer.

Returns:

  • (Integer) —

    xpad

#xpad=(xpad) ⇒ Integer

The left and right padding of the renderer.

Parameters:

  • xpad (Integer)

Returns:

  • (Integer) —

    xpad

  • (Integer) —

    xpad

#yalign ⇒ GtkSource::gfloat

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 the alignment.

Returns:

  • (GtkSource::gfloat) —

    yalign

#yalign=(yalign) ⇒ GtkSource::gfloat

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 the alignment.

Parameters:

  • yalign (GtkSource::gfloat)

Returns:

  • (GtkSource::gfloat) —

    yalign

  • (GtkSource::gfloat) —

    yalign

#ypad ⇒ Integer

The top and bottom padding of the renderer.

Returns:

  • (Integer) —

    ypad

#ypad=(ypad) ⇒ Integer

The top and bottom padding of the renderer.

Parameters:

  • ypad (Integer)

Returns:

  • (Integer) —

    ypad

  • (Integer) —

    ypad