[−]Struct gtk::FileChooser

pub struct FileChooser(_, _);

FileChooser is an interface that can be implemented by file selection widgets. In GTK+, the main objects that implement this interface are FileChooserWidget, FileChooserDialog, and FileChooserButton. You do not need to write an object that implements the FileChooser interface unless you are trying to adapt an existing file selector to expose a standard programming interface.

FileChooser allows for shortcuts to various places in the filesystem. In the default implementation these are displayed in the left pane. It may be a bit confusing at first that these shortcuts come from various sources and in various flavours, so lets explain the terminology here:

Bookmarks: are created by the user, by dragging folders from the right pane to the left pane, or by using the “Add”. Bookmarks can be renamed and deleted by the user.
Shortcuts: can be provided by the application. For example, a Paint program may want to add a shortcut for a Clipart folder. Shortcuts cannot be modified by the user.
Volumes: are provided by the underlying filesystem abstraction. They are the “roots” of the filesystem.

File Names and Encodings

When the user is finished selecting files in a FileChooser, your program can get the selected names either as filenames or as URIs. For URIs, the normal escaping rules are applied if the URI contains non-ASCII characters. However, filenames are always returned in the character set specified by the G_FILENAME_ENCODING environment variable. Please see the GLib documentation for more details about this variable.

This means that while you can pass the result of FileChooser::get_filename to open or fopen, you may not be able to directly set it as the text of a Label widget unless you convert it first to UTF-8, which all GTK+ widgets expect. You should use g_filename_to_utf8 to convert filenames into strings that can be passed to GTK+ widgets.

Adding a Preview Widget

You can add a custom preview widget to a file chooser and then get notification about when the preview needs to be updated. To install a preview widget, use FileChooser::set_preview_widget. Then, connect to the FileChooser::update-preview signal to get notified when you need to update the contents of the preview.

Your callback should use FileChooser::get_preview_filename to see what needs previewing. Once you have generated the preview for the corresponding file, you must call FileChooser::set_preview_widget_active with a boolean flag that indicates whether your callback could successfully generate a preview.

Example: Using a Preview Widget ## {`gtkfilechooser`-preview}

{
  GtkImage *preview;

  ...

  preview = gtk_image_new ();

  gtk_file_chooser_set_preview_widget (my_file_chooser, preview);
  g_signal_connect (my_file_chooser, "update-preview",
            G_CALLBACK (update_preview_cb), preview);
}

static void
update_preview_cb (GtkFileChooser *file_chooser, gpointer data)
{
  GtkWidget *preview;
  char *filename;
  GdkPixbuf *pixbuf;
  gboolean have_preview;

  preview = GTK_WIDGET (data);
  filename = gtk_file_chooser_get_preview_filename (file_chooser);

  pixbuf = gdk_pixbuf_new_from_file_at_size (filename, 128, 128, NULL);
  have_preview = (pixbuf != NULL);
  g_free (filename);

  gtk_image_set_from_pixbuf (GTK_IMAGE (preview), pixbuf);
  if (pixbuf)
    g_object_unref (pixbuf);

  gtk_file_chooser_set_preview_widget_active (file_chooser, have_preview);
}

Adding Extra Widgets

You can add extra widgets to a file chooser to provide options that are not present in the default design. For example, you can add a toggle button to give the user the option to open a file in read-only mode. You can use FileChooser::set_extra_widget to insert additional widgets in a file chooser.

An example for adding extra widgets:


  GtkWidget *toggle;

  ...

  toggle = gtk_check_button_new_with_label ("Open file read-only");
  gtk_widget_show (toggle);
  gtk_file_chooser_set_extra_widget (my_file_chooser, toggle);
}

If you want to set more than one extra widget in the file chooser, you can a container such as a Box or a Grid and include your widgets in it. Then, set the container as the whole extra widget.

Implements

FileChooserExt

Trait Implementations

`impl Clone for FileChooser`

`fn clone(&self) -> FileChooser`

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Debug for FileChooser`

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

`impl Display for FileChooser`[src]

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

`impl Eq for FileChooser`

`impl Hash for FileChooser`

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

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

`impl IsA<FileChooser> for FileChooserButton`

`impl IsA<FileChooser> for FileChooserDialog`

`impl IsA<FileChooser> for FileChooserNative`

`impl IsA<FileChooser> for FileChooserWidget`

`impl Ord for FileChooser`

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

`#[must_use]fn max(self, other: Self) -> Self`1.21.0[src]

`#[must_use]fn min(self, other: Self) -> Self`1.21.0[src]

`#[must_use]fn clamp(self, min: Self, max: Self) -> Self`[src]

`impl<T: ObjectType> PartialEq<T> for FileChooser`

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

`#[must_use]fn ne(&self, other: &Rhs) -> bool`1.0.0[src]

`impl<T: ObjectType> PartialOrd<T> for FileChooser`

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

`#[must_use]fn lt(&self, other: &Rhs) -> bool`1.0.0[src]

`#[must_use]fn le(&self, other: &Rhs) -> bool`1.0.0[src]

`#[must_use]fn gt(&self, other: &Rhs) -> bool`1.0.0[src]

`#[must_use]fn ge(&self, other: &Rhs) -> bool`1.0.0[src]

`impl StaticType for FileChooser`

`fn static_type() -> Type`

Auto Trait Implementations

`impl RefUnwindSafe for FileChooser`

`impl !Send for FileChooser`

`impl !Sync for FileChooser`

`impl Unpin for FileChooser`

`impl UnwindSafe for FileChooser`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<Super, Sub> CanDowncast for Super where Sub: IsA<Super>, Super: IsA<Super>,`

`impl<T> Cast for T where T: ObjectType,`

`fn upcast<T>(self) -> T where Self: IsA<T>, T: ObjectType,`

`fn upcast_ref<T>(&self) -> &T where Self: IsA<T>, T: ObjectType,`

`fn downcast<T>(self) -> Result<T, Self> where Self: CanDowncast<T>, T: ObjectType,`

`fn downcast_ref<T>(&self) -> Option<&T> where Self: CanDowncast<T>, T: ObjectType,`

`fn dynamic_cast<T>(self) -> Result<T, Self> where T: ObjectType,`

`fn dynamic_cast_ref<T>(&self) -> Option<&T> where T: ObjectType,`

`unsafe fn unsafe_cast<T>(self) -> T where T: ObjectType,`

`unsafe fn unsafe_cast_ref<T>(&self) -> &T where T: ObjectType,`

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> ObjectExt for T where T: ObjectType,`

`fn is(&self) -> bool where U: StaticType,`

`fn get_type(&self) -> Type`

`fn get_object_class(&self) -> &ObjectClass`

`fn set_properties( &self, property_values: &[(&str, &dyn ToValue)] ) -> Result<(), BoolError>`

`fn set_property<'a, N>( &self, property_name: N, value: &dyn ToValue ) -> Result<(), BoolError> where N: Into<&'a str>,`

`fn get_property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where N: Into<&'a str>,`

`unsafe fn set_qdata<QD>(&self, key: Quark, value: QD) where QD: 'static,`

`unsafe fn get_qdata<QD>(&self, key: Quark) -> Option<&QD> where QD: 'static,`

`unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD> where QD: 'static,`

`unsafe fn set_data<QD>(&self, key: &str, value: QD) where QD: 'static,`

`unsafe fn get_data<QD>(&self, key: &str) -> Option<&QD> where QD: 'static,`

`unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD> where QD: 'static,`

`fn block_signal(&self, handler_id: &SignalHandlerId)`

`fn unblock_signal(&self, handler_id: &SignalHandlerId)`

`fn stop_signal_emission(&self, signal_name: &str)`

`fn disconnect(&self, handler_id: SignalHandlerId)`

`fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where F: 'static + Send + Sync + Fn(&T, &ParamSpec),`

`unsafe fn connect_notify_unsafe<F>( &self, name: Option<&str>, f: F ) -> SignalHandlerId where F: Fn(&T, &ParamSpec),`

`fn notify<'a, N>(&self, property_name: N) where N: Into<&'a str>,`

`fn notify_by_pspec(&self, pspec: &ParamSpec)`

`fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where N: Into<&'a str>,`

`fn get_property_type<'a, N>(&self, property_name: N) -> Option<Type> where N: Into<&'a str>,`

`fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where N: Into<&'a str>,`

`fn list_properties(&self) -> Vec<ParamSpec>`

`fn connect<'a, N, F>( &self, signal_name: N, after: bool, callback: F ) -> Result<SignalHandlerId, BoolError> where F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static, N: Into<&'a str>,`

`fn connect_local<'a, N, F>( &self, signal_name: N, after: bool, callback: F ) -> Result<SignalHandlerId, BoolError> where F: Fn(&[Value]) -> Option<Value> + 'static, N: Into<&'a str>,`

`unsafe fn connect_unsafe<'a, N, F>( &self, signal_name: N, after: bool, callback: F ) -> Result<SignalHandlerId, BoolError> where F: Fn(&[Value]) -> Option<Value>, N: Into<&'a str>,`

`fn emit<'a, N>( &self, signal_name: N, args: &[&dyn ToValue] ) -> Result<Option<Value>, BoolError> where N: Into<&'a str>,`

`fn downgrade(&self) -> WeakRef<T>`

`fn bind_property<'a, O, N, M>( &'a self, source_property: N, target: &'a O, target_property: M ) -> BindingBuilder<'a> where M: Into<&'a str>, N: Into<&'a str>, O: ObjectType,`

`fn ref_count(&self) -> u32`

`impl<'a, T> ToGlibContainerFromSlice<'a, *const GList> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,`

`type Storage = (Option<List>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (const GList, <T as ToGlibContainerFromSlice<'a, const GList>>::Storage)`

`fn to_glib_container_from_slice( _t: &'a [T] ) -> (const GList, <T as ToGlibContainerFromSlice<'a, const GList>>::Storage)`

`fn to_glib_full_from_slice(_t: &[T]) -> *const GList`

`impl<'a, T> ToGlibContainerFromSlice<'a, *const GPtrArray> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,`

`type Storage = (Option<PtrArray>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (const GPtrArray, <T as ToGlibContainerFromSlice<'a, const GPtrArray>>::Storage)`

`fn to_glib_container_from_slice( _t: &'a [T] ) -> (const GPtrArray, <T as ToGlibContainerFromSlice<'a, const GPtrArray>>::Storage)`

`fn to_glib_full_from_slice(_t: &[T]) -> *const GPtrArray`

`impl<'a, T> ToGlibContainerFromSlice<'a, *mut GArray> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,`

`type Storage = (Option<Array>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (mut GArray, <T as ToGlibContainerFromSlice<'a, mut GArray>>::Storage)`

`fn to_glib_container_from_slice( t: &'a [T] ) -> (mut GArray, <T as ToGlibContainerFromSlice<'a, mut GArray>>::Storage)`

`fn to_glib_full_from_slice(t: &[T]) -> *mut GArray`

`impl<'a, T> ToGlibContainerFromSlice<'a, *mut GList> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,`

`type Storage = (Option<List>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (mut GList, <T as ToGlibContainerFromSlice<'a, mut GList>>::Storage)`

`fn to_glib_container_from_slice( t: &'a [T] ) -> (mut GList, <T as ToGlibContainerFromSlice<'a, mut GList>>::Storage)`

`fn to_glib_full_from_slice(t: &[T]) -> *mut GList`

`impl<'a, T> ToGlibContainerFromSlice<'a, *mut GPtrArray> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,`

`type Storage = (Option<PtrArray>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (mut GPtrArray, <T as ToGlibContainerFromSlice<'a, mut GPtrArray>>::Storage)`

`fn to_glib_container_from_slice( t: &'a [T] ) -> (mut GPtrArray, <T as ToGlibContainerFromSlice<'a, mut GPtrArray>>::Storage)`

`fn to_glib_full_from_slice(t: &[T]) -> *mut GPtrArray`

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T> ToSendValue for T where T: ToValue + SetValue + Send + ?Sized,`

`fn to_send_value(&self) -> SendValue`

`impl<T> ToString for T where T: Display + ?Sized,` [src]

`default fn to_string(&self) -> String`[src]

`impl<T> ToValue for T where T: SetValue + ?Sized,`

`fn to_value(&self) -> Value`

`fn to_value_type(&self) -> Type`

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src]

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, >::Error>`[src]

[−]Struct gtk::FileChooser

File Names and Encodings

Adding a Preview Widget

Example: Using a Preview Widget ## {gtkfilechooser-preview}

Adding Extra Widgets

Implements

Trait Implementations

impl Clone for FileChooser

fn clone(&self) -> FileChooser

fn clone_from(&mut self, source: &Self)1.0.0[src]

impl Debug for FileChooser

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

impl Display for FileChooser[src]

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

impl Eq for FileChooser

impl Hash for FileChooser

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

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

impl IsA<FileChooser> for FileChooserButton

impl IsA<FileChooser> for FileChooserDialog

impl IsA<FileChooser> for FileChooserNative

impl IsA<FileChooser> for FileChooserWidget

impl Ord for FileChooser

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

#[must_use]fn max(self, other: Self) -> Self1.21.0[src]

#[must_use]fn min(self, other: Self) -> Self1.21.0[src]

#[must_use]fn clamp(self, min: Self, max: Self) -> Self[src]

impl<T: ObjectType> PartialEq<T> for FileChooser

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

#[must_use]fn ne(&self, other: &Rhs) -> bool1.0.0[src]

impl<T: ObjectType> PartialOrd<T> for FileChooser

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

#[must_use]fn lt(&self, other: &Rhs) -> bool1.0.0[src]

#[must_use]fn le(&self, other: &Rhs) -> bool1.0.0[src]

#[must_use]fn gt(&self, other: &Rhs) -> bool1.0.0[src]

#[must_use]fn ge(&self, other: &Rhs) -> bool1.0.0[src]

impl StaticType for FileChooser

fn static_type() -> Type

Auto Trait Implementations

impl RefUnwindSafe for FileChooser

impl !Send for FileChooser

impl !Sync for FileChooser

impl Unpin for FileChooser

impl UnwindSafe for FileChooser

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized, [src]

fn type_id(&self) -> TypeId[src]

impl<T> Borrow<T> for T where T: ?Sized, [src]

fn borrow(&self) -> &T[src]

impl<T> BorrowMut<T> for T where T: ?Sized, [src]

fn borrow_mut(&mut self) -> &mut T[src]

impl<Super, Sub> CanDowncast<Sub> for Super where Sub: IsA<Super>, Super: IsA<Super>,

impl<T> Cast for T where T: ObjectType,

fn upcast<T>(self) -> T where Self: IsA<T>, T: ObjectType,

fn upcast_ref<T>(&self) -> &T where Self: IsA<T>, T: ObjectType,

fn downcast<T>(self) -> Result<T, Self> where Self: CanDowncast<T>, T: ObjectType,

fn downcast_ref<T>(&self) -> Option<&T> where Self: CanDowncast<T>, T: ObjectType,

fn dynamic_cast<T>(self) -> Result<T, Self> where T: ObjectType,

fn dynamic_cast_ref<T>(&self) -> Option<&T> where T: ObjectType,

unsafe fn unsafe_cast<T>(self) -> T where T: ObjectType,

unsafe fn unsafe_cast_ref<T>(&self) -> &T where T: ObjectType,

impl<T> From<T> for T[src]

fn from(t: T) -> T[src]

impl<T, U> Into<U> for T where U: From<T>, [src]

fn into(self) -> U[src]

impl<T> ObjectExt for T where T: ObjectType,

fn is<U>(&self) -> bool where U: StaticType,

fn get_type(&self) -> Type

fn get_object_class(&self) -> &ObjectClass

fn set_properties( &self, property_values: &[(&str, &dyn ToValue)]) -> Result<(), BoolError>

fn set_property<'a, N>( &self, property_name: N, value: &dyn ToValue) -> Result<(), BoolError> where N: Into<&'a str>,

fn get_property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where N: Into<&'a str>,

unsafe fn set_qdata<QD>(&self, key: Quark, value: QD) where QD: 'static,

unsafe fn get_qdata<QD>(&self, key: Quark) -> Option<&QD> where QD: 'static,

unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD> where QD: 'static,

unsafe fn set_data<QD>(&self, key: &str, value: QD) where QD: 'static,

unsafe fn get_data<QD>(&self, key: &str) -> Option<&QD> where QD: 'static,

unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD> where QD: 'static,

fn block_signal(&self, handler_id: &SignalHandlerId)

fn unblock_signal(&self, handler_id: &SignalHandlerId)