Struct gtk4::FileChooserWidget

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

FileChooserWidget is a widget for choosing files.

It exposes the FileChooser interface, and you should use the methods of this interface to interact with the widget.

CSS nodes

FileChooserWidget has a single CSS node with name filechooser.

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, FileChooserExt, WidgetExtManual, AccessibleExtManual, FileChooserExtManual

Implementations

impl FileChooserWidget

pub fn new(action: FileChooserAction) -> FileChooserWidget

Creates a new FileChooserWidget.

This is a file chooser widget that can be embedded in custom windows, and it is the same widget that is used by FileChooserDialog.

action

Open or save mode for the widget

Returns

a new FileChooserWidget

pub fn builder() -> FileChooserWidgetBuilder

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

This method returns an instance of FileChooserWidgetBuilder which can be used to create FileChooserWidget objects.

pub fn is_search_mode(&self) -> bool

pub fn set_search_mode(&self, search_mode: bool)

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

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

Emitted when the user asks for it.

This is a keybinding signal.

This is used to make the file chooser show the user’s Desktop folder in the file list.

The default binding for this signal is Alt-D.

pub fn emit_desktop_folder(&self)

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

Emitted when the user asks for it.

This is a keybinding signal.

This is used to make the file chooser go to a child of the current folder in the file hierarchy. The subfolder that will be used is displayed in the path bar widget of the file chooser. For example, if the path bar is showing “/foo/bar/baz”, with bar currently displayed, then this will cause the file chooser to switch to the “baz” subfolder.

The default binding for this signal is Alt-Down.

pub fn emit_down_folder(&self)

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

Emitted when the user asks for it.

This is a keybinding signal.

This is used to make the file chooser show the user’s home folder in the file list.

The default binding for this signal is Alt-Home.

pub fn emit_home_folder(&self)

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

Emitted when the user asks for it.

This is a keybinding signal.

This is used to make the file chooser show a “Location” prompt which the user can use to manually type the name of the file he wishes to select.

The default bindings for this signal are Control-L with a @path string of “” (the empty string). It is also bound to / with a @path string of “/” (a slash): this lets you type / and immediately type a path name. On Unix systems, this is bound to ~ (tilde) with a @path string of “~” itself for access to home directories.

path

a string that gets put in the text entry for the file name

pub fn emit_location_popup(&self, path: &str)

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

Emitted when the user asks for it.

This is a keybinding signal.

This is used to make the file chooser show a “Location” prompt when the user pastes into a FileChooserWidget.

The default binding for this signal is Control-V.

pub fn emit_location_popup_on_paste(&self)

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

Emitted when the user asks for it.

This is a keybinding signal.

This is used to toggle the visibility of a “Location” prompt which the user can use to manually type the name of the file he wishes to select.

The default binding for this signal is Control-L.

pub fn emit_location_toggle_popup(&self)

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

Emitted when the user asks for it.

This is a keybinding signal.

This is used to move the focus to the places sidebar.

The default binding for this signal is Alt-P.

pub fn emit_places_shortcut(&self)

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

Emitted when the user asks for it.

This is a keybinding signal.

This is used to make the file chooser switch to the bookmark specified in the @bookmark_index parameter. For example, if you have three bookmarks, you can pass 0, 1, 2 to this signal to switch to each of them, respectively.

The default binding for this signal is Alt-1, Alt-2, etc. until Alt-0. Note that in the default binding, that Alt-1 is actually defined to switch to the bookmark at index 0, and so on successively.

bookmark_index

the number of the bookmark to switch to

pub fn emit_quick_bookmark(&self, bookmark_index: i32)

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

Emitted when the user asks for it.

This is a keybinding signal.

This is used to make the file chooser show the Recent location.

The default binding for this signal is Alt-R.

pub fn emit_recent_shortcut(&self)

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

Emitted when the user asks for it.

This is a keybinding signal.

This is used to make the file chooser show the search entry.

The default binding for this signal is Alt-S.

pub fn emit_search_shortcut(&self)

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

Emitted when the user asks for it.

This is a keybinding signal.

This is used to make the file chooser display hidden files.

The default binding for this signal is Control-H.

pub fn emit_show_hidden(&self)

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

Emitted when the user asks for it.

This is a keybinding signal.

This is used to make the file chooser go to the parent of the current folder in the file hierarchy.

The default binding for this signal is Alt-Up.

pub fn emit_up_folder(&self)

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

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

Trait Implementations

impl Clone for FileChooserWidget

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 FileChooserWidget

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

Formats the value using the given formatter.

impl Default for FileChooserWidget

fn default() -> Self

Returns the “default value” for a type.

impl Display for FileChooserWidget

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

Formats the value using the given formatter.

impl Hash for FileChooserWidget

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 FileChooserWidget

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 FileChooserWidget

type Parent = Widget

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

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 FileChooserWidget

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 FileChooserWidget

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for FileChooserWidget

impl IsA<Accessible> for FileChooserWidget

impl IsA<Buildable> for FileChooserWidget

impl IsA<ConstraintTarget> for FileChooserWidget

impl IsA<FileChooser> for FileChooserWidget

impl IsA<Widget> for FileChooserWidget