GI.GtkSource.Interfaces.CompletionProposal

Exported types

newtype CompletionProposal

Constructors

CompletionProposal (ManagedPtr CompletionProposal)

Instances

GObject CompletionProposal

Methods

gobjectType :: CompletionProposal -> IO GType

IsObject CompletionProposal

IsCompletionProposal CompletionProposal

noCompletionProposal :: Maybe CompletionProposal

class GObject o => IsCompletionProposal o

Instances

(GObject a, UnknownAncestorError Constraint CompletionProposal a) => IsCompletionProposal a

IsCompletionProposal CompletionProposal

IsCompletionProposal CompletionItem

toCompletionProposal :: (MonadIO m, IsCompletionProposal o) => o -> m CompletionProposal

Methods

changed

completionProposalChanged

Arguments

:: (HasCallStack, MonadIO m, IsCompletionProposal a)

=> a

proposal: a CompletionProposal.

-> m ()

Emits the "changed" signal on proposal. This should be called by implementations whenever the name, icon or info of the proposal has changed.

equal

completionProposalEqual

Arguments

:: (HasCallStack, MonadIO m, IsCompletionProposal a, IsCompletionProposal b)

=> a

proposal: a CompletionProposal.

-> b

other: a CompletionProposal.

-> m Bool

Returns: True if proposal and object are the same proposal

Get whether two proposal objects are the same. This is used to (together with completionProposalHash) to match proposals in the completion model. By default, it uses direct equality (directEqual).

getGicon

completionProposalGetGicon

Arguments

:: (HasCallStack, MonadIO m, IsCompletionProposal a)

=> a

proposal: a CompletionProposal.

-> m (Maybe Icon)

Returns: A Icon with the icon of proposal.

Gets the Icon for the icon of proposal.

Since: 3.18

getIcon

completionProposalGetIcon

Arguments

:: (HasCallStack, MonadIO m, IsCompletionProposal a)

=> a

proposal: a CompletionProposal.

-> m (Maybe Pixbuf)

Returns: A Pixbuf with the icon of proposal.

Gets the Pixbuf for the icon of proposal.

getIconName

completionProposalGetIconName

Arguments

:: (HasCallStack, MonadIO m, IsCompletionProposal a)

=> a

proposal: a CompletionProposal.

-> m (Maybe Text)

Returns: The icon name of proposal.

Gets the icon name of proposal.

Since: 3.18

getInfo

completionProposalGetInfo

Arguments

:: (HasCallStack, MonadIO m, IsCompletionProposal a)

=> a

proposal: a CompletionProposal.

-> m (Maybe Text)

Returns: a newly-allocated string containing extra information of proposal or Nothing if no extra information is associated to proposal.

Gets extra information associated to the proposal. This information will be used to present the user with extra, detailed information about the selected proposal. The returned string must be freed with free.

getLabel

completionProposalGetLabel

Arguments

:: (HasCallStack, MonadIO m, IsCompletionProposal a)

=> a

proposal: a CompletionProposal.

-> m Text

Returns: a new string containing the label of proposal.

Gets the label of proposal. The label is shown in the list of proposals as plain text. If you need any markup (such as bold or italic text), you have to implement completionProposalGetMarkup. The returned string must be freed with free.

getMarkup

completionProposalGetMarkup

Arguments

:: (HasCallStack, MonadIO m, IsCompletionProposal a)

=> a

proposal: a CompletionProposal.

-> m Text

Returns: a new string containing the label of proposal with markup.

Gets the label of proposal with markup. The label is shown in the list of proposals and may contain markup. This will be used instead of completionProposalGetLabel if implemented. The returned string must be freed with free.

getText

completionProposalGetText

Arguments

:: (HasCallStack, MonadIO m, IsCompletionProposal a)

=> a

proposal: a CompletionProposal.

-> m Text

Returns: a new string containing the text of proposal.

Gets the text of proposal. The text that is inserted into the text buffer when the proposal is activated by the default activation. You are free to implement a custom activation handler in the provider and not implement this function. For more information, see completionProviderActivateProposal. The returned string must be freed with free.

hash

completionProposalHash

Arguments

:: (HasCallStack, MonadIO m, IsCompletionProposal a)

=> a

proposal: a CompletionProposal.

-> m Word32

Returns: The hash value of proposal.

Get the hash value of proposal. This is used to (together with completionProposalEqual) to match proposals in the completion model. By default, it uses a direct hash (directHash).

Signals

changed

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

type CompletionProposalChangedCallback = IO ()

afterCompletionProposalChanged :: (IsCompletionProposal a, MonadIO m) => a -> CompletionProposalChangedCallback -> m SignalHandlerId

genClosure_CompletionProposalChanged :: CompletionProposalChangedCallback -> IO Closure

mk_CompletionProposalChangedCallback :: C_CompletionProposalChangedCallback -> IO (FunPtr C_CompletionProposalChangedCallback)

noCompletionProposalChangedCallback :: Maybe CompletionProposalChangedCallback

onCompletionProposalChanged :: (IsCompletionProposal a, MonadIO m) => a -> CompletionProposalChangedCallback -> m SignalHandlerId

wrap_CompletionProposalChangedCallback :: CompletionProposalChangedCallback -> Ptr () -> Ptr () -> IO ()