Copyright	Will Thompson, Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.GtkSource.Interfaces.CompletionProvider

Contents

Exported types
Methods

Description

Synopsis

Exported types

newtype CompletionProvider Source #

Constructors

CompletionProvider (ManagedPtr CompletionProvider)

Instances

GObject CompletionProvider Source #
Methods gobjectType :: CompletionProvider -> IO GType #
IsObject CompletionProvider Source #

IsCompletionProvider CompletionProvider Source #

((~) * info (ResolveCompletionProviderMethod t CompletionProvider), MethodInfo * info CompletionProvider p) => IsLabel t (CompletionProvider -> p) Source #
Methods fromLabel :: Proxy# Symbol t -> CompletionProvider -> p #
((~) * info (ResolveCompletionProviderMethod t CompletionProvider), MethodInfo * info CompletionProvider p) => IsLabelProxy t (CompletionProvider -> p) Source #
Methods fromLabelProxy :: Proxy Symbol t -> CompletionProvider -> p #
HasAttributeList * CompletionProvider Source #

type AttributeList CompletionProvider Source #
type AttributeList CompletionProvider
type SignalList CompletionProvider Source #
type SignalList CompletionProvider

noCompletionProvider :: Maybe CompletionProvider Source #

class GObject o => IsCompletionProvider o Source #

Instances

(GObject a, UnknownAncestorError Constraint CompletionProvider a) => IsCompletionProvider a Source #

IsCompletionProvider CompletionProvider Source #

IsCompletionProvider CompletionWords Source #

toCompletionProvider :: IsCompletionProvider o => o -> IO CompletionProvider Source #

Methods

activateProposal

data CompletionProviderActivateProposalMethodInfo Source #

Instances

((~) * signature (b -> TextIter -> m Bool), MonadIO m, IsCompletionProvider a, IsCompletionProposal b) => MethodInfo * CompletionProviderActivateProposalMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy CompletionProviderActivateProposalMethodInfo a -> signature -> s #

completionProviderActivateProposal Source #

Arguments

:: (HasCallStack, MonadIO m, IsCompletionProvider a, IsCompletionProposal b)
=> a	`provider`: a `CompletionProvider`.
-> b	`proposal`: a `CompletionProposal`.
-> TextIter	`iter`: a `TextIter`.
-> m Bool	Returns: `True` to indicate that the proposal activation has been handled, `False` otherwise.

Activate proposal at iter. When this functions returns False, the default activation of proposal will take place which replaces the word at iter with the text of proposal (see completionProposalGetText).

Here is how the default activation selects the boundaries of the word to replace. The end of the word is iter. For the start of the word, it depends on whether a start iter is defined for proposal (see completionProviderGetStartIter). If a start iter is defined, the start of the word is the start iter. Else, the word (as long as possible) will contain only alphanumerical and the "_" characters.

getActivation

data CompletionProviderGetActivationMethodInfo Source #

Instances

((~) * signature (m [CompletionActivation]), MonadIO m, IsCompletionProvider a) => MethodInfo * CompletionProviderGetActivationMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy CompletionProviderGetActivationMethodInfo a -> signature -> s #

completionProviderGetActivation Source #

Arguments

:: (HasCallStack, MonadIO m, IsCompletionProvider a)
=> a	`provider`: a `CompletionProvider`.
-> m [CompletionActivation]	Returns: a combination of `CompletionActivation`.

Get with what kind of activation the provider should be activated.

getGicon

data CompletionProviderGetGiconMethodInfo Source #

Instances

((~) * signature (m (Maybe Icon)), MonadIO m, IsCompletionProvider a) => MethodInfo * CompletionProviderGetGiconMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy CompletionProviderGetGiconMethodInfo a -> signature -> s #

completionProviderGetGicon Source #

Arguments

:: (HasCallStack, MonadIO m, IsCompletionProvider a)
=> a	`provider`: The `CompletionProvider`
-> m (Maybe Icon)	Returns: The icon to be used for the provider, or `Nothing` if the provider does not have a special icon.

Gets the Icon for the icon of provider.

Since: 3.18

getIcon

data CompletionProviderGetIconMethodInfo Source #

Instances

((~) * signature (m (Maybe Pixbuf)), MonadIO m, IsCompletionProvider a) => MethodInfo * CompletionProviderGetIconMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy CompletionProviderGetIconMethodInfo a -> signature -> s #

completionProviderGetIcon Source #

Arguments

:: (HasCallStack, MonadIO m, IsCompletionProvider a)
=> a	`provider`: The `CompletionProvider`
-> m (Maybe Pixbuf)	Returns: The icon to be used for the provider, or `Nothing` if the provider does not have a special icon.

Get the Pixbuf for the icon of the provider.

getIconName

data CompletionProviderGetIconNameMethodInfo Source #

Instances

((~) * signature (m (Maybe Text)), MonadIO m, IsCompletionProvider a) => MethodInfo * CompletionProviderGetIconNameMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy CompletionProviderGetIconNameMethodInfo a -> signature -> s #

completionProviderGetIconName Source #

Arguments

:: (HasCallStack, MonadIO m, IsCompletionProvider a)
=> a	`provider`: The `CompletionProvider`
-> m (Maybe Text)	Returns: The icon name to be used for the provider, or `Nothing` if the provider does not have a special icon.

Gets the icon name of provider.

Since: 3.18

getInfoWidget

data CompletionProviderGetInfoWidgetMethodInfo Source #

Instances

((~) * signature (b -> m (Maybe Widget)), MonadIO m, IsCompletionProvider a, IsCompletionProposal b) => MethodInfo * CompletionProviderGetInfoWidgetMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy CompletionProviderGetInfoWidgetMethodInfo a -> signature -> s #

completionProviderGetInfoWidget Source #

Arguments

:: (HasCallStack, MonadIO m, IsCompletionProvider a, IsCompletionProposal b)
=> a	`provider`: a `CompletionProvider`.
-> b	`proposal`: a currently selected `CompletionProposal`.
-> m (Maybe Widget)	Returns: a custom `Widget` to show extra information about `proposal`, or `Nothing` if the provider does not have a special info widget.

Get a customized info widget to show extra information of a proposal. This allows for customized widgets on a proposal basis, although in general providers will have the same custom widget for all their proposals and proposal can be ignored. The implementation of this function is optional.

If this function is not implemented, the default widget is a Label. The return value of completionProposalGetInfo is used as the content of the Label.

<note> <para> If implemented, completionProviderUpdateInfo <emphasis>must</emphasis> also be implemented. </para> </note>

getInteractiveDelay

data CompletionProviderGetInteractiveDelayMethodInfo Source #

Instances

((~) * signature (m Int32), MonadIO m, IsCompletionProvider a) => MethodInfo * CompletionProviderGetInteractiveDelayMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy CompletionProviderGetInteractiveDelayMethodInfo a -> signature -> s #

completionProviderGetInteractiveDelay Source #

Arguments

:: (HasCallStack, MonadIO m, IsCompletionProvider a)
=> a	`provider`: a `CompletionProvider`.
-> m Int32	Returns: the interactive delay in milliseconds.

Get the delay in milliseconds before starting interactive completion for this provider. A value of -1 indicates to use the default value as set by the Completion:auto-complete-delay property.

getName

data CompletionProviderGetNameMethodInfo Source #

Instances

((~) * signature (m Text), MonadIO m, IsCompletionProvider a) => MethodInfo * CompletionProviderGetNameMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy CompletionProviderGetNameMethodInfo a -> signature -> s #

completionProviderGetName Source #

Arguments

:: (HasCallStack, MonadIO m, IsCompletionProvider a)
=> a	`provider`: a `CompletionProvider`.
-> m Text	Returns: a new string containing the name of the provider.

Get the name of the provider. This should be a translatable name for display to the user. For example: _("Document word completion provider"). The returned string must be freed with free.

getPriority

data CompletionProviderGetPriorityMethodInfo Source #

Instances

((~) * signature (m Int32), MonadIO m, IsCompletionProvider a) => MethodInfo * CompletionProviderGetPriorityMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy CompletionProviderGetPriorityMethodInfo a -> signature -> s #

completionProviderGetPriority Source #

Arguments

:: (HasCallStack, MonadIO m, IsCompletionProvider a)
=> a	`provider`: a `CompletionProvider`.
-> m Int32	Returns: the provider priority.

Get the provider priority. The priority determines the order in which proposals appear in the completion popup. Higher priorities are sorted before lower priorities. The default priority is 0.

getStartIter

data CompletionProviderGetStartIterMethodInfo Source #

Instances

((~) * signature (b -> c -> m (Bool, TextIter)), MonadIO m, IsCompletionProvider a, IsCompletionContext b, IsCompletionProposal c) => MethodInfo * CompletionProviderGetStartIterMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy CompletionProviderGetStartIterMethodInfo a -> signature -> s #

completionProviderGetStartIter Source #

Arguments

:: (HasCallStack, MonadIO m, IsCompletionProvider a, IsCompletionContext b, IsCompletionProposal c)
=> a	`provider`: a `CompletionProvider`.
-> b	`context`: a `CompletionContext`.
-> c	`proposal`: a `CompletionProposal`.
-> m (Bool, TextIter)	Returns: `True` if `iter` was set for `proposal`, `False` otherwise.

Get the TextIter at which the completion for proposal starts. When implemented, this information is used to position the completion window accordingly when a proposal is selected in the completion window. The proposal text inside the completion window is aligned on iter.

If this function is not implemented, the word boundary is taken to position the completion window. See completionProviderActivateProposal for an explanation on the word boundaries.

When the proposal is activated, the default handler uses iter as the start of the word to replace. See completionProviderActivateProposal for more information.

match

data CompletionProviderMatchMethodInfo Source #

Instances

((~) * signature (b -> m Bool), MonadIO m, IsCompletionProvider a, IsCompletionContext b) => MethodInfo * CompletionProviderMatchMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy CompletionProviderMatchMethodInfo a -> signature -> s #

completionProviderMatch Source #

Arguments

:: (HasCallStack, MonadIO m, IsCompletionProvider a, IsCompletionContext b)
=> a	`provider`: a `CompletionProvider`.
-> b	`context`: a `CompletionContext`.
-> m Bool	Returns: `True` if `provider` matches the completion context, `False` otherwise.

Get whether the provider match the context of completion detailed in context.

populate

data CompletionProviderPopulateMethodInfo Source #

Instances

((~) * signature (b -> m ()), MonadIO m, IsCompletionProvider a, IsCompletionContext b) => MethodInfo * CompletionProviderPopulateMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy CompletionProviderPopulateMethodInfo a -> signature -> s #

completionProviderPopulate Source #

Arguments

:: (HasCallStack, MonadIO m, IsCompletionProvider a, IsCompletionContext b)
=> a	`provider`: a `CompletionProvider`.
-> b	`context`: a `CompletionContext`.
-> m ()

Populate context with proposals from provider added with the completionContextAddProposals function.

updateInfo

data CompletionProviderUpdateInfoMethodInfo Source #

Instances

((~) * signature (b -> c -> m ()), MonadIO m, IsCompletionProvider a, IsCompletionProposal b, IsCompletionInfo c) => MethodInfo * CompletionProviderUpdateInfoMethodInfo a signature Source #
Methods overloadedMethod :: MethodProxy CompletionProviderUpdateInfoMethodInfo a -> signature -> s #

completionProviderUpdateInfo Source #

Arguments

:: (HasCallStack, MonadIO m, IsCompletionProvider a, IsCompletionProposal b, IsCompletionInfo c)
=> a	`provider`: a `CompletionProvider`.
-> b	`proposal`: a `CompletionProposal`.
-> c	`info`: a `CompletionInfo`.
-> m ()

Update extra information shown in info for proposal.

<note> <para> This function <emphasis>must</emphasis> be implemented when completionProviderGetInfoWidget is implemented. </para> </note>