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
// 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::{EmblemOrigin, Icon};
use glib::{prelude::*, translate::*};
use std::fmt;
glib::wrapper! {
/// [`Emblem`][crate::Emblem] is an implementation of [`Icon`][crate::Icon] that supports
/// having an emblem, which is an icon with additional properties.
/// It can than be added to a [`EmblemedIcon`][crate::EmblemedIcon].
///
/// Currently, only metainformation about the emblem's origin is
/// supported. More may be added in the future.
///
/// ## Properties
///
///
/// #### `icon`
/// Readable | Writeable | Construct Only
///
///
/// #### `origin`
/// Readable | Writeable | Construct Only
///
/// # Implements
///
/// [`trait@glib::ObjectExt`], [`IconExt`][trait@crate::prelude::IconExt]
#[doc(alias = "GEmblem")]
pub struct Emblem(Object<ffi::GEmblem, ffi::GEmblemClass>) @implements Icon;
match fn {
type_ => || ffi::g_emblem_get_type(),
}
}
impl Emblem {
/// Creates a new emblem for `icon`.
/// ## `icon`
/// a GIcon containing the icon.
///
/// # Returns
///
/// a new [`Emblem`][crate::Emblem].
#[doc(alias = "g_emblem_new")]
pub fn new(icon: &impl IsA<Icon>) -> Emblem {
unsafe { from_glib_full(ffi::g_emblem_new(icon.as_ref().to_glib_none().0)) }
}
/// Creates a new emblem for `icon`.
/// ## `icon`
/// a GIcon containing the icon.
/// ## `origin`
/// a GEmblemOrigin enum defining the emblem's origin
///
/// # Returns
///
/// a new [`Emblem`][crate::Emblem].
#[doc(alias = "g_emblem_new_with_origin")]
#[doc(alias = "new_with_origin")]
pub fn with_origin(icon: &impl IsA<Icon>, origin: EmblemOrigin) -> Emblem {
unsafe {
from_glib_full(ffi::g_emblem_new_with_origin(
icon.as_ref().to_glib_none().0,
origin.into_glib(),
))
}
}
/// Gives back the icon from `self`.
///
/// # Returns
///
/// a [`Icon`][crate::Icon]. The returned object belongs to
/// the emblem and should not be modified or freed.
#[doc(alias = "g_emblem_get_icon")]
#[doc(alias = "get_icon")]
pub fn icon(&self) -> Icon {
unsafe { from_glib_none(ffi::g_emblem_get_icon(self.to_glib_none().0)) }
}
/// Gets the origin of the emblem.
///
/// # Returns
///
/// the origin of the emblem
#[doc(alias = "g_emblem_get_origin")]
#[doc(alias = "get_origin")]
pub fn origin(&self) -> EmblemOrigin {
unsafe { from_glib(ffi::g_emblem_get_origin(self.to_glib_none().0)) }
}
}
impl fmt::Display for Emblem {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
f.write_str("Emblem")
}
}