Package org.gnome.gtk

Class FileDialog

java.lang.Object

org.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

Asynchronous API to present a file chooser dialog.

GtkFileDialog collects the arguments that are needed to present the 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.

Since:

4.10

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 FileDialog.
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.
@Nullable String	getAcceptLabel()	Retrieves the text used by the dialog on its accept button.
@Nullable FileFilter	getDefaultFilter()	Gets the filter that will be selected by default in the file chooser dialog.
@Nullable ListModel	getFilters()	Gets the filters that will be offered to the user in the file chooser dialog.
@Nullable File	getInitialFile()	Gets the file that will be initially selected in the file chooser dialog.
@Nullable File	getInitialFolder()	Gets the folder that will be set as the initial folder in the file chooser dialog.
@Nullable String	getInitialName()	Gets the filename that will be initially selected.
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 @Nullable Type	getType()	Get the GType of the FileDialog class
void	open(@Nullable Window parent, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Presents 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.
void	openMultiple(@Nullable Window parent, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Presents 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.
void	openMultipleTextFiles(@Nullable Window parent, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Presents a file chooser dialog to the user.
ListModel	openMultipleTextFilesFinish(AsyncResult result, Out<String> encoding)	Finishes the open(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call.
void	openTextFile(@Nullable Window parent, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Initiates a file selection operation by presenting a file chooser dialog to the user.
File	openTextFileFinish(AsyncResult result, Out<String> encoding)	Finishes the openTextFile(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call and returns the resulting file and text encoding.
void	save(@Nullable Window parent, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Presents 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.
void	saveTextFile(@Nullable Window parent, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Initiates a file save operation by presenting a file chooser dialog to the user.
File	saveTextFileFinish(AsyncResult result, Out<String> encoding, Out<String> lineEnding)	Finishes the saveTextFile(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call and returns the resulting file, text encoding and line endings.
void	selectFolder(@Nullable Window parent, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Presents 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.
void	selectMultipleFolders(@Nullable Window parent, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Presents 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.
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 filename that will be initially selected.
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, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.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 FileDialog.

Method Details

getType

public static @Nullable 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 @Nullable String getAcceptLabel()

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

Returns:

the label shown on the file chooser's accept button

Since:

4.10

getDefaultFilter

public @Nullable FileFilter getDefaultFilter()

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

Returns:

the default filter

Since:

4.10

getFilters

public @Nullable ListModel getFilters()

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

Returns:

the filters, as a list model of FileFilter

Since:

4.10

getInitialFile

public @Nullable File getInitialFile()

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

Returns:

the file

Since:

4.10

getInitialFolder

public @Nullable File getInitialFolder()

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

Returns:

the folder

Since:

4.10

getInitialName

public @Nullable String getInitialName()

Gets the filename that will be initially selected.

Returns:

the name

Since:

4.10

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

Since:

4.10

getTitle

public String getTitle()

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

Returns:

the title

Since:

4.10

open

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

Presents a file chooser dialog to the user.

The file chooser dialog will be set up to select a single file.

The callback will be called when the dialog is closed.

Parameters:

parent - the parent window

cancellable - a cancellable to cancel the operation

callback - a callback to call when the operation is complete

Since:

4.10

openFinish

public File openFinish(AsyncResult result)
                throws GErrorException

Finishes the open(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call.

Note that this function returns a Gtk.DialogError.DISMISSED error if the user cancels the dialog.

Parameters:

result - the result

Returns:

the file that was selected

Throws:

GErrorException - see GError

Since:

4.10

openMultiple

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

Presents a file chooser dialog to the user.

The file chooser dialog will be set up to select multiple files.

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

The callback will be called when the dialog is closed.

Parameters:

parent - the parent window

cancellable - a cancellable to cancel the operation

callback - a callback to call when the operation is complete

Since:

4.10

openMultipleFinish

public ListModel openMultipleFinish(AsyncResult result)
                             throws GErrorException

Finishes the open(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call.

Note that this function returns a Gtk.DialogError.DISMISSED error if the user cancels the dialog.

Parameters:

result - the result

Returns:

the files that were selected, as a list model of File

Throws:

GErrorException - see GError

Since:

4.10

openMultipleTextFiles

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

Presents a file chooser dialog to the user.

The file chooser dialog will be set up to select multiple files.

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

In contrast to open(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback), this function lets the user select the text encoding for the files, if possible.

The callback will be called when the dialog is closed.

Parameters:

parent - the parent window

cancellable - a cancellable to cancel the operation

callback - a callback to call when the operation is complete

Since:

4.18

openMultipleTextFilesFinish

public ListModel openMultipleTextFilesFinish(AsyncResult result,
 Out<String> encoding)
                                      throws GErrorException

Finishes the open(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call.

Note that this function returns a Gtk.DialogError.DISMISSED error if the user cancels the dialog.

Parameters:

result - the result

encoding - return location for the text encoding to use

Returns:

the files that were selected, as a list model of File

Throws:

GErrorException - see GError

Since:

4.18

openTextFile

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

Initiates a file selection operation by presenting a file chooser dialog to the user.

In contrast to open(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback), this function lets the user select the text encoding for the file, if possible.

The callback will be called when the dialog is closed.

Parameters:

parent - the parent GtkWindow

cancellable - a GCancellable to cancel the operation

callback - a callback to call when the operation is complete

Since:

4.18

openTextFileFinish

public File openTextFileFinish(AsyncResult result,
 Out<String> encoding)
                        throws GErrorException

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

If the user has explicitly selected a text encoding to use for the file, then encoding will be set to a codeset name that is suitable for passing to iconv_open(). Otherwise, it will be NULL.

Note that this function returns a Gtk.DialogError.DISMISSED error if the user cancels the dialog.

Parameters:

result - a GAsyncResult

encoding - return location for the text encoding to use

Returns:

the file that was selected

Throws:

GErrorException - see GError

Since:

4.18

save

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

Presents a file chooser dialog to the user.

The file chooser dialog will be save mode.

The callback will be called when the dialog is closed.

Parameters:

parent - the parent window

cancellable - a cancellable to cancel the operation

callback - a callback to call when the operation is complete

Since:

4.10

saveFinish

public File saveFinish(AsyncResult result)
                throws GErrorException

Finishes the save(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call.

Note that this function returns a Gtk.DialogError.DISMISSED error if the user cancels the dialog.

Parameters:

result - the result

Returns:

the file that was selected

Throws:

GErrorException - see GError

Since:

4.10

saveTextFile

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

Initiates a file save operation by presenting a file chooser dialog to the user.

In contrast to save(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback), this function lets the user select the text encoding and line endings for the text file, if possible.

The callback will be called when the dialog is closed.

Parameters:

parent - the parent GtkWindow

cancellable - a GCancellable to cancel the operation

callback - a callback to call when the operation is complete

Since:

4.18

saveTextFileFinish

public File saveTextFileFinish(AsyncResult result,
 Out<String> encoding,
 Out<String> lineEnding)
                        throws GErrorException

Finishes the saveTextFile(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call and returns the resulting file, text encoding and line endings.

If the user has explicitly selected a text encoding to use for the file, then encoding will be set to a codeset name that is suitable for passing to iconv_open(). Otherwise, it will be NULL.

The lineEnding will be set to one of "\\n", "\\r\\n", "\\r" or "", where the latter means to preserve existing line endings.

Note that this function returns a Gtk.DialogError.DISMISSED error if the user cancels the dialog.

Parameters:

result - a GAsyncResult

encoding - return location for the text encoding to use

lineEnding - return location for the line endings to use

Returns:

the file that was selected.

Throws:

GErrorException - see GError

Since:

4.18

selectFolder

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

Presents a file chooser dialog to the user.

The file chooser dialog will be set up to select a single folder.

If you pass initialFolder, the file chooser dialog 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 closed.

Parameters:

parent - the parent window

cancellable - a cancellable to cancel the operation

callback - a callback to call when the operation is complete

Since:

4.10

selectFolderFinish

public File selectFolderFinish(AsyncResult result)
                        throws GErrorException

Finishes the selectFolder(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call.

Note that this function returns a Gtk.DialogError.DISMISSED error if the user cancels the dialog.

Parameters:

result - the result

Returns:

the folder that was selected

Throws:

GErrorException - see GError

Since:

4.10

selectMultipleFolders

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

Presents a file chooser dialog to the user.

The file chooser dialog will be set up to allow selecting multiple folders.

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

The callback will be called when the dialog is closed.

Parameters:

parent - the parent window

cancellable - a cancellable to cancel the operation

callback - a callback to call when the operation is complete

Since:

4.10

selectMultipleFoldersFinish

public ListModel selectMultipleFoldersFinish(AsyncResult result)
                                      throws GErrorException

Finishes the selectMultipleFolders(org.gnome.gtk.Window, org.gnome.gio.Cancellable, org.gnome.gio.AsyncReadyCallback) call.

Note that this function returns a Gtk.DialogError.DISMISSED error if the user cancels the dialog.

Parameters:

result - the result

Returns:

the folders that were selected, as a list model of File

Throws:

GErrorException - see GError

Since:

4.10

setAcceptLabel

public void setAcceptLabel(@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

Since:

4.10

setDefaultFilter

public void setDefaultFilter(@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 - the file filter

Since:

4.10

setFilters

public void setFilters(@Nullable ListModel filters)

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

Parameters:

filters - a list model of FileFilter

Since:

4.10

setInitialFile

public void setInitialFile(@Nullable File file)

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

This function is a shortcut for calling both setInitialFolder(org.gnome.gio.File) and setInitialName(java.lang.String) with the directory and name of file, respectively.

Parameters:

file - a file

Since:

4.10

setInitialFolder

public void setInitialFolder(@Nullable File folder)

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

Parameters:

folder - a file

Since:

4.10

setInitialName

public void setInitialName(@Nullable String name)

Sets the filename that will be initially selected.

For save dialogs, name 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 will preselect it.

Parameters:

name - a string

Since:

4.10

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

Since:

4.10

setTitle

public void setTitle(String title)

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

Parameters:

title - the new title

Since:

4.10

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().

Returns:

the builder object