Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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.
Synopsis
- newtype Hover = Hover (ManagedPtr Hover)
- class (GObject o, IsDescendantOf Hover o) => IsHover o
- toHover :: (MonadIO m, IsHover o) => o -> m Hover
- hoverAddProvider :: (HasCallStack, MonadIO m, IsHover a, IsHoverProvider b) => a -> b -> m ()
- hoverRemoveProvider :: (HasCallStack, MonadIO m, IsHover a, IsHoverProvider b) => a -> b -> m ()
- constructHoverHoverDelay :: (IsHover o, MonadIO m) => Word32 -> m (GValueConstruct o)
- getHoverHoverDelay :: (MonadIO m, IsHover o) => o -> m Word32
- setHoverHoverDelay :: (MonadIO m, IsHover o) => o -> Word32 -> m ()
Exported types
Memory-managed wrapper type.
Instances
Eq Hover Source # | |
GObject Hover Source # | |
Defined in GI.GtkSource.Objects.Hover | |
ManagedPtrNewtype Hover Source # | |
Defined in GI.GtkSource.Objects.Hover toManagedPtr :: Hover -> ManagedPtr Hover | |
TypedObject Hover Source # | |
Defined in GI.GtkSource.Objects.Hover | |
HasParentTypes Hover Source # | |
Defined in GI.GtkSource.Objects.Hover | |
IsGValue (Maybe Hover) Source # | Convert |
Defined in GI.GtkSource.Objects.Hover gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Hover -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Hover) | |
type ParentTypes Hover Source # | |
Defined in GI.GtkSource.Objects.Hover type ParentTypes Hover = '[Object] |
class (GObject o, IsDescendantOf Hover o) => IsHover o Source #
Instances
(GObject o, IsDescendantOf Hover o) => IsHover o Source # | |
Defined in GI.GtkSource.Objects.Hover |
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
addProvider
hoverAddProvider :: (HasCallStack, MonadIO m, IsHover a, IsHoverProvider b) => a -> b -> m () Source #
No description available in the introspection data.
removeProvider
hoverRemoveProvider :: (HasCallStack, MonadIO m, IsHover a, IsHoverProvider b) => a -> b -> m () Source #
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) Source #
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 Source #
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 () Source #
Set the value of the “hover-delay
” property.
When overloading is enabled, this is equivalent to
set
hover [ #hoverDelay:=
value ]