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
// 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! {
/// [`BookmarkList`][crate::BookmarkList] is a list model that wraps `GBookmarkFile`.
///
/// It presents a `GListModel` and fills it asynchronously with the
/// `GFileInfo`s returned from that function.
///
/// The `GFileInfo`s in the list have some attributes in the recent
/// namespace added: `recent::private` (boolean) and `recent:applications`
/// (stringv).
///
/// ## Properties
///
///
/// #### `attributes`
/// The attributes to query.
///
/// Readable | Writeable
///
///
/// #### `filename`
/// The bookmark file to load.
///
/// Readable | Writeable | Construct Only
///
///
/// #### `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
///
///
/// #### `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 = "GtkBookmarkList")]
pub struct BookmarkList(Object<ffi::GtkBookmarkList, ffi::GtkBookmarkListClass>) @implements gio::ListModel;
match fn {
type_ => || ffi::gtk_bookmark_list_get_type(),
}
}
impl BookmarkList {
/// Creates a new [`BookmarkList`][crate::BookmarkList] with the given @attributes.
/// ## `filename`
/// The bookmark file to load
/// ## `attributes`
/// The attributes to query
///
/// # Returns
///
/// a new [`BookmarkList`][crate::BookmarkList]
#[doc(alias = "gtk_bookmark_list_new")]
pub fn new(
filename: Option<impl AsRef<std::path::Path>>,
attributes: Option<&str>,
) -> BookmarkList {
assert_initialized_main_thread!();
unsafe {
from_glib_full(ffi::gtk_bookmark_list_new(
filename.as_ref().map(|p| p.as_ref()).to_glib_none().0,
attributes.to_glib_none().0,
))
}
}
/// Gets the attributes queried on the children.
///
/// # Returns
///
/// The queried attributes
#[doc(alias = "gtk_bookmark_list_get_attributes")]
#[doc(alias = "get_attributes")]
pub fn attributes(&self) -> Option<glib::GString> {
unsafe { from_glib_none(ffi::gtk_bookmark_list_get_attributes(self.to_glib_none().0)) }
}
/// Returns the filename of the bookmark file that
/// this list is loading.
///
/// # Returns
///
/// the filename of the .xbel file
#[doc(alias = "gtk_bookmark_list_get_filename")]
#[doc(alias = "get_filename")]
pub fn filename(&self) -> std::path::PathBuf {
unsafe { from_glib_none(ffi::gtk_bookmark_list_get_filename(self.to_glib_none().0)) }
}
/// Returns [`true`] if the files are currently being loaded.
///
/// 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_bookmark_list_is_loading")]
pub fn is_loading(&self) -> bool {
unsafe { from_glib(ffi::gtk_bookmark_list_is_loading(self.to_glib_none().0)) }
}
/// Sets the @attributes to be enumerated and starts the enumeration.
///
/// If @attributes is [`None`], no attributes will be queried, but a list
/// of `GFileInfo`s will still be created.
/// ## `attributes`
/// the attributes to enumerate
#[doc(alias = "gtk_bookmark_list_set_attributes")]
pub fn set_attributes(&self, attributes: Option<&str>) {
unsafe {
ffi::gtk_bookmark_list_set_attributes(
self.to_glib_none().0,
attributes.to_glib_none().0,
);
}
}
#[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(&BookmarkList) + 'static>(
this: *mut ffi::GtkBookmarkList,
_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 = "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(&BookmarkList) + 'static>(
this: *mut ffi::GtkBookmarkList,
_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(&BookmarkList) + 'static>(
this: *mut ffi::GtkBookmarkList,
_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),
)
}
}
}
impl fmt::Display for BookmarkList {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("BookmarkList")
}
}