GI.GtkSource.Objects.Hover

Interactive tooltips.

GtkSourceHover allows a [classview] to provide contextual information. When enabled, if the user hovers over a word in the text editor, a series of registered [ifacehoverProvider] can populate a [classhoverDisplay] with useful information.

To enable call [methodview.get_hover] and add [ifacehoverProvider] using [methodhover.add_provider]. To disable, remove all registered providers with [methodhover.remove_provider].

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

Exported types

newtype Hover

Memory-managed wrapper type.

Constructors

Hover (ManagedPtr Hover)

Instances

Eq Hover

Defined in GI.GtkSource.Objects.Hover

Methods

(==) :: Hover -> Hover -> Bool

(/=) :: Hover -> Hover -> Bool

GObject Hover

Defined in GI.GtkSource.Objects.Hover

ManagedPtrNewtype Hover

Defined in GI.GtkSource.Objects.Hover

Methods

toManagedPtr :: Hover -> ManagedPtr Hover

TypedObject Hover

Defined in GI.GtkSource.Objects.Hover

Methods

glibType :: IO GType

HasParentTypes Hover

Defined in GI.GtkSource.Objects.Hover

IsGValue (Maybe Hover)

Convert Hover to and from GValue. See toGValue and fromGValue.

Defined in GI.GtkSource.Objects.Hover

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Hover -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Hover)

type ParentTypes Hover

Defined in GI.GtkSource.Objects.Hover

type ParentTypes Hover = '[Object]

class (GObject o, IsDescendantOf Hover o) => IsHover o

Type class for types which can be safely cast to Hover, for instance with toHover.

Instances

(GObject o, IsDescendantOf Hover o) => IsHover o

Defined in GI.GtkSource.Objects.Hover

toHover :: (MonadIO m, IsHover o) => o -> m Hover

Cast to Hover, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

addProvider, bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, removeProvider, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getData, getProperty, getQdata.

Setters

setData, setDataFull, setProperty.

addProvider

hoverAddProvider :: (HasCallStack, MonadIO m, IsHover a, IsHoverProvider b) => a -> b -> m ()

No description available in the introspection data.

removeProvider

hoverRemoveProvider :: (HasCallStack, MonadIO m, IsHover a, IsHoverProvider b) => a -> b -> m ()

No description available in the introspection data.

Properties

hoverDelay

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

constructHoverHoverDelay :: (IsHover o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “hover-delay” property. This is rarely needed directly, but it is used by new.

getHoverHoverDelay :: (MonadIO m, IsHover o) => o -> m Word32

Get the value of the “hover-delay” property. When overloading is enabled, this is equivalent to

get hover #hoverDelay

setHoverHoverDelay :: (MonadIO m, IsHover o) => o -> Word32 -> m ()

Set the value of the “hover-delay” property. When overloading is enabled, this is equivalent to

set hover [ #hoverDelay := value ]