Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria (inaki@blueleaf.cc) |
Safe Haskell | None |
Language | Haskell2010 |
No description available in the introspection data.
Synopsis
- newtype CompletionContext = CompletionContext (ManagedPtr CompletionContext)
- class (GObject o, IsDescendantOf CompletionContext o) => IsCompletionContext o
- toCompletionContext :: (MonadIO m, IsCompletionContext o) => o -> m CompletionContext
- noCompletionContext :: Maybe CompletionContext
- completionContextAddProposals :: (HasCallStack, MonadIO m, IsCompletionContext a, IsCompletionProvider b, IsCompletionProposal c) => a -> b -> [c] -> Bool -> m ()
- completionContextGetActivation :: (HasCallStack, MonadIO m, IsCompletionContext a) => a -> m [CompletionActivation]
- completionContextGetIter :: (HasCallStack, MonadIO m, IsCompletionContext a) => a -> m (Bool, TextIter)
- constructCompletionContextActivation :: IsCompletionContext o => [CompletionActivation] -> IO (GValueConstruct o)
- getCompletionContextActivation :: (MonadIO m, IsCompletionContext o) => o -> m [CompletionActivation]
- setCompletionContextActivation :: (MonadIO m, IsCompletionContext o) => o -> [CompletionActivation] -> m ()
- constructCompletionContextCompletion :: (IsCompletionContext o, IsCompletion a) => a -> IO (GValueConstruct o)
- getCompletionContextCompletion :: (MonadIO m, IsCompletionContext o) => o -> m (Maybe Completion)
- clearCompletionContextIter :: (MonadIO m, IsCompletionContext o) => o -> m ()
- constructCompletionContextIter :: IsCompletionContext o => TextIter -> IO (GValueConstruct o)
- getCompletionContextIter :: (MonadIO m, IsCompletionContext o) => o -> m (Maybe TextIter)
- setCompletionContextIter :: (MonadIO m, IsCompletionContext o) => o -> TextIter -> m ()
- type C_CompletionContextCancelledCallback = Ptr () -> Ptr () -> IO ()
- type CompletionContextCancelledCallback = IO ()
- afterCompletionContextCancelled :: (IsCompletionContext a, MonadIO m) => a -> CompletionContextCancelledCallback -> m SignalHandlerId
- genClosure_CompletionContextCancelled :: MonadIO m => CompletionContextCancelledCallback -> m (GClosure C_CompletionContextCancelledCallback)
- mk_CompletionContextCancelledCallback :: C_CompletionContextCancelledCallback -> IO (FunPtr C_CompletionContextCancelledCallback)
- noCompletionContextCancelledCallback :: Maybe CompletionContextCancelledCallback
- onCompletionContextCancelled :: (IsCompletionContext a, MonadIO m) => a -> CompletionContextCancelledCallback -> m SignalHandlerId
- wrap_CompletionContextCancelledCallback :: CompletionContextCancelledCallback -> C_CompletionContextCancelledCallback
Exported types
newtype CompletionContext Source #
Memory-managed wrapper type.
CompletionContext (ManagedPtr CompletionContext) |
Instances
GObject CompletionContext Source # | |
Defined in GI.GtkSource.Objects.CompletionContext gobjectType :: IO GType | |
HasParentTypes CompletionContext Source # | |
Defined in GI.GtkSource.Objects.CompletionContext | |
type ParentTypes CompletionContext Source # | |
Defined in GI.GtkSource.Objects.CompletionContext |
class (GObject o, IsDescendantOf CompletionContext o) => IsCompletionContext o Source #
Type class for types which can be safely cast to CompletionContext
, for instance with toCompletionContext
.
Instances
(GObject o, IsDescendantOf CompletionContext o) => IsCompletionContext o Source # | |
Defined in GI.GtkSource.Objects.CompletionContext |
toCompletionContext :: (MonadIO m, IsCompletionContext o) => o -> m CompletionContext Source #
Cast to CompletionContext
, for types for which this is known to be safe. For general casts, use castTo
.
noCompletionContext :: Maybe CompletionContext Source #
A convenience alias for Nothing
:: Maybe
CompletionContext
.
Methods
addProposals
completionContextAddProposals Source #
:: (HasCallStack, MonadIO m, IsCompletionContext a, IsCompletionProvider b, IsCompletionProposal c) | |
=> a |
|
-> b |
|
-> [c] |
|
-> Bool |
|
-> m () |
Providers can use this function to add proposals to the completion. They
can do so asynchronously by means of the finished
argument. Providers must
ensure that they always call this function with finished
set to True
once each population (even if no proposals need to be added).
Population occurs when the completionProviderPopulate
function is called.
getActivation
completionContextGetActivation Source #
:: (HasCallStack, MonadIO m, IsCompletionContext a) | |
=> a |
|
-> m [CompletionActivation] | Returns: The context activation. |
Get the context activation.
getIter
completionContextGetIter Source #
:: (HasCallStack, MonadIO m, IsCompletionContext a) | |
=> a |
|
-> m (Bool, TextIter) |
Get the iter at which the completion was invoked. Providers can use this to determine how and if to match proposals.
Properties
activation
The completion activation
constructCompletionContextActivation :: IsCompletionContext o => [CompletionActivation] -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “activation
” property. This is rarely needed directly, but it is used by new
.
getCompletionContextActivation :: (MonadIO m, IsCompletionContext o) => o -> m [CompletionActivation] Source #
Get the value of the “activation
” property.
When overloading is enabled, this is equivalent to
get
completionContext #activation
setCompletionContextActivation :: (MonadIO m, IsCompletionContext o) => o -> [CompletionActivation] -> m () Source #
Set the value of the “activation
” property.
When overloading is enabled, this is equivalent to
set
completionContext [ #activation:=
value ]
completion
The Completion
associated with the context.
constructCompletionContextCompletion :: (IsCompletionContext o, IsCompletion a) => a -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “completion
” property. This is rarely needed directly, but it is used by new
.
getCompletionContextCompletion :: (MonadIO m, IsCompletionContext o) => o -> m (Maybe Completion) Source #
Get the value of the “completion
” property.
When overloading is enabled, this is equivalent to
get
completionContext #completion
iter
The TextIter
at which the completion is invoked.
clearCompletionContextIter :: (MonadIO m, IsCompletionContext o) => o -> m () Source #
Set the value of the “iter
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#iter
constructCompletionContextIter :: IsCompletionContext o => TextIter -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “iter
” property. This is rarely needed directly, but it is used by new
.
getCompletionContextIter :: (MonadIO m, IsCompletionContext o) => o -> m (Maybe TextIter) Source #
Get the value of the “iter
” property.
When overloading is enabled, this is equivalent to
get
completionContext #iter
setCompletionContextIter :: (MonadIO m, IsCompletionContext o) => o -> TextIter -> m () Source #
Set the value of the “iter
” property.
When overloading is enabled, this is equivalent to
set
completionContext [ #iter:=
value ]
Signals
cancelled
type C_CompletionContextCancelledCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type CompletionContextCancelledCallback = IO () Source #
Emitted when the current population of proposals has been cancelled. Providers adding proposals asynchronously should connect to this signal to know when to cancel running proposal queries.
afterCompletionContextCancelled :: (IsCompletionContext a, MonadIO m) => a -> CompletionContextCancelledCallback -> m SignalHandlerId Source #
Connect a signal handler for the “cancelled
” signal, to be run after the default handler.
When overloading is enabled, this is equivalent to
after
completionContext #cancelled callback
genClosure_CompletionContextCancelled :: MonadIO m => CompletionContextCancelledCallback -> m (GClosure C_CompletionContextCancelledCallback) Source #
Wrap the callback into a GClosure
.
mk_CompletionContextCancelledCallback :: C_CompletionContextCancelledCallback -> IO (FunPtr C_CompletionContextCancelledCallback) Source #
Generate a function pointer callable from C code, from a C_CompletionContextCancelledCallback
.
noCompletionContextCancelledCallback :: Maybe CompletionContextCancelledCallback Source #
A convenience synonym for
.Nothing
:: Maybe
CompletionContextCancelledCallback
onCompletionContextCancelled :: (IsCompletionContext a, MonadIO m) => a -> CompletionContextCancelledCallback -> m SignalHandlerId Source #
Connect a signal handler for the “cancelled
” signal, to be run before the default handler.
When overloading is enabled, this is equivalent to
on
completionContext #cancelled callback