gi-gio
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Gio.Objects.FilenameCompleter

Description

Completes partial file and directory names given a partial string by looking in the file system for clues. Can return a list of possible completion strings for widget implementations.

Synopsis

Exported types

newtype FilenameCompleter Source #

Memory-managed wrapper type.

Instances

Instances details
Eq FilenameCompleter Source # 
Instance details

Defined in GI.Gio.Objects.FilenameCompleter

GObject FilenameCompleter Source # 
Instance details

Defined in GI.Gio.Objects.FilenameCompleter

ManagedPtrNewtype FilenameCompleter Source # 
Instance details

Defined in GI.Gio.Objects.FilenameCompleter

TypedObject FilenameCompleter Source # 
Instance details

Defined in GI.Gio.Objects.FilenameCompleter

Methods

glibType :: IO GType #

HasParentTypes FilenameCompleter Source # 
Instance details

Defined in GI.Gio.Objects.FilenameCompleter

HasAttributeList FilenameCompleter Source # 
Instance details

Defined in GI.Gio.Objects.FilenameCompleter

(info ~ ResolveFilenameCompleterMethod t FilenameCompleter, OverloadedMethod info FilenameCompleter p, HasField t FilenameCompleter p) => HasField (t :: Symbol) FilenameCompleter (p :: Type) Source # 
Instance details

Defined in GI.Gio.Objects.FilenameCompleter

(info ~ ResolveFilenameCompleterMethod t FilenameCompleter, OverloadedMethodInfo info FilenameCompleter) => IsLabel t (MethodProxy info FilenameCompleter) Source # 
Instance details

Defined in GI.Gio.Objects.FilenameCompleter

(info ~ ResolveFilenameCompleterMethod t FilenameCompleter, OverloadedMethod info FilenameCompleter p) => IsLabel t (FilenameCompleter -> p) Source # 
Instance details

Defined in GI.Gio.Objects.FilenameCompleter

IsGValue (Maybe FilenameCompleter) Source #

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

Instance details

Defined in GI.Gio.Objects.FilenameCompleter

type AttributeList FilenameCompleter Source # 
Instance details

Defined in GI.Gio.Objects.FilenameCompleter

type ParentTypes FilenameCompleter Source # 
Instance details

Defined in GI.Gio.Objects.FilenameCompleter

type SignalList FilenameCompleter Source # 
Instance details

Defined in GI.Gio.Objects.FilenameCompleter

class (GObject o, IsDescendantOf FilenameCompleter o) => IsFilenameCompleter o Source #

Type class for types which can be safely cast to FilenameCompleter, for instance with toFilenameCompleter.

Instances

Instances details
(GObject o, IsDescendantOf FilenameCompleter o) => IsFilenameCompleter o Source # 
Instance details

Defined in GI.Gio.Objects.FilenameCompleter

toFilenameCompleter :: (MonadIO m, IsFilenameCompleter o) => o -> m FilenameCompleter Source #

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

Methods

type family ResolveFilenameCompleterMethod (t :: Symbol) o where ... Source #

Equations

ResolveFilenameCompleterMethod "bindProperty" o = ObjectBindPropertyMethodInfo 
ResolveFilenameCompleterMethod "bindPropertyFull" o = ObjectBindPropertyFullMethodInfo 
ResolveFilenameCompleterMethod "forceFloating" o = ObjectForceFloatingMethodInfo 
ResolveFilenameCompleterMethod "freezeNotify" o = ObjectFreezeNotifyMethodInfo 
ResolveFilenameCompleterMethod "getv" o = ObjectGetvMethodInfo 
ResolveFilenameCompleterMethod "isFloating" o = ObjectIsFloatingMethodInfo 
ResolveFilenameCompleterMethod "notify" o = ObjectNotifyMethodInfo 
ResolveFilenameCompleterMethod "notifyByPspec" o = ObjectNotifyByPspecMethodInfo 
ResolveFilenameCompleterMethod "ref" o = ObjectRefMethodInfo 
ResolveFilenameCompleterMethod "refSink" o = ObjectRefSinkMethodInfo 
ResolveFilenameCompleterMethod "runDispose" o = ObjectRunDisposeMethodInfo 
ResolveFilenameCompleterMethod "stealData" o = ObjectStealDataMethodInfo 
ResolveFilenameCompleterMethod "stealQdata" o = ObjectStealQdataMethodInfo 
ResolveFilenameCompleterMethod "thawNotify" o = ObjectThawNotifyMethodInfo 
ResolveFilenameCompleterMethod "unref" o = ObjectUnrefMethodInfo 
ResolveFilenameCompleterMethod "watchClosure" o = ObjectWatchClosureMethodInfo 
ResolveFilenameCompleterMethod "getCompletionSuffix" o = FilenameCompleterGetCompletionSuffixMethodInfo 
ResolveFilenameCompleterMethod "getCompletions" o = FilenameCompleterGetCompletionsMethodInfo 
ResolveFilenameCompleterMethod "getData" o = ObjectGetDataMethodInfo 
ResolveFilenameCompleterMethod "getProperty" o = ObjectGetPropertyMethodInfo 
ResolveFilenameCompleterMethod "getQdata" o = ObjectGetQdataMethodInfo 
ResolveFilenameCompleterMethod "setData" o = ObjectSetDataMethodInfo 
ResolveFilenameCompleterMethod "setDataFull" o = ObjectSetDataFullMethodInfo 
ResolveFilenameCompleterMethod "setDirsOnly" o = FilenameCompleterSetDirsOnlyMethodInfo 
ResolveFilenameCompleterMethod "setProperty" o = ObjectSetPropertyMethodInfo 
ResolveFilenameCompleterMethod l o = MethodResolutionFailed l o :: Type 

getCompletionSuffix

filenameCompleterGetCompletionSuffix Source #

Arguments

:: (HasCallStack, MonadIO m, IsFilenameCompleter a) 
=> a

completer: the filename completer.

-> Text

initialText: text to be completed.

-> m (Maybe Text)

Returns: a completed string, or Nothing if no completion exists. This string is not owned by GIO, so remember to free it when finished.

Obtains a completion for initialText from completer.

getCompletions

filenameCompleterGetCompletions Source #

Arguments

:: (HasCallStack, MonadIO m, IsFilenameCompleter a) 
=> a

completer: the filename completer.

-> Text

initialText: text to be completed.

-> m [Text]

Returns: array of strings with possible completions for initialText. This array must be freed by strfreev when finished.

Gets an array of completion strings for a given initial text.

new

filenameCompleterNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m FilenameCompleter

Returns: a FilenameCompleter.

Creates a new filename completer.

setDirsOnly

filenameCompleterSetDirsOnly Source #

Arguments

:: (HasCallStack, MonadIO m, IsFilenameCompleter a) 
=> a

completer: the filename completer.

-> Bool

dirsOnly: a Bool.

-> m () 

If dirsOnly is True, completer will only complete directory names, and not file names.

Signals

gotCompletionData

type FilenameCompleterGotCompletionDataCallback = IO () Source #

Emitted when the file name completion information comes available.

afterFilenameCompleterGotCompletionData :: (IsFilenameCompleter a, MonadIO m) => a -> ((?self :: a) => FilenameCompleterGotCompletionDataCallback) -> m SignalHandlerId Source #

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

after filenameCompleter #gotCompletionData 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.

onFilenameCompleterGotCompletionData :: (IsFilenameCompleter a, MonadIO m) => a -> ((?self :: a) => FilenameCompleterGotCompletionDataCallback) -> m SignalHandlerId Source #

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

on filenameCompleter #gotCompletionData callback