//! Build and show dropdown menus. use crate::container::{self, Container}; use crate::core::alignment; use crate::core::event::{self, Event}; use crate::core::layout::{self, Layout}; use crate::core::mouse; use crate::core::overlay; use crate::core::renderer; use crate::core::text::{self, Text}; use crate::core::touch; use crate::core::widget::Tree; use crate::core::{ Clipboard, Color, Length, Padding, Pixels, Point, Rectangle, Size, Vector, }; use crate::core::{Element, Shell, Widget}; use crate::scrollable::{self, Scrollable}; pub use iced_style::menu::{Appearance, StyleSheet}; /// A list of selectable options. #[allow(missing_debug_implementations)] pub struct Menu<'a, T, Message, Renderer = crate::Renderer> where Renderer: text::Renderer, Renderer::Theme: StyleSheet, { state: &'a mut State, options: &'a [T], hovered_option: &'a mut Option, on_selected: Box Message + 'a>, on_option_hovered: Option<&'a dyn Fn(T) -> Message>, width: f32, padding: Padding, text_size: Option, text_line_height: text::LineHeight, text_shaping: text::Shaping, font: Option, style: ::Style, } impl<'a, T, Message, Renderer> Menu<'a, T, Message, Renderer> where T: ToString + Clone, Message: 'a, Renderer: text::Renderer + 'a, Renderer::Theme: StyleSheet + container::StyleSheet + scrollable::StyleSheet, { /// Creates a new [`Menu`] with the given [`State`], a list of options, and /// the message to produced when an option is selected. pub fn new( state: &'a mut State, options: &'a [T], hovered_option: &'a mut Option, on_selected: impl FnMut(T) -> Message + 'a, on_option_hovered: Option<&'a dyn Fn(T) -> Message>, ) -> Self { Menu { state, options, hovered_option, on_selected: Box::new(on_selected), on_option_hovered, width: 0.0, padding: Padding::ZERO, text_size: None, text_line_height: text::LineHeight::default(), text_shaping: text::Shaping::Basic, font: None, style: Default::default(), } } /// Sets the width of the [`Menu`]. pub fn width(mut self, width: f32) -> Self { self.width = width; self } /// Sets the [`Padding`] of the [`Menu`]. pub fn padding>(mut self, padding: P) -> Self { self.padding = padding.into(); self } /// Sets the text size of the [`Menu`]. pub fn text_size(mut self, text_size: impl Into) -> Self { self.text_size = Some(text_size.into()); self } /// Sets the text [`text::LineHeight`] of the [`Menu`]. pub fn text_line_height( mut self, line_height: impl Into, ) -> Self { self.text_line_height = line_height.into(); self } /// Sets the [`text::Shaping`] strategy of the [`Menu`]. pub fn text_shaping(mut self, shaping: text::Shaping) -> Self { self.text_shaping = shaping; self } /// Sets the font of the [`Menu`]. pub fn font(mut self, font: impl Into) -> Self { self.font = Some(font.into()); self } /// Sets the style of the [`Menu`]. pub fn style( mut self, style: impl Into<::Style>, ) -> Self { self.style = style.into(); self } /// Turns the [`Menu`] into an overlay [`Element`] at the given target /// position. /// /// The `target_height` will be used to display the menu either on top /// of the target or under it, depending on the screen position and the /// dimensions of the [`Menu`]. pub fn overlay( self, position: Point, target_height: f32, ) -> overlay::Element<'a, Message, Renderer> { overlay::Element::new( position, Box::new(Overlay::new(self, target_height)), ) } } /// The local state of a [`Menu`]. #[derive(Debug)] pub struct State { tree: Tree, } impl State { /// Creates a new [`State`] for a [`Menu`]. pub fn new() -> Self { Self { tree: Tree::empty(), } } } impl Default for State { fn default() -> Self { Self::new() } } struct Overlay<'a, Message, Renderer> where Renderer: crate::core::Renderer, Renderer::Theme: StyleSheet + container::StyleSheet, { state: &'a mut Tree, container: Container<'a, Message, Renderer>, width: f32, target_height: f32, style: ::Style, } impl<'a, Message, Renderer> Overlay<'a, Message, Renderer> where Message: 'a, Renderer: 'a, Renderer: text::Renderer, Renderer::Theme: StyleSheet + container::StyleSheet + scrollable::StyleSheet, { pub fn new( menu: Menu<'a, T, Message, Renderer>, target_height: f32, ) -> Self where T: Clone + ToString, { let Menu { state, options, hovered_option, on_selected, on_option_hovered, width, padding, font, text_size, text_line_height, text_shaping, style, } = menu; let container = Container::new(Scrollable::new(List { options, hovered_option, on_selected, on_option_hovered, font, text_size, text_line_height, text_shaping, padding, style: style.clone(), })); state.tree.diff(&container as &dyn Widget<_, _>); Self { state: &mut state.tree, container, width, target_height, style, } } } impl<'a, Message, Renderer> crate::core::Overlay for Overlay<'a, Message, Renderer> where Renderer: text::Renderer, Renderer::Theme: StyleSheet + container::StyleSheet, { fn layout( &mut self, renderer: &Renderer, bounds: Size, position: Point, _translation: Vector, ) -> layout::Node { let space_below = bounds.height - (position.y + self.target_height); let space_above = position.y; let limits = layout::Limits::new( Size::ZERO, Size::new( bounds.width - position.x, if space_below > space_above { space_below } else { space_above }, ), ) .width(self.width); let mut node = self.container.layout(self.state, renderer, &limits); node.move_to(if space_below > space_above { position + Vector::new(0.0, self.target_height) } else { position - Vector::new(0.0, node.size().height) }); node } fn on_event( &mut self, event: Event, layout: Layout<'_>, cursor: mouse::Cursor, renderer: &Renderer, clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, ) -> event::Status { let bounds = layout.bounds(); self.container.on_event( self.state, event, layout, cursor, renderer, clipboard, shell, &bounds, ) } fn mouse_interaction( &self, layout: Layout<'_>, cursor: mouse::Cursor, viewport: &Rectangle, renderer: &Renderer, ) -> mouse::Interaction { self.container .mouse_interaction(self.state, layout, cursor, viewport, renderer) } fn draw( &self, renderer: &mut Renderer, theme: &Renderer::Theme, style: &renderer::Style, layout: Layout<'_>, cursor: mouse::Cursor, ) { let appearance = theme.appearance(&self.style); let bounds = layout.bounds(); renderer.fill_quad( renderer::Quad { bounds, border_color: appearance.border_color, border_width: appearance.border_width, border_radius: appearance.border_radius, }, appearance.background, ); self.container .draw(self.state, renderer, theme, style, layout, cursor, &bounds); } } struct List<'a, T, Message, Renderer> where Renderer: text::Renderer, Renderer::Theme: StyleSheet, { options: &'a [T], hovered_option: &'a mut Option, on_selected: Box Message + 'a>, on_option_hovered: Option<&'a dyn Fn(T) -> Message>, padding: Padding, text_size: Option, text_line_height: text::LineHeight, text_shaping: text::Shaping, font: Option, style: ::Style, } impl<'a, T, Message, Renderer> Widget for List<'a, T, Message, Renderer> where T: Clone + ToString, Renderer: text::Renderer, Renderer::Theme: StyleSheet, { fn width(&self) -> Length { Length::Fill } fn height(&self) -> Length { Length::Shrink } fn layout( &self, _tree: &mut Tree, renderer: &Renderer, limits: &layout::Limits, ) -> layout::Node { use std::f32; let limits = limits.width(Length::Fill).height(Length::Shrink); let text_size = self.text_size.unwrap_or_else(|| renderer.default_size()); let text_line_height = self.text_line_height.to_absolute(text_size); let size = { let intrinsic = Size::new( 0.0, (f32::from(text_line_height) + self.padding.vertical()) * self.options.len() as f32, ); limits.resolve(intrinsic) }; layout::Node::new(size) } fn on_event( &mut self, _state: &mut Tree, event: Event, layout: Layout<'_>, cursor: mouse::Cursor, renderer: &Renderer, _clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, _viewport: &Rectangle, ) -> event::Status { match event { Event::Mouse(mouse::Event::ButtonPressed(mouse::Button::Left)) => { if cursor.is_over(layout.bounds()) { if let Some(index) = *self.hovered_option { if let Some(option) = self.options.get(index) { shell.publish((self.on_selected)(option.clone())); return event::Status::Captured; } } } } Event::Mouse(mouse::Event::CursorMoved { .. }) => { if let Some(cursor_position) = cursor.position_in(layout.bounds()) { let text_size = self .text_size .unwrap_or_else(|| renderer.default_size()); let option_height = f32::from(self.text_line_height.to_absolute(text_size)) + self.padding.vertical(); let new_hovered_option = (cursor_position.y / option_height) as usize; if let Some(on_option_hovered) = self.on_option_hovered { if *self.hovered_option != Some(new_hovered_option) { if let Some(option) = self.options.get(new_hovered_option) { shell .publish(on_option_hovered(option.clone())); } } } *self.hovered_option = Some(new_hovered_option); } } Event::Touch(touch::Event::FingerPressed { .. }) => { if let Some(cursor_position) = cursor.position_in(layout.bounds()) { let text_size = self .text_size .unwrap_or_else(|| renderer.default_size()); let option_height = f32::from(self.text_line_height.to_absolute(text_size)) + self.padding.vertical(); *self.hovered_option = Some((cursor_position.y / option_height) as usize); if let Some(index) = *self.hovered_option { if let Some(option) = self.options.get(index) { shell.publish((self.on_selected)(option.clone())); return event::Status::Captured; } } } } _ => {} } event::Status::Ignored } fn mouse_interaction( &self, _state: &Tree, layout: Layout<'_>, cursor: mouse::Cursor, _viewport: &Rectangle, _renderer: &Renderer, ) -> mouse::Interaction { let is_mouse_over = cursor.is_over(layout.bounds()); if is_mouse_over { mouse::Interaction::Pointer } else { mouse::Interaction::default() } } fn draw( &self, _state: &Tree, renderer: &mut Renderer, theme: &Renderer::Theme, _style: &renderer::Style, layout: Layout<'_>, _cursor: mouse::Cursor, viewport: &Rectangle, ) { let appearance = theme.appearance(&self.style); let bounds = layout.bounds(); let text_size = self.text_size.unwrap_or_else(|| renderer.default_size()); let option_height = f32::from(self.text_line_height.to_absolute(text_size)) + self.padding.vertical(); let offset = viewport.y - bounds.y; let start = (offset / option_height) as usize; let end = ((offset + viewport.height) / option_height).ceil() as usize; let visible_options = &self.options[start..end.min(self.options.len())]; for (i, option) in visible_options.iter().enumerate() { let i = start + i; let is_selected = *self.hovered_option == Some(i); let bounds = Rectangle { x: bounds.x, y: bounds.y + (option_height * i as f32), width: bounds.width, height: option_height, }; if is_selected { renderer.fill_quad( renderer::Quad { bounds: Rectangle { x: bounds.x + appearance.border_width, width: bounds.width - appearance.border_width * 2.0, ..bounds }, border_color: Color::TRANSPARENT, border_width: 0.0, border_radius: appearance.border_radius, }, appearance.selected_background, ); } renderer.fill_text( Text { content: &option.to_string(), bounds: Size::new(f32::INFINITY, bounds.height), size: text_size, line_height: self.text_line_height, font: self.font.unwrap_or_else(|| renderer.default_font()), horizontal_alignment: alignment::Horizontal::Left, vertical_alignment: alignment::Vertical::Center, shaping: self.text_shaping, }, Point::new(bounds.x + self.padding.left, bounds.center_y()), if is_selected { appearance.selected_text_color } else { appearance.text_color }, ); } } } impl<'a, T, Message, Renderer> From> for Element<'a, Message, Renderer> where T: ToString + Clone, Message: 'a, Renderer: 'a + text::Renderer, Renderer::Theme: StyleSheet, { fn from(list: List<'a, T, Message, Renderer>) -> Self { Element::new(list) } }