1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT
use glib::{
prelude::*,
signal::{connect_raw, SignalHandlerId},
translate::*,
};
use std::{boxed::Box as Box_, fmt, mem::transmute};
glib::wrapper! {
/// [`DirectoryList`][crate::DirectoryList] is a list model that wraps g_file_enumerate_children_async().
///
/// It presents a `GListModel` and fills it asynchronously with the `GFileInfo`s
/// returned from that function.
///
/// Enumeration will start automatically when a the
/// [`file`][struct@crate::DirectoryList#file] property is set.
///
/// While the [`DirectoryList`][crate::DirectoryList] is being filled, the
/// [`loading`][struct@crate::DirectoryList#loading] property will be set to [`true`]. You can
/// listen to that property if you want to show information like a [`Spinner`][crate::Spinner]
/// or a "Loading..." text.
///
/// If loading fails at any point, the [`error`][struct@crate::DirectoryList#error]
/// property will be set to give more indication about the failure.
///
/// The `GFileInfo`s returned from a [`DirectoryList`][crate::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`][crate::DirectoryList], but can access
/// the `GFile` directly from the `GFileInfo` when operating with a [`ListView`][crate::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
///
/// [`trait@glib::ObjectExt`], [`trait@gio::prelude::ListModelExt`]
#[doc(alias = "GtkDirectoryList")]
pub struct DirectoryList(Object<ffi::GtkDirectoryList, ffi::GtkDirectoryListClass>) @implements gio::ListModel;
match fn {
type_ => || ffi::gtk_directory_list_get_type(),
}
}
impl DirectoryList {
/// Creates a new [`DirectoryList`][crate::DirectoryList].
///
/// The [`DirectoryList`][crate::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`][crate::DirectoryList]
#[doc(alias = "gtk_directory_list_new")]
pub fn new(attributes: Option<&str>, file: Option<&impl IsA<gio::File>>) -> DirectoryList {
assert_initialized_main_thread!();
unsafe {
from_glib_full(ffi::gtk_directory_list_new(
attributes.to_glib_none().0,
file.map(|p| p.as_ref()).to_glib_none().0,
))
}
}
/// Gets the attributes queried on the children.
///
/// # Returns
///
/// The queried attributes
#[doc(alias = "gtk_directory_list_get_attributes")]
#[doc(alias = "get_attributes")]
pub fn attributes(&self) -> Option<glib::GString> {
unsafe {
from_glib_none(ffi::gtk_directory_list_get_attributes(
self.to_glib_none().0,
))
}
}
/// 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
#[doc(alias = "gtk_directory_list_get_error")]
#[doc(alias = "get_error")]
pub fn error(&self) -> Option<glib::Error> {
unsafe { from_glib_none(ffi::gtk_directory_list_get_error(self.to_glib_none().0)) }
}
/// Gets the file whose children are currently enumerated.
///
/// # Returns
///
/// The file whose children are enumerated
#[doc(alias = "gtk_directory_list_get_file")]
#[doc(alias = "get_file")]
pub fn file(&self) -> Option<gio::File> {
unsafe { from_glib_none(ffi::gtk_directory_list_get_file(self.to_glib_none().0)) }
}
/// Returns whether the directory list is monitoring
/// the directory for changes.
///
/// # Returns
///
/// [`true`] if the directory is monitored
#[doc(alias = "gtk_directory_list_get_monitored")]
#[doc(alias = "get_monitored")]
pub fn is_monitored(&self) -> bool {
unsafe { from_glib(ffi::gtk_directory_list_get_monitored(self.to_glib_none().0)) }
}
/// 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
#[doc(alias = "gtk_directory_list_is_loading")]
pub fn is_loading(&self) -> bool {
unsafe { from_glib(ffi::gtk_directory_list_is_loading(self.to_glib_none().0)) }
}
/// 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
#[doc(alias = "gtk_directory_list_set_attributes")]
pub fn set_attributes(&self, attributes: Option<&str>) {
unsafe {
ffi::gtk_directory_list_set_attributes(
self.to_glib_none().0,
attributes.to_glib_none().0,
);
}
}
/// 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
#[doc(alias = "gtk_directory_list_set_file")]
pub fn set_file(&self, file: Option<&impl IsA<gio::File>>) {
unsafe {
ffi::gtk_directory_list_set_file(
self.to_glib_none().0,
file.map(|p| p.as_ref()).to_glib_none().0,
);
}
}
/// 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
#[doc(alias = "gtk_directory_list_set_monitored")]
pub fn set_monitored(&self, monitored: bool) {
unsafe {
ffi::gtk_directory_list_set_monitored(self.to_glib_none().0, monitored.into_glib());
}
}
#[doc(alias = "attributes")]
pub fn connect_attributes_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_attributes_trampoline<F: Fn(&DirectoryList) + 'static>(
this: *mut ffi::GtkDirectoryList,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::attributes\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_attributes_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "error")]
pub fn connect_error_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_error_trampoline<F: Fn(&DirectoryList) + 'static>(
this: *mut ffi::GtkDirectoryList,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::error\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_error_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "file")]
pub fn connect_file_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_file_trampoline<F: Fn(&DirectoryList) + 'static>(
this: *mut ffi::GtkDirectoryList,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::file\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_file_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "io-priority")]
pub fn connect_io_priority_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_io_priority_trampoline<F: Fn(&DirectoryList) + 'static>(
this: *mut ffi::GtkDirectoryList,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::io-priority\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_io_priority_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "loading")]
pub fn connect_loading_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_loading_trampoline<F: Fn(&DirectoryList) + 'static>(
this: *mut ffi::GtkDirectoryList,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::loading\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_loading_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
#[doc(alias = "monitored")]
pub fn connect_monitored_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_monitored_trampoline<F: Fn(&DirectoryList) + 'static>(
this: *mut ffi::GtkDirectoryList,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(&from_glib_borrow(this))
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::monitored\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_monitored_trampoline::<F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl fmt::Display for DirectoryList {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("DirectoryList")
}
}