Basics

Guides

API Reference

Menu

Basics

Guides

API Reference

class: FileChooserWidgetDesktopfolderCallback

[493:7] extends: object

Generated low-level callback wrapper for GIR callback desktop-folder.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • FileChooserWidgetDesktopfolderCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: FileChooserWidgetMeta

[1335:14] static extends: object

Generated metadata helpers for FileChooserWidget class surfaces.

Methods

  • properties ()

    Returns property metadata for FileChooserWidget.

    • @r A list.
  • signals ()

    Returns signal metadata for FileChooserWidget.

    • @r A list.

class: FileChooserWidgetUpfolderCallback

[1265:7] extends: object

Generated low-level callback wrapper for GIR callback up-folder.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • FileChooserWidgetUpfolderCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: FileChooserWidget

[31:7] extends: object

GtkFileChooserWidget is a widget for choosing files. It exposes the [iface@Gtk.FileChooser] interface, and you should use the methods of this interface to interact with the widget. # Shortcuts and Gestures GtkFileChooserWidget supports the following keyboard shortcuts: - Shift+F10 or Menu opens the context menu. The following signals have default keybindings: - [signal@Gtk.FileChooserWidget::desktop-folder] - [signal@Gtk.FileChooserWidget::down-folder] - [signal@Gtk.FileChooserWidget::home-folder] - [signal@Gtk.FileChooserWidget::location-popup] - [signal@Gtk.FileChooserWidget::location-popup-on-paste] - [signal@Gtk.FileChooserWidget::location-toggle-popup] - [signal@Gtk.FileChooserWidget::places-shortcut] - [signal@Gtk.FileChooserWidget::quick-bookmark] - [signal@Gtk.FileChooserWidget::recent-shortcut] - [signal@Gtk.FileChooserWidget::search-shortcut] - [signal@Gtk.FileChooserWidget::show-hidden] - [signal@Gtk.FileChooserWidget::up-folder] # CSS nodes GtkFileChooserWidget has a single CSS node with name filechooser.

Members

  • handleObj
  • lib
  • retainedCallbacks
  • signalHandlerNames
  • signalSetterHandlers

Methods

  • FileChooserWidget (action = null)

    Creates a new GtkFileChooserWidget. This is a file chooser widget that can be embedded in custom windows, and it is the same widget that is used by GtkFileChooserDialog.

    • @p action is Open or save mode for the widget.
  • toNativeHandle (Source)

    Normalizes a constructor argument into a raw pointer carrier. Accepts a raw NativeHandle, a raw NativeBuffer returned from fn.call(...), another generated wrapper exposing handle(), or null. Returns null when the argument carries no pointer.

    • @p Source is the raw handle, raw buffer, wrapper, or null.
    • @r A raw pointer carrier or null when no pointer is present.
  • getLib ()

    Returns the opened native library for this generated wrapper.

    • @r The opened native library.
  • handle ()

    Returns the wrapped NativeHandle.

    • @r The wrapped NativeHandle.
  • isNull ()

    Returns true when the wrapped handle is null.

    • @r A bool.
  • describe ()

    Returns a small string for debugging generated wrappers.

    • @r A string.
  • asWidget ()

    Wraps this handle as Widget.

    • @r A Widget object.
  • asAccessible ()

    Wraps this handle as Accessible.

    • @r A Accessible object.
  • asBuildable ()

    Wraps this handle as Buildable.

    • @r A Buildable object.
  • asConstraintTarget ()

    Wraps this handle as ConstraintTarget.

    • @r A ConstraintTarget object.
  • asFileChooser ()

    Wraps this handle as FileChooser.

    • @r A FileChooser object.
  • connectSignal (string Name, CallbackObj)

    Connects one generated callback wrapper to a named signal.

    • @p Name is the signal name.
    • @p CallbackObj is the generated callback wrapper to connect.
    • @r The connected handler id.
  • disconnectSignalHandler (int HandlerId)

    Disconnects one retained signal handler id.

    • @p HandlerId is the signal handler id to disconnect.
    • @r None.
  • setOnDesktopfolder (callback Fn, UserData = null)

    Emitted when the user asks for it. This is a keybinding signal. This is used to make the file chooser show the user's Desktop folder in the file list. The default binding for this signal is Alt-D.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (FileChooserWidget Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • setOnDownfolder (callback Fn, UserData = null)

    Emitted when the user asks for it. This is a keybinding signal. This is used to make the file chooser go to a child of the current folder in the file hierarchy. The subfolder that will be used is displayed in the path bar widget of the file chooser. For example, if the path bar is showing "/foo/bar/baz", with bar currently displayed, then this will cause the file chooser to switch to the "baz" subfolder. The default binding for this signal is Alt-Down.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (FileChooserWidget Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • setOnHomefolder (callback Fn, UserData = null)

    Emitted when the user asks for it. This is a keybinding signal. This is used to make the file chooser show the user's home folder in the file list. The default binding for this signal is Alt-Home.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (FileChooserWidget Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • setOnLocationpopup (callback Fn, UserData = null)

    Emitted when the user asks for it. This is a keybinding signal. This is used to make the file chooser show a "Location" prompt which the user can use to manually type the name of the file he wishes to select. The default bindings for this signal are Control-L with a @path string of "" (the empty string). It is also bound to / with a @path string of "/" (a slash): this lets you type / and immediately type a path name. On Unix systems, this is bound to ~ (tilde) with a @path string of "~" itself for access to home directories.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (FileChooserWidget Self, string Path).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • setOnLocationpopuponpaste (callback Fn, UserData = null)

    Emitted when the user asks for it. This is a keybinding signal. This is used to make the file chooser show a "Location" prompt when the user pastes into a GtkFileChooserWidget. The default binding for this signal is Control-V.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (FileChooserWidget Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • setOnLocationtogglepopup (callback Fn, UserData = null)

    Emitted when the user asks for it. This is a keybinding signal. This is used to toggle the visibility of a "Location" prompt which the user can use to manually type the name of the file he wishes to select. The default binding for this signal is Control-L.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (FileChooserWidget Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • setOnPlacesshortcut (callback Fn, UserData = null)

    Emitted when the user asks for it. This is a keybinding signal. This is used to move the focus to the places sidebar. The default binding for this signal is Alt-P.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (FileChooserWidget Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • setOnQuickbookmark (callback Fn, UserData = null)

    Emitted when the user asks for it. This is a keybinding signal. This is used to make the file chooser switch to the bookmark specified in the @bookmark_index parameter. For example, if you have three bookmarks, you can pass 0, 1, 2 to this signal to switch to each of them, respectively. The default binding for this signal is Alt-1, Alt-2, etc. until Alt-0. Note that in the default binding, that Alt-1 is actually defined to switch to the bookmark at index 0, and so on successively.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (FileChooserWidget Self, int Bookmark_index).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • setOnRecentshortcut (callback Fn, UserData = null)

    Emitted when the user asks for it. This is a keybinding signal. This is used to make the file chooser show the Recent location. The default binding for this signal is Alt-R.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (FileChooserWidget Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • setOnSearchshortcut (callback Fn, UserData = null)

    Emitted when the user asks for it. This is a keybinding signal. This is used to make the file chooser show the search entry. The default binding for this signal is Alt-S.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (FileChooserWidget Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • setOnShowhidden (callback Fn, UserData = null)

    Emitted when the user asks for it. This is a keybinding signal. This is used to make the file chooser display hidden files. The default binding for this signal is Control-H.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (FileChooserWidget Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • setOnUpfolder (callback Fn, UserData = null)

    Emitted when the user asks for it. This is a keybinding signal. This is used to make the file chooser go to the parent of the current folder in the file hierarchy. The default binding for this signal is Alt-Up.

    • @p Fn is the Aussom callback.
    • @p Fn is called with (FileChooserWidget Self).
    • @p UserData is retained and passed through to the generated callback wrapper when provided.
    • @r The connected handler id.
  • getProperty (string Name)

    Reads one generated property by name.

  • setProperty (string Name, Value)

    Writes one generated property by name.

  • setSearchmode (bool Value)

    Whether search mode is enabled.

    • @p Value is the new property value.
    • @r None.

class: FileChooserWidgetLocationtogglepopupCallback

[845:7] extends: object

Generated low-level callback wrapper for GIR callback location-toggle-popup.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • FileChooserWidgetLocationtogglepopupCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: FileChooserWidgetQuickbookmarkCallback

[985:7] extends: object

Generated low-level callback wrapper for GIR callback quick-bookmark.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • FileChooserWidgetQuickbookmarkCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (nativeSelf, bookmark_index, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: FileChooserWidgetLocationpopuponpasteCallback

[774:7] extends: object

Generated low-level callback wrapper for GIR callback location-popup-on-paste.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • FileChooserWidgetLocationpopuponpasteCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: FileChooserWidgetHomefolderCallback

[633:7] extends: object

Generated low-level callback wrapper for GIR callback home-folder.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • FileChooserWidgetHomefolderCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: FileChooserWidgetPlacesshortcutCallback

[915:7] extends: object

Generated low-level callback wrapper for GIR callback places-shortcut.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • FileChooserWidgetPlacesshortcutCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: FileChooserWidgetLocationpopupCallback

[703:7] extends: object

Generated low-level callback wrapper for GIR callback location-popup.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • FileChooserWidgetLocationpopupCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (nativeSelf, path, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: FileChooserWidgetDownfolderCallback

[563:7] extends: object

Generated low-level callback wrapper for GIR callback down-folder.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • FileChooserWidgetDownfolderCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: FileChooserWidgetSearchshortcutCallback

[1125:7] extends: object

Generated low-level callback wrapper for GIR callback search-shortcut.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • FileChooserWidgetSearchshortcutCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: FileChooserWidgetRecentshortcutCallback

[1055:7] extends: object

Generated low-level callback wrapper for GIR callback recent-shortcut.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • FileChooserWidgetRecentshortcutCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.

class: FileChooserWidgetShowhiddenCallback

[1195:7] extends: object

Generated low-level callback wrapper for GIR callback show-hidden.

Members

  • callbackObj
  • userFn
  • userData
  • hasUserData

Methods

  • FileChooserWidgetShowhiddenCallback (callback Fn, UserData = null)

    Creates one native callback wrapper. The wrapper owns a trampoline that converts native pointers into generated wrapper objects before invoking Fn.

    • @p Fn is the Aussom callback implementation.
    • @p UserData is retained and passed through to Fn on each invocation when provided.
  • trampoline (nativeSelf, nativeUserData)

    Internal trampoline. Converts native pointer arguments into generated wrapper instances, then invokes the user's callback.

  • callback ()

    Returns the wrapped NativeCallback.

  • handle ()

    Returns the callback as a NativeHandle.

  • close ()

    Closes the underlying NativeCallback.

  • isClosed ()

    Returns true when the callback has been closed.