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
// 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::translate::*;
use std::fmt;
#[cfg(any(feature = "v1_46", feature = "dox"))]
#[cfg_attr(feature = "dox", doc(cfg(feature = "v1_46")))]
use std::mem;

glib::wrapper! {
    /// The [`Color`][crate::Color] structure is used to
    /// represent a color in an uncalibrated RGB color-space.
    #[derive(Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
    pub struct Color(Boxed<ffi::PangoColor>);

    match fn {
        copy => |ptr| ffi::pango_color_copy(ptr),
        free => |ptr| ffi::pango_color_free(ptr),
        type_ => || ffi::pango_color_get_type(),
    }
}

impl Color {
    /// Fill in the fields of a color from a string specification. The
    /// string can either one of a large set of standard names. (Taken
    /// from the CSS <ulink url="http://dev.w3.org/csswg/css-color/`named`-colors">specification`</ulink>`), or it can be a hexadecimal
    /// value in the
    /// form '&num;rgb' '&num;rrggbb' '&num;rrrgggbbb' or '&num;rrrrggggbbbb' where
    /// 'r', 'g' and 'b' are hex digits of the red, green, and blue
    /// components of the color, respectively. (White in the four
    /// forms is '&num;fff' '&num;ffffff' '&num;fffffffff' and '&num;ffffffffffff')
    /// ## `spec`
    /// a string specifying the new color
    ///
    /// # Returns
    ///
    /// [`true`] if parsing of the specifier succeeded,
    ///  otherwise false.
    #[doc(alias = "pango_color_parse")]
    pub fn parse(&mut self, spec: &str) -> bool {
        unsafe {
            from_glib(ffi::pango_color_parse(
                self.to_glib_none_mut().0,
                spec.to_glib_none().0,
            ))
        }
    }

    /// Fill in the fields of a color from a string specification. The
    /// string can either one of a large set of standard names. (Taken
    /// from the CSS <ulink url="http://dev.w3.org/csswg/css-color/`named`-colors">specification`</ulink>`), or it can be a hexadecimal
    /// value in the
    /// form '&num;rgb' '&num;rrggbb' '&num;rrrgggbbb' or '&num;rrrrggggbbbb' where
    /// 'r', 'g' and 'b' are hex digits of the red, green, and blue
    /// components of the color, respectively. (White in the four
    /// forms is '&num;fff' '&num;ffffff' '&num;fffffffff' and '&num;ffffffffffff')
    ///
    /// Additionally, parse strings of the form
    /// '&num;rgba', '&num;rrggbbaa', '&num;rrrrggggbbbbaaaa',
    /// if `alpha` is not [`None`], and set `alpha` to the value specified
    /// by the hex digits for 'a'. If no alpha component is found
    /// in `spec`, `alpha` is set to 0xffff (for a solid color).
    /// ## `spec`
    /// a string specifying the new color
    ///
    /// # Returns
    ///
    /// [`true`] if parsing of the specifier succeeded,
    ///  otherwise false.
    ///
    /// ## `alpha`
    /// return location for alpha, or [`None`]
    #[cfg(any(feature = "v1_46", feature = "dox"))]
    #[cfg_attr(feature = "dox", doc(cfg(feature = "v1_46")))]
    #[doc(alias = "pango_color_parse_with_alpha")]
    pub fn parse_with_alpha(&mut self, spec: &str) -> Option<u16> {
        unsafe {
            let mut alpha = mem::MaybeUninit::uninit();
            let ret = from_glib(ffi::pango_color_parse_with_alpha(
                self.to_glib_none_mut().0,
                alpha.as_mut_ptr(),
                spec.to_glib_none().0,
            ));
            let alpha = alpha.assume_init();
            if ret {
                Some(alpha)
            } else {
                None
            }
        }
    }

    #[doc(alias = "pango_color_to_string")]
    #[doc(alias = "to_string")]
    pub fn to_str(&self) -> glib::GString {
        unsafe { from_glib_full(ffi::pango_color_to_string(self.to_glib_none().0)) }
    }
}

impl fmt::Display for Color {
    #[inline]
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.write_str(&self.to_str())
    }
}