GI.GtkSource.Objects.Completion

Exported types

newtype Completion

Constructors

Completion (ManagedPtr Completion)

Instances

GObject Completion

Methods

gobjectType :: Completion -> IO GType

IsObject Completion

IsBuildable Completion

IsCompletion Completion

class GObject o => IsCompletion o

Instances

(GObject a, UnknownAncestorError Constraint Completion a) => IsCompletion a

IsCompletion Completion

toCompletion :: (MonadIO m, IsCompletion o) => o -> m Completion

noCompletion :: Maybe Completion

Methods

addProvider

completionAddProvider

Arguments

:: (HasCallStack, MonadIO m, IsCompletion a, IsCompletionProvider b)

=> a

completion: a Completion.

-> b

provider: a CompletionProvider.

-> m ()

(Can throw GError)

Add a new CompletionProvider to the completion object. This will add a reference provider, so make sure to unref your own copy when you no longer need it.

blockInteractive

completionBlockInteractive

Arguments

:: (HasCallStack, MonadIO m, IsCompletion a)

=> a

completion: a Completion.

-> m ()

Block interactive completion. This can be used to disable interactive completion when inserting or deleting text from the buffer associated with the completion. Use completionUnblockInteractive to enable interactive completion again.

This function may be called multiple times. It will continue to block interactive completion until completionUnblockInteractive has been called the same number of times.

createContext

completionCreateContext

Arguments

:: (HasCallStack, MonadIO m, IsCompletion a)

=> a

completion: a Completion.

-> Maybe TextIter

position: a TextIter, or Nothing.

-> m CompletionContext

Returns: a new CompletionContext. The reference being returned is a 'floating' reference, so if you invoke completionShow with this context you don't need to unref it.

Create a new CompletionContext for completion. The position where the completion occurs can be specified by position. If position is Nothing, the current cursor position will be used.

getInfoWindow

completionGetInfoWindow

Arguments

:: (HasCallStack, MonadIO m, IsCompletion a)

=> a

completion: a Completion.

-> m CompletionInfo

Returns: The CompletionInfo window associated with completion.

The info widget is the window where the completion displays optional extra information of the proposal.

getProviders

completionGetProviders

Arguments

:: (HasCallStack, MonadIO m, IsCompletion a)

=> a

completion: a Completion.

-> m [CompletionProvider]

Returns: list of CompletionProvider.

Get list of providers registered on completion. The returned list is owned by the completion and should not be freed.

getView

completionGetView

Arguments

:: (HasCallStack, MonadIO m, IsCompletion a)

=> a

completion: a Completion.

-> m (Maybe View)

Returns: The View associated with completion, or Nothing.

The View associated with completion, or Nothing if the view has been destroyed.

hide

completionHide

Arguments

:: (HasCallStack, MonadIO m, IsCompletion a)

=> a

completion: a Completion.

-> m ()

Hides the completion if it is active (visible).

moveWindow

completionMoveWindow

Arguments

:: (HasCallStack, MonadIO m, IsCompletion a)

=> a

completion: a Completion.

-> TextIter

iter: a TextIter.

-> m ()

Deprecated: (Since version 3.8)Use completionProviderGetStartIter instead.

Move the completion window to a specific iter.

removeProvider

completionRemoveProvider

Arguments

:: (HasCallStack, MonadIO m, IsCompletion a, IsCompletionProvider b)

=> a

completion: a Completion.

-> b

provider: a CompletionProvider.

-> m ()

(Can throw GError)

Remove provider from the completion.

show

completionShow

Arguments

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

=> a

completion: a Completion.

-> [b]

providers: a list of CompletionProvider, or Nothing.

-> c

context: The CompletionContext with which to start the completion.

-> m Bool

Returns: True if it was possible to the show completion window.

Starts a new completion with the specified CompletionContext and a list of potential candidate providers for completion.

It can be convenient for showing a completion on-the-fly, without the need to add or remove providers to the Completion.

Another solution is to add providers with completionAddProvider, and implement completionProviderMatch for each provider.

unblockInteractive

completionUnblockInteractive

Arguments

:: (HasCallStack, MonadIO m, IsCompletion a)

=> a

completion: a Completion.

-> m ()

Unblock interactive completion. This can be used after using completionBlockInteractive to enable interactive completion again.

Properties

accelerators

constructCompletionAccelerators :: IsCompletion o => Word32 -> IO (GValueConstruct o)

getCompletionAccelerators :: (MonadIO m, IsCompletion o) => o -> m Word32

setCompletionAccelerators :: (MonadIO m, IsCompletion o) => o -> Word32 -> m ()

autoCompleteDelay

constructCompletionAutoCompleteDelay :: IsCompletion o => Word32 -> IO (GValueConstruct o)

getCompletionAutoCompleteDelay :: (MonadIO m, IsCompletion o) => o -> m Word32

setCompletionAutoCompleteDelay :: (MonadIO m, IsCompletion o) => o -> Word32 -> m ()

proposalPageSize

constructCompletionProposalPageSize :: IsCompletion o => Word32 -> IO (GValueConstruct o)

getCompletionProposalPageSize :: (MonadIO m, IsCompletion o) => o -> m Word32

setCompletionProposalPageSize :: (MonadIO m, IsCompletion o) => o -> Word32 -> m ()

providerPageSize

constructCompletionProviderPageSize :: IsCompletion o => Word32 -> IO (GValueConstruct o)

getCompletionProviderPageSize :: (MonadIO m, IsCompletion o) => o -> m Word32

setCompletionProviderPageSize :: (MonadIO m, IsCompletion o) => o -> Word32 -> m ()

rememberInfoVisibility

constructCompletionRememberInfoVisibility :: IsCompletion o => Bool -> IO (GValueConstruct o)

getCompletionRememberInfoVisibility :: (MonadIO m, IsCompletion o) => o -> m Bool

setCompletionRememberInfoVisibility :: (MonadIO m, IsCompletion o) => o -> Bool -> m ()

selectOnShow

constructCompletionSelectOnShow :: IsCompletion o => Bool -> IO (GValueConstruct o)

getCompletionSelectOnShow :: (MonadIO m, IsCompletion o) => o -> m Bool

setCompletionSelectOnShow :: (MonadIO m, IsCompletion o) => o -> Bool -> m ()

showHeaders

constructCompletionShowHeaders :: IsCompletion o => Bool -> IO (GValueConstruct o)

getCompletionShowHeaders :: (MonadIO m, IsCompletion o) => o -> m Bool

setCompletionShowHeaders :: (MonadIO m, IsCompletion o) => o -> Bool -> m ()

showIcons

constructCompletionShowIcons :: IsCompletion o => Bool -> IO (GValueConstruct o)

getCompletionShowIcons :: (MonadIO m, IsCompletion o) => o -> m Bool

setCompletionShowIcons :: (MonadIO m, IsCompletion o) => o -> Bool -> m ()

view

constructCompletionView :: (IsCompletion o, IsView a) => a -> IO (GValueConstruct o)

getCompletionView :: (MonadIO m, IsCompletion o) => o -> m (Maybe View)

Signals

activateProposal

type C_CompletionActivateProposalCallback = Ptr () -> Ptr () -> IO ()

type CompletionActivateProposalCallback = IO ()

afterCompletionActivateProposal :: (IsCompletion a, MonadIO m) => a -> CompletionActivateProposalCallback -> m SignalHandlerId

genClosure_CompletionActivateProposal :: CompletionActivateProposalCallback -> IO Closure

mk_CompletionActivateProposalCallback :: C_CompletionActivateProposalCallback -> IO (FunPtr C_CompletionActivateProposalCallback)

noCompletionActivateProposalCallback :: Maybe CompletionActivateProposalCallback

onCompletionActivateProposal :: (IsCompletion a, MonadIO m) => a -> CompletionActivateProposalCallback -> m SignalHandlerId

wrap_CompletionActivateProposalCallback :: CompletionActivateProposalCallback -> Ptr () -> Ptr () -> IO ()

hide

type C_CompletionHideCallback = Ptr () -> Ptr () -> IO ()

type CompletionHideCallback = IO ()

afterCompletionHide :: (IsCompletion a, MonadIO m) => a -> CompletionHideCallback -> m SignalHandlerId

genClosure_CompletionHide :: CompletionHideCallback -> IO Closure

mk_CompletionHideCallback :: C_CompletionHideCallback -> IO (FunPtr C_CompletionHideCallback)

noCompletionHideCallback :: Maybe CompletionHideCallback

onCompletionHide :: (IsCompletion a, MonadIO m) => a -> CompletionHideCallback -> m SignalHandlerId

wrap_CompletionHideCallback :: CompletionHideCallback -> Ptr () -> Ptr () -> IO ()

moveCursor

type C_CompletionMoveCursorCallback = Ptr () -> CUInt -> Int32 -> Ptr () -> IO ()

type CompletionMoveCursorCallback = ScrollStep -> Int32 -> IO ()

afterCompletionMoveCursor :: (IsCompletion a, MonadIO m) => a -> CompletionMoveCursorCallback -> m SignalHandlerId

genClosure_CompletionMoveCursor :: CompletionMoveCursorCallback -> IO Closure

mk_CompletionMoveCursorCallback :: C_CompletionMoveCursorCallback -> IO (FunPtr C_CompletionMoveCursorCallback)

noCompletionMoveCursorCallback :: Maybe CompletionMoveCursorCallback

onCompletionMoveCursor :: (IsCompletion a, MonadIO m) => a -> CompletionMoveCursorCallback -> m SignalHandlerId

wrap_CompletionMoveCursorCallback :: CompletionMoveCursorCallback -> Ptr () -> CUInt -> Int32 -> Ptr () -> IO ()

movePage

type C_CompletionMovePageCallback = Ptr () -> CUInt -> Int32 -> Ptr () -> IO ()

type CompletionMovePageCallback = ScrollStep -> Int32 -> IO ()

afterCompletionMovePage :: (IsCompletion a, MonadIO m) => a -> CompletionMovePageCallback -> m SignalHandlerId

genClosure_CompletionMovePage :: CompletionMovePageCallback -> IO Closure

mk_CompletionMovePageCallback :: C_CompletionMovePageCallback -> IO (FunPtr C_CompletionMovePageCallback)

noCompletionMovePageCallback :: Maybe CompletionMovePageCallback

onCompletionMovePage :: (IsCompletion a, MonadIO m) => a -> CompletionMovePageCallback -> m SignalHandlerId

wrap_CompletionMovePageCallback :: CompletionMovePageCallback -> Ptr () -> CUInt -> Int32 -> Ptr () -> IO ()

populateContext

type C_CompletionPopulateContextCallback = Ptr () -> Ptr CompletionContext -> Ptr () -> IO ()

type CompletionPopulateContextCallback = CompletionContext -> IO ()

afterCompletionPopulateContext :: (IsCompletion a, MonadIO m) => a -> CompletionPopulateContextCallback -> m SignalHandlerId

genClosure_CompletionPopulateContext :: CompletionPopulateContextCallback -> IO Closure

mk_CompletionPopulateContextCallback :: C_CompletionPopulateContextCallback -> IO (FunPtr C_CompletionPopulateContextCallback)

noCompletionPopulateContextCallback :: Maybe CompletionPopulateContextCallback

onCompletionPopulateContext :: (IsCompletion a, MonadIO m) => a -> CompletionPopulateContextCallback -> m SignalHandlerId

wrap_CompletionPopulateContextCallback :: CompletionPopulateContextCallback -> Ptr () -> Ptr CompletionContext -> Ptr () -> IO ()

show

type C_CompletionShowCallback = Ptr () -> Ptr () -> IO ()

type CompletionShowCallback = IO ()

afterCompletionShow :: (IsCompletion a, MonadIO m) => a -> CompletionShowCallback -> m SignalHandlerId

genClosure_CompletionShow :: CompletionShowCallback -> IO Closure

mk_CompletionShowCallback :: C_CompletionShowCallback -> IO (FunPtr C_CompletionShowCallback)

noCompletionShowCallback :: Maybe CompletionShowCallback

onCompletionShow :: (IsCompletion a, MonadIO m) => a -> CompletionShowCallback -> m SignalHandlerId

wrap_CompletionShowCallback :: CompletionShowCallback -> Ptr () -> Ptr () -> IO ()