Struct gtk4::FileChooserWidget

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

Direct use of FileChooserWidget is deprecated 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.

Properties

search-mode

Readable | Writeable

show-time

Whether to show the time.

Readable

subtitle

Readable

Widget

can-focus

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

Readable | Writeable

focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

Enables or disables the emission of the ::query-tooltip signal on @widget.

A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

height-request

Override for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

The LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

Whether the widget will receive the default action when it is focused.

Readable | Writeable

root

The Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Override for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

accessible-role

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

FileChooser

action

The type of operation that the file chooser is performing.

Readable | Writeable

create-folders

Whether a file chooser not in FileChooserAction::Open mode will offer the user to create new folders.

Readable | Writeable

filter

The current filter for selecting files that are displayed.

Readable | Writeable

filters

A GListModel containing the filters that have been added with gtk_file_chooser_add_filter().

The returned object should not be modified. It may or may not be updated for later changes.

Readable

select-multiple

Whether to allow multiple files to be selected.

Readable | Writeable

shortcut-folders

A GListModel containing the shortcut folders that have been added with gtk_file_chooser_add_shortcut_folder().

The returned object should not be modified. It may or may not be updated for later changes.

Readable

Signals

desktop-folder

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.

Action

down-folder

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.

Action

home-folder

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.

Action

location-popup

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.

Action

location-popup-on-paste

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.

Action

location-toggle-popup

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.

Action

places-shortcut

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.

Action

quick-bookmark

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.

Action

recent-shortcut

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.

Action

search-shortcut

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.

Action

show-hidden

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.

Action

up-folder

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.

Action

Widget

destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

May result in finalization of the widget if all references are released.

This signal is not suitable for saving widget state.

direction-changed

Emitted when the text direction of a widget changes.

hide

Emitted when @widget is hidden.

keynav-failed

Emitted if keyboard navigation fails.

See WidgetExt::keynav_failed() for details.

map

Emitted when @widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with visible) and all its parents up to the toplevel widget are also visible.

The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of unmap.

mnemonic-activate

Emitted when a widget is activated via a mnemonic.

The default handler for this signal activates @widget if @group_cycling is false, or just makes @widget grab focus if @group_cycling is true.

move-focus

Emitted when the focus is moved.

Action

query-tooltip

Emitted when the widgets tooltip is about to be shown.

This happens when the has-tooltip property is true and the hover timeout has expired with the cursor hovering “above” @widget; or emitted when @widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for @widget. If this is the case true should be returned, false otherwise. Note that if @keyboard_mode is true, the values of @x and @y are undefined and should not be used.

The signal handler is free to manipulate @tooltip with the therefore destined function calls.

realize

Emitted when @widget is associated with a gdk::Surface.

This means that WidgetExt::realize() has been called or the widget has been mapped (that is, it is going to be drawn).

show

Emitted when @widget is shown.

state-flags-changed

Emitted when the widget state changes.

See WidgetExt::state_flags().

unmap

Emitted when @widget is going to be unmapped.

A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

unrealize

Emitted when the gdk::Surface associated with @widget is destroyed.

This means that WidgetExt::unrealize() has been called or the widget has been unmapped (that is, it is going to be hidden).

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.

Deprecated since 4.10

Direct use of FileChooserWidget is deprecated

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 shows_time(&self) -> bool

Available on crate feature v4_10 only.

Whether to show the time.

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_show_time_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Available on crate feature v4_10 only.

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 HasParamSpec for FileChooserWidget

type ParamSpec = ParamSpecObject

type SetValue = FileChooserWidget

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

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

fn param_spec_builder() -> Self::BuilderFn

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