Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
GI.GtkSource.Interfaces.CompletionProposal
Description
No description available in the introspection data.
Synopsis
- newtype CompletionProposal = CompletionProposal (ManagedPtr CompletionProposal)
- class (GObject o, IsDescendantOf CompletionProposal o) => IsCompletionProposal o
- toCompletionProposal :: (MonadIO m, IsCompletionProposal o) => o -> m CompletionProposal
- completionProposalChanged :: (HasCallStack, MonadIO m, IsCompletionProposal a) => a -> m ()
- completionProposalEqual :: (HasCallStack, MonadIO m, IsCompletionProposal a, IsCompletionProposal b) => a -> b -> m Bool
- completionProposalGetGicon :: (HasCallStack, MonadIO m, IsCompletionProposal a) => a -> m (Maybe Icon)
- completionProposalGetIcon :: (HasCallStack, MonadIO m, IsCompletionProposal a) => a -> m (Maybe Pixbuf)
- completionProposalGetIconName :: (HasCallStack, MonadIO m, IsCompletionProposal a) => a -> m (Maybe Text)
- completionProposalGetInfo :: (HasCallStack, MonadIO m, IsCompletionProposal a) => a -> m (Maybe Text)
- completionProposalGetLabel :: (HasCallStack, MonadIO m, IsCompletionProposal a) => a -> m Text
- completionProposalGetMarkup :: (HasCallStack, MonadIO m, IsCompletionProposal a) => a -> m Text
- completionProposalGetText :: (HasCallStack, MonadIO m, IsCompletionProposal a) => a -> m Text
- completionProposalHash :: (HasCallStack, MonadIO m, IsCompletionProposal a) => a -> m Word32
- type CompletionProposalChangedCallback = IO ()
- afterCompletionProposalChanged :: (IsCompletionProposal a, MonadIO m) => a -> ((?self :: a) => CompletionProposalChangedCallback) -> m SignalHandlerId
- onCompletionProposalChanged :: (IsCompletionProposal a, MonadIO m) => a -> ((?self :: a) => CompletionProposalChangedCallback) -> m SignalHandlerId
Exported types
newtype CompletionProposal Source #
Memory-managed wrapper type.
Constructors
CompletionProposal (ManagedPtr CompletionProposal) |
Instances
class (GObject o, IsDescendantOf CompletionProposal o) => IsCompletionProposal o Source #
Type class for types which can be safely cast to CompletionProposal
, for instance with toCompletionProposal
.
Instances
(GObject o, IsDescendantOf CompletionProposal o) => IsCompletionProposal o Source # | |
Defined in GI.GtkSource.Interfaces.CompletionProposal |
toCompletionProposal :: (MonadIO m, IsCompletionProposal o) => o -> m CompletionProposal Source #
Cast to CompletionProposal
, for types for which this is known to be safe. For general casts, use castTo
.
Methods
Click to display all available methods, including inherited ones
Methods
bindProperty, bindPropertyFull, changed, equal, forceFloating, freezeNotify, getv, hash, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getData, getGicon, getIcon, getIconName, getInfo, getLabel, getMarkup, getProperty, getQdata, getText.
Setters
changed
completionProposalChanged Source #
Arguments
:: (HasCallStack, MonadIO m, IsCompletionProposal a) | |
=> a |
|
-> 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 Source #
Arguments
:: (HasCallStack, MonadIO m, IsCompletionProposal a, IsCompletionProposal b) | |
=> a |
|
-> b |
|
-> m Bool | Returns: |
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 Source #
Arguments
:: (HasCallStack, MonadIO m, IsCompletionProposal a) | |
=> a |
|
-> m (Maybe Icon) | Returns: A |
Gets the Icon
for the icon of proposal
.
Since: 3.18
getIcon
completionProposalGetIcon Source #
Arguments
:: (HasCallStack, MonadIO m, IsCompletionProposal a) | |
=> a |
|
-> m (Maybe Pixbuf) | Returns: A |
Gets the Pixbuf
for the icon of proposal
.
getIconName
completionProposalGetIconName Source #
Arguments
:: (HasCallStack, MonadIO m, IsCompletionProposal a) | |
=> a |
|
-> m (Maybe Text) | Returns: The icon name of |
Gets the icon name of proposal
.
Since: 3.18
getInfo
completionProposalGetInfo Source #
Arguments
:: (HasCallStack, MonadIO m, IsCompletionProposal a) | |
=> a |
|
-> m (Maybe Text) | Returns: a newly-allocated string containing
extra information of |
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 Source #
Arguments
:: (HasCallStack, MonadIO m, IsCompletionProposal a) | |
=> a |
|
-> m Text | Returns: a new string containing the label of |
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 Source #
Arguments
:: (HasCallStack, MonadIO m, IsCompletionProposal a) | |
=> a |
|
-> m Text | Returns: a new string containing the label of |
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 Source #
Arguments
:: (HasCallStack, MonadIO m, IsCompletionProposal a) | |
=> a |
|
-> m Text | Returns: a new string containing the text of |
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 Source #
Arguments
:: (HasCallStack, MonadIO m, IsCompletionProposal a) | |
=> a |
|
-> m Word32 | Returns: The hash value of |
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 CompletionProposalChangedCallback = IO () Source #
Emitted when the proposal has changed. The completion popup will react to this by updating the shown information.
afterCompletionProposalChanged :: (IsCompletionProposal a, MonadIO m) => a -> ((?self :: a) => CompletionProposalChangedCallback) -> m SignalHandlerId Source #
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
By default the object invoking the signal is not passed to the callback.
If you need to access it, you can use the implit ?self
parameter.
Note that this requires activating the ImplicitParams
GHC extension.
onCompletionProposalChanged :: (IsCompletionProposal a, MonadIO m) => a -> ((?self :: a) => CompletionProposalChangedCallback) -> m SignalHandlerId Source #
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