gdk4 0.5.5

Rust bindings of the GDK 4 library
Documentation
// Take a look at the license at the top of the repository in the LICENSE file.

use crate::RGBA;
use glib::translate::*;
use std::fmt;
use std::str::FromStr;

#[derive(Debug, Default)]
// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`RGBA`] 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 RGBABuilder {
    red: Option<f32>,
    green: Option<f32>,
    blue: Option<f32>,
    alpha: Option<f32>,
}

impl RGBABuilder {
    // rustdoc-stripper-ignore-next
    /// Create a new [`RGBABuilder`].
    pub fn new() -> Self {
        Self::default()
    }

    pub fn blue(mut self, blue: f32) -> Self {
        self.blue = Some(blue);
        self
    }

    pub fn green(mut self, green: f32) -> Self {
        self.green = Some(green);
        self
    }

    pub fn red(mut self, red: f32) -> Self {
        self.red = Some(red);
        self
    }

    pub fn alpha(mut self, alpha: f32) -> Self {
        self.alpha = Some(alpha);
        self
    }

    // rustdoc-stripper-ignore-next
    /// Build the [`RGBA`].
    #[must_use = "The RGBA returned by this builder should probably be used"]
    pub fn build(self) -> RGBA {
        let mut rgba = RGBA::WHITE;
        if let Some(blue) = self.blue {
            rgba.set_blue(blue);
        }
        if let Some(red) = self.red {
            rgba.set_red(red);
        }
        if let Some(green) = self.green {
            rgba.set_green(green);
        }
        if let Some(alpha) = self.alpha {
            rgba.set_alpha(alpha);
        }
        rgba
    }
}

impl RGBA {
    pub fn new(red: f32, green: f32, blue: f32, alpha: f32) -> RGBA {
        skip_assert_initialized!();
        unsafe {
            Self::unsafe_from(ffi::GdkRGBA {
                red,
                green,
                blue,
                alpha,
            })
        }
    }

    // rustdoc-stripper-ignore-next
    /// Creates a new builder-pattern struct instance to construct [`RGBA`] objects.
    ///
    /// This method returns an instance of [`RGBABuilder`](crate::builders::RGBABuilder) which can be used to create [`RGBA`] objects.
    pub fn builder() -> RGBABuilder {
        RGBABuilder::default()
    }

    pub fn red(&self) -> f32 {
        self.inner.red
    }

    pub fn set_red(&mut self, red: f32) {
        self.inner.red = red;
    }

    pub fn green(&self) -> f32 {
        self.inner.green
    }

    pub fn set_green(&mut self, green: f32) {
        self.inner.green = green;
    }

    pub fn blue(&self) -> f32 {
        self.inner.blue
    }

    pub fn set_blue(&mut self, blue: f32) {
        self.inner.blue = blue;
    }

    pub fn alpha(&self) -> f32 {
        self.inner.alpha
    }

    pub fn set_alpha(&mut self, alpha: f32) {
        self.inner.alpha = alpha;
    }

    #[doc(alias = "gdk_rgba_parse")]
    pub fn parse(s: &str) -> Result<RGBA, glib::error::BoolError> {
        skip_assert_initialized!();
        unsafe {
            let mut res = RGBA::uninitialized();
            glib::result_from_gboolean!(
                ffi::gdk_rgba_parse(res.to_glib_none_mut().0, s.to_glib_none().0),
                "Can't parse RGBA"
            )
            .map(|_| res)
        }
    }

    pub const BLACK: RGBA = Self {
        inner: ffi::GdkRGBA {
            red: 0f32,
            green: 0f32,
            blue: 0f32,
            alpha: 1f32,
        },
    };

    pub const BLUE: RGBA = Self {
        inner: ffi::GdkRGBA {
            red: 0f32,
            green: 0f32,
            blue: 1f32,
            alpha: 1f32,
        },
    };

    pub const GREEN: RGBA = Self {
        inner: ffi::GdkRGBA {
            red: 0f32,
            green: 1f32,
            blue: 0f32,
            alpha: 1f32,
        },
    };

    pub const RED: RGBA = Self {
        inner: ffi::GdkRGBA {
            red: 1f32,
            green: 0f32,
            blue: 0f32,
            alpha: 1f32,
        },
    };

    pub const WHITE: RGBA = Self {
        inner: ffi::GdkRGBA {
            red: 1f32,
            green: 1f32,
            blue: 1f32,
            alpha: 1f32,
        },
    };
}

impl fmt::Debug for RGBA {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.debug_struct("RGBA")
            .field("red", &self.red())
            .field("green", &self.green())
            .field("blue", &self.blue())
            .field("alpha", &self.alpha())
            .finish()
    }
}

impl FromStr for RGBA {
    type Err = glib::BoolError;
    fn from_str(s: &str) -> Result<Self, Self::Err> {
        skip_assert_initialized!();
        RGBA::parse(s)
    }
}