GI.Gio.Objects.FilenameCompleter

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.

Exported types

newtype FilenameCompleter

Memory-managed wrapper type.

Constructors

FilenameCompleter (ManagedPtr FilenameCompleter)

Instances

Eq FilenameCompleter

Defined in GI.Gio.Objects.FilenameCompleter

Methods

(==) :: FilenameCompleter -> FilenameCompleter -> Bool

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

GObject FilenameCompleter

Defined in GI.Gio.Objects.FilenameCompleter

ManagedPtrNewtype FilenameCompleter

Defined in GI.Gio.Objects.FilenameCompleter

Methods

toManagedPtr :: FilenameCompleter -> ManagedPtr FilenameCompleter

TypedObject FilenameCompleter

Defined in GI.Gio.Objects.FilenameCompleter

Methods

glibType :: IO GType

HasParentTypes FilenameCompleter

Defined in GI.Gio.Objects.FilenameCompleter

IsGValue (Maybe FilenameCompleter)

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

Defined in GI.Gio.Objects.FilenameCompleter

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes FilenameCompleter

Defined in GI.Gio.Objects.FilenameCompleter

type ParentTypes FilenameCompleter = '[Object]

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

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

Instances

(GObject o, IsDescendantOf FilenameCompleter o) => IsFilenameCompleter o

Defined in GI.Gio.Objects.FilenameCompleter

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

Cast to FilenameCompleter, 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

getCompletionSuffix, getCompletions, getData, getProperty, getQdata.

Setters

setData, setDataFull, setDirsOnly, setProperty.

getCompletionSuffix

filenameCompleterGetCompletionSuffix

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

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

Arguments

:: (HasCallStack, MonadIO m)

=> m FilenameCompleter

Returns: a FilenameCompleter.

Creates a new filename completer.

setDirsOnly

filenameCompleterSetDirsOnly

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

Emitted when the file name completion information comes available.

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

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

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