sweeten 0.14.0

`sweeten` your daily `iced` brew
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
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138

//! Helper functions to create widgets.

use crate::core;
use crate::core::Element;
use crate::overlay::menu;
use crate::widget::MouseArea;
use crate::widget::button::{self, Button};
use crate::widget::column::{self, Column};
use crate::widget::pick_list::{self, PickList};
use crate::widget::row::{self, Row};
use crate::widget::text_input::{self, TextInput};

use std::borrow::Borrow;

/// Creates a [`Column`] with the given children.
///
/// Columns distribute their children vertically.
#[macro_export]
macro_rules! column {
    () => (
        $crate::widget::Column::new()
    );
    ($($x:expr),+ $(,)?) => (
        $crate::widget::Column::with_children([$($crate::core::Element::from($x)),+])
    );
}

/// Creates a [`Row`] with the given children.
///
/// Rows distribute their children horizontally.
#[macro_export]
macro_rules! row {
    () => (
        $crate::widget::Row::new()
    );
    ($($x:expr),+ $(,)?) => (
        $crate::widget::Row::with_children([$($crate::core::Element::from($x)),+])
    );
}

/// Creates a new [`Row`] with the given children.
pub fn row<'a, Message, Theme, Renderer>(
    children: impl IntoIterator<Item = Element<'a, Message, Theme, Renderer>>,
) -> Row<'a, Message, Theme, Renderer>
where
    Renderer: core::Renderer,
    Theme: row::Catalog,
{
    Row::with_children(children)
}

/// Creates a new [`Column`] with the given children.
pub fn column<'a, Message, Theme, Renderer>(
    children: impl IntoIterator<Item = Element<'a, Message, Theme, Renderer>>,
) -> Column<'a, Message, Theme, Renderer>
where
    Renderer: core::Renderer,
    Theme: column::Catalog,
{
    Column::with_children(children)
}

/// Creates a new [`Button`] with the given content.
///
/// This is a sweetened version of [`iced`'s `button`] with support for
/// [`on_focus`] and [`on_blur`] messages.
///
/// [`iced`'s `button`]: https://docs.iced.rs/iced/widget/button/index.html
/// [`on_focus`]: Button::on_focus
/// [`on_blur`]: Button::on_blur
pub fn button<'a, Message, Theme, Renderer>(
    content: impl Into<Element<'a, Message, Theme, Renderer>>,
) -> Button<'a, Message, Theme, Renderer>
where
    Renderer: core::Renderer,
    Theme: button::Catalog,
{
    Button::new(content)
}

/// Creates a new [`TextInput`].
///
/// This is a sweetened version of [`iced`'s `text_input`] with support for
/// [`on_focus`] and [`on_blur`] messages.
///
/// [`iced`'s `text_input`]: https://docs.iced.rs/iced/widget/text_input/index.html
/// [`on_focus`]: TextInput::on_focus
/// [`on_blur`]: TextInput::on_blur
pub fn text_input<'a, Message, Theme, Renderer>(
    placeholder: &str,
    value: &str,
) -> TextInput<'a, Message, Theme, Renderer>
where
    Message: Clone,
    Theme: text_input::Catalog + 'a,
    Renderer: core::text::Renderer,
{
    TextInput::new(placeholder, value)
}

/// Creates a new [`PickList`].
///
/// This is a sweetened version of [`iced`'s `pick_list`] with support for
/// disabling items in the dropdown via [`disabled`].
///
/// [`iced`'s `pick_list`]: https://docs.iced.rs/iced/widget/pick_list/index.html
/// [`disabled`]: PickList::disabled
pub fn pick_list<'a, T, L, V, Message, Theme, Renderer>(
    options: L,
    selected: Option<V>,
    on_selected: impl Fn(T) -> Message + 'a,
) -> PickList<'a, T, L, V, Message, Theme, Renderer>
where
    T: ToString + PartialEq + Clone + 'a,
    L: Borrow<[T]> + 'a,
    V: Borrow<T> + 'a,
    Message: Clone,
    Theme: pick_list::Catalog + menu::Catalog,
    Renderer: core::text::Renderer,
{
    PickList::new(options, selected, on_selected)
}

/// Creates a new [`MouseArea`] for capturing mouse events.
///
/// This is a sweetened version of [`iced`'s `MouseArea`] where all event
/// handlers receive the cursor position as a [`Point`].
///
/// [`iced`'s `MouseArea`]: https://docs.iced.rs/iced/widget/struct.MouseArea.html
/// [`Point`]: crate::core::Point
pub fn mouse_area<'a, Message, Theme, Renderer>(
    widget: impl Into<Element<'a, Message, Theme, Renderer>>,
) -> MouseArea<'a, Message, Theme, Renderer>
where
    Renderer: core::Renderer,
{
    MouseArea::new(widget)
}