Package org.gnome.gtk

Class FileDialog

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtk.FileDialog

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class FileDialog
extends GObject

A GtkFileDialog 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 open(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback), save(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback), etc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FileDialog.Builder<B extends FileDialog.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	FileDialog.FileDialogClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
FileDialog()	Creates a new GtkFileDialog object.
FileDialog(MemorySegment address)	Create a FileDialog proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected FileDialog	asParent()	Returns this instance as if it were its parent type.
static FileDialog.Builder<? extends FileDialog.Builder>	builder()	A FileDialog.Builder object constructs a FileDialog with the specified properties.
String	getAcceptLabel()	Retrieves the text used by the dialog on its accept button.
FileFilter	getDefaultFilter()	Gets the filter that will be selected by default in the file chooser dialog.
ListModel	getFilters()	Gets the filters that will be offered to the user in the file chooser dialog.
File	getInitialFile()	Gets the file that will be initially selected in the file chooser dialog.
File	getInitialFolder()	Gets the folder that will be set as the initial folder in the file chooser dialog.
String	getInitialName()	Gets the name for the file that should be initially set.
boolean	getModal()	Returns whether the file chooser dialog blocks interaction with the parent window while it is presented.
String	getTitle()	Returns the title that will be shown on the file chooser dialog.
static Type	getType()	Get the GType of the FileDialog class
void	open(@Nullable Window parent, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	This function initiates a file selection operation by presenting a file chooser dialog to the user.
File	openFinish(AsyncResult result)	Finishes the open(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call and returns the resulting file.
void	openMultiple(@Nullable Window parent, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	This function initiates a multi-file selection operation by presenting a file chooser dialog to the user.
ListModel	openMultipleFinish(AsyncResult result)	Finishes the open(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call and returns the resulting files in a GListModel.
void	save(@Nullable Window parent, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	This function initiates a file save operation by presenting a file chooser dialog to the user.
File	saveFinish(AsyncResult result)	Finishes the save(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call and returns the resulting file.
void	selectFolder(@Nullable Window parent, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	This function initiates a directory selection operation by presenting a file chooser dialog to the user.
File	selectFolderFinish(AsyncResult result)	Finishes the selectFolder(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call and returns the resulting file.
void	selectMultipleFolders(@Nullable Window parent, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	This function initiates a multi-directory selection operation by presenting a file chooser dialog to the user.
ListModel	selectMultipleFoldersFinish(AsyncResult result)	Finishes the selectMultipleFolders(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call and returns the resulting files in a GListModel.
void	setAcceptLabel(@Nullable String acceptLabel)	Sets the label shown on the file chooser's accept button.
void	setDefaultFilter(@Nullable FileFilter filter)	Sets the filter that will be selected by default in the file chooser dialog.
void	setFilters(@Nullable ListModel filters)	Sets the filters that will be offered to the user in the file chooser dialog.
void	setInitialFile(@Nullable File file)	Sets the file that will be initially selected in the file chooser dialog.
void	setInitialFolder(@Nullable File folder)	Sets the folder that will be set as the initial folder in the file chooser dialog.
void	setInitialName(@Nullable String name)	Sets the name for the file that should be initially set.
void	setModal(boolean modal)	Sets whether the file chooser dialog blocks interaction with the parent window while it is presented.
void	setTitle(String title)	Sets the title that will be shown on the file chooser dialog.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FileDialog

public FileDialog(MemorySegment address)

Create a FileDialog proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

FileDialog

public FileDialog()

Creates a new GtkFileDialog object.

Method Details

getType

public static Type getType()

Get the GType of the FileDialog class

Returns:

the GType

asParent

protected FileDialog asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

getAcceptLabel

public String getAcceptLabel()

Retrieves the text used by the dialog on its accept button.

Returns:

the label shown on the file chooser's accept button.

getDefaultFilter

public FileFilter getDefaultFilter()

Gets the filter that will be selected by default in the file chooser dialog.

Returns:

the current filter

getFilters

public ListModel getFilters()

Gets the filters that will be offered to the user in the file chooser dialog.

Returns:

the filters, as a GListModel of GtkFileFilters

getInitialFile

public File getInitialFile()

Gets the file that will be initially selected in the file chooser dialog.

Returns:

the file

getInitialFolder

public File getInitialFolder()

Gets the folder that will be set as the initial folder in the file chooser dialog.

Returns:

the folder

getInitialName

public String getInitialName()

Gets the name for the file that should be initially set.

Returns:

the name

getModal

public boolean getModal()

Returns whether the file chooser dialog blocks interaction with the parent window while it is presented.

Returns:

TRUE if the file chooser dialog is modal

getTitle

public String getTitle()

Returns the title that will be shown on the file chooser dialog.

Returns:

the title

open

public void open(@Nullable
 @Nullable Window parent,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

This function initiates a file selection operation by presenting a file chooser dialog to the user.

The callback will be called when the dialog is dismissed.

Parameters:

parent - the parent GtkWindow

cancellable - a GCancellable to cancel the operation

callback - a callback to call when the operation is complete

openFinish

public File openFinish(AsyncResult result)
                throws GErrorException

Finishes the open(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call and returns the resulting file.

Parameters:

result - a GAsyncResult

Returns:

the file that was selected. Otherwise, NULL is returned and error is set

Throws:

GErrorException - see GError

openMultiple

public void openMultiple(@Nullable
 @Nullable Window parent,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

This function initiates a multi-file selection operation by presenting a file chooser dialog to the user.

The file chooser will initially be opened in the directory Gtk.FileDialog:initial-folder.

The callback will be called when the dialog is dismissed.

Parameters:

parent - the parent GtkWindow

cancellable - a GCancellable to cancel the operation

callback - a callback to call when the operation is complete

openMultipleFinish

public ListModel openMultipleFinish(AsyncResult result)
                             throws GErrorException

Finishes the open(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call and returns the resulting files in a GListModel.

Parameters:

result - a GAsyncResult

Returns:

the file that was selected, as a GListModel of GFiles. Otherwise, NULL is returned and error is set

Throws:

GErrorException - see GError

save

public void save(@Nullable
 @Nullable Window parent,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

This function initiates a file save operation by presenting a file chooser dialog to the user.

The callback will be called when the dialog is dismissed.

Parameters:

parent - the parent GtkWindow

cancellable - a GCancellable to cancel the operation

callback - a callback to call when the operation is complete

saveFinish

public File saveFinish(AsyncResult result)
                throws GErrorException

Finishes the save(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call and returns the resulting file.

Parameters:

result - a GAsyncResult

Returns:

the file that was selected. Otherwise, NULL is returned and error is set

Throws:

GErrorException - see GError

selectFolder

public void selectFolder(@Nullable
 @Nullable Window parent,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

This function initiates a directory selection operation by presenting a file chooser dialog to the user.

If you pass initialFolder, the file chooser will initially be opened in the parent directory of that folder, otherwise, it will be in the directory Gtk.FileDialog:initial-folder.

The callback will be called when the dialog is dismissed.

Parameters:

parent - the parent GtkWindow

cancellable - a GCancellable to cancel the operation

callback - a callback to call when the operation is complete

selectFolderFinish

public File selectFolderFinish(AsyncResult result)
                        throws GErrorException

Finishes the selectFolder(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call and returns the resulting file.

Parameters:

result - a GAsyncResult

Returns:

the file that was selected. Otherwise, NULL is returned and error is set

Throws:

GErrorException - see GError

selectMultipleFolders

public void selectMultipleFolders(@Nullable
 @Nullable Window parent,
 @Nullable
 @Nullable Cancellable cancellable,
 @Nullable
 @Nullable AsyncReadyCallback callback)

This function initiates a multi-directory selection operation by presenting a file chooser dialog to the user.

The file chooser will initially be opened in the directory Gtk.FileDialog:initial-folder.

The callback will be called when the dialog is dismissed.

Parameters:

parent - the parent GtkWindow

cancellable - a GCancellable to cancel the operation

callback - a callback to call when the operation is complete

selectMultipleFoldersFinish

public ListModel selectMultipleFoldersFinish(AsyncResult result)
                                      throws GErrorException

Finishes the selectMultipleFolders(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call and returns the resulting files in a GListModel.

Parameters:

result - a GAsyncResult

Returns:

the file that was selected, as a GListModel of GFiles. Otherwise, NULL is returned and error is set

Throws:

GErrorException - see GError

setAcceptLabel

public void setAcceptLabel(@Nullable
 @Nullable String acceptLabel)

Sets the label shown on the file chooser's accept button.

Leaving the accept label unset or setting it as NULL will fall back to a default label, depending on what API is used to launch the file dialog.

Parameters:

acceptLabel - the new accept label

setDefaultFilter

public void setDefaultFilter(@Nullable
 @Nullable FileFilter filter)

Sets the filter that will be selected by default in the file chooser dialog.

If set to null, the first item in Gtk.FileDialog:filters will be used as the default filter. If that list is empty, the dialog will be unfiltered.

Parameters:

filter - a GtkFileFilter

setFilters

public void setFilters(@Nullable
 @Nullable ListModel filters)

Sets the filters that will be offered to the user in the file chooser dialog.

Parameters:

filters - a GListModel of GtkFileFilters

setInitialFile

public void setInitialFile(@Nullable
 @Nullable File file)

Sets the file that will be initially selected in the file chooser dialog.

This function is a shortcut for calling both gtk_file_dialog_set_initial_folder() and gtk_file_dialog_set_initial_name() with the directory and name of file respectively.

Parameters:

file - a GFile

setInitialFolder

public void setInitialFolder(@Nullable
 @Nullable File folder)

Sets the folder that will be set as the initial folder in the file chooser dialog.

Parameters:

folder - a GFile

setInitialName

public void setInitialName(@Nullable
 @Nullable 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.

If a file with this name already exists in the directory set via Gtk.FileDialog:initial-folder, the dialog should preselect it.

Parameters:

name - a UTF8 string

setModal

public void setModal(boolean modal)

Sets whether the file chooser dialog blocks interaction with the parent window while it is presented.

Parameters:

modal - the new value

setTitle

public void setTitle(String title)

Sets the title that will be shown on the file chooser dialog.

Parameters:

title - the new title

builder

public static FileDialog.Builder<? extends FileDialog.Builder> builder()

A FileDialog.Builder object constructs a FileDialog with the specified properties. Use the various set...() methods to set properties, and finish construction with FileDialog.Builder.build().