FileDialog

A gtk.file_dialog.FileDialog object collects the arguments that are needed to present a file chooser dialog to the user, such as a title for the dialog and whether it should be modal.

The dialog is shown with gtk.file_dialog.FileDialog.open, gtk.file_dialog.FileDialog.save, etc. These APIs follow the GIO async pattern, and the result can be obtained by calling the corresponding finish function, for example gtk.file_dialog.FileDialog.openFinish.

class FileDialog : ObjectG {

this();

string getAcceptLabel();

gtk.file_filter.FileFilter getDefaultFilter();

gio.list_model.ListModel getFilters();

gio.file.File getInitialFile();

gio.file.File getInitialFolder();

string getInitialName();

bool getModal();

string getTitle();

void open(gtk.window.Window parent, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback);

gio.file.File openFinish(gio.async_result.AsyncResult result);

void openMultiple(gtk.window.Window parent, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback);

gio.list_model.ListModel openMultipleFinish(gio.async_result.AsyncResult result);

void save(gtk.window.Window parent, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback);

gio.file.File saveFinish(gio.async_result.AsyncResult result);

void selectFolder(gtk.window.Window parent, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback);

gio.file.File selectFolderFinish(gio.async_result.AsyncResult result);

void selectMultipleFolders(gtk.window.Window parent, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback);

gio.list_model.ListModel selectMultipleFoldersFinish(gio.async_result.AsyncResult result);

void setAcceptLabel(string acceptLabel);

void setDefaultFilter(gtk.file_filter.FileFilter filter);

void setFilters(gio.list_model.ListModel filters);

void setInitialFile(gio.file.File file);

void setInitialFolder(gio.file.File folder);

void setInitialName(string name);

void setModal(bool modal);

void setTitle(string title);

}

Constructors

this this(): Creates a new gtk.file_dialog.FileDialog object.

Members

Functions

getAcceptLabel string getAcceptLabel()
getDefaultFilter gtk.file_filter.FileFilter getDefaultFilter(): Gets the filter that will be selected by default in the file chooser dialog.
getFilters gio.list_model.ListModel getFilters(): Gets the filters that will be offered to the user in the file chooser dialog.
getInitialFile gio.file.File getInitialFile(): Gets the file that will be initially selected in the file chooser dialog.
getInitialFolder gio.file.File getInitialFolder(): Gets the folder that will be set as the initial folder in the file chooser dialog.
getInitialName string getInitialName(): Gets the name for the file that should be initially set.
getModal bool getModal(): Returns whether the file chooser dialog blocks interaction with the parent window while it is presented.
getTitle string getTitle(): Returns the title that will be shown on the file chooser dialog.
open void open(gtk.window.Window parent, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback): This function initiates a file selection operation by presenting a file chooser dialog to the user.
openFinish gio.file.File openFinish(gio.async_result.AsyncResult result): Finishes the gtk.file_dialog.FileDialog.open call and returns the resulting file.
openMultiple void openMultiple(gtk.window.Window parent, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback): This function initiates a multi-file selection operation by presenting a file chooser dialog to the user.
openMultipleFinish gio.list_model.ListModel openMultipleFinish(gio.async_result.AsyncResult result): Finishes the gtk.file_dialog.FileDialog.open call and returns the resulting files in a gio.list_model.ListModel.
save void save(gtk.window.Window parent, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback): This function initiates a file save operation by presenting a file chooser dialog to the user.
saveFinish gio.file.File saveFinish(gio.async_result.AsyncResult result): Finishes the gtk.file_dialog.FileDialog.save call and returns the resulting file.
selectFolder void selectFolder(gtk.window.Window parent, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback): This function initiates a directory selection operation by presenting a file chooser dialog to the user.
selectFolderFinish gio.file.File selectFolderFinish(gio.async_result.AsyncResult result): Finishes the gtk.file_dialog.FileDialog.selectFolder call and returns the resulting file.
selectMultipleFolders void selectMultipleFolders(gtk.window.Window parent, gio.cancellable.Cancellable cancellable, gio.types.AsyncReadyCallback callback): This function initiates a multi-directory selection operation by presenting a file chooser dialog to the user.
selectMultipleFoldersFinish gio.list_model.ListModel selectMultipleFoldersFinish(gio.async_result.AsyncResult result): Finishes the gtk.file_dialog.FileDialog.selectMultipleFolders call and returns the resulting files in a gio.list_model.ListModel.
setAcceptLabel void setAcceptLabel(string acceptLabel): Sets the label shown on the file chooser's accept button.
setDefaultFilter void setDefaultFilter(gtk.file_filter.FileFilter filter): Sets the filter that will be selected by default in the file chooser dialog.
setFilters void setFilters(gio.list_model.ListModel filters): Sets the filters that will be offered to the user in the file chooser dialog.
setInitialFile void setInitialFile(gio.file.File file): Sets the file that will be initially selected in the file chooser dialog.
setInitialFolder void setInitialFolder(gio.file.File folder): Sets the folder that will be set as the initial folder in the file chooser dialog.
setInitialName void setInitialName(string name): Sets the name for the file that should be initially set. For saving dialogs, this will usually be pre-entered into the name field.
setModal void setModal(bool modal): Sets whether the file chooser dialog blocks interaction with the parent window while it is presented.
setTitle void setTitle(string title): Sets the title that will be shown on the file chooser dialog.

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.

gtk file_dialog classes

FileDialog