Struct gtk4::FileDialog

#[repr(transparent)]
pub struct FileDialog { /* private fields */ }

Available on crate feature v4_10 only.

A 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 open(), save(), etc. These APIs follow the GIO async pattern, and the result can be obtained by calling the corresponding finish function, for example Gtk::FileDialog::open_finish().

Properties

accept-label

Label for the file chooser’s accept button.

Readable | Writeable

default-filter

The default filter, that is, the filter that is initially active in the file chooser dialog.

If the default filter is None, the first filter of filters is used as the default filter. If that property contains no filter, the dialog will be unfiltered.

If filters is not None, the default filter should be part of the list. If it is not, the dialog may choose to not make it available.

Readable | Writeable

filters

The list of filters.

See default-filter about how those two properties interact.

Readable | Writeable

initial-file

The inital file, that is, the file that is initially selected in the file chooser dialog

This is a utility property that sets both initial-folder and initial-name.

Readable | Writeable

initial-folder

The inital folder, that is, the directory that is initially opened in the file chooser dialog

Readable | Writeable

initial-name

The inital name, that is, the filename that is initially selected in the file chooser dialog.

Readable | Writeable

modal

Whether the file chooser dialog is modal.

Readable | Writeable

title

A title that may be shown on the file chooser dialog.

Readable | Writeable

Implements

glib::ObjectExt

Implementations

impl FileDialog

pub fn new() -> FileDialog

Creates a new FileDialog object.

Returns

the new FileDialog

pub fn builder() -> FileDialogBuilder

Creates a new builder-pattern struct instance to construct FileDialog objects.

This method returns an instance of FileDialogBuilder which can be used to create FileDialog objects.

pub fn accept_label(&self) -> Option<GString>

Returns

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

pub fn default_filter(&self) -> Option<FileFilter>

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

Returns

the current filter

pub fn filters(&self) -> Option<ListModel>

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

Returns

the filters, as a GListModel of GtkFileFilters

pub fn initial_file(&self) -> Option<File>

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

Returns

the file

pub fn initial_folder(&self) -> Option<File>

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

Returns

the folder

pub fn initial_name(&self) -> Option<GString>

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

Returns

the name

pub fn is_modal(&self) -> bool

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

pub fn title(&self) -> GString

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

Returns

the title

pub fn open<P: FnOnce(Result<File, Error>) + 'static>( &self, parent: Option<&impl IsA<Window>>, cancellable: Option<&impl IsA<Cancellable>>, callback: P )

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. It should call Gtk::FileDialog::open_finish() to obtain the result.

parent

the parent Window

cancellable

a GCancellable to cancel the operation

callback

a callback to call when the operation is complete

pub fn open_future( &self, parent: Option<&impl IsA<Window> + Clone + 'static> ) -> Pin<Box_<dyn Future<Output = Result<File, Error>> + 'static>>

pub fn open_multiple<P: FnOnce(Result<ListModel, Error>) + 'static>( &self, parent: Option<&impl IsA<Window>>, cancellable: Option<&impl IsA<Cancellable>>, callback: P )

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 initial-folder.

The @callback will be called when the dialog is dismissed. It should call Gtk::FileDialog::open_multiple_finish() to obtain the result.

parent

the parent Window

cancellable

a GCancellable to cancel the operation

callback

a callback to call when the operation is complete

pub fn open_multiple_future( &self, parent: Option<&impl IsA<Window> + Clone + 'static> ) -> Pin<Box_<dyn Future<Output = Result<ListModel, Error>> + 'static>>

pub fn save<P: FnOnce(Result<File, Error>) + 'static>( &self, parent: Option<&impl IsA<Window>>, cancellable: Option<&impl IsA<Cancellable>>, callback: P )

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. It should call Gtk::FileDialog::save_finish() to obtain the result.

parent

the parent Window

cancellable

a GCancellable to cancel the operation

callback

a callback to call when the operation is complete

pub fn save_future( &self, parent: Option<&impl IsA<Window> + Clone + 'static> ) -> Pin<Box_<dyn Future<Output = Result<File, Error>> + 'static>>

pub fn select_folder<P: FnOnce(Result<File, Error>) + 'static>( &self, parent: Option<&impl IsA<Window>>, cancellable: Option<&impl IsA<Cancellable>>, callback: P )

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

If you pass @initial_folder, the file chooser will initially be opened in the parent directory of that folder, otherwise, it will be in the directory initial-folder.

The @callback will be called when the dialog is dismissed. It should call Gtk::FileDialog::select_folder_finish() to obtain the result.

parent

the parent Window

cancellable

a GCancellable to cancel the operation

callback

a callback to call when the operation is complete

pub fn select_folder_future( &self, parent: Option<&impl IsA<Window> + Clone + 'static> ) -> Pin<Box_<dyn Future<Output = Result<File, Error>> + 'static>>

pub fn select_multiple_folders<P: FnOnce(Result<Option<ListModel>, Error>) + 'static>( &self, parent: Option<&impl IsA<Window>>, cancellable: Option<&impl IsA<Cancellable>>, callback: P )

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 initial-folder.

The @callback will be called when the dialog is dismissed. It should call Gtk::FileDialog::select_multiple_folders_finish() to obtain the result.

parent

the parent Window

cancellable

a GCancellable to cancel the operation

callback

a callback to call when the operation is complete

pub fn select_multiple_folders_future( &self, parent: Option<&impl IsA<Window> + Clone + 'static> ) -> Pin<Box_<dyn Future<Output = Result<Option<ListModel>, Error>> + 'static>>

pub fn set_accept_label(&self, accept_label: Option<&str>)

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.

accept_label

the new accept label

pub fn set_default_filter(&self, filter: Option<&FileFilter>)

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

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

filter

a FileFilter

pub fn set_filters(&self, filters: &impl IsA<ListModel>)

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

filters

a GListModel of GtkFileFilters

pub fn set_initial_file(&self, file: Option<&impl IsA<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.

file

a GFile

pub fn set_initial_folder(&self, folder: Option<&impl IsA<File>>)

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

folder

a GFile

pub fn set_initial_name(&self, name: Option<&str>)

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 initial-folder, the dialog should preselect it.

name

a UTF8 string

pub fn set_modal(&self, modal: bool)

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

modal

the new value

pub fn set_title(&self, title: &str)

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

title

the new title

pub fn connect_accept_label_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_default_filter_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_filters_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_initial_file_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_initial_folder_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_initial_name_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_modal_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_title_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations

impl Clone for FileDialog

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FileDialog

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FileDialog

fn default() -> Self

Returns the “default value” for a type.

impl Display for FileDialog

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for FileDialog

type ParamSpec = ParamSpecObject

type SetValue = FileDialog

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, FileDialog>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for FileDialog

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FileDialog

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for FileDialog

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for FileDialog

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for FileDialog

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for FileDialog

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for FileDialog