gtk4/auto/
symbolic_paintable.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
// 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;
use glib::{prelude::*, translate::*};

glib::wrapper! {
    /// [`SymbolicPaintable`][crate::SymbolicPaintable] is an interface that support symbolic colors in
    /// paintables.
    ///
    /// [`gdk::Paintable`][crate::gdk::Paintable]s implementing the interface will have the
    /// `vfunc::Gtk::SymbolicPaintable::snapshot_symbolic` function called and
    /// have the colors for drawing symbolic icons passed. At least 4 colors are guaranteed
    /// to be passed every time.
    ///
    /// These 4 colors are the foreground color, and the colors to use for errors, warnings
    /// and success information in that order.
    ///
    /// More colors may be added in the future.
    ///
    /// # Implements
    ///
    /// [`SymbolicPaintableExt`][trait@crate::prelude::SymbolicPaintableExt], [`trait@gdk::prelude::PaintableExt`]
    #[doc(alias = "GtkSymbolicPaintable")]
    pub struct SymbolicPaintable(Interface<ffi::GtkSymbolicPaintable, ffi::GtkSymbolicPaintableInterface>) @requires gdk::Paintable;

    match fn {
        type_ => || ffi::gtk_symbolic_paintable_get_type(),
    }
}

impl SymbolicPaintable {
    pub const NONE: Option<&'static SymbolicPaintable> = None;
}

/// Trait containing all [`struct@SymbolicPaintable`] methods.
///
/// # Implementors
///
/// [`IconPaintable`][struct@crate::IconPaintable], [`SymbolicPaintable`][struct@crate::SymbolicPaintable]
pub trait SymbolicPaintableExt: IsA<SymbolicPaintable> + 'static {
    /// Snapshots the paintable with the given colors.
    ///
    /// If less than 4 colors are provided, GTK will pad the array with default
    /// colors.
    /// ## `snapshot`
    /// a [`gdk::Snapshot`][crate::gdk::Snapshot] to snapshot to
    /// ## `width`
    /// width to snapshot in
    /// ## `height`
    /// height to snapshot in
    /// ## `colors`
    /// a pointer to an array of colors
    #[doc(alias = "gtk_symbolic_paintable_snapshot_symbolic")]
    fn snapshot_symbolic(
        &self,
        snapshot: &impl IsA<gdk::Snapshot>,
        width: f64,
        height: f64,
        colors: &[gdk::RGBA],
    ) {
        let n_colors = colors.len() as _;
        unsafe {
            ffi::gtk_symbolic_paintable_snapshot_symbolic(
                self.as_ref().to_glib_none().0,
                snapshot.as_ref().to_glib_none().0,
                width,
                height,
                colors.to_glib_none().0,
                n_colors,
            );
        }
    }
}

impl<O: IsA<SymbolicPaintable>> SymbolicPaintableExt for O {}