Struct gtk4::DirectoryList

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

DirectoryList is a list model that wraps g_file_enumerate_children_async().

It presents a GListModel and fills it asynchronously with the GFileInfos returned from that function.

Enumeration will start automatically when a the file property is set.

While the DirectoryList is being filled, the loading property will be set to true. You can listen to that property if you want to show information like a Spinner or a “Loading…” text.

If loading fails at any point, the error property will be set to give more indication about the failure.

The GFileInfos returned from a DirectoryList have the “standard::file” attribute set to the GFile they refer to. This way you can get at the file that is referred to in the same way you would via g_file_enumerator_get_child(). This means you do not need access to the DirectoryList, but can access the GFile directly from the GFileInfo when operating with a ListView or similar.

Properties

attributes

The attributes to query.

Readable | Writeable

error

Error encountered while loading files.

Readable

file

File to query.

Readable | Writeable

io-priority

Priority used when loading.

Readable | Writeable

item-type

The type of items. See [ListModelExtManual::item_type()][crate::gio::prelude::ListModelExtManual::item_type()].

Readable

loading

true if files are being loaded.

Readable

monitored

true if the directory is monitored for changed.

Readable | Writeable

n-items

The number of items. See [ListModelExtManual::n_items()][crate::gio::prelude::ListModelExtManual::n_items()].

Readable

Implements

glib::ObjectExt, gio::prelude::ListModelExt

Implementations

impl DirectoryList

pub fn new( attributes: Option<&str>, file: Option<&impl IsA<File>> ) -> DirectoryList

Creates a new DirectoryList.

The DirectoryList is querying the given @file with the given @attributes.

attributes

The attributes to query with

file

The file to query

Returns

a new DirectoryList

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

Gets the attributes queried on the children.

Returns

The queried attributes

pub fn error(&self) -> Option<Error>

Gets the loading error, if any.

If an error occurs during the loading process, the loading process will finish and this property allows querying the error that happened. This error will persist until a file is loaded again.

An error being set does not mean that no files were loaded, and all successfully queried files will remain in the list.

Returns

The loading error or None if loading finished successfully

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

Gets the file whose children are currently enumerated.

Returns

The file whose children are enumerated

pub fn is_monitored(&self) -> bool

Returns whether the directory list is monitoring the directory for changes.

Returns

true if the directory is monitored

pub fn is_loading(&self) -> bool

Returns true if the children enumeration is currently in progress.

Files will be added to @self from time to time while loading is going on. The order in which are added is undefined and may change in between runs.

Returns

true if @self is loading

pub fn set_attributes(&self, attributes: Option<&str>)

Sets the @attributes to be enumerated and starts the enumeration.

If @attributes is None, the list of file infos will still be created, it will just not contain any extra attributes.

attributes

the attributes to enumerate

pub fn set_file(&self, file: Option<&impl IsA<File>>)

Sets the @file to be enumerated and starts the enumeration.

If @file is None, the result will be an empty list.

file

the GFile to be enumerated

pub fn set_monitored(&self, monitored: bool)

Sets whether the directory list will monitor the directory for changes.

If monitoring is enabled, the ::items-changed signal will be emitted when the directory contents change.

When monitoring is turned on after the initial creation of the directory list, the directory is reloaded to avoid missing files that appeared between the initial loading and when monitoring was turned on.

monitored

true to monitor the directory for changes

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

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

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

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

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

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

impl DirectoryList

pub fn io_priority(&self) -> Priority

Gets the IO priority set via gtk_directory_list_set_io_priority().

Returns

The IO priority.

pub fn set_io_priority(&self, io_priority: Priority)

Sets the IO priority to use while loading directories.

Setting the priority while @self is loading will reprioritize the ongoing load as soon as possible.

The default IO priority is G_PRIORITY_DEFAULT, which is higher than the GTK redraw priority. If you are loading a lot of directories in parallel, lowering it to something like G_PRIORITY_DEFAULT_IDLE may increase responsiveness.

io_priority

IO priority to use

pub fn builder() -> DirectoryListBuilder

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

This method returns an instance of DirectoryListBuilder which can be used to create DirectoryList objects.

Trait Implementations

impl Clone for DirectoryList

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 DirectoryList

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

Formats the value using the given formatter.

impl Display for DirectoryList

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

Formats the value using the given formatter.

impl HasParamSpec for DirectoryList

type ParamSpec = ParamSpecObject

type SetValue = DirectoryList

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for DirectoryList

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 DirectoryList

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 DirectoryList

type Parent = Object

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

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 DirectoryList

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 DirectoryList

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for DirectoryList

impl IsA<ListModel> for DirectoryList