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 |
Interface to populate interactive tooltips.
GtkSourceHoverProvider
is an interface that should be implemented to extend
the contents of a [classhoverDisplay
]. This is typical in editors that
interact external tooling such as those utilizing Language Server Protocol.
If you can populate the [classhoverDisplay
] synchronously, use
[vfunchoverProvider
.populate]. Otherwise, interface implementations that
may take additional time should use [vfunchoverProvider
.populate_async]
to avoid blocking the main loop.
Synopsis
- newtype HoverProvider = HoverProvider (ManagedPtr HoverProvider)
- class (GObject o, IsDescendantOf HoverProvider o) => IsHoverProvider o
- toHoverProvider :: (MonadIO m, IsHoverProvider o) => o -> m HoverProvider
- hoverProviderPopulateAsync :: (HasCallStack, MonadIO m, IsHoverProvider a, IsHoverContext b, IsHoverDisplay c, IsCancellable d) => a -> b -> c -> Maybe d -> Maybe AsyncReadyCallback -> m ()
- hoverProviderPopulateFinish :: (HasCallStack, MonadIO m, IsHoverProvider a, IsAsyncResult b) => a -> b -> m ()
Exported types
newtype HoverProvider Source #
Memory-managed wrapper type.
HoverProvider (ManagedPtr HoverProvider) |
Instances
Eq HoverProvider Source # | |
Defined in GI.GtkSource.Interfaces.HoverProvider (==) :: HoverProvider -> HoverProvider -> Bool # (/=) :: HoverProvider -> HoverProvider -> Bool # | |
GObject HoverProvider Source # | |
Defined in GI.GtkSource.Interfaces.HoverProvider | |
ManagedPtrNewtype HoverProvider Source # | |
Defined in GI.GtkSource.Interfaces.HoverProvider toManagedPtr :: HoverProvider -> ManagedPtr HoverProvider | |
TypedObject HoverProvider Source # | |
Defined in GI.GtkSource.Interfaces.HoverProvider | |
HasParentTypes HoverProvider Source # | |
Defined in GI.GtkSource.Interfaces.HoverProvider | |
IsGValue (Maybe HoverProvider) Source # | Convert |
Defined in GI.GtkSource.Interfaces.HoverProvider gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe HoverProvider -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe HoverProvider) | |
type ParentTypes HoverProvider Source # | |
Defined in GI.GtkSource.Interfaces.HoverProvider type ParentTypes HoverProvider = '[Object] |
class (GObject o, IsDescendantOf HoverProvider o) => IsHoverProvider o Source #
Type class for types which can be safely cast to HoverProvider
, for instance with toHoverProvider
.
Instances
(GObject o, IsDescendantOf HoverProvider o) => IsHoverProvider o Source # | |
Defined in GI.GtkSource.Interfaces.HoverProvider |
toHoverProvider :: (MonadIO m, IsHoverProvider o) => o -> m HoverProvider Source #
Cast to HoverProvider
, 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
bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, populateAsync, populateFinish, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getData, getProperty, getQdata.
Setters
populateAsync
hoverProviderPopulateAsync :: (HasCallStack, MonadIO m, IsHoverProvider a, IsHoverContext b, IsHoverDisplay c, IsCancellable d) => a -> b -> c -> Maybe d -> Maybe AsyncReadyCallback -> m () Source #
No description available in the introspection data.
populateFinish
hoverProviderPopulateFinish Source #
:: (HasCallStack, MonadIO m, IsHoverProvider a, IsAsyncResult b) | |
=> a | |
-> b | |
-> m () | (Can throw |
No description available in the introspection data.