DirectoryList

gtk.directory_list.DirectoryList is a list model that wraps gio.file.File.enumerateChildrenAsync.

It presents a gio.list_model.ListModel and fills it asynchronously with the gio.file_info.FileInfos returned from that function.

Enumeration will start automatically when the gtk.directory_list.DirectoryList.Gio.File property is set.

While the gtk.directory_list.DirectoryList is being filled, the gtk.directory_list.DirectoryList.gboolean property will be set to true. You can listen to that property if you want to show information like a gtk.spinner.Spinner or a "Loading..." text.

If loading fails at any point, the gtk.directory_list.DirectoryList.GLib.Error property will be set to give more indication about the failure.

The gio.file_info.FileInfos returned from a gtk.directory_list.DirectoryList have the "standard::file" attribute set to the gio.file.File they refer to. This way you can get at the file that is referred to in the same way you would via gio.file_enumerator.FileEnumerator.getChild. This means you do not need access to the gtk.directory_list.DirectoryList, but can access the gio.file.File directly from the gio.file_info.FileInfo when operating with a gtk.list_view.ListView or similar.

class DirectoryList : ObjectG , ListModel {

this(string attributes, gio.file.File file);

string getAttributes();

glib.error.ErrorG getError();

gio.file.File getFile();

int getIoPriority();

bool getMonitored();

bool isLoading();

void setAttributes(string attributes);

void setFile(gio.file.File file);

void setIoPriority(int ioPriority);

void setMonitored(bool monitored);

}

Constructors

this this(string attributes, gio.file.File file): Creates a new gtk.directory_list.DirectoryList.

Members

Functions

getAttributes string getAttributes(): Gets the attributes queried on the children.
getError glib.error.ErrorG getError(): Gets the loading error, if any.
getFile gio.file.File getFile(): Gets the file whose children are currently enumerated.
getIoPriority int getIoPriority(): Gets the IO priority set via gtk.directory_list.DirectoryList.setIoPriority.
getMonitored bool getMonitored(): Returns whether the directory list is monitoring the directory for changes.
isLoading bool isLoading(): Returns true if the children enumeration is currently in progress.
setAttributes void setAttributes(string attributes): Sets the attributes to be enumerated and starts the enumeration.
setFile void setFile(gio.file.File file): Sets the file to be enumerated and starts the enumeration.
setIoPriority void setIoPriority(int ioPriority): Sets the IO priority to use while loading directories.
setMonitored void setMonitored(bool monitored): Sets whether the directory list will monitor the directory for changes.

Mixed In Members

From `mixin ListModelT!()`

getItem T getItem(uint position): Get the item at position and cast to the template type. NOTE: If type is an interface and no known D object is found that the object conforms to, the interface IfaceProxy object will be used. If position is greater than the number of items in list, %NULL is returned. %NULL may be returned if index is smaller than the length of the list, but the object does not conform to the template type. This function is meant to be used by language bindings in place of Gio.ListModel.getItem. See also: Gio.ListModel.getNItems
getItemType gobject.types.GType getItemType(): Gets the type of the items in list.
getNItems uint getNItems(): Gets the number of items in list.
getItem gobject.object.ObjectG getItem(uint position): Get the item at position.
itemsChanged void itemsChanged(uint position, uint removed, uint added): Emits the #GListModel::items-changed signal on list.
connectItemsChanged ulong connectItemsChanged(T callback, Flag!"After" after): Connect to ItemsChanged signal.

Inherited Members

From ObjectG

setGObject void setGObject(void* cObj, Flag!"Take" take): Set the GObject of a D ObjectG wrapper.
cPtr void* cPtr(Flag!"Dup" dup): Get a pointer to the underlying C object.
ref_ void* ref_(void* gObj): Calls g_object_ref() on a GObject.
unref unref(void* gObj): Calls g_object_unref() on a GObject.
getType GType getType(): Get the GType of an object.
gType GType gType [@property getter]: GObject GType property.
self ObjectG self(): Convenience method to return this cast to a type. For use in D with statements.
getDObject T getDObject(void* cptr, Flag!"Take" take): Template to get the D object from a C GObject and cast it to the given D object type.
connectSignalClosure ulong connectSignalClosure(string signalDetail, DClosure closure, Flag!"After" after): Connect a D closure to an object signal.
setProperty void setProperty(string propertyName, T val): Template for setting a GObject property.
getProperty T getProperty(string propertyName): Template for getting a GObject property.
compatControl size_t compatControl(size_t what, void* data)
bindProperty gobject.binding.Binding bindProperty(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags): Creates a binding between source_property on source and target_property on target.
bindPropertyFull gobject.binding.Binding bindPropertyFull(string sourceProperty, gobject.object.ObjectG target, string targetProperty, gobject.types.BindingFlags flags, gobject.closure.Closure transformTo, gobject.closure.Closure transformFrom): Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.
forceFloating void forceFloating(): This function is intended for #GObject implementations to re-enforce a floating[floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling gobject.object.ObjectG.refSink.
freezeNotify void freezeNotify(): Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.
getData void* getData(string key): Gets a named field from the objects table of associations (see gobject.object.ObjectG.setData).
getProperty void getProperty(string propertyName, gobject.value.Value value): Gets a property of an object.
getQdata void* getQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata.
getv void getv(string[] names, gobject.value.Value[] values): Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.
isFloating bool isFloating(): Checks whether object has a floating[floating-ref] reference.
notify void notify(string propertyName): Emits a "notify" signal for the property property_name on object.
notifyByPspec void notifyByPspec(gobject.param_spec.ParamSpec pspec): Emits a "notify" signal for the property specified by pspec on object.
refSink gobject.object.ObjectG refSink(): Increase the reference count of object, and possibly remove the floating[floating-ref] reference, if object has a floating reference.
runDispose void runDispose(): Releases all references to other objects. This can be used to break reference cycles.
setData void setData(string key, void* data): Each object carries around a table of associations from strings to pointers. This function lets you set an association.
setProperty void setProperty(string propertyName, gobject.value.Value value): Sets a property on an object.
stealData void* stealData(string key): Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
stealQdata void* stealQdata(glib.types.Quark quark): This function gets back user data pointers stored via gobject.object.ObjectG.setQdata and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:
thawNotify void thawNotify(): Reverts the effect of a previous call to gobject.object.ObjectG.freezeNotify. The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.
watchClosure void watchClosure(gobject.closure.Closure closure): This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling gobject.closure.Closure.invalidate on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, gobject.object.ObjectG.ref_ and gobject.object.ObjectG.unref are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.
connectNotify ulong connectNotify(string detail, T callback, Flag!"After" after): Connect to Notify signal.

From ListModel

getItem T getItem(uint position): Get the item at position and cast to the template type. NOTE: If type is an interface and no known D object is found that the object conforms to, the interface IfaceProxy object will be used. If position is greater than the number of items in list, %NULL is returned. %NULL may be returned if index is smaller than the length of the list, but the object does not conform to the template type. This function is meant to be used by language bindings in place of Gio.ListModel.getItem. See also: Gio.ListModel.getNItems
getItemType gobject.types.GType getItemType(): Gets the type of the items in list.
getNItems uint getNItems(): Gets the number of items in list.
getItem gobject.object.ObjectG getItem(uint position): Get the item at position.
itemsChanged void itemsChanged(uint position, uint removed, uint added): Emits the #GListModel::items-changed signal on list.
connectItemsChanged ulong connectItemsChanged(T callback, Flag!"After" after): Connect to ItemsChanged signal.

gtk directory_list classes

DirectoryList