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 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
// 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 crate::RecentData;
use crate::RecentInfo;
use glib::object::Cast;
use glib::object::IsA;
use glib::signal::connect_raw;
use glib::signal::SignalHandlerId;
use glib::translate::*;
use glib::StaticType;
use glib::ToValue;
use std::boxed::Box as Box_;
use std::fmt;
use std::mem::transmute;
use std::ptr;
glib::wrapper! {
/// [`RecentManager`][crate::RecentManager] provides a facility for adding, removing and
/// looking up recently used files. Each recently used file is
/// identified by its URI, and has meta-data associated to it, like
/// the names and command lines of the applications that have
/// registered it, the number of time each application has registered
/// the same file, the mime type of the file and whether the file
/// should be displayed only by the applications that have
/// registered it.
///
/// The recently used files list is per user.
///
/// The [`RecentManager`][crate::RecentManager] acts like a database of all the recently
/// used files. You can create new [`RecentManager`][crate::RecentManager] objects, but
/// it is more efficient to use the default manager created by GTK+.
///
/// Adding a new recently used file is as simple as:
///
///
///
/// **⚠️ The following code is in C ⚠️**
///
/// ```C
/// GtkRecentManager *manager;
///
/// manager = gtk_recent_manager_get_default ();
/// gtk_recent_manager_add_item (manager, file_uri);
/// ```
///
/// The [`RecentManager`][crate::RecentManager] will try to gather all the needed information
/// from the file itself through GIO.
///
/// Looking up the meta-data associated with a recently used file
/// given its URI requires calling [`RecentManagerExt::lookup_item()`][crate::prelude::RecentManagerExt::lookup_item()]:
///
///
///
/// **⚠️ The following code is in C ⚠️**
///
/// ```C
/// GtkRecentManager *manager;
/// GtkRecentInfo *info;
/// GError *error = NULL;
///
/// manager = gtk_recent_manager_get_default ();
/// info = gtk_recent_manager_lookup_item (manager, file_uri, &error);
/// if (error)
/// {
/// g_warning ("Could not find the file: %s", error->message);
/// g_error_free (error);
/// }
/// else
/// {
/// // Use the info object
/// gtk_recent_info_unref (info);
/// }
/// ```
///
/// In order to retrieve the list of recently used files, you can use
/// [`RecentManagerExt::items()`][crate::prelude::RecentManagerExt::items()], which returns a list of [`RecentInfo`][crate::RecentInfo]-structs.
///
/// A [`RecentManager`][crate::RecentManager] is the model used to populate the contents of
/// one, or more [`RecentChooser`][crate::RecentChooser] implementations.
///
/// Note that the maximum age of the recently used files list is
/// controllable through the `property::Settings::gtk-recent-files-max-age`
/// property.
///
/// Recently used files are supported since GTK+ 2.10.
///
/// # Implements
///
/// [`RecentManagerExt`][trait@crate::prelude::RecentManagerExt], [`trait@glib::ObjectExt`]
#[doc(alias = "GtkRecentManager")]
pub struct RecentManager(Object<ffi::GtkRecentManager, ffi::GtkRecentManagerClass>);
match fn {
type_ => || ffi::gtk_recent_manager_get_type(),
}
}
impl RecentManager {
pub const NONE: Option<&'static RecentManager> = None;
/// Creates a new recent manager object. Recent manager objects are used to
/// handle the list of recently used resources. A [`RecentManager`][crate::RecentManager] object
/// monitors the recently used resources list, and emits the “changed” signal
/// each time something inside the list changes.
///
/// [`RecentManager`][crate::RecentManager] objects are expensive: be sure to create them only when
/// needed. You should use [`default()`][Self::default()] instead.
///
/// # Returns
///
/// A newly created [`RecentManager`][crate::RecentManager] object
#[doc(alias = "gtk_recent_manager_new")]
pub fn new() -> RecentManager {
assert_initialized_main_thread!();
unsafe { from_glib_full(ffi::gtk_recent_manager_new()) }
}
// rustdoc-stripper-ignore-next
/// Creates a new builder-pattern struct instance to construct [`RecentManager`] objects.
///
/// This method returns an instance of [`RecentManagerBuilder`](crate::builders::RecentManagerBuilder) which can be used to create [`RecentManager`] objects.
pub fn builder() -> RecentManagerBuilder {
RecentManagerBuilder::default()
}
/// Gets a unique instance of [`RecentManager`][crate::RecentManager], that you can share
/// in your application without caring about memory management.
///
/// # Returns
///
/// A unique [`RecentManager`][crate::RecentManager]. Do not ref or
/// unref it.
#[doc(alias = "gtk_recent_manager_get_default")]
#[doc(alias = "get_default")]
pub fn default() -> Option<RecentManager> {
assert_initialized_main_thread!();
unsafe { from_glib_none(ffi::gtk_recent_manager_get_default()) }
}
}
impl Default for RecentManager {
fn default() -> Self {
Self::new()
}
}
#[derive(Clone, Default)]
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`RecentManager`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct RecentManagerBuilder {
filename: Option<String>,
}
impl RecentManagerBuilder {
// rustdoc-stripper-ignore-next
/// Create a new [`RecentManagerBuilder`].
pub fn new() -> Self {
Self::default()
}
// rustdoc-stripper-ignore-next
/// Build the [`RecentManager`].
#[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
pub fn build(self) -> RecentManager {
let mut properties: Vec<(&str, &dyn ToValue)> = vec![];
if let Some(ref filename) = self.filename {
properties.push(("filename", filename));
}
glib::Object::new::<RecentManager>(&properties)
}
/// The full path to the file to be used to store and read the
/// recently used resources list
pub fn filename(mut self, filename: &str) -> Self {
self.filename = Some(filename.to_string());
self
}
}
/// Trait containing all [`struct@RecentManager`] methods.
///
/// # Implementors
///
/// [`RecentManager`][struct@crate::RecentManager]
pub trait RecentManagerExt: 'static {
/// Adds a new resource, pointed by `uri`, into the recently used
/// resources list, using the metadata specified inside the
/// [`RecentData`][crate::RecentData]-struct passed in `recent_data`.
///
/// The passed URI will be used to identify this resource inside the
/// list.
///
/// In order to register the new recently used resource, metadata about
/// the resource must be passed as well as the URI; the metadata is
/// stored in a [`RecentData`][crate::RecentData]-struct, which must contain the MIME
/// type of the resource pointed by the URI; the name of the application
/// that is registering the item, and a command line to be used when
/// launching the item.
///
/// Optionally, a [`RecentData`][crate::RecentData]-struct might contain a UTF-8 string
/// to be used when viewing the item instead of the last component of
/// the URI; a short description of the item; whether the item should
/// be considered private - that is, should be displayed only by the
/// applications that have registered it.
/// ## `uri`
/// a valid URI
/// ## `recent_data`
/// metadata of the resource
///
/// # Returns
///
/// [`true`] if the new item was successfully added to the
/// recently used resources list, [`false`] otherwise
#[doc(alias = "gtk_recent_manager_add_full")]
fn add_full(&self, uri: &str, recent_data: &RecentData) -> bool;
/// Adds a new resource, pointed by `uri`, into the recently used
/// resources list.
///
/// This function automatically retrieves some of the needed
/// metadata and setting other metadata to common default values;
/// it then feeds the data to [`add_full()`][Self::add_full()].
///
/// See [`add_full()`][Self::add_full()] if you want to explicitly
/// define the metadata for the resource pointed by `uri`.
/// ## `uri`
/// a valid URI
///
/// # Returns
///
/// [`true`] if the new item was successfully added
/// to the recently used resources list
#[doc(alias = "gtk_recent_manager_add_item")]
fn add_item(&self, uri: &str) -> bool;
/// Gets the list of recently used resources.
///
/// # Returns
///
/// a list of
/// newly allocated [`RecentInfo`][crate::RecentInfo] objects. Use
/// `gtk_recent_info_unref()` on each item inside the list, and then
/// free the list itself using `g_list_free()`.
#[doc(alias = "gtk_recent_manager_get_items")]
#[doc(alias = "get_items")]
fn items(&self) -> Vec<RecentInfo>;
/// Checks whether there is a recently used resource registered
/// with `uri` inside the recent manager.
/// ## `uri`
/// a URI
///
/// # Returns
///
/// [`true`] if the resource was found, [`false`] otherwise
#[doc(alias = "gtk_recent_manager_has_item")]
fn has_item(&self, uri: &str) -> bool;
/// Searches for a URI inside the recently used resources list, and
/// returns a [`RecentInfo`][crate::RecentInfo]-struct containing informations about the resource
/// like its MIME type, or its display name.
/// ## `uri`
/// a URI
///
/// # Returns
///
/// a [`RecentInfo`][crate::RecentInfo]-struct containing information
/// about the resource pointed by `uri`, or [`None`] if the URI was
/// not registered in the recently used resources list. Free with
/// `gtk_recent_info_unref()`.
#[doc(alias = "gtk_recent_manager_lookup_item")]
fn lookup_item(&self, uri: &str) -> Result<Option<RecentInfo>, glib::Error>;
/// Changes the location of a recently used resource from `uri` to `new_uri`.
///
/// Please note that this function will not affect the resource pointed
/// by the URIs, but only the URI used in the recently used resources list.
/// ## `uri`
/// the URI of a recently used resource
/// ## `new_uri`
/// the new URI of the recently used resource, or
/// [`None`] to remove the item pointed by `uri` in the list
///
/// # Returns
///
/// [`true`] on success
#[doc(alias = "gtk_recent_manager_move_item")]
fn move_item(&self, uri: &str, new_uri: Option<&str>) -> Result<(), glib::Error>;
/// Purges every item from the recently used resources list.
///
/// # Returns
///
/// the number of items that have been removed from the
/// recently used resources list
#[doc(alias = "gtk_recent_manager_purge_items")]
fn purge_items(&self) -> Result<i32, glib::Error>;
/// Removes a resource pointed by `uri` from the recently used resources
/// list handled by a recent manager.
/// ## `uri`
/// the URI of the item you wish to remove
///
/// # Returns
///
/// [`true`] if the item pointed by `uri` has been successfully
/// removed by the recently used resources list, and [`false`] otherwise
#[doc(alias = "gtk_recent_manager_remove_item")]
fn remove_item(&self, uri: &str) -> Result<(), glib::Error>;
/// The full path to the file to be used to store and read the
/// recently used resources list
fn filename(&self) -> Option<glib::GString>;
/// The size of the recently used resources list.
fn size(&self) -> i32;
/// Emitted when the current recently used resources manager changes
/// its contents, either by calling [`add_item()`][Self::add_item()] or
/// by another application.
#[doc(alias = "changed")]
fn connect_changed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId;
#[doc(alias = "size")]
fn connect_size_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId;
}
impl<O: IsA<RecentManager>> RecentManagerExt for O {
fn add_full(&self, uri: &str, recent_data: &RecentData) -> bool {
unsafe {
from_glib(ffi::gtk_recent_manager_add_full(
self.as_ref().to_glib_none().0,
uri.to_glib_none().0,
recent_data.to_glib_none().0,
))
}
}
fn add_item(&self, uri: &str) -> bool {
unsafe {
from_glib(ffi::gtk_recent_manager_add_item(
self.as_ref().to_glib_none().0,
uri.to_glib_none().0,
))
}
}
fn items(&self) -> Vec<RecentInfo> {
unsafe {
FromGlibPtrContainer::from_glib_full(ffi::gtk_recent_manager_get_items(
self.as_ref().to_glib_none().0,
))
}
}
fn has_item(&self, uri: &str) -> bool {
unsafe {
from_glib(ffi::gtk_recent_manager_has_item(
self.as_ref().to_glib_none().0,
uri.to_glib_none().0,
))
}
}
fn lookup_item(&self, uri: &str) -> Result<Option<RecentInfo>, glib::Error> {
unsafe {
let mut error = ptr::null_mut();
let ret = ffi::gtk_recent_manager_lookup_item(
self.as_ref().to_glib_none().0,
uri.to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
fn move_item(&self, uri: &str, new_uri: Option<&str>) -> Result<(), glib::Error> {
unsafe {
let mut error = ptr::null_mut();
let is_ok = ffi::gtk_recent_manager_move_item(
self.as_ref().to_glib_none().0,
uri.to_glib_none().0,
new_uri.to_glib_none().0,
&mut error,
);
assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
fn purge_items(&self) -> Result<i32, glib::Error> {
unsafe {
let mut error = ptr::null_mut();
let ret =
ffi::gtk_recent_manager_purge_items(self.as_ref().to_glib_none().0, &mut error);
if error.is_null() {
Ok(ret)
} else {
Err(from_glib_full(error))
}
}
}
fn remove_item(&self, uri: &str) -> Result<(), glib::Error> {
unsafe {
let mut error = ptr::null_mut();
let is_ok = ffi::gtk_recent_manager_remove_item(
self.as_ref().to_glib_none().0,
uri.to_glib_none().0,
&mut error,
);
assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
fn filename(&self) -> Option<glib::GString> {
glib::ObjectExt::property(self.as_ref(), "filename")
}
fn size(&self) -> i32 {
glib::ObjectExt::property(self.as_ref(), "size")
}
fn connect_changed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn changed_trampoline<P: IsA<RecentManager>, F: Fn(&P) + 'static>(
this: *mut ffi::GtkRecentManager,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(RecentManager::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"changed\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
changed_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
fn connect_size_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
unsafe extern "C" fn notify_size_trampoline<P: IsA<RecentManager>, F: Fn(&P) + 'static>(
this: *mut ffi::GtkRecentManager,
_param_spec: glib::ffi::gpointer,
f: glib::ffi::gpointer,
) {
let f: &F = &*(f as *const F);
f(RecentManager::from_glib_borrow(this).unsafe_cast_ref())
}
unsafe {
let f: Box_<F> = Box_::new(f);
connect_raw(
self.as_ptr() as *mut _,
b"notify::size\0".as_ptr() as *const _,
Some(transmute::<_, unsafe extern "C" fn()>(
notify_size_trampoline::<Self, F> as *const (),
)),
Box_::into_raw(f),
)
}
}
}
impl fmt::Display for RecentManager {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("RecentManager")
}
}