iced_aw 0.14.0

Additional widgets for the Iced 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
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159

#![allow(clippy::doc_markdown)]

//! A [`MenuBar`] widget for displaying menu trees created with [`Item`]s and [`Menu`]s
//!
//! *This API requires the following crate features to be activated: `menu`*
//!
//! ## Example 1
//!
//! ```ignore
//! use iced_widget::button;
//! use iced_aw::menu::{Item, Menu, MenuBar};
//!
//! let sub_2 = Item::with_menu(
//!     button("Sub Menu 2"),
//!     Menu::new([
//!         Item::new(button("item_1")),
//!         Item::new(button("item_2")),
//!         Item::new(button("item_3")),
//!     ].into())
//! );
//!
//! let sub_1 = Item::with_menu(
//!     button("Sub Menu 1"),
//!     Menu::new([
//!         Item::new(button("item_1")),
//!         sub_2,
//!         Item::new(button("item_2")),
//!         Item::new(button("item_3")),
//!     ].into())
//! );
//!
//! let root_1 = Item::with_menu(
//!     button("Menu 1"),
//!     Menu::new([
//!         Item::new(button("item_1")),
//!         Item::new(button("item_2")),
//!         sub_1,
//!         Item::new(button("item_3")),
//!     ].into())
//! );
//!
//! let root_2 = Item::with_menu(
//!     button("Menu 2"),
//!     Menu::new([
//!         Item::new(button("item_1")),
//!         Item::new(button("item_2")),
//!         Item::new(button("item_3")),
//!     ].into())
//! );
//!
//! let menu_bar = MenuBar::new(vec![root_1, root_2]);
//!
//! ```
//!
//! Alternatively you can use the helper macros
//!
//! ## Example 2
//! ```ignore
//! use iced_widget::button;
//! use iced_aw::menu::{Menu, Item, MenuBar};
//! use iced_aw::{menu_bar, menu_items};
//!
//! let menu_template = |items| Menu::new(items).max_width(180.0).offset(6.0);
//!
//! let menu_bar: MenuBar<'_, (), iced_widget::Theme, iced::Renderer> = menu_bar!(
//!     (button("Menu 1"),menu_template(menu_items!(
//!         (button("item_1"))
//!         (button("item_2"))
//!         (button("Sub Menu 1"), menu_template(menu_items!(
//!             (button("item_1"))
//!             (button("Sub Menu 2"), menu_template(menu_items!(
//!                 (button("item_1"))
//!                 (button("item_2"))
//!                 (button("item_3"))
//!             )))
//!             (button("item_2"))
//!             (button("item_3"))
//!         )))
//!         (button("item_3"))
//!     )))
//!     (button("Menu 2"), menu_template(menu_items!(
//!         (button("item_1"))
//!         (button("item_2"))
//!         (button("item_3"))
//!     )))
//! );
//! ```
//!
//! Here a menu_template function/closure is used in example 2,
//! usually some properties are sync across all menus while others are not,
//! using template functions can reduce the repeated code.
//! If you find writing menu_template(menu_items!()) too cumbersome,
//! there's a menu! macro you can use to create template macros
//!
//! ## Example 3
//!
//! ```ignore
//! use iced_widget::button;
//! use iced_aw::{menu, Menu};
//!
//! macro_rules! menu_template {
//!     ($($x:tt)+) => {
//!         menu!($($x)+).max_width(180.0).offset(6.0)
//!     };
//! }
//!
//! // then you can just write
//! let m: Menu<'_, (), iced_widget::Theme, iced::Renderer> = menu_template!(
//!     (button("item_1"))
//!     (button("item_2"))
//!     (button("sub menu"), menu_template!(
//!         (button("item_1"))
//!         (button("item_2"))
//!     ))
//!     (button("item_3"))
//! );
//! ```
//!
//! Technically you can create menu template functions with the menu! macro,
//! but turns out closures can't infer the proper generic types in this case,
//! and creating a function for it you have to write a bunch of generic annotations
//!
//! ## Example 4
//!
//! ```ignore
//! use iced_aw::{menu, Menu};
//! use iced_widget::button;
//!
//! fn menu_template<'a, Message, Theme, Renderer>(
//! menu: Menu<'a, Message, Theme, Renderer>
//! ) -> Menu<'a, Message, Theme, Renderer>
//! where
//!     Theme: iced_aw::menu::Catalog,
//!     Renderer: iced_core::Renderer,
//! {
//!     menu.max_width(180.0).offset(6.0)
//! }
//!
//! let m: Menu<'_, (), iced_widget::Theme, iced::Renderer> = menu_template(menu!(
//!     (button("item_1"))
//!     (button("item_2"))
//!     (button("item_3"))
//! ));
//! ```
//!
//! For a more detailed example please
//! take a look at the menu example in the iced_aw repo
//!

mod common;
mod flex;
mod menu_bar;
mod menu_bar_overlay;
mod menu_tree;

pub use crate::style::menu_bar::{Catalog, Style, primary};
pub use common::{DrawPath, ScrollSpeed};
pub use menu_bar::MenuBar;
pub use menu_tree::{Item, Menu};