Struct sourceview5::Indenter

pub struct Indenter { /* private fields */ }

Auto-indentation interface.

By default, View can auto-indent as you type when auto-indent is enabled. The indentation simply copies the previous lines indentation.

This can be changed by implementing Indenter and setting the indenter property.

Implementors of this interface should implement both vfunc::Indenter::is_trigger and vfunc::Indenter::indent.

vfunc::Indenter::is_trigger is called upon key-press to determine of the key press should trigger an indentation. The default implementation of the interface checks to see if the key was Gdk::KEY_Return or Gdk::KEY_KP_Enter without [gdk::ModifierType::SHIFT_MASK][crate::gdk::ModifierType::SHIFT_MASK] set.

vfunc::Indenter::indent is called after text has been inserted into Buffer when vfunc::Indenter::is_trigger returned true. The gtk::TextIter is placed directly after the inserted character or characters.

It may be beneficial to move the insertion mark using [TextBufferExtManual::select_range()][crate::gtk::prelude::TextBufferExtManual::select_range()] depending on how the indenter changes the indentation.

All changes are encapsulated within a single user action so that the user may undo them using standard undo/redo accelerators.

Implements

IndenterExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl Indenter

pub const NONE: Option<&'static Indenter> = None

Trait Implementations

impl Clone for Indenter

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 Indenter

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

Formats the value using the given formatter.

impl HasParamSpec for Indenter

type ParamSpec = ParamSpecObject

type SetValue = Indenter

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Indenter

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<T: IndenterImpl> IsImplementable<T> for Indenter

fn interface_init(iface: &mut Interface<Self>)

Override the virtual methods of this interface for the given subclass and do other interface initialization.

fn instance_init(_instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for Indenter

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<OT: ObjectType> PartialEq<OT> for Indenter

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 Indenter

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 Indenter

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Indenter