gio/auto/emblemed_icon.rs
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
// 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::{ffi, Emblem, Icon};
use glib::{prelude::*, translate::*};
glib::wrapper! {
/// `GEmblemedIcon` is an implementation of [`Icon`][crate::Icon] that supports
/// adding an emblem to an icon. Adding multiple emblems to an
/// icon is ensured via [`EmblemedIconExt::add_emblem()`][crate::prelude::EmblemedIconExt::add_emblem()].
///
/// Note that `GEmblemedIcon` allows no control over the position
/// of the emblems. See also [`Emblem`][crate::Emblem] for more information.
///
/// ## Properties
///
///
/// #### `gicon`
/// The [`Icon`][crate::Icon] to attach emblems to.
///
/// Readable | Writeable | Construct Only
///
/// # Implements
///
/// [`EmblemedIconExt`][trait@crate::prelude::EmblemedIconExt], [`trait@glib::ObjectExt`], [`IconExt`][trait@crate::prelude::IconExt]
#[doc(alias = "GEmblemedIcon")]
pub struct EmblemedIcon(Object<ffi::GEmblemedIcon, ffi::GEmblemedIconClass>) @implements Icon;
match fn {
type_ => || ffi::g_emblemed_icon_get_type(),
}
}
impl EmblemedIcon {
pub const NONE: Option<&'static EmblemedIcon> = None;
/// Creates a new emblemed icon for @icon with the emblem @emblem.
/// ## `icon`
/// a #GIcon
/// ## `emblem`
/// a #GEmblem, or [`None`]
///
/// # Returns
///
/// a new #GIcon
#[doc(alias = "g_emblemed_icon_new")]
pub fn new(icon: &impl IsA<Icon>, emblem: Option<&Emblem>) -> EmblemedIcon {
unsafe {
from_glib_full(ffi::g_emblemed_icon_new(
icon.as_ref().to_glib_none().0,
emblem.to_glib_none().0,
))
}
}
}
/// Trait containing all [`struct@EmblemedIcon`] methods.
///
/// # Implementors
///
/// [`EmblemedIcon`][struct@crate::EmblemedIcon]
pub trait EmblemedIconExt: IsA<EmblemedIcon> + 'static {
/// Adds @emblem to the #GList of #GEmblems.
/// ## `emblem`
/// a #GEmblem
#[doc(alias = "g_emblemed_icon_add_emblem")]
fn add_emblem(&self, emblem: &Emblem) {
unsafe {
ffi::g_emblemed_icon_add_emblem(
self.as_ref().to_glib_none().0,
emblem.to_glib_none().0,
);
}
}
/// Removes all the emblems from @icon.
#[doc(alias = "g_emblemed_icon_clear_emblems")]
fn clear_emblems(&self) {
unsafe {
ffi::g_emblemed_icon_clear_emblems(self.as_ref().to_glib_none().0);
}
}
/// Gets the list of emblems for the @icon.
///
/// # Returns
///
/// a #GList of
/// #GEmblems that is owned by @self
#[doc(alias = "g_emblemed_icon_get_emblems")]
#[doc(alias = "get_emblems")]
fn emblems(&self) -> Vec<Emblem> {
unsafe {
FromGlibPtrContainer::from_glib_none(ffi::g_emblemed_icon_get_emblems(
self.as_ref().to_glib_none().0,
))
}
}
/// Gets the main icon for @self.
///
/// # Returns
///
/// a #GIcon that is owned by @self
#[doc(alias = "g_emblemed_icon_get_icon")]
#[doc(alias = "get_icon")]
fn icon(&self) -> Icon {
unsafe {
from_glib_none(ffi::g_emblemed_icon_get_icon(
self.as_ref().to_glib_none().0,
))
}
}
/// The [`Icon`][crate::Icon] to attach emblems to.
fn gicon(&self) -> Option<Icon> {
ObjectExt::property(self.as_ref(), "gicon")
}
}
impl<O: IsA<EmblemedIcon>> EmblemedIconExt for O {}