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 |
A [ifacecompletionProvider
] for the completion of words.
The GtkSourceCompletionWords
is an example of an implementation of
the [ifacecompletionProvider
] interface. The proposals are words
appearing in the registered TextBuffer
s.
Synopsis
- newtype CompletionWords = CompletionWords (ManagedPtr CompletionWords)
- class (GObject o, IsDescendantOf CompletionWords o) => IsCompletionWords o
- toCompletionWords :: (MonadIO m, IsCompletionWords o) => o -> m CompletionWords
- completionWordsNew :: (HasCallStack, MonadIO m) => Maybe Text -> m CompletionWords
- completionWordsRegister :: (HasCallStack, MonadIO m, IsCompletionWords a, IsTextBuffer b) => a -> b -> m ()
- completionWordsUnregister :: (HasCallStack, MonadIO m, IsCompletionWords a, IsTextBuffer b) => a -> b -> m ()
- constructCompletionWordsMinimumWordSize :: (IsCompletionWords o, MonadIO m) => Word32 -> m (GValueConstruct o)
- getCompletionWordsMinimumWordSize :: (MonadIO m, IsCompletionWords o) => o -> m Word32
- setCompletionWordsMinimumWordSize :: (MonadIO m, IsCompletionWords o) => o -> Word32 -> m ()
- constructCompletionWordsPriority :: (IsCompletionWords o, MonadIO m) => Int32 -> m (GValueConstruct o)
- getCompletionWordsPriority :: (MonadIO m, IsCompletionWords o) => o -> m Int32
- setCompletionWordsPriority :: (MonadIO m, IsCompletionWords o) => o -> Int32 -> m ()
- constructCompletionWordsProposalsBatchSize :: (IsCompletionWords o, MonadIO m) => Word32 -> m (GValueConstruct o)
- getCompletionWordsProposalsBatchSize :: (MonadIO m, IsCompletionWords o) => o -> m Word32
- setCompletionWordsProposalsBatchSize :: (MonadIO m, IsCompletionWords o) => o -> Word32 -> m ()
- constructCompletionWordsScanBatchSize :: (IsCompletionWords o, MonadIO m) => Word32 -> m (GValueConstruct o)
- getCompletionWordsScanBatchSize :: (MonadIO m, IsCompletionWords o) => o -> m Word32
- setCompletionWordsScanBatchSize :: (MonadIO m, IsCompletionWords o) => o -> Word32 -> m ()
- clearCompletionWordsTitle :: (MonadIO m, IsCompletionWords o) => o -> m ()
- constructCompletionWordsTitle :: (IsCompletionWords o, MonadIO m) => Text -> m (GValueConstruct o)
- getCompletionWordsTitle :: (MonadIO m, IsCompletionWords o) => o -> m (Maybe Text)
- setCompletionWordsTitle :: (MonadIO m, IsCompletionWords o) => o -> Text -> m ()
Exported types
newtype CompletionWords Source #
Memory-managed wrapper type.
CompletionWords (ManagedPtr CompletionWords) |
Instances
Eq CompletionWords Source # | |
Defined in GI.GtkSource.Objects.CompletionWords (==) :: CompletionWords -> CompletionWords -> Bool # (/=) :: CompletionWords -> CompletionWords -> Bool # | |
GObject CompletionWords Source # | |
Defined in GI.GtkSource.Objects.CompletionWords | |
ManagedPtrNewtype CompletionWords Source # | |
Defined in GI.GtkSource.Objects.CompletionWords toManagedPtr :: CompletionWords -> ManagedPtr CompletionWords | |
TypedObject CompletionWords Source # | |
Defined in GI.GtkSource.Objects.CompletionWords | |
HasParentTypes CompletionWords Source # | |
Defined in GI.GtkSource.Objects.CompletionWords | |
IsGValue (Maybe CompletionWords) Source # | Convert |
Defined in GI.GtkSource.Objects.CompletionWords gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe CompletionWords -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe CompletionWords) | |
type ParentTypes CompletionWords Source # | |
Defined in GI.GtkSource.Objects.CompletionWords |
class (GObject o, IsDescendantOf CompletionWords o) => IsCompletionWords o Source #
Type class for types which can be safely cast to CompletionWords
, for instance with toCompletionWords
.
Instances
(GObject o, IsDescendantOf CompletionWords o) => IsCompletionWords o Source # | |
Defined in GI.GtkSource.Objects.CompletionWords |
toCompletionWords :: (MonadIO m, IsCompletionWords o) => o -> m CompletionWords Source #
Cast to CompletionWords
, 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
activate, bindProperty, bindPropertyFull, display, forceFloating, freezeNotify, getv, isFloating, isTrigger, keyActivates, listAlternates, notify, notifyByPspec, populateAsync, populateFinish, ref, refSink, refilter, register, runDispose, stealData, stealQdata, thawNotify, unref, unregister, watchClosure.
Getters
getData, getPriority, getProperty, getQdata, getTitle.
Setters
new
:: (HasCallStack, MonadIO m) | |
=> Maybe Text |
|
-> m CompletionWords | Returns: a new |
No description available in the introspection data.
register
completionWordsRegister Source #
:: (HasCallStack, MonadIO m, IsCompletionWords a, IsTextBuffer b) | |
=> a |
|
-> b |
|
-> m () |
Registers buffer
in the words
provider.
unregister
completionWordsUnregister Source #
:: (HasCallStack, MonadIO m, IsCompletionWords a, IsTextBuffer b) | |
=> a |
|
-> b |
|
-> m () |
Unregisters buffer
from the words
provider.
Properties
minimumWordSize
No description available in the introspection data.
constructCompletionWordsMinimumWordSize :: (IsCompletionWords o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “minimum-word-size
” property. This is rarely needed directly, but it is used by new
.
getCompletionWordsMinimumWordSize :: (MonadIO m, IsCompletionWords o) => o -> m Word32 Source #
Get the value of the “minimum-word-size
” property.
When overloading is enabled, this is equivalent to
get
completionWords #minimumWordSize
setCompletionWordsMinimumWordSize :: (MonadIO m, IsCompletionWords o) => o -> Word32 -> m () Source #
Set the value of the “minimum-word-size
” property.
When overloading is enabled, this is equivalent to
set
completionWords [ #minimumWordSize:=
value ]
priority
No description available in the introspection data.
constructCompletionWordsPriority :: (IsCompletionWords o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “priority
” property. This is rarely needed directly, but it is used by new
.
getCompletionWordsPriority :: (MonadIO m, IsCompletionWords o) => o -> m Int32 Source #
Get the value of the “priority
” property.
When overloading is enabled, this is equivalent to
get
completionWords #priority
setCompletionWordsPriority :: (MonadIO m, IsCompletionWords o) => o -> Int32 -> m () Source #
Set the value of the “priority
” property.
When overloading is enabled, this is equivalent to
set
completionWords [ #priority:=
value ]
proposalsBatchSize
No description available in the introspection data.
constructCompletionWordsProposalsBatchSize :: (IsCompletionWords o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “proposals-batch-size
” property. This is rarely needed directly, but it is used by new
.
getCompletionWordsProposalsBatchSize :: (MonadIO m, IsCompletionWords o) => o -> m Word32 Source #
Get the value of the “proposals-batch-size
” property.
When overloading is enabled, this is equivalent to
get
completionWords #proposalsBatchSize
setCompletionWordsProposalsBatchSize :: (MonadIO m, IsCompletionWords o) => o -> Word32 -> m () Source #
Set the value of the “proposals-batch-size
” property.
When overloading is enabled, this is equivalent to
set
completionWords [ #proposalsBatchSize:=
value ]
scanBatchSize
No description available in the introspection data.
constructCompletionWordsScanBatchSize :: (IsCompletionWords o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “scan-batch-size
” property. This is rarely needed directly, but it is used by new
.
getCompletionWordsScanBatchSize :: (MonadIO m, IsCompletionWords o) => o -> m Word32 Source #
Get the value of the “scan-batch-size
” property.
When overloading is enabled, this is equivalent to
get
completionWords #scanBatchSize
setCompletionWordsScanBatchSize :: (MonadIO m, IsCompletionWords o) => o -> Word32 -> m () Source #
Set the value of the “scan-batch-size
” property.
When overloading is enabled, this is equivalent to
set
completionWords [ #scanBatchSize:=
value ]
title
No description available in the introspection data.
clearCompletionWordsTitle :: (MonadIO m, IsCompletionWords o) => o -> m () Source #
Set the value of the “title
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#title
constructCompletionWordsTitle :: (IsCompletionWords o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “title
” property. This is rarely needed directly, but it is used by new
.
getCompletionWordsTitle :: (MonadIO m, IsCompletionWords o) => o -> m (Maybe Text) Source #
Get the value of the “title
” property.
When overloading is enabled, this is equivalent to
get
completionWords #title
setCompletionWordsTitle :: (MonadIO m, IsCompletionWords o) => o -> Text -> m () Source #
Set the value of the “title
” property.
When overloading is enabled, this is equivalent to
set
completionWords [ #title:=
value ]