GI.GtkSource.Objects.CompletionContext

No description available in the introspection data.

Exported types

newtype CompletionContext

Memory-managed wrapper type.

Constructors

CompletionContext (ManagedPtr CompletionContext)

Instances

Eq CompletionContext

Defined in GI.GtkSource.Objects.CompletionContext

Methods

(==) :: CompletionContext -> CompletionContext -> Bool

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

IsGValue CompletionContext

Convert CompletionContext to and from GValue with toGValue and fromGValue.

Defined in GI.GtkSource.Objects.CompletionContext

Methods

toGValue :: CompletionContext -> IO GValue

fromGValue :: GValue -> IO CompletionContext

GObject CompletionContext

Defined in GI.GtkSource.Objects.CompletionContext

Methods

gobjectType :: IO GType

HasParentTypes CompletionContext

Defined in GI.GtkSource.Objects.CompletionContext

type ParentTypes CompletionContext

Defined in GI.GtkSource.Objects.CompletionContext

type ParentTypes CompletionContext = '[Object]

class (GObject o, IsDescendantOf CompletionContext o) => IsCompletionContext o

Type class for types which can be safely cast to CompletionContext, for instance with toCompletionContext.

Instances

(GObject o, IsDescendantOf CompletionContext o) => IsCompletionContext o

Defined in GI.GtkSource.Objects.CompletionContext

toCompletionContext :: (MonadIO m, IsCompletionContext o) => o -> m CompletionContext

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

noCompletionContext :: Maybe CompletionContext

A convenience alias for Nothing :: Maybe CompletionContext.

Methods

Overloaded methods

addProposals

completionContextAddProposals

Arguments

:: (HasCallStack, MonadIO m, IsCompletionContext a, IsCompletionProvider b, IsCompletionProposal c)

=> a

context: a CompletionContext.

-> b

provider: a CompletionProvider.

-> [c]

proposals: The list of proposals to add.

-> Bool

finished: Whether the provider is finished adding proposals.

-> 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

Arguments

:: (HasCallStack, MonadIO m, IsCompletionContext a)

=> a

context: a CompletionContext.

-> m [CompletionActivation]

Returns: The context activation.

Get the context activation.

getIter

completionContextGetIter

Arguments

:: (HasCallStack, MonadIO m, IsCompletionContext a)

=> a

context: a CompletionContext.

-> m (Bool, TextIter)

Returns: True if iter is correctly set, False otherwise.

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)

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]

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 ()

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)

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)

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 ()

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)

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)

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 ()

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 ()

Type for the callback on the (unwrapped) C side.

type CompletionContextCancelledCallback = IO ()

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

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)

Wrap the callback into a GClosure.

mk_CompletionContextCancelledCallback :: C_CompletionContextCancelledCallback -> IO (FunPtr C_CompletionContextCancelledCallback)

Generate a function pointer callable from C code, from a C_CompletionContextCancelledCallback.

noCompletionContextCancelledCallback :: Maybe CompletionContextCancelledCallback

A convenience synonym for Nothing :: Maybe CompletionContextCancelledCallback.

onCompletionContextCancelled :: (IsCompletionContext a, MonadIO m) => a -> CompletionContextCancelledCallback -> m SignalHandlerId

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

wrap_CompletionContextCancelledCallback :: CompletionContextCancelledCallback -> C_CompletionContextCancelledCallback

Wrap a CompletionContextCancelledCallback into a C_CompletionContextCancelledCallback.