GI.GtkSource.Interfaces.CompletionProposal

No description available in the introspection data.

Exported types

newtype CompletionProposal

Memory-managed wrapper type.

Constructors

CompletionProposal (ManagedPtr CompletionProposal)

Instances

Eq CompletionProposal

Defined in GI.GtkSource.Interfaces.CompletionProposal

Methods

(==) :: CompletionProposal -> CompletionProposal -> Bool

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

IsGValue CompletionProposal

Convert CompletionProposal to and from GValue with toGValue and fromGValue.

Defined in GI.GtkSource.Interfaces.CompletionProposal

Methods

toGValue :: CompletionProposal -> IO GValue

fromGValue :: GValue -> IO CompletionProposal

GObject CompletionProposal

Defined in GI.GtkSource.Interfaces.CompletionProposal

Methods

gobjectType :: IO GType

HasParentTypes CompletionProposal

Defined in GI.GtkSource.Interfaces.CompletionProposal

type ParentTypes CompletionProposal

Defined in GI.GtkSource.Interfaces.CompletionProposal

type ParentTypes CompletionProposal = '[Object]

noCompletionProposal :: Maybe CompletionProposal

A convenience alias for Nothing :: Maybe CompletionProposal.

class (GObject o, IsDescendantOf CompletionProposal o) => IsCompletionProposal o

Type class for types which can be safely cast to CompletionProposal, for instance with toCompletionProposal.

Instances

(GObject o, IsDescendantOf CompletionProposal o) => IsCompletionProposal o

Defined in GI.GtkSource.Interfaces.CompletionProposal

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

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

Methods

Overloaded 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 for the callback on the (unwrapped) C side.

type CompletionProposalChangedCallback = IO ()

Emitted when the proposal has changed. The completion popup will react to this by updating the shown information.

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

Connect a signal handler for the changed signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after completionProposal #changed callback

genClosure_CompletionProposalChanged :: MonadIO m => CompletionProposalChangedCallback -> m (GClosure C_CompletionProposalChangedCallback)

Wrap the callback into a GClosure.

mk_CompletionProposalChangedCallback :: C_CompletionProposalChangedCallback -> IO (FunPtr C_CompletionProposalChangedCallback)

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

noCompletionProposalChangedCallback :: Maybe CompletionProposalChangedCallback

A convenience synonym for Nothing :: Maybe CompletionProposalChangedCallback.

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

Connect a signal handler for the changed signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on completionProposal #changed callback

wrap_CompletionProposalChangedCallback :: CompletionProposalChangedCallback -> C_CompletionProposalChangedCallback

Wrap a CompletionProposalChangedCallback into a C_CompletionProposalChangedCallback.