smudge-widgets 0.2.0

The core widget set, containers and button, for the Smudge GUI library
Documentation 
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

//! Layout containers: the row, the column, the stack and the spacer.
//!
//! All four are [`Panel`]s, so they take every style builder the core
//! defines. The containers only decide the defaults: which way their children
//! flow, and for the stack, how its children are placed.

use smudge_core::element::Element;
use smudge_core::style::{Edges, Length, Position, Style};
use smudge_core::widget::{Panel, panel};

/// Creates a container that lays its children out left to right.
///
/// The gap between adjacent children starts at zero; [`Element::gap`] sets
/// it.
///
/// ```
/// use smudge_core::style::px;
/// use smudge_widgets::{button, row};
///
/// let bar = row()
///     .gap(smudge_core::geometry::Size {
///         width: 8.0,
///         height: 0.0,
///     })
///     .child(button("Undo"))
///     .child(button("Redo").padding(px(8.0)));
/// ```
pub fn row() -> Element<Panel> {
    panel().row()
}

/// Creates a container that lays its children out top to bottom.
///
/// The gap between adjacent children starts at zero; [`Element::gap`] sets
/// it.
pub fn column() -> Element<Panel> {
    panel().column()
}

/// Creates a container whose children overlap.
///
/// Every child added to the stack is taken out of the flow and stretched to
/// the stack's own bounds, so the children paint on top of each other in the
/// order they were added and the last one covers the ones below it. Because
/// the children do not take part in the flow, they do not size the stack: a
/// stack sizes itself through its own style, such as a fixed
/// [`Element::size`], or through children that stay in the flow.
///
/// ```
/// use smudge_core::geometry::Color;
/// use smudge_core::style::px;
/// use smudge_widgets::stack;
///
/// let layered = stack()
///     .size(smudge_core::geometry::Size {
///         width: 100.0,
///         height: 60.0,
///     })
///     .child(smudge_core::widget::panel().background(Color::WHITE))
///     .child(smudge_core::widget::panel().background(Color::BLACK));
/// ```
pub fn stack() -> Element<Panel> {
    panel().style_children(|style: &mut Style| {
        style.layout.position = Position::Absolute;
        style.layout.inset = Edges::all(Length::px(0.0));
    })
}

/// Creates an empty box that takes the leftover space on the main axis.
///
/// Between two children of a [`row`](crate::row) it pushes them apart; inside
/// a [`column`](crate::column) it fills the space below the content.
pub fn spacer() -> Element<Panel> {
    panel().grow(1.0)
}