Struct sourceview5::Hover

pub struct Hover { /* private fields */ }

Interactive tooltips.

Hover allows a View to provide contextual information. When enabled, if the user hovers over a word in the text editor, a series of registered HoverProvider can populate a HoverDisplay with useful information.

To enable call ViewExt::hover() and add HoverProvider using add_provider(). To disable, remove all registered providers with remove_provider().

You can change how long to wait to display the interactive tooltip by setting the hover-delay property in milliseconds.

Properties

hover-delay

Contains the number of milliseconds to delay before showing the hover assistant.

Readable | Writeable

Implements

[trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl Hover

pub fn builder() -> HoverBuilder

Creates a new builder-pattern struct instance to construct Hover objects.

This method returns an instance of HoverBuilder which can be used to create Hover objects.

pub fn add_provider(&self, provider: &impl IsA<HoverProvider>)

pub fn remove_provider(&self, provider: &impl IsA<HoverProvider>)

pub fn hover_delay(&self) -> u32

Contains the number of milliseconds to delay before showing the hover assistant.

pub fn set_hover_delay(&self, hover_delay: u32)

Contains the number of milliseconds to delay before showing the hover assistant.

pub fn connect_hover_delay_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Trait Implementations

impl Clone for Hover

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 Hover

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

Formats the value using the given formatter.

impl HasParamSpec for Hover

type ParamSpec = ParamSpecObject

type SetValue = Hover

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Hover

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 Hover

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 Hover

type Parent = Object

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

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 Hover

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 Hover

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Hover