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 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560
//! //! Widgets in pixel-widgets are defined using the [`Widget`](trait.Widget.html) trait. //! You can choose to implement widgets yourself, or you can use the built in widgets that come with pixel-widgets: //! - [`Button`](button/struct.Button.html) //! - [`Toggle`](toggle/struct.Toggle.html) //! - [`Column`](column/struct.Column.html) //! - [`Row`](row/struct.Row.html) //! - [`Text`](text/struct.Text.html) //! - [`Space`](space/struct.Space.html) //! - [`Input`](input/struct.Input.html) //! - [`Scroll`](scroll/struct.Scroll.html) //! - [`Layers`](layers/struct.Layers.html) //! - [`Window`](window/struct.Window.html) //! //! Since pixel-widgets rebuilds the whole ui every time the [`Model`](../trait.Model.html) is modified, //! most widgets need to keep track of some kind of state across rebuilds. You can manually supply these state //! objects in your [`view`](../trait.Model.html#tymethod.view) implementation, or you can use a //! [`ManagedState`](../tracker/struct.ManagedState.html), which tracks state for your widgets using user defined ids. //! //! When implementing custom widgets, you need to make sure that the custom widgets do not remember absolute layouts. //! Widgets like [`Scroll`](scroll/struct.Scroll.html) can change the layout without needing a rebuild of the ui. use std::cell::Cell; use std::ops::Deref; use crate::bitset::BitSet; use crate::draw::Primitive; use crate::event::{Event, Key, NodeEvent}; use crate::layout::*; use crate::stylesheet::tree::Query; use crate::stylesheet::*; pub use self::button::Button; pub use self::column::Column; pub use self::drag_drop::{Drag, Drop}; pub use self::dropdown::Dropdown; pub use self::dummy::Dummy; pub use self::frame::Frame; pub use self::image::Image; pub use self::input::Input; pub use self::layers::Layers; pub use self::menu::Menu; pub use self::panel::Panel; pub use self::progress::Progress; pub use self::row::Row; pub use self::scroll::Scroll; pub use self::space::Space; pub use self::text::Text; pub use self::toggle::Toggle; pub use self::window::Window; use smallvec::SmallVec; use std::sync::Arc; /// A clickable button pub mod button; /// Layout child widgets vertically pub mod column; /// Drag and drop zones pub mod drag_drop; /// Pick an item from a dropdown box pub mod dropdown; /// Dummy widget that has a custom widget name pub mod dummy; /// A widget that wraps around a content widget pub mod frame; /// Just an image pub mod image; /// Editable text input pub mod input; /// Stack child widgets on top of each other, while only the topmost receives events. pub mod layers; /// A context menu with nestable items pub mod menu; /// A panel with a fixed size and location within it's parent pub mod panel; /// A bar that fills up according to a value. pub mod progress; /// Layout child widgets horizontally pub mod row; /// View a small section of larger widget, with scrollbars. pub mod scroll; /// Empty widget pub mod space; /// Widget that renders a paragraph of text. pub mod text; /// A clickable button that toggles some `bool`. pub mod toggle; /// A window with a title and a content widget that can be moved by dragging the title. pub mod window; /// A user interface widget. pub trait Widget<'a, Message>: Send { /// The name of this widget, used to identify widgets of this type in stylesheets. fn widget(&self) -> &'static str; /// The state of this widget, used for computing the style. /// If `None` is returned, `Node` will automatically compute a state, such as "hover" and "pressed". fn state(&self) -> StateVec { StateVec::new() } /// Should return the amount of children this widget has. Must be consistent with /// [`visit_children()`](#tymethod.visit_children). fn len(&self) -> usize; /// Applies a visitor to all childs of the widget. If an widget fails to visit it's children, the children won't /// be able to resolve their stylesheet, resulting in a panic when calling [`size`](struct.Node.html#method.size), /// [`hit`](struct.Node.html#method.hit), [`event`](struct.Node.html#method.event) or /// [`draw`](struct.Node.html#method.draw). fn visit_children(&mut self, visitor: &mut dyn FnMut(&mut Node<'a, Message>)); /// Returns the `(width, height)` of this widget. /// The extents are defined as a [`Size`](../layout/struct.Size.html), /// which will later be resolved to actual dimensions. fn size(&self, style: &Stylesheet) -> (Size, Size); /// Perform a hit detect on the widget. Most widgets are fine with the default implementation, but some /// widgets (like [`Window`](window/struct.Window.html) need to report a _miss_ (`false`) even when the queried /// position is within their layout. /// /// Arguments: /// - `layout`: the layout assigned to the widget /// - `clip`: a clipping rect for mouse events. Mouse events outside of this rect should be considered invalid, /// such as with [`Scroll`](scroll/struct.Scroll.html), where the widget would not be visible outside of the /// currently visible rect. /// - `x`: x mouse coordinate being queried /// - `y`: y mouse coordinate being queried fn hit(&self, layout: Rectangle, clip: Rectangle, _style: &Stylesheet, x: f32, y: f32) -> bool { layout.point_inside(x, y) && clip.point_inside(x, y) } /// Test the widget for focus exclusivity. /// If the widget or one of it's descendants is in an exclusive focus state, this function should return `true`. /// In all other cases, it should return `false`. When a widget is in an exclusive focus state it is /// the only widget that is allowed to receive events in [`event`](#tymethod.event). /// Widgets that intended to use this behaviour are modal dialogs, dropdown boxes, context menu's, etc. fn focused(&self) -> bool { false } /// Handle an event. If an event changes the graphical appearance of an `Widget`, /// [`redraw`](struct.Context.html#method.redraw) should be called to let the [`Ui`](../struct.Ui.html) know that /// the ui should be redrawn. /// /// Arguments: /// - `layout`: the layout assigned to the widget /// - `clip`: a clipping rect for mouse events. Mouse events outside of this rect should be considered invalid, /// such as with [`Scroll`](scroll/struct.Scroll.html), where the widget would not be visible outside of the /// currently visible rect. /// - `event`: the event that needs to be handled /// - `context`: context for submitting messages and requesting redraws of the ui. fn event( &mut self, _layout: Rectangle, _clip: Rectangle, _style: &Stylesheet, _event: Event, _context: &mut Context<Message>, ) { } /// Handle a node event. If an event changes the graphical appearance of an `Widget`, /// [`redraw`](struct.Context.html#method.redraw) should be called to let the [`Ui`](../struct.Ui.html) know that /// the ui should be redrawn. /// /// Arguments: /// - `event`: the event that needs to be handled /// - `context`: context for submitting messages and requesting redraws of the ui. fn node_event( &mut self, _layout: Rectangle, _style: &Stylesheet, _event: NodeEvent, _context: &mut Context<Message>, ) { } /// Draw the widget. Returns a list of [`Primitive`s](../draw/enum.Primitive.html) that should be drawn. /// /// Arguments: /// - `layout`: the layout assigned to the widget /// - `clip`: a clipping rect for use with [`Primitive::PushClip`](../draw/enum.Primitive.html#variant.PushClip). fn draw(&mut self, layout: Rectangle, clip: Rectangle, style: &Stylesheet) -> Vec<Primitive<'a>>; } /// Convert to a generic widget. All widgets should implement this trait. It is also implemented by `Node` itself, /// which simply returns self. pub trait IntoNode<'a, Message: 'a>: 'a + Sized { /// Perform the conversion. fn into_node(self) -> Node<'a, Message>; /// Convenience function that converts to a node and then adds a style class to the `Node`. fn class(self, class: &'a str) -> Node<'a, Message> { self.into_node().class(class) } /// Convenience function that converts to a node and then sets a handler for when a node event occurs. fn on_event(self, event: NodeEvent, f: impl 'a + Send + Fn(&mut Context<Message>)) -> Node<'a, Message> { self.into_node().on_event(event, f) } } /// Storage for style states pub type StateVec = SmallVec<[StyleState<&'static str>; 3]>; /// Generic ui widget. pub struct Node<'a, Message> { widget: Box<dyn Widget<'a, Message> + 'a>, event_handlers: Vec<(NodeEvent, Box<dyn 'a + Fn(&mut Context<Message>) + Send>)>, clicks: Vec<Key>, hovered: bool, size: Cell<Option<(Size, Size)>>, focused: Cell<Option<bool>>, position: (usize, usize), style: Option<Arc<Style>>, selector_matches: BitSet, stylesheet: Option<Arc<Stylesheet>>, class: Option<&'a str>, state: StateVec, } /// Context for posting messages and requesting redraws of the ui. pub struct Context<Message> { cursor: (f32, f32), redraw: bool, messages: Vec<Message>, } impl<'a, Message> Node<'a, Message> { /// Construct a new `Node` from an [`Widget`](trait.Widget.html). pub fn new<T: 'a + Widget<'a, Message>>(widget: T) -> Self { Node { widget: Box::new(widget), event_handlers: Vec::new(), clicks: Vec::new(), hovered: false, size: Cell::new(None), focused: Cell::new(None), position: (0, 1), style: None, selector_matches: BitSet::new(), stylesheet: None, class: None, state: SmallVec::new(), } } /// Sets the style class pub fn class(mut self, class: &'a str) -> Self { self.class = Some(class); self } /// Sets a handler for when a node event occurs pub fn on_event(mut self, event: NodeEvent, f: impl 'a + Send + Fn(&mut Context<Message>)) -> Self { self.event_handlers.push((event, Box::new(f))); self } fn state(&self) -> StateVec { let mut result = self.widget.state(); if self.hovered { result.push(StyleState::Hover); } if self.clicks.len() > 0 { result.push(StyleState::Pressed); } result } pub(crate) fn style(&mut self, query: &mut Query) { // remember style self.style = Some(query.style.clone()); // resolve own stylesheet self.state = self.state(); self.selector_matches = query.match_widget( self.widget.widget(), self.class.unwrap_or(""), self.state.as_slice(), self.position.0, self.position.1, ); self.stylesheet.replace(query.style.get(&self.selector_matches)); // resolve children style query.ancestors.push(self.selector_matches.clone()); let own_siblings = std::mem::replace(&mut query.siblings, Vec::new()); let mut i = 0; let len = self.widget.len(); self.widget.visit_children(&mut |child| { child.position = (i, len); child.style(&mut *query); i += 1; }); query.siblings = own_siblings; query.siblings.push(query.ancestors.pop().unwrap()); } fn add_matches(&mut self, query: &mut Query) { let additions = query.match_widget( self.widget.widget(), self.class.unwrap_or(""), self.state.as_slice(), self.position.0, self.position.1, ); let new_style = self.selector_matches.union(&additions); if new_style != self.selector_matches { self.selector_matches = new_style; self.stylesheet .replace(self.style.as_ref().unwrap().get(&self.selector_matches)); } query.ancestors.push(additions); let own_siblings = std::mem::replace(&mut query.siblings, Vec::new()); self.widget.visit_children(&mut |child| child.add_matches(&mut *query)); query.siblings = own_siblings; query.siblings.push(query.ancestors.pop().unwrap()); } fn remove_matches(&mut self, query: &mut Query) { let removals = query.match_widget( self.widget.widget(), self.class.unwrap_or(""), self.state.as_slice(), self.position.0, self.position.1, ); let new_style = self.selector_matches.difference(&removals); if new_style != self.selector_matches { self.selector_matches = new_style; self.stylesheet .replace(self.style.as_ref().unwrap().get(&self.selector_matches)); } query.ancestors.push(removals); let own_siblings = std::mem::replace(&mut query.siblings, Vec::new()); self.widget .visit_children(&mut |child| child.remove_matches(&mut *query)); query.siblings = own_siblings; query.siblings.push(query.ancestors.pop().unwrap()); } /// Returns the `(width, height)` of this widget. /// The extents are defined as a [`Size`](../layout/struct.Size.html), /// which will later be resolved to actual dimensions. pub fn size(&self) -> (Size, Size) { if self.size.get().is_none() { let style = self.stylesheet.as_ref().unwrap().deref(); let mut size = self.widget.size(style); size.0 = match size.0 { Size::Exact(size) => Size::Exact(size + style.margin.left + style.margin.right), other => other, }; size.1 = match size.1 { Size::Exact(size) => Size::Exact(size + style.margin.top + style.margin.bottom), other => other, }; self.size.replace(Some(size)); } self.size.get().unwrap() } /// Perform a hit detect on the widget. Most widgets are fine with the default implementation, but some /// widgets (like [`Window`](window/struct.Window.html) need to report a _miss_ (`false`) even when the queried /// position is within their layout. /// /// Arguments: /// - `layout`: the layout assigned to the widget /// - `clip`: a clipping rect for mouse events. Mouse events outside of this rect should be considered invalid, /// such as with [`Scroll`](scroll/struct.Scroll.html), where the widget would not be visible outside of the /// currently visible rect. /// - `x`: x mouse coordinate being queried /// - `y`: y mouse coordinate being queried pub fn hit(&self, layout: Rectangle, clip: Rectangle, x: f32, y: f32) -> bool { let stylesheet = self.stylesheet.as_ref().unwrap().deref(); let layout = layout.after_padding(stylesheet.margin); self.widget.hit(layout, clip, stylesheet, x, y) } /// Test the widget for focus exclusivity. /// If the widget or one of it's descendants is in an exclusive focus state, this function should return `true`. /// In all other cases, it should return `false`. When a widget is in an exclusive focus state it is /// the only widget that is allowed to receive events in [`event`](#tymethod.event). /// Widgets that intended to use this behaviour are modal dialogs, dropdown boxes, context menu's, etc. pub fn focused(&self) -> bool { if self.focused.get().is_none() { self.focused.replace(Some(self.widget.focused())); } self.focused.get().unwrap() } fn dispatch(&mut self, layout: Rectangle, event: NodeEvent, context: &mut Context<Message>) { self.widget .node_event(layout, self.stylesheet.as_ref().unwrap().deref(), event, context); for (handler_event, handler) in self.event_handlers.iter_mut() { if *handler_event == event { (handler)(context); } } } /// Handle an event. /// /// Arguments: /// - `layout`: the layout assigned to the widget /// - `clip`: a clipping rect for mouse events. Mouse events outside of this rect should be considered invalid, /// such as with [`Scroll`](scroll/struct.Scroll.html), where the widget would not be visible outside of the /// currently visible rect. /// - `event`: the event that needs to be handled /// - `context`: context for submitting messages and requesting redraws of the ui. pub fn event(&mut self, layout: Rectangle, clip: Rectangle, event: Event, context: &mut Context<Message>) { // generate higher level events match event { Event::Cursor(x, y) => { let hovered = self.hit(layout, clip, x, y); if hovered != self.hovered { self.hovered = hovered; if hovered { self.dispatch(layout, NodeEvent::MouseEnter, context); } else { self.dispatch(layout, NodeEvent::MouseLeave, context); self.clicks.clear(); } } } Event::Press(button) if self.hovered => { self.dispatch(layout, NodeEvent::MouseDown(button), context); self.clicks.push(button); } Event::Release(button) if self.hovered => { self.dispatch(layout, NodeEvent::MouseUp(button), context); let len = self.clicks.len(); self.clicks.retain(|click| click != &button); if len != self.clicks.len() { self.dispatch(layout, NodeEvent::MouseClick(button), context); } } _ => (), } let stylesheet = self.stylesheet.as_ref().unwrap().deref(); let layout = layout.after_padding(stylesheet.margin); self.widget.event(layout, clip, stylesheet, event, context); self.focused.replace(Some(self.widget.focused())); let next_state = self.state(); if next_state != self.state { self.state = next_state; // find out if the style changed as a result of the state change let new_style = self.style.as_ref().unwrap().rule_tree().rematch( &self.selector_matches, self.state.as_slice(), self.class.unwrap_or(""), self.position.0, self.position.1, ); // apply the style change to self and any children that have styles living down the same rule tree paths. if new_style != self.selector_matches { context.redraw(); let difference = new_style.difference(&self.selector_matches); let additions = difference.intersection(&new_style); let removals = difference.intersection(&self.selector_matches); if !additions.is_empty() { let mut query = Query { style: self.style.clone().unwrap(), ancestors: vec![additions], siblings: vec![], }; self.widget.visit_children(&mut |child| child.add_matches(&mut query)); } if !removals.is_empty() { let mut query = Query { style: self.style.clone().unwrap(), ancestors: vec![removals], siblings: vec![], }; self.widget .visit_children(&mut |child| child.remove_matches(&mut query)); } self.selector_matches = new_style; self.stylesheet .replace(self.style.as_ref().unwrap().get(&self.selector_matches)); } } } /// Draw the widget. Returns a list of [`Primitive`s](../draw/enum.Primitive.html) that should be drawn. /// /// Arguments: /// - `layout`: the layout assigned to the widget /// - `clip`: a clipping rect for use with [`Primitive::PushClip`](../draw/enum.Primitive.html#variant.PushClip). pub fn draw(&mut self, layout: Rectangle, clip: Rectangle) -> Vec<Primitive<'a>> { let stylesheet = self.stylesheet.as_ref().unwrap().deref(); let layout = layout.after_padding(stylesheet.margin); self.widget.draw(layout, clip, stylesheet) } } impl<'a, Message: 'a> IntoNode<'a, Message> for Node<'a, Message> { fn into_node(self) -> Node<'a, Message> { self } } impl<Message> Context<Message> { pub(crate) fn new(redraw: bool, cursor: (f32, f32)) -> Self { Self { cursor, redraw, messages: Vec::new(), } } /// Push a message to the current [`Model`]. pub fn push(&mut self, message: Message) { self.messages.push(message); } /// Push multiple messages to the current [`Model`] using an iterator. pub fn extend<I: IntoIterator<Item = Message>>(&mut self, iter: I) { self.messages.extend(iter); } /// Request a redraw of the ui. pub fn redraw(&mut self) { self.redraw = true; } /// Returns the redraw flag. pub fn redraw_requested(&self) -> bool { self.redraw } /// Returns the cursor position pub fn cursor(&self) -> (f32, f32) { self.cursor } } impl<Message> IntoIterator for Context<Message> { type Item = Message; type IntoIter = std::vec::IntoIter<Message>; fn into_iter(self) -> Self::IntoIter { self.messages.into_iter() } }