gtk4/org.gtkkn.bindings.gtk/DirectoryList

DirectoryList

open class DirectoryList(pointer: <Error class: unknown class><<Error class: unknown class>>)

GtkDirectoryList is a list model that wraps g_file_enumerate_children_async().

It presents a GListModel and fills it asynchronously with the GFileInfos returned from that function.

Enumeration will start automatically when the property@Gtk.DirectoryList:file property is set.

While the GtkDirectoryList is being filled, the property@Gtk.DirectoryList:loading property will be set to true. You can listen to that property if you want to show information like a GtkSpinner or a "Loading..." text.

If loading fails at any point, the property@Gtk.DirectoryList:error property will be set to give more indication about the failure.

The GFileInfos returned from a GtkDirectoryList have the "standard::file" attribute set to the GFile they refer to. This way you can get at the file that is referred to in the same way you would via g_file_enumerator_get_child(). This means you do not need access to the GtkDirectoryList, but can access the GFile directly from the GFileInfo when operating with a GtkListView or similar.

Skipped during bindings generation

method item-type: Property has no getter nor setter
method loading: Property has no getter nor setter
method n-items: Property has no getter nor setter

Constructors

constructor(attributes: String? = null, file: <Error class: unknown class>? = null)

Creates a new GtkDirectoryList.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

object Companion

Properties

open var attributes: String?

The attributes to query.

open val error: <Error class: unknown class>?

Error encountered while loading files.

open var file: <Error class: unknown class>?

File to query.

gioListModelPointer

open val gioListModelPointer: <Error class: unknown class><<Error class: unknown class>>

gtkDirectoryListPointer

val gtkDirectoryListPointer: <Error class: unknown class><<Error class: unknown class>>

open var ioPriority: Int

Priority used when loading.

open var monitored: Boolean

true if the directory is monitored for changed.

Functions

open fun getAttributes(): String?

Gets the attributes queried on the children.

open fun getError(): <Error class: unknown class>?

Gets the loading error, if any.

open fun getFile(): <Error class: unknown class>?

Gets the file whose children are currently enumerated.

open fun getIoPriority(): Int

Gets the IO priority set via gtk_directory_list_set_io_priority().

open fun getMonitored(): Boolean

Returns whether the directory list is monitoring the directory for changes.

open fun isLoading(): Boolean

Returns true if the children enumeration is currently in progress.

open fun setAttributes(attributes: String? = null)

Sets the @attributes to be enumerated and starts the enumeration.

open fun setFile(file: <Error class: unknown class>? = null)

Sets the @file to be enumerated and starts the enumeration.

open fun setIoPriority(ioPriority: Int)

Sets the IO priority to use while loading directories.

open fun setMonitored(monitored: Boolean)

Sets whether the directory list will monitor the directory for changes.