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

Methods

gobjectType :: IO GType

IsGValue FilenameCompleter

Convert FilenameCompleter to and from GValue with toGValue and fromGValue.

Defined in GI.Gio.Objects.FilenameCompleter

Methods

toGValue :: FilenameCompleter -> IO GValue

fromGValue :: GValue -> IO FilenameCompleter

HasParentTypes FilenameCompleter

Defined in GI.Gio.Objects.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.

noFilenameCompleter :: Maybe FilenameCompleter

A convenience alias for Nothing :: Maybe FilenameCompleter.

Methods

Overloaded methods

getCompletionSuffix

filenameCompleterGetCompletionSuffix

Arguments

:: (HasCallStack, MonadIO m, IsFilenameCompleter a)

=> a

completer: the filename completer.

-> Text

initialText: text to be completed.

-> m 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 C_FilenameCompleterGotCompletionDataCallback = Ptr () -> Ptr () -> IO ()

Type for the callback on the (unwrapped) C side.

type FilenameCompleterGotCompletionDataCallback = IO ()

Emitted when the file name completion information comes available.

afterFilenameCompleterGotCompletionData :: (IsFilenameCompleter a, MonadIO m) => 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

genClosure_FilenameCompleterGotCompletionData :: MonadIO m => FilenameCompleterGotCompletionDataCallback -> m (GClosure C_FilenameCompleterGotCompletionDataCallback)

Wrap the callback into a GClosure.

mk_FilenameCompleterGotCompletionDataCallback :: C_FilenameCompleterGotCompletionDataCallback -> IO (FunPtr C_FilenameCompleterGotCompletionDataCallback)

Generate a function pointer callable from C code, from a C_FilenameCompleterGotCompletionDataCallback.

noFilenameCompleterGotCompletionDataCallback :: Maybe FilenameCompleterGotCompletionDataCallback

A convenience synonym for Nothing :: Maybe FilenameCompleterGotCompletionDataCallback.

onFilenameCompleterGotCompletionData :: (IsFilenameCompleter a, MonadIO m) => 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

wrap_FilenameCompleterGotCompletionDataCallback :: FilenameCompleterGotCompletionDataCallback -> C_FilenameCompleterGotCompletionDataCallback

Wrap a FilenameCompleterGotCompletionDataCallback into a C_FilenameCompleterGotCompletionDataCallback.