Trait sourceview5::prelude::GutterRendererExt

source ·

pub trait GutterRendererExt: IsA<GutterRenderer> + Sealed + 'static {
Show 26 methods    // Provided methods
    fn activate(
        &self,
        iter: &TextIter,
        area: &Rectangle,
        button: u32,
        state: ModifierType,
        n_presses: i32,
    ) { ... }
    fn align_cell(&self, line: u32, width: f32, height: f32) -> (f32, f32) { ... }
    fn alignment_mode(&self) -> GutterRendererAlignmentMode { ... }
    fn buffer(&self) -> Option<Buffer> { ... }
    fn view(&self) -> View { ... }
    fn xalign(&self) -> f32 { ... }
    fn xpad(&self) -> i32 { ... }
    fn yalign(&self) -> f32 { ... }
    fn ypad(&self) -> i32 { ... }
    fn query_activatable(&self, iter: &TextIter, area: &Rectangle) -> bool { ... }
    fn set_alignment_mode(&self, mode: GutterRendererAlignmentMode) { ... }
    fn set_xalign(&self, xalign: f32) { ... }
    fn set_xpad(&self, xpad: i32) { ... }
    fn set_yalign(&self, yalign: f32) { ... }
    fn set_ypad(&self, ypad: i32) { ... }
    fn lines(&self) -> Option<GutterLines> { ... }
    fn connect_activate<F: Fn(&Self, &TextIter, &Rectangle, u32, ModifierType, i32) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_query_activatable<F: Fn(&Self, &TextIter, &Rectangle) -> bool + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_query_data<F: Fn(&Self, &Object, u32) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_alignment_mode_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_lines_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_view_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_xalign_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_xpad_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_yalign_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_ypad_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
}

Expand description

Trait containing all GutterRenderer methods.

§Implementors

GutterRendererPixbuf, GutterRendererText, GutterRenderer

Provided Methods§

source

fn activate( &self, iter: &TextIter, area: &Rectangle, button: u32, state: ModifierType, n_presses: i32, )

Emits the activate signal of the renderer. This is called from Gutter and should never have to be called manually.

§`iter`

a #GtkTextIter at the start of the line where the renderer is activated

§`area`

a #GdkRectangle of the cell area where the renderer is activated

§`button`

the button that was pressed

§`state`

a #GdkModifierType

§`n_presses`

the number of button presses

source

fn align_cell(&self, line: u32, width: f32, height: f32) -> (f32, f32)

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.

§`line`

the line number for content

§`width`

the width of the content to draw

§`height`

the height of the content to draw

§Returns

§`x`

the X position to render the content

§`y`

the Y position to render the content

source

fn alignment_mode(&self) -> GutterRendererAlignmentMode

Get the alignment mode.

The alignment mode describes the manner in which the renderer is aligned (see xalign and yalign).

§Returns

a #GtkSourceGutterRendererAlignmentMode

source

fn buffer(&self) -> Option<Buffer>

Gets the Buffer for which the gutter renderer is drawing.

§Returns

a #GtkTextBuffer or None

source

fn view(&self) -> View

Get the view associated to the gutter renderer

§Returns

a #GtkSourceView

source

fn xalign(&self) -> f32

Gets the xalign property.

This may be used to adjust where within the cell rectangle the renderer will draw.

source

fn xpad(&self) -> i32

Gets the xpad property.

This may be used to adjust the cell rectangle that the renderer will use to draw.

source

fn yalign(&self) -> f32

Gets the yalign property.

This may be used to adjust where within the cell rectangle the renderer will draw.

source

fn ypad(&self) -> i32

Gets the ypad property.

This may be used to adjust the cell rectangle that the renderer will use to draw.

source

fn query_activatable(&self, iter: &TextIter, area: &Rectangle) -> bool

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