Skip to main content

FileChooser

Struct FileChooser 

Source
pub struct FileChooser { /* private fields */ }
๐Ÿ‘ŽDeprecated:

Since 4.10

Expand description

Use FileDialog instead FileChooser is an interface that can be implemented by file selection widgets.

In GTK, the main objects that implement this interface are FileChooserWidget and FileChooserDialog.

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 filenames as GFiles.

ยงAdding options

You can add extra widgets to a file chooser to provide options that are not present in the default design, by using FileChooserExtManual::add_choice(). Each choice has an identifier and a user visible label; additionally, each choice can have multiple options. If a choice has no option, it will be rendered as a check button with the given label; if a choice has options, it will be rendered as a combo box.

ยงProperties

ยงaction

The type of operation that the file chooser is performing.

Readable | Writable

ยงcreate-folders

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

Readable | Writable

ยงfilter

The current filter for selecting files that are displayed.

Readable | Writable

ยง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 | Writable

ยง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

ยงImplements

FileChooserExt, FileChooserExtManual

GLib type: GObject with reference counted clone semantics.

Implementationsยง

Sourceยง

impl FileChooser

Source

pub const NONE: Option<&'static FileChooser> = None

๐Ÿ‘ŽDeprecated:

Since 4.10

Trait Implementationsยง

Sourceยง

impl Clone for FileChooser

Sourceยง

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

1.0.0 (const: unstable) ยท Sourceยง

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

Performs copy-assignment from source. Read more
Sourceยง

impl Debug for FileChooser

Sourceยง

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

Formats the value using the given formatter. Read more
Sourceยง

impl Eq for FileChooser

Sourceยง

impl HasParamSpec for FileChooser

Sourceยง

type ParamSpec = ParamSpecObject

Sourceยง

type SetValue = FileChooser

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

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

Sourceยง

fn param_spec_builder() -> Self::BuilderFn

Sourceยง

impl Hash for FileChooser

Sourceยง

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

Hashes the memory address of this object.

1.3.0 ยท Sourceยง

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

Feeds a slice of this type into the given Hasher. Read more
Sourceยง

impl IsA<FileChooser> for FileChooserDialog

Sourceยง

impl IsA<FileChooser> for FileChooserNative

Sourceยง

impl IsA<FileChooser> for FileChooserWidget

Sourceยง

impl Ord for FileChooser

Sourceยง

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

1.21.0 (const: unstable) ยท Sourceยง

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

Compares and returns the maximum of two values. Read more
1.21.0 (const: unstable) ยท Sourceยง

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

Compares and returns the minimum of two values. Read more
1.50.0 (const: unstable) ยท Sourceยง

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Sourceยง

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

Sourceยง

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

1.0.0 (const: unstable) ยท Sourceยง

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Sourceยง

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

Sourceยง

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

1.0.0 (const: unstable) ยท Sourceยง

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 (const: unstable) ยท Sourceยง

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 (const: unstable) ยท Sourceยง

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 (const: unstable) ยท Sourceยง

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Sourceยง

impl StaticType for FileChooser

Sourceยง

fn static_type() -> Type

Returns the type identifier of Self.

Auto Trait Implementationsยง

Blanket Implementationsยง

Sourceยง

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

Sourceยง

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Sourceยง

impl<T> Borrow<T> for T
where T: ?Sized,

Sourceยง

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Sourceยง

impl<T> BorrowMut<T> for T
where T: ?Sized,

Sourceยง

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
ยง

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

ยง

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

Upcasts an object to a superclass or interface T. Read more
ยง

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

Upcasts an object to a reference of its superclass or interface T. Read more
ยง

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

Tries to downcast to a subclass or interface implementor T. Read more
ยง

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

Tries to downcast to a reference of its subclass or interface implementor T. Read more
ยง

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

Tries to cast to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while upcast will do many checks at compile-time already. downcast will perform the same checks at runtime as dynamic_cast, but will also ensure some amount of compile-time safety. Read more
ยง

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

Tries to cast to reference to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more
ยง

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

Casts to T unconditionally. Read more
ยง

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

Casts to &T unconditionally. Read more
Sourceยง

impl<T> CloneToUninit for T
where T: Clone,

Sourceยง

unsafe fn clone_to_uninit(&self, dest: *mut u8)

๐Ÿ”ฌThis is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Sourceยง

impl<O> FileChooserExt for O
where O: IsA<FileChooser>,

Sourceยง

fn add_filter(&self, filter: &FileFilter)

๐Ÿ‘ŽDeprecated:

Since 4.10

Adds @filter to the list of filters that the user can select between. Read more
Sourceยง

fn add_shortcut_folder(&self, folder: &impl IsA<File>) -> Result<(), Error>

๐Ÿ‘ŽDeprecated:

Since 4.10

Adds a folder to be displayed with the shortcut folders in a file chooser. Read more
Sourceยง

fn action(&self) -> FileChooserAction

๐Ÿ‘ŽDeprecated:

Since 4.10

Gets the type of operation that the file chooser is performing. Read more
Sourceยง

fn choice(&self, id: &str) -> Option<GString>

๐Ÿ‘ŽDeprecated:

Since 4.10

Gets the currently selected option in the โ€˜choiceโ€™ with the given ID. Read more
Sourceยง

fn creates_folders(&self) -> bool

๐Ÿ‘ŽDeprecated:

Since 4.10

Gets whether file chooser will offer to create new folders. Read more
Sourceยง

fn current_folder(&self) -> Option<File>

๐Ÿ‘ŽDeprecated:

Since 4.10

Gets the current folder of @self as GFile. Read more
Sourceยง

fn current_name(&self) -> Option<GString>

๐Ÿ‘ŽDeprecated:

Since 4.10

Gets the current name in the file selector, as entered by the user. Read more
Sourceยง

fn file(&self) -> Option<File>

๐Ÿ‘ŽDeprecated:

Since 4.10

Gets the GFile for the currently selected file in the file selector. Read more
Sourceยง

fn files(&self) -> ListModel

๐Ÿ‘ŽDeprecated:

Since 4.10

Lists all the selected files and subfolders in the current folder of @self as GFile. Read more
Sourceยง

fn filter(&self) -> Option<FileFilter>

๐Ÿ‘ŽDeprecated:

Since 4.10

Gets the current filter. Read more
Sourceยง

fn filters(&self) -> ListModel

๐Ÿ‘ŽDeprecated:

Since 4.10

Gets the current set of user-selectable filters, as a list model. Read more
Sourceยง

fn selects_multiple(&self) -> bool

๐Ÿ‘ŽDeprecated:

Since 4.10

Gets whether multiple files can be selected in the file chooser. Read more
Sourceยง

fn shortcut_folders(&self) -> ListModel

๐Ÿ‘ŽDeprecated:

Since 4.10

Queries the list of shortcut folders in the file chooser. Read more
Sourceยง

fn remove_choice(&self, id: &str)

๐Ÿ‘ŽDeprecated:

Since 4.10

Removes a โ€˜choiceโ€™ that has been added with gtk_file_chooser_add_choice(). Read more
Sourceยง

fn remove_filter(&self, filter: &FileFilter)

๐Ÿ‘ŽDeprecated:

Since 4.10

Removes @filter from the list of filters that the user can select between. Read more
Sourceยง

fn remove_shortcut_folder(&self, folder: &impl IsA<File>) -> Result<(), Error>

๐Ÿ‘ŽDeprecated:

Since 4.10

Removes a folder from the shortcut folders in a file chooser. Read more
Sourceยง

fn set_action(&self, action: FileChooserAction)

๐Ÿ‘ŽDeprecated:

Since 4.10

Sets the type of operation that the chooser is performing. Read more
Sourceยง

fn set_choice(&self, id: &str, option: &str)

๐Ÿ‘ŽDeprecated:

Since 4.10

Selects an option in a โ€˜choiceโ€™ that has been added with gtk_file_chooser_add_choice(). Read more
Sourceยง

fn set_create_folders(&self, create_folders: bool)

๐Ÿ‘ŽDeprecated:

Since 4.10

Sets whether file chooser will offer to create new folders. Read more
Sourceยง

fn set_current_name(&self, name: &str)

๐Ÿ‘ŽDeprecated:

Since 4.10

Sets the current name in the file selector, as if entered by the user. Read more
Sourceยง

fn set_file(&self, file: &impl IsA<File>) -> Result<(), Error>

๐Ÿ‘ŽDeprecated:

Since 4.10

Sets @file as the current filename for the file chooser. Read more
Sourceยง

fn set_filter(&self, filter: &FileFilter)

๐Ÿ‘ŽDeprecated:

Since 4.10

Sets the current filter. Read more
Sourceยง

fn set_select_multiple(&self, select_multiple: bool)

๐Ÿ‘ŽDeprecated:

Since 4.10

Sets whether multiple files can be selected in the file chooser. Read more
Sourceยง

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

๐Ÿ‘ŽDeprecated:

Since 4.10

Sourceยง

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

๐Ÿ‘ŽDeprecated:

Since 4.10

Sourceยง

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

๐Ÿ‘ŽDeprecated:

Since 4.10

Sourceยง

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

๐Ÿ‘ŽDeprecated:

Since 4.10

Sourceยง

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

๐Ÿ‘ŽDeprecated:

Since 4.10

Sourceยง

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

๐Ÿ‘ŽDeprecated:

Since 4.10

Sourceยง

impl<O> FileChooserExtManual for O
where O: IsA<FileChooser>,

Sourceยง

fn add_choice( &self, id: impl IntoGStr, label: impl IntoGStr, options: &[(&str, &str)], )

๐Ÿ‘ŽDeprecated:

Since 4.10

Adds a โ€˜choiceโ€™ to the file chooser. Read more
Sourceยง

fn set_current_folder( &self, file: Option<&impl IsA<File>>, ) -> Result<bool, Error>

๐Ÿ‘ŽDeprecated:

Since 4.10

Sets the current folder for @self from a GFile. Read more
Sourceยง

impl<T> From<T> for T

Sourceยง

fn from(t: T) -> T

Returns the argument unchanged.

ยง

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

ยง

unsafe fn from_glib_none_num_as_vec(ptr: *const GList, num: usize) -> Vec<T>

ยง

unsafe fn from_glib_container_num_as_vec(_: *const GList, _: usize) -> Vec<T>

ยง

unsafe fn from_glib_full_num_as_vec(_: *const GList, _: usize) -> Vec<T>

ยง

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

ยง

unsafe fn from_glib_none_num_as_vec(ptr: *const GPtrArray, num: usize) -> Vec<T>

ยง

unsafe fn from_glib_container_num_as_vec( _: *const GPtrArray, _: usize, ) -> Vec<T>

ยง

unsafe fn from_glib_full_num_as_vec(_: *const GPtrArray, _: usize) -> Vec<T>

ยง

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

ยง

unsafe fn from_glib_none_num_as_vec(ptr: *const GSList, num: usize) -> Vec<T>

ยง

unsafe fn from_glib_container_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

ยง

unsafe fn from_glib_full_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

ยง

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

ยง

unsafe fn from_glib_none_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

ยง

unsafe fn from_glib_container_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

ยง

unsafe fn from_glib_full_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

ยง

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

ยง

unsafe fn from_glib_none_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

ยง

unsafe fn from_glib_container_num_as_vec( ptr: *mut GPtrArray, num: usize, ) -> Vec<T>

ยง

unsafe fn from_glib_full_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

ยง

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

ยง

unsafe fn from_glib_none_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

ยง

unsafe fn from_glib_container_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

ยง

unsafe fn from_glib_full_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

ยง

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

ยง

unsafe fn from_glib_none_as_vec(ptr: *const GList) -> Vec<T>

ยง

unsafe fn from_glib_container_as_vec(_: *const GList) -> Vec<T>

ยง

unsafe fn from_glib_full_as_vec(_: *const GList) -> Vec<T>

ยง

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

ยง

unsafe fn from_glib_none_as_vec(ptr: *const GPtrArray) -> Vec<T>

ยง

unsafe fn from_glib_container_as_vec(_: *const GPtrArray) -> Vec<T>

ยง

unsafe fn from_glib_full_as_vec(_: *const GPtrArray) -> Vec<T>

ยง

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

ยง

unsafe fn from_glib_none_as_vec(ptr: *const GSList) -> Vec<T>

ยง

unsafe fn from_glib_container_as_vec(_: *const GSList) -> Vec<T>

ยง

unsafe fn from_glib_full_as_vec(_: *const GSList) -> Vec<T>

ยง

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

ยง

unsafe fn from_glib_none_as_vec(ptr: *mut GList) -> Vec<T>

ยง

unsafe fn from_glib_container_as_vec(ptr: *mut GList) -> Vec<T>

ยง

unsafe fn from_glib_full_as_vec(ptr: *mut GList) -> Vec<T>

ยง

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

ยง

unsafe fn from_glib_none_as_vec(ptr: *mut GPtrArray) -> Vec<T>

ยง

unsafe fn from_glib_container_as_vec(ptr: *mut GPtrArray) -> Vec<T>

ยง

unsafe fn from_glib_full_as_vec(ptr: *mut GPtrArray) -> Vec<T>

ยง

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T
where T: GlibPtrDefault + FromGlibPtrNone<<T as GlibPtrDefault>::GlibType> + FromGlibPtrFull<<T as GlibPtrDefault>::GlibType>,

ยง

unsafe fn from_glib_none_as_vec(ptr: *mut GSList) -> Vec<T>

ยง

unsafe fn from_glib_container_as_vec(ptr: *mut GSList) -> Vec<T>

ยง

unsafe fn from_glib_full_as_vec(ptr: *mut GSList) -> Vec<T>

ยง

impl<'a, T, C, E> FromValueOptional<'a> for T
where T: FromValue<'a, Checker = C>, C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError<E>>, E: Error + Send + 'static,

Sourceยง

impl<O> GObjectPropertyExpressionExt for O
where O: IsA<Object>,

Sourceยง

fn property_expression(&self, property_name: &str) -> PropertyExpression

Create an expression looking up an objectโ€™s property.
Sourceยง

fn property_expression_weak(&self, property_name: &str) -> PropertyExpression

Create an expression looking up an objectโ€™s property with a weak reference.
Sourceยง

fn this_expression(property_name: &str) -> PropertyExpression

Create an expression looking up a property in the bound this object.
Sourceยง

impl<T, U> Into<U> for T
where U: From<T>,

Sourceยง

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

ยง

impl<T> IntoClosureReturnValue for T
where T: Into<Value>,

ยง

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

ยง

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

ยง

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

Returns true if the object is an instance of (can be cast to) T.
ยง

fn type_(&self) -> Type

Returns the type of the object.
ยง

fn object_class(&self) -> &Class<Object>

Returns the [ObjectClass] of the object. Read more
ยง

fn class(&self) -> &Class<T>
where T: IsClass,

Returns the class of the object.
ยง

fn class_of<U>(&self) -> Option<&Class<U>>
where U: IsClass,

Returns the class of the object in the given type T. Read more
ยง

fn interface<U>(&self) -> Option<InterfaceRef<'_, U>>
where U: IsInterface,

Returns the interface T of the object. Read more
ยง

fn set_property(&self, property_name: &str, value: impl Into<Value>)

Sets the property property_name of the object to value value. Read more
ยง

fn set_property_from_value(&self, property_name: &str, value: &Value)

Sets the property property_name of the object to value value. Read more
ยง

fn set_properties(&self, property_values: &[(&str, &dyn ToValue)])

Sets multiple properties of the object at once. Read more
ยง

fn set_properties_from_value(&self, property_values: &[(&str, Value)])

Sets multiple properties of the object at once. Read more
ยง

fn property<V>(&self, property_name: &str) -> V
where V: for<'b> FromValue<'b> + 'static,

Gets the property property_name of the object and cast it to the type V. Read more
ยง

fn property_value(&self, property_name: &str) -> Value

Gets the property property_name of the object. Read more
ยง

fn has_property(&self, property_name: &str) -> bool

Check if the object has a property property_name.
ยง

fn has_property_with_type(&self, property_name: &str, type_: Type) -> bool

Check if the object has a property property_name of the given type_.
ยง

fn property_type(&self, property_name: &str) -> Option<Type>

Get the type of the property property_name of this object. Read more
ยง

fn find_property(&self, property_name: &str) -> Option<ParamSpec>

Get the ParamSpec of the property property_name of this object.
ยง

fn list_properties(&self) -> PtrSlice<ParamSpec>

Return all ParamSpec of the properties of this object.
ยง

fn freeze_notify(&self) -> PropertyNotificationFreezeGuard

Freeze all property notifications until the return guard object is dropped. Read more
ยง

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

Set arbitrary data on this object with the given key. Read more
ยง

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

Return previously set arbitrary data of this object with the given key. Read more
ยง

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

Retrieve previously set arbitrary data of this object with the given key. Read more
ยง

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

Set arbitrary data on this object with the given key. Read more
ยง

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

Return previously set arbitrary data of this object with the given key. Read more
ยง

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

Retrieve previously set arbitrary data of this object with the given key. Read more
ยง

fn block_signal(&self, handler_id: &SignalHandlerId)

Block a given signal handler. Read more
ยง

fn unblock_signal(&self, handler_id: &SignalHandlerId)

Unblock a given signal handler.
ยง

fn stop_signal_emission(&self, signal_id: SignalId, detail: Option<Quark>)

Stop emission of the currently emitted signal.
ยง

fn stop_signal_emission_by_name(&self, signal_name: &str)

Stop emission of the currently emitted signal by the (possibly detailed) signal name.
ยง

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

Connect to the signal signal_name on this object. Read more
ยง

fn connect_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F, ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,

Connect to the signal signal_id on this object. Read more
ยง

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

Connect to the signal signal_name on this object. Read more
ยง

fn connect_local_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F, ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + 'static,

Connect to the signal signal_id on this object. Read more
ยง

unsafe fn connect_unsafe<F>( &self, signal_name: &str, after: bool, callback: F, ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value>,

Connect to the signal signal_name on this object. Read more
ยง

unsafe fn connect_unsafe_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F, ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value>,

Connect to the signal signal_id on this object. Read more
ยง

fn connect_closure( &self, signal_name: &str, after: bool, closure: RustClosure, ) -> SignalHandlerId

Connect a closure to the signal signal_name on this object. Read more
ยง

fn connect_closure_id( &self, signal_id: SignalId, details: Option<Quark>, after: bool, closure: RustClosure, ) -> SignalHandlerId

Connect a closure to the signal signal_id on this object. Read more
ยง

fn watch_closure(&self, closure: &impl AsRef<Closure>)

Limits the lifetime of closure to the lifetime of the object. When the objectโ€™s reference count drops to zero, the closure will be invalidated. An invalidated closure will ignore any calls to invoke_with_values, or invoke when using Rust closures.
ยง

fn emit<R>(&self, signal_id: SignalId, args: &[&dyn ToValue]) -> R
where R: TryFromClosureReturnValue,

Emit signal by signal id. Read more
ยง

fn emit_with_values(&self, signal_id: SignalId, args: &[Value]) -> Option<Value>

Same as [Self::emit] but takes Value for the arguments.
ยง

fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> R
where R: TryFromClosureReturnValue,

Emit signal by its name. Read more
ยง

fn emit_by_name_with_values( &self, signal_name: &str, args: &[Value], ) -> Option<Value>

Emit signal by its name. Read more
ยง

fn emit_by_name_with_details<R>( &self, signal_name: &str, details: Quark, args: &[&dyn ToValue], ) -> R
where R: TryFromClosureReturnValue,

Emit signal by its name with details. Read more
ยง

fn emit_by_name_with_details_and_values( &self, signal_name: &str, details: Quark, args: &[Value], ) -> Option<Value>

Emit signal by its name with details. Read more
ยง

fn emit_with_details<R>( &self, signal_id: SignalId, details: Quark, args: &[&dyn ToValue], ) -> R
where R: TryFromClosureReturnValue,

Emit signal by signal id with details. Read more
ยง

fn emit_with_details_and_values( &self, signal_id: SignalId, details: Quark, args: &[Value], ) -> Option<Value>

Emit signal by signal id with details. Read more
ยง

fn disconnect(&self, handler_id: SignalHandlerId)

Disconnect a previously connected signal handler.
ยง

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

Connect to the notify signal of the object. Read more
ยง

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

Connect to the notify signal of the object. Read more
ยง

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

Connect to the notify signal of the object. Read more
ยง

fn notify(&self, property_name: &str)

Notify that the given property has changed its value. Read more
ยง

fn notify_by_pspec(&self, pspec: &ParamSpec)

Notify that the given property has changed its value. Read more
ยง

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

Downgrade this object to a weak reference.
ยง

fn add_weak_ref_notify<F>(&self, f: F) -> WeakRefNotify<T>
where F: FnOnce() + Send + 'static,

Add a callback to be notified when the Object is disposed.
ยง

fn add_weak_ref_notify_local<F>(&self, f: F) -> WeakRefNotify<T>
where F: FnOnce() + 'static,

Add a callback to be notified when the Object is disposed. Read more
ยง

fn bind_property<'a, 'f, 't, O>( &'a self, source_property: &'a str, target: &'a O, target_property: &'a str, ) -> BindingBuilder<'a, 'f, 't>
where O: ObjectType,

Bind property source_property on this object to the target_property on the target object. Read more
ยง

fn ref_count(&self) -> u32

Returns the strong reference count of this object.
ยง

unsafe fn run_dispose(&self)

Runs the dispose mechanism of the object. Read more
ยง

impl<T> Property for T
where T: HasParamSpec,

ยง

type Value = T

ยง

impl<T> PropertyGet for T
where T: HasParamSpec,

ยง

type Value = T

ยง

fn get<R, F>(&self, f: F) -> R
where F: Fn(&<T as PropertyGet>::Value) -> R,

ยง

impl<T> StaticTypeExt for T
where T: StaticType,

ยง

fn ensure_type()

Ensures that the type has been registered with the type system.
Sourceยง

impl<T> ToOwned for T
where T: Clone,

Sourceยง

type Owned = T

The resulting type after obtaining ownership.
Sourceยง

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Sourceยง

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
ยง

impl<T> TransparentType for T
where T: TransparentPtrType,

ยง

type GlibType = <T as GlibPtrDefault>::GlibType

Sourceยง

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Sourceยง

type Error = Infallible

The type returned in the event of a conversion error.
Sourceยง

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

Performs the conversion.
ยง

impl<T> TryFromClosureReturnValue for T
where T: for<'a> FromValue<'a> + StaticType + 'static,

ยง

fn try_from_closure_return_value(v: Option<Value>) -> Result<T, BoolError>

Sourceยง

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Sourceยง

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Sourceยง

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.