GI.GtkSource.Objects.CompletionWords

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 TextBuffers.

Exported types

newtype CompletionWords

Memory-managed wrapper type.

Constructors

CompletionWords (ManagedPtr CompletionWords)

Instances

Eq CompletionWords

Defined in GI.GtkSource.Objects.CompletionWords

Methods

(==) :: CompletionWords -> CompletionWords -> Bool

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

GObject CompletionWords

Defined in GI.GtkSource.Objects.CompletionWords

ManagedPtrNewtype CompletionWords

Defined in GI.GtkSource.Objects.CompletionWords

Methods

toManagedPtr :: CompletionWords -> ManagedPtr CompletionWords

TypedObject CompletionWords

Defined in GI.GtkSource.Objects.CompletionWords

Methods

glibType :: IO GType

HasParentTypes CompletionWords

Defined in GI.GtkSource.Objects.CompletionWords

IsGValue (Maybe CompletionWords)

Convert CompletionWords to and from GValue. See toGValue and fromGValue.

Defined in GI.GtkSource.Objects.CompletionWords

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe CompletionWords -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe CompletionWords)

type ParentTypes CompletionWords

Defined in GI.GtkSource.Objects.CompletionWords

type ParentTypes CompletionWords = '[Object, CompletionProvider]

class (GObject o, IsDescendantOf CompletionWords o) => IsCompletionWords o

Type class for types which can be safely cast to CompletionWords, for instance with toCompletionWords.

Instances

(GObject o, IsDescendantOf CompletionWords o) => IsCompletionWords o

Defined in GI.GtkSource.Objects.CompletionWords

toCompletionWords :: (MonadIO m, IsCompletionWords o) => o -> m CompletionWords

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

setData, setDataFull, setProperty.

new

completionWordsNew

Arguments

:: (HasCallStack, MonadIO m)

=> Maybe Text

title: The title for the provider, or Nothing.

-> m CompletionWords

Returns: a new CompletionWords provider

No description available in the introspection data.

register

completionWordsRegister

Arguments

:: (HasCallStack, MonadIO m, IsCompletionWords a, IsTextBuffer b)

=> a

words: a CompletionWords

-> b

buffer: a TextBuffer

-> m ()

Registers buffer in the words provider.

unregister

completionWordsUnregister

Arguments

:: (HasCallStack, MonadIO m, IsCompletionWords a, IsTextBuffer b)

=> a

words: a CompletionWords

-> b

buffer: a TextBuffer

-> 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)

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

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 ()

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)

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

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 ()

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)

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

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 ()

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)

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

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 ()

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 ()

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)

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)

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 ()

Set the value of the “title” property. When overloading is enabled, this is equivalent to

set completionWords [ #title := value ]