Struct sourceview5::GutterLines

pub struct GutterLines { /* private fields */ }

Collected information about visible lines.

The GutterLines object is used to collect information about visible lines.

Use this from your query-data to collect the necessary information on visible lines. Doing so reduces the number of passes through the text btree allowing GtkSourceView to reach more frames-per-second while performing kinetic scrolling.

Implements

[trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl GutterLines

pub fn add_class(&self, line: u32, name: &str)

Adds the class @name to @line.

@name will be converted to a alias::GLib.Quark as part of this process. A faster version of this function is available via add_qclass() for situations where the alias::GLib.Quark is known ahead of time.

line

a line number starting from zero

name

a class name

pub fn add_qclass(&self, line: u32, qname: Quark)

Adds the class denoted by @qname to @line.

You may check if a line has @qname by calling has_qclass().

You can remove @qname by calling remove_qclass().

line

a line number starting from zero

qname

a class name as a #GQuark

pub fn buffer(&self) -> TextBuffer

Gets the gtk::TextBuffer that the GutterLines represents.

Returns

a #GtkTextBuffer

pub fn first(&self) -> u32

Gets the line number (starting from 0) for the first line that is user visible.

Returns

a line number starting from 0

pub fn iter_at_line(&self, line: u32) -> TextIter

Gets a #GtkTextIter for the current buffer at @line

line

the line number

Returns

iter

a location for a #GtkTextIter

pub fn last(&self) -> u32

Gets the line number (starting from 0) for the last line that is user visible.

Returns

a line number starting from 0

pub fn line_yrange( &self, line: u32, mode: GutterRendererAlignmentMode, ) -> (i32, i32)

Gets the Y range for a line based on @mode.

The value for @y is relative to the renderers widget coordinates.

line

a line number starting from zero

mode

a #GtkSourceGutterRendererAlignmentMode

Returns

y

a location for the Y position in widget coordinates

height

the line height based on @mode

pub fn view(&self) -> TextView

Gets the gtk::TextView that the GutterLines represents.

Returns

a #GtkTextView

pub fn has_any_class(&self, line: u32) -> bool

Checks to see if the line has any GQuark classes set. This can be used to help renderer implementations avoid work if nothing has been set on the class.

line

a line contained within @self

Returns

true if any quark was set for the line

pub fn has_class(&self, line: u32, name: &str) -> bool

Checks to see if add_class() was called with the @name for @line.

A faster version of this function is provided via has_qclass() for situations where the quark is known ahead of time.

line

a line number starting from zero

name

a class name that may be converted, to a #GQuark

Returns

true if @line contains @name

pub fn has_qclass(&self, line: u32, qname: Quark) -> bool

Checks to see if add_qclass() was called with the quark denoted by @qname for @line.

line

a line number starting from zero

qname

a #GQuark containing the class name

Returns

true if @line contains @qname

pub fn is_cursor(&self, line: u32) -> bool

Checks to see if @line contains the insertion cursor.

line

a line number starting from zero

Returns

true if the insertion cursor is on @line

pub fn is_prelit(&self, line: u32) -> bool

Checks to see if @line is marked as prelit. Generally, this means the mouse pointer is over the line within the gutter.

line

a line number starting from zero

Returns

true if the line is prelit

pub fn is_selected(&self, line: u32) -> bool

Checks to see if the view had a selection and if that selection overlaps @line in some way.

line

a line number starting from zero

Returns

true if the line contains a selection

pub fn remove_class(&self, line: u32, name: &str)

Removes the class matching @name from @line.

A faster version of this function is available via remove_qclass() for situations where the #GQuark is known ahead of time.

line

a line number starting from zero

name

a class name

pub fn remove_qclass(&self, line: u32, qname: Quark)

Reverses a call to add_qclass() by removing the alias::GLib.Quark matching @qname.

line

a line number starting from zero

qname

a #GQuark to remove from @line

Trait Implementations

impl Clone for GutterLines

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GutterLines

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for GutterLines

type ParamSpec = ParamSpecObject

type SetValue = GutterLines

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, GutterLines>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for GutterLines

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for GutterLines

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for GutterLines

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for GutterLines

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for GutterLines

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for GutterLines

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for GutterLines