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 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295
//! Sub-menu popup widget and properties.
use std::sync::Arc;
use colors::BASE_COLOR_VAR;
use zng_ext_input::{
focus::{WidgetInfoFocusExt as _, FOCUS, FOCUS_CHANGED_EVENT},
keyboard::{Key, KeyState, KEY_INPUT_EVENT},
};
use zng_layout::unit::Orientation2D;
use zng_wgt::{base_color, border, prelude::*};
use zng_wgt_fill::background_color;
use zng_wgt_input::pointer_capture::{capture_pointer_on_init, CaptureMode};
use zng_wgt_layer::popup::{PopupCloseMode, POPUP, POPUP_CLOSE_CMD, POPUP_CLOSE_REQUESTED_EVENT};
use zng_wgt_stack::Stack;
use zng_wgt_style::{impl_style_fn, style_fn};
use super::sub::{SubMenuWidgetInfoExt, HOVER_OPEN_DELAY_VAR};
/// Sub-menu popup.
#[widget($crate::popup::SubMenuPopup)]
pub struct SubMenuPopup(zng_wgt_layer::popup::Popup);
impl SubMenuPopup {
fn widget_intrinsic(&mut self) {
self.style_intrinsic(STYLE_FN_VAR, property_id!(self::style_fn));
widget_set! {
self;
style_base_fn = style_fn!(|_| DefaultStyle!());
// Supports press-and-drag to click gesture:
//
// - Sub-menu is `capture_pointer = true`.
// - Menu items set`click_mode = release`.
//
// So the user can press to open the menu, then drag over an item and release to click it.
capture_pointer_on_init = CaptureMode::Subtree;
}
self.widget_builder().push_build_action(|wgt| {
let id = wgt.capture_value::<WidgetId>(property_id!(Self::parent_id));
let children = wgt
.capture_property(property_id!(Self::children))
.map(|p| p.args.ui_node_list(0).clone())
.unwrap_or_else(|| ArcNodeList::new(ui_vec![].boxed()));
wgt.set_child(sub_menu_popup_node(children, id));
});
}
}
impl_style_fn!(SubMenuPopup);
/// Sub-menu items.
#[property(CHILD, capture, default(ui_vec![]), widget_impl(SubMenuPopup))]
pub fn children(children: impl UiNodeList) {}
/// Parent sub-menu ID.
#[property(CONTEXT, capture, widget_impl(SubMenuPopup))]
pub fn parent_id(submenu_id: impl IntoValue<WidgetId>) {}
context_var! {
/// Defines the layout widget for [`SubMenuPopup!`].
///
/// Is [`default_panel_fn`] by default.
///
/// [`SubMenuPopup!`]: struct@SubMenuPopup
pub static PANEL_FN_VAR: WidgetFn<zng_wgt_panel::PanelArgs> = WidgetFn::new(default_panel_fn);
}
/// Widget function that generates the sub-menu popup layout.
///
/// This property sets [`PANEL_FN_VAR`].
#[property(CONTEXT, default(PANEL_FN_VAR), widget_impl(SubMenuPopup))]
pub fn panel_fn(child: impl UiNode, panel: impl IntoVar<WidgetFn<zng_wgt_panel::PanelArgs>>) -> impl UiNode {
with_context_var(child, PANEL_FN_VAR, panel)
}
/// Sub-menu popup default style.
#[widget($crate::popup::DefaultStyle)]
pub struct DefaultStyle(zng_wgt_layer::popup::DefaultStyle);
impl DefaultStyle {
fn widget_intrinsic(&mut self) {
widget_set! {
self;
super::sub::style_fn = style_fn!(|_| super::sub::SubMenuStyle!());
base_color = light_dark(rgb(0.82, 0.82, 0.82), rgb(0.18, 0.18, 0.18));
background_color = BASE_COLOR_VAR.rgba();
border = {
widths: 1,
sides: BASE_COLOR_VAR.shade_into(1),
};
}
}
}
/// Default sub-menu popup panel view.
///
/// See [`PANEL_FN_VAR`] for more details.
pub fn default_panel_fn(args: zng_wgt_panel::PanelArgs) -> impl UiNode {
// remove arrow key shortcuts, they are used to nav. focus.
let scroll_id = WidgetId::new_unique();
let _ = zng_wgt_scroll::cmd::SCROLL_UP_CMD
.scoped(scroll_id)
.shortcut()
.set(Shortcuts::new());
let _ = zng_wgt_scroll::cmd::SCROLL_DOWN_CMD
.scoped(scroll_id)
.shortcut()
.set(Shortcuts::new());
zng_wgt_scroll::Scroll! {
id = scroll_id;
focusable = false;
child = Stack! {
children = args.children;
direction = zng_wgt_stack::StackDirection::top_to_bottom();
};
mode = zng_wgt_scroll::ScrollMode::VERTICAL;
}
}
/// Sub-menu popup implementation.
pub fn sub_menu_popup_node(children: ArcNodeList<BoxedUiNodeList>, parent: Option<WidgetId>) -> impl UiNode {
let child = zng_wgt_panel::node(
children,
if parent.is_none() {
super::context::PANEL_FN_VAR
} else {
PANEL_FN_VAR
},
);
let mut close_timer = None;
match_node(child, move |c, op| match op {
UiNodeOp::Init => {
WIDGET
.sub_event(&KEY_INPUT_EVENT)
.sub_event(&POPUP_CLOSE_REQUESTED_EVENT)
.sub_event(&FOCUS_CHANGED_EVENT);
}
UiNodeOp::Deinit => {
close_timer = None;
}
UiNodeOp::Info { info } => {
// sub-menus set the popup as parent in context menu.
let parent_ctx = Some(parent.unwrap_or_else(|| WIDGET.id()));
super::sub::SUB_MENU_PARENT_CTX.with_context(&mut Some(Arc::new(parent_ctx)), || c.info(info));
info.set_meta(*super::sub::SUB_MENU_POPUP_ID, super::sub::SubMenuPopupInfo { parent });
}
UiNodeOp::Event { update } => {
c.event(update);
if let Some(args) = KEY_INPUT_EVENT.on_unhandled(update) {
if let KeyState::Pressed = args.state {
match &args.key {
Key::Escape => {
let info = WIDGET.info();
if let Some(m) = info.submenu_parent() {
args.propagation().stop();
FOCUS.focus_widget(m.id(), true);
POPUP.force_close_id(info.id());
}
}
Key::ArrowLeft | Key::ArrowRight => {
if let Some(info) = WINDOW.info().get(args.target.widget_id()) {
let info = info.into_focus_info(true, true);
if info.focusable_left().is_none() && info.focusable_right().is_none() {
// escape to parent or change root.
if let Some(m) = info.info().submenu_parent() {
let mut escape = false;
if m.submenu_parent().is_some() {
if let Some(o) = m.orientation_from(info.info().center()) {
escape = match o {
Orientation2D::Left => args.key == Key::ArrowLeft,
Orientation2D::Right => args.key == Key::ArrowRight,
Orientation2D::Below | Orientation2D::Above => false,
};
}
}
if escape {
args.propagation().stop();
// escape
FOCUS.focus_widget(m.id(), true);
POPUP.force_close_id(WIDGET.id());
} else if let Some(m) = info.info().submenu_root() {
args.propagation().stop();
// change root
let m = m.into_focus_info(true, true);
let next_root = match &args.key {
Key::ArrowLeft => m.next_left(),
Key::ArrowRight => m.next_right(),
_ => unreachable!(),
};
if let Some(n) = next_root {
FOCUS.focus_widget(n.info().id(), true);
}
}
}
}
}
}
_ => {}
}
}
} else if let Some(args) = POPUP_CLOSE_REQUESTED_EVENT.on_unhandled(update) {
let sub_self = if parent.is_some() {
WIDGET.info().submenu_parent()
} else {
// is context menu
Some(WIDGET.info())
};
if let Some(sub_self) = sub_self {
let mut close_ancestors = Some(None);
if let Some(focused) = FOCUS.focused().get() {
if let Some(focused) = sub_self.tree().get(focused.widget_id()) {
if let Some(sub_focused) = focused.submenu_parent() {
if sub_focused.submenu_ancestors().any(|a| a.id() == sub_self.id()) {
// keep open, focused child.
args.propagation().stop();
close_ancestors = None;
} else if sub_self.submenu_ancestors().any(|a| a.id() == sub_focused.id()) {
if Some(sub_focused.id()) == sub_self.submenu_parent().map(|s| s.id()) {
// keep open, focused parent.
args.propagation().stop();
close_ancestors = None;
} else {
close_ancestors = Some(Some(sub_focused.id()));
}
}
}
}
}
if let Some(sub_parent_focused) = close_ancestors {
// close any parent sub-menu that is not focused.
for a in sub_self.submenu_ancestors() {
if Some(a.id()) == sub_parent_focused {
break;
}
if let Some(v) = a.is_submenu_open() {
if v.get() {
// request ancestor close the popup.
POPUP_CLOSE_CMD.scoped(a.id()).notify();
}
} else if a.menu().is_none() {
// request context menu popup close
POPUP_CLOSE_CMD.scoped(a.id()).notify_param(PopupCloseMode::Force);
}
}
}
}
} else if let Some(args) = FOCUS_CHANGED_EVENT.on(update) {
if args.is_focus_leave(WIDGET.id()) {
if let Some(f) = &args.new_focus {
let info = WIDGET.info();
let sub_self = if parent.is_some() {
info.submenu_parent()
} else {
// is context menu
Some(info.clone())
};
if let (Some(sub_menu), Some(f)) = (sub_self, info.tree().get(f.widget_id())) {
if !f.submenu_self_and_ancestors().any(|s| s.id() == sub_menu.id()) {
// Focus did not move to child sub-menu nor parent,
// close after delay.
//
// This covers the case of focus moving to a widget that is not
// a child sub-menu and is not the parent sub-menu,
// `sub_menu_node` covers the case of focus moving to the parent sub-menu and out.
let t = TIMERS.deadline(HOVER_OPEN_DELAY_VAR.get());
t.subscribe(UpdateOp::Update, info.id()).perm();
close_timer = Some(t);
}
}
}
}
}
}
UiNodeOp::Update { .. } => {
if let Some(t) = &close_timer {
if t.get().has_elapsed() {
close_timer = None;
POPUP.force_close_id(WIDGET.id());
}
}
}
_ => {}
})
}