| 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
Interface for completion proposals.
This interface is used to denote that an object is capable of being
a completion proposal for [classcompletion].
Currently, no method or functions are required but additional methods
may be added in the future. Proposals created by
CompletionProvider can use GObject.IMPLEMENT_INTERFACE to
implement this with Nothing for the interface init function.
Synopsis
- newtype CompletionProposal = CompletionProposal (ManagedPtr CompletionProposal)
- class (GObject o, IsDescendantOf CompletionProposal o) => IsCompletionProposal o
- toCompletionProposal :: (MonadIO m, IsCompletionProposal o) => o -> m CompletionProposal
- completionProposalGetTypedText :: (HasCallStack, MonadIO m, IsCompletionProposal a) => a -> m (Maybe Text)
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, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getData, getProperty, getQdata, getTypedText.
Setters
getTypedText
completionProposalGetTypedText Source #
Arguments
| :: (HasCallStack, MonadIO m, IsCompletionProposal a) | |
| => a |
|
| -> m (Maybe Text) | Returns: a newly allocated string, or |
Gets the typed-text for the proposal, if supported by the implementation.
Implementing this virtual-function is optional, but can be useful to allow external tooling to compare results.
Since: 5.6