mod axis; mod direction; mod node; mod pane; mod split; mod state; pub use axis::Axis; pub use direction::Direction; pub use pane::Pane; pub use split::Split; pub use state::{Focus, State}; use crate::{ input::{keyboard, mouse, ButtonState}, layout, Clipboard, Element, Event, Hasher, Layout, Length, Point, Size, Widget, }; #[allow(missing_debug_implementations)] pub struct PaneGrid<'a, Message, Renderer> { state: &'a mut state::Internal, modifiers: &'a mut keyboard::ModifiersState, elements: Vec<(Pane, Element<'a, Message, Renderer>)>, width: Length, height: Length, spacing: u16, modifier_keys: keyboard::ModifiersState, on_drag: Option Message>>, on_resize: Option Message>>, on_key_press: Option Option>>, } impl<'a, Message, Renderer> PaneGrid<'a, Message, Renderer> { pub fn new( state: &'a mut State, view: impl Fn( Pane, &'a mut T, Option, ) -> Element<'a, Message, Renderer>, ) -> Self { let elements = { let action = state.internal.action(); let current_focus = action.focus(); state .panes .iter_mut() .map(move |(pane, pane_state)| { let focus = match current_focus { Some((focused_pane, focus)) if *pane == focused_pane => { Some(focus) } _ => None, }; (*pane, view(*pane, pane_state, focus)) }) .collect() }; Self { state: &mut state.internal, modifiers: &mut state.modifiers, elements, width: Length::Fill, height: Length::Fill, spacing: 0, modifier_keys: keyboard::ModifiersState { control: true, ..Default::default() }, on_drag: None, on_resize: None, on_key_press: None, } } /// Sets the width of the [`PaneGrid`]. /// /// [`PaneGrid`]: struct.Column.html pub fn width(mut self, width: Length) -> Self { self.width = width; self } /// Sets the height of the [`PaneGrid`]. /// /// [`PaneGrid`]: struct.Column.html pub fn height(mut self, height: Length) -> Self { self.height = height; self } /// Sets the spacing _between_ the panes of the [`PaneGrid`]. /// /// [`PaneGrid`]: struct.Column.html pub fn spacing(mut self, units: u16) -> Self { self.spacing = units; self } pub fn modifier_keys( mut self, modifier_keys: keyboard::ModifiersState, ) -> Self { self.modifier_keys = modifier_keys; self } pub fn on_drag( mut self, f: impl Fn(DragEvent) -> Message + 'static, ) -> Self { self.on_drag = Some(Box::new(f)); self } pub fn on_resize( mut self, f: impl Fn(ResizeEvent) -> Message + 'static, ) -> Self { self.on_resize = Some(Box::new(f)); self } pub fn on_key_press( mut self, f: impl Fn(KeyPressEvent) -> Option + 'static, ) -> Self { self.on_key_press = Some(Box::new(f)); self } fn trigger_resize( &mut self, layout: Layout<'_>, cursor_position: Point, messages: &mut Vec, ) { if let Some(on_resize) = &self.on_resize { if let Some((split, _)) = self.state.picked_split() { let bounds = layout.bounds(); let splits = self.state.splits( f32::from(self.spacing), Size::new(bounds.width, bounds.height), ); if let Some((axis, rectangle, _)) = splits.get(&split) { let ratio = match axis { Axis::Horizontal => { let position = cursor_position.y - bounds.y - rectangle.y; (position / rectangle.height).max(0.1).min(0.9) } Axis::Vertical => { let position = cursor_position.x - bounds.x - rectangle.x; (position / rectangle.width).max(0.1).min(0.9) } }; messages.push(on_resize(ResizeEvent { split, ratio })); } } } } } #[derive(Debug, Clone, Copy)] pub enum DragEvent { Picked { pane: Pane }, Dropped { pane: Pane, target: Pane }, Canceled { pane: Pane }, } #[derive(Debug, Clone, Copy)] pub struct ResizeEvent { pub split: Split, pub ratio: f32, } #[derive(Debug, Clone, Copy)] pub struct KeyPressEvent { pub key_code: keyboard::KeyCode, pub modifiers: keyboard::ModifiersState, } impl<'a, Message, Renderer> Widget for PaneGrid<'a, Message, Renderer> where Renderer: self::Renderer + 'static, Message: 'static, { fn width(&self) -> Length { self.width } fn height(&self) -> Length { self.height } fn layout( &self, renderer: &Renderer, limits: &layout::Limits, ) -> layout::Node { let limits = limits.width(self.width).height(self.height); let size = limits.resolve(Size::ZERO); let regions = self.state.regions(f32::from(self.spacing), size); let children = self .elements .iter() .filter_map(|(pane, element)| { let region = regions.get(pane)?; let size = Size::new(region.width, region.height); let mut node = element.layout(renderer, &layout::Limits::new(size, size)); node.move_to(Point::new(region.x, region.y)); Some(node) }) .collect(); layout::Node::with_children(size, children) } fn on_event( &mut self, event: Event, layout: Layout<'_>, cursor_position: Point, messages: &mut Vec, renderer: &Renderer, clipboard: Option<&dyn Clipboard>, ) { match event { Event::Mouse(mouse::Event::Input { button: mouse::Button::Left, state, }) => match state { ButtonState::Pressed => { let mut clicked_region = self.elements.iter().zip(layout.children()).filter( |(_, layout)| { layout.bounds().contains(cursor_position) }, ); if let Some(((pane, _), _)) = clicked_region.next() { match &self.on_drag { Some(on_drag) if self .modifiers .matches(self.modifier_keys) => { self.state.pick_pane(pane); messages.push(on_drag(DragEvent::Picked { pane: *pane, })); } _ => { self.state.focus(pane); } } } else { self.state.unfocus(); } } ButtonState::Released => { if let Some(pane) = self.state.picked_pane() { self.state.focus(&pane); if let Some(on_drag) = &self.on_drag { let mut dropped_region = self .elements .iter() .zip(layout.children()) .filter(|(_, layout)| { layout.bounds().contains(cursor_position) }); let event = match dropped_region.next() { Some(((target, _), _)) if pane != *target => { DragEvent::Dropped { pane, target: *target, } } _ => DragEvent::Canceled { pane }, }; messages.push(on_drag(event)); } } } }, Event::Mouse(mouse::Event::Input { button: mouse::Button::Right, state: ButtonState::Pressed, }) if self.on_resize.is_some() && self.state.picked_pane().is_none() && self.modifiers.matches(self.modifier_keys) => { let bounds = layout.bounds(); let relative_cursor = Point::new( cursor_position.x - bounds.x, cursor_position.y - bounds.y, ); let splits = self.state.splits( f32::from(self.spacing), Size::new(bounds.width, bounds.height), ); let mut sorted_splits: Vec<_> = splits .iter() .filter(|(_, (axis, rectangle, _))| match axis { Axis::Horizontal => { relative_cursor.x > rectangle.x && relative_cursor.x < rectangle.x + rectangle.width } Axis::Vertical => { relative_cursor.y > rectangle.y && relative_cursor.y < rectangle.y + rectangle.height } }) .collect(); sorted_splits.sort_by_key(|(_, (axis, rectangle, ratio))| { let distance = match axis { Axis::Horizontal => (relative_cursor.y - (rectangle.y + rectangle.height * ratio)) .abs(), Axis::Vertical => (relative_cursor.x - (rectangle.x + rectangle.width * ratio)) .abs(), }; distance.round() as u32 }); if let Some((split, (axis, _, _))) = sorted_splits.first() { self.state.pick_split(split, *axis); self.trigger_resize(layout, cursor_position, messages); } } Event::Mouse(mouse::Event::Input { button: mouse::Button::Right, state: ButtonState::Released, }) if self.state.picked_split().is_some() => { self.state.drop_split(); } Event::Mouse(mouse::Event::CursorMoved { .. }) => { self.trigger_resize(layout, cursor_position, messages); } Event::Keyboard(keyboard::Event::Input { modifiers, key_code, state, }) => { if let Some(on_key_press) = &self.on_key_press { // TODO: Discard when event is captured if state == ButtonState::Pressed { if let Some(_) = self.state.idle_pane() { if modifiers.matches(self.modifier_keys) { if let Some(message) = on_key_press(KeyPressEvent { key_code, modifiers, }) { messages.push(message); } } } } } *self.modifiers = modifiers; } _ => {} } if self.state.picked_pane().is_none() { { self.elements.iter_mut().zip(layout.children()).for_each( |((_, pane), layout)| { pane.widget.on_event( event.clone(), layout, cursor_position, messages, renderer, clipboard, ) }, ); } } } fn draw( &self, renderer: &mut Renderer, defaults: &Renderer::Defaults, layout: Layout<'_>, cursor_position: Point, ) -> Renderer::Output { renderer.draw( defaults, &self.elements, self.state.picked_pane(), self.state.picked_split().map(|(_, axis)| axis), layout, cursor_position, ) } fn hash_layout(&self, state: &mut Hasher) { use std::hash::Hash; std::any::TypeId::of::>().hash(state); self.width.hash(state); self.height.hash(state); self.state.hash_layout(state); for (_, element) in &self.elements { element.hash_layout(state); } } } /// The renderer of a [`PaneGrid`]. /// /// Your [renderer] will need to implement this trait before being /// able to use a [`PaneGrid`] in your user interface. /// /// [`PaneGrid`]: struct.PaneGrid.html /// [renderer]: ../../renderer/index.html pub trait Renderer: crate::Renderer + Sized { /// Draws a [`PaneGrid`]. /// /// It receives: /// - the elements of the [`PaneGrid`] /// - the [`Pane`] that is currently being dragged /// - the [`Layout`] of the [`PaneGrid`] and its elements /// - the cursor position /// /// [`Column`]: struct.Row.html /// [`Layout`]: ../layout/struct.Layout.html fn draw( &mut self, defaults: &Self::Defaults, content: &[(Pane, Element<'_, Message, Self>)], dragging: Option, resizing: Option, layout: Layout<'_>, cursor_position: Point, ) -> Self::Output; } impl<'a, Message, Renderer> From> for Element<'a, Message, Renderer> where Renderer: self::Renderer + 'static, Message: 'static, { fn from( pane_grid: PaneGrid<'a, Message, Renderer>, ) -> Element<'a, Message, Renderer> { Element::new(pane_grid) } }