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
// Copyright 2019 The Druid Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//! Events.
use crate::kurbo::{Rect, Shape, Size, Vec2};
use druid_shell::{Clipboard, KeyEvent, TimerToken};
use crate::mouse::MouseEvent;
use crate::{Command, Notification, WidgetId};
/// An event, propagated downwards during event flow.
///
/// With two exceptions ([`Event::Command`] and [`Event::Notification`], which
/// have special considerations outlined in their own docs) each event
/// corresponds to some user action or other message recieved from the platform.
///
/// Events are things that happen that can change the state of widgets.
/// An important category is events plumbed from the platform windowing
/// system, which includes mouse and keyboard events, but also (in the
/// future) status changes such as window focus changes.
///
/// Events can also be higher level concepts indicating state changes
/// within the widget hierarchy, for example when a widget gains or loses
/// focus or "hot" (also known as hover) status.
///
/// Events are a key part of what is called "event flow", which is
/// basically the propagation of an event through the widget hierarchy
/// through the [`event`] widget method. A container widget will
/// generally pass the event to its children, mediated through the
/// [`WidgetPod`] container, which is where most of the event flow logic
/// is applied (especially the decision whether or not to propagate).
///
/// This enum is expected to grow considerably, as there are many, many
/// different kinds of events that are relevant in a GUI.
///
/// [`event`]: trait.Widget.html#tymethod.event
/// [`WidgetPod`]: struct.WidgetPod.html
#[derive(Debug, Clone)]
pub enum Event {
/// Sent to all widgets in a given window when that window is first instantiated.
///
/// This should always be the first `Event` received, although widgets will
/// receive [`LifeCycle::WidgetAdded`] first.
///
/// Widgets should handle this event if they need to do some addition setup
/// when a window is first created.
///
/// [`LifeCycle::WidgetAdded`]: enum.LifeCycle.html#variant.WidgetAdded
WindowConnected,
/// Sent to all widgets in a given window when the system requests to close the window.
///
/// If the event is handled (with [`set_handled`]), the window will not be closed.
/// All widgets are given an opportunity to handle this event; your widget should not assume
/// that the window *will* close just because this event is received; for instance, you should
/// avoid destructive side effects such as cleaning up resources.
///
/// [`set_handled`]: crate::EventCtx::set_handled
WindowCloseRequested,
/// Sent to all widgets in a given window when the system is going to close that window.
///
/// This event means the window *will* go away; it is safe to dispose of resources and
/// do any other cleanup.
WindowDisconnected,
/// Called on the root widget when the window size changes.
///
/// Discussion: it's not obvious this should be propagated to user
/// widgets. It *is* propagated through the RootWidget and handled
/// in the WindowPod, but after that it might be considered better
/// to just handle it in `layout`.
WindowSize(Size),
/// Called when a mouse button is pressed.
MouseDown(MouseEvent),
/// Called when a mouse button is released.
MouseUp(MouseEvent),
/// Called when the mouse is moved.
///
/// The `MouseMove` event is propagated to the active widget, if
/// there is one, otherwise to hot widgets (see `HotChanged`).
/// If a widget loses its hot status due to `MouseMove` then that specific
/// `MouseMove` event is also still sent to that widget.
///
/// The `MouseMove` event is also the primary mechanism for widgets
/// to set a cursor, for example to an I-bar inside a text widget. A
/// simple tactic is for the widget to unconditionally call
/// [`set_cursor`] in the MouseMove handler, as `MouseMove` is only
/// propagated to active or hot widgets.
///
/// [`set_cursor`]: struct.EventCtx.html#method.set_cursor
MouseMove(MouseEvent),
/// Called when the mouse wheel or trackpad is scrolled.
Wheel(MouseEvent),
/// Called when a key is pressed.
KeyDown(KeyEvent),
/// Called when a key is released.
///
/// Because of repeat, there may be a number `KeyDown` events before
/// a corresponding `KeyUp` is sent.
KeyUp(KeyEvent),
/// Called when a paste command is received.
Paste(Clipboard),
/// Called when the trackpad is pinched.
///
/// The value is a delta.
Zoom(f64),
/// Called on a timer event.
///
/// Request a timer event through [`EventCtx::request_timer()`]. That will
/// cause a timer event later.
///
/// Note that timer events from other widgets may be delivered as well. Use
/// the token returned from the `request_timer()` call to filter events more
/// precisely.
///
/// [`EventCtx::request_timer()`]: struct.EventCtx.html#method.request_timer
Timer(TimerToken),
/// Called at the beginning of a new animation frame.
///
/// On the first frame when transitioning from idle to animating, `interval`
/// will be 0. (This logic is presently per-window but might change to
/// per-widget to make it more consistent). Otherwise it is in nanoseconds.
///
/// The `paint` method will be called shortly after this event is finished.
/// As a result, you should try to avoid doing anything computationally
/// intensive in response to an `AnimFrame` event: it might make Druid miss
/// the monitor's refresh, causing lag or jerky animation.
AnimFrame(u64),
/// An event containing a [`Command`] to be handled by the widget.
///
/// [`Command`]s are messages, optionally with attached data, that can
/// may be generated from a number of sources:
///
/// - If your application uses menus (either window or context menus)
/// then the [`MenuItem`]s in the menu will each correspond to a `Command`.
/// When the menu item is selected, that [`Command`] will be delivered to
/// the root widget of the appropriate window.
/// - If you are doing work in another thread (using an [`ExtEventSink`])
/// then [`Command`]s are the mechanism by which you communicate back to
/// the main thread.
/// - Widgets and other Druid components can send custom [`Command`]s at
/// runtime, via methods such as [`EventCtx::submit_command`].
///
/// [`Command`]: struct.Command.html
/// [`Widget`]: trait.Widget.html
/// [`EventCtx::submit_command`]: struct.EventCtx.html#method.submit_command
/// [`ExtEventSink`]: crate::ExtEventSink
/// [`MenuItem`]: crate::MenuItem
Command(Command),
/// A [`Notification`] from one of this widget's descendants.
///
/// While handling events, widgets can submit notifications to be
/// delivered to their ancestors immdiately after they return.
///
/// If you handle a [`Notification`], you should call [`EventCtx::set_handled`]
/// to stop the notification from being delivered to further ancestors.
///
/// ## Special considerations
///
/// Notifications are slightly different from other events; they originate
/// inside Druid, and they are delivered as part of the handling of another
/// event. In this sense, they can sort of be thought of as an augmentation
/// of an event; they are a way for multiple widgets to coordinate the
/// handling of an event.
///
/// [`EventCtx::set_handled`]: crate::EventCtx::set_handled
Notification(Notification),
/// Sent to a widget when the platform may have mutated shared IME state.
///
/// This is sent to a widget that has an attached IME session anytime the
/// platform has released a mutable lock on shared state.
///
/// This does not *mean* that any state has changed, but the widget
/// should check the shared state, perform invalidation, and update `Data`
/// as necessary.
ImeStateChange,
/// Internal druid event.
///
/// This should always be passed down to descendant [`WidgetPod`]s.
///
/// [`WidgetPod`]: struct.WidgetPod.html
Internal(InternalEvent),
}
/// Internal events used by druid inside [`WidgetPod`].
///
/// These events are translated into regular [`Event`]s
/// and should not be used directly.
///
/// [`WidgetPod`]: struct.WidgetPod.html
/// [`Event`]: enum.Event.html
#[derive(Debug, Clone)]
pub enum InternalEvent {
/// Sent in some cases when the mouse has left the window.
///
/// This is used in cases when the platform no longer sends mouse events,
/// but we know that we've stopped receiving the mouse events.
MouseLeave,
/// A command still in the process of being dispatched.
TargetedCommand(Command),
/// Used for routing timer events.
RouteTimer(TimerToken, WidgetId),
/// Route an IME change event.
RouteImeStateChange(WidgetId),
}
/// Application life cycle events.
///
/// Unlike [`Event`]s, [`LifeCycle`] events are generated by Druid, and
/// may occur at different times during a given pass of the event loop. The
/// [`LifeCycle::WidgetAdded`] event, for instance, may occur when the app
/// first launches (during the handling of [`Event::WindowConnected`]) or it
/// may occur during [`update`] cycle, if some widget has been added there.
///
/// Similarly the [`LifeCycle::Size`] method occurs during [`layout`], and
/// [`LifeCycle::HotChanged`] can occur both during [`event`] (if the mouse
/// moves over a widget) or during [`layout`], if a widget is resized and
/// that moves it under the mouse.
///
/// [`event`]: crate::Widget::event
/// [`update`]: crate::Widget::update
/// [`layout`]: crate::Widget::layout
#[derive(Debug, Clone)]
pub enum LifeCycle {
/// Sent to a `Widget` when it is added to the widget tree. This should be
/// the first message that each widget receives.
///
/// Widgets should handle this event in order to do any initial setup.
///
/// In addition to setup, this event is also used by the framework to
/// track certain types of important widget state.
///
/// ## Registering children
///
/// Container widgets (widgets which use [`WidgetPod`] to manage children)
/// must ensure that this event is forwarded to those children. The [`WidgetPod`]
/// itself will handle registering those children with the system; this is
/// required for things like correct routing of events.
///
/// ## Participating in focus
///
/// Widgets which wish to participate in automatic focus (using tab to change
/// focus) must handle this event and call [`LifeCycleCtx::register_for_focus`].
///
/// [`LifeCycleCtx::register_child`]: struct.LifeCycleCtx.html#method.register_child
/// [`WidgetPod`]: struct.WidgetPod.html
/// [`LifeCycleCtx::register_for_focus`]: struct.LifeCycleCtx.html#method.register_for_focus
WidgetAdded,
/// Called when the [`Size`] of the widget changes.
///
/// This will be called after [`Widget::layout`], if the [`Size`] returned
/// by the widget differs from its previous size.
///
/// [`Size`]: struct.Size.html
/// [`Widget::layout`]: trait.Widget.html#tymethod.layout
Size(Size),
/// Called when the Disabled state of the widgets is changed.
///
/// To check if a widget is disabled, see [`is_disabled`].
///
/// To change a widget's disabled state, see [`set_disabled`].
///
/// [`is_disabled`]: crate::EventCtx::is_disabled
/// [`set_disabled`]: crate::EventCtx::set_disabled
DisabledChanged(bool),
/// Called when the "hot" status changes.
///
/// This will always be called _before_ the event that triggered it; that is,
/// when the mouse moves over a widget, that widget will receive
/// `LifeCycle::HotChanged` before it receives `Event::MouseMove`.
///
/// See [`is_hot`](struct.EventCtx.html#method.is_hot) for
/// discussion about the hot status.
HotChanged(bool),
/// This is called when the widget-tree changes and druid wants to rebuild the
/// Focus-chain.
///
/// It is the only place from witch [`register_for_focus`] should be called.
/// By doing so the widget can get focused by other widgets using [`focus_next`] or [`focus_prev`].
///
/// [`register_for_focus`]: crate::LifeCycleCtx::register_for_focus
/// [`focus_next`]: crate::EventCtx::focus_next
/// [`focus_prev`]: crate::EventCtx::focus_prev
BuildFocusChain,
/// Called when the focus status changes.
///
/// This will always be called immediately after a new widget gains focus.
/// The newly focused widget will receive this with `true` and the widget
/// that lost focus will receive this with `false`.
///
/// See [`EventCtx::is_focused`] for more information about focus.
///
/// [`EventCtx::is_focused`]: struct.EventCtx.html#method.is_focused
FocusChanged(bool),
/// Internal druid lifecycle event.
///
/// This should always be passed down to descendant [`WidgetPod`]s.
///
/// [`WidgetPod`]: struct.WidgetPod.html
Internal(InternalLifeCycle),
}
/// Internal lifecycle events used by druid inside [`WidgetPod`].
///
/// These events are translated into regular [`LifeCycle`] events
/// and should not be used directly.
///
/// [`WidgetPod`]: struct.WidgetPod.html
/// [`LifeCycle`]: enum.LifeCycle.html
#[derive(Debug, Clone)]
pub enum InternalLifeCycle {
/// Used to route the `WidgetAdded` event to the required widgets.
RouteWidgetAdded,
/// Used to route the `FocusChanged` event.
RouteFocusChanged {
/// the widget that is losing focus, if any
old: Option<WidgetId>,
/// the widget that is gaining focus, if any
new: Option<WidgetId>,
},
/// Used to route the `DisabledChanged` event to the required widgets.
RouteDisabledChanged,
/// The parents widget origin in window coordinate space has changed.
ParentWindowOrigin,
/// For testing: request the `WidgetState` of a specific widget.
///
/// During testing, you may wish to verify that the state of a widget
/// somewhere in the tree is as expected. In that case you can dispatch
/// this event, specifying the widget in question, and that widget will
/// set its state in the provided `Cell`, if it exists.
DebugRequestState {
/// the widget whose state is requested
widget: WidgetId,
/// a cell used to store the a widget's state
state_cell: StateCell,
},
/// For testing: apply the given function on every widget.
DebugInspectState(StateCheckFn),
}
impl Event {
/// Transform the event for the contents of a scrolling container.
///
/// the `force` flag is used to ensure an event is delivered even
/// if the cursor is out of the viewport, such as if the contents are active
/// or hot.
pub fn transform_scroll(&self, offset: Vec2, viewport: Rect, force: bool) -> Option<Event> {
match self {
Event::MouseDown(mouse_event) => {
if force || viewport.winding(mouse_event.pos) != 0 {
let mut mouse_event = mouse_event.clone();
mouse_event.pos += offset;
Some(Event::MouseDown(mouse_event))
} else {
None
}
}
Event::MouseUp(mouse_event) => {
if force || viewport.winding(mouse_event.pos) != 0 {
let mut mouse_event = mouse_event.clone();
mouse_event.pos += offset;
Some(Event::MouseUp(mouse_event))
} else {
None
}
}
Event::MouseMove(mouse_event) => {
if force || viewport.winding(mouse_event.pos) != 0 {
let mut mouse_event = mouse_event.clone();
mouse_event.pos += offset;
Some(Event::MouseMove(mouse_event))
} else {
None
}
}
Event::Wheel(mouse_event) => {
if force || viewport.winding(mouse_event.pos) != 0 {
let mut mouse_event = mouse_event.clone();
mouse_event.pos += offset;
Some(Event::Wheel(mouse_event))
} else {
None
}
}
_ => Some(self.clone()),
}
}
/// Whether this event should be sent to widgets which are currently not visible and not
/// accessible.
///
/// For example: the hidden tabs in a tabs widget are `hidden` whereas the non-visible
/// widgets in a scroll are not, since you can bring them into view by scrolling.
///
/// This distinction between scroll and tabs is due to one of the main purposes of
/// this method: determining which widgets are allowed to receive focus. As a rule
/// of thumb a widget counts as `hidden` if it makes no sense for it to receive focus
/// when the user presses thee 'tab' key.
///
/// If a widget changes which children are hidden it must call [`children_changed`].
///
/// See also [`LifeCycle::should_propagate_to_hidden`].
///
/// [`children_changed`]: crate::EventCtx::children_changed
/// [`LifeCycle::should_propagate_to_hidden`]: LifeCycle::should_propagate_to_hidden
pub fn should_propagate_to_hidden(&self) -> bool {
match self {
Event::WindowConnected
| Event::WindowCloseRequested
| Event::WindowDisconnected
| Event::WindowSize(_)
| Event::Timer(_)
| Event::AnimFrame(_)
| Event::Command(_)
| Event::Notification(_)
| Event::Internal(_) => true,
Event::MouseDown(_)
| Event::MouseUp(_)
| Event::MouseMove(_)
| Event::Wheel(_)
| Event::KeyDown(_)
| Event::KeyUp(_)
| Event::Paste(_)
| Event::ImeStateChange
| Event::Zoom(_) => false,
}
}
}
impl LifeCycle {
/// Whether this event should be sent to widgets which are currently not visible and not
/// accessible.
///
/// If a widget changes which children are `hidden` it must call [`children_changed`].
/// For a more detailed explanation of the `hidden` state, see [`Event::should_propagate_to_hidden`].
///
/// [`children_changed`]: crate::EventCtx::children_changed
/// [`Event::should_propagate_to_hidden`]: Event::should_propagate_to_hidden
pub fn should_propagate_to_hidden(&self) -> bool {
match self {
LifeCycle::Internal(internal) => internal.should_propagate_to_hidden(),
LifeCycle::WidgetAdded | LifeCycle::DisabledChanged(_) => true,
LifeCycle::Size(_)
| LifeCycle::HotChanged(_)
| LifeCycle::FocusChanged(_)
| LifeCycle::BuildFocusChain => false,
}
}
}
impl InternalLifeCycle {
/// Whether this event should be sent to widgets which are currently not visible and not
/// accessible.
///
/// If a widget changes which children are `hidden` it must call [`children_changed`].
/// For a more detailed explanation of the `hidden` state, see [`Event::should_propagate_to_hidden`].
///
/// [`children_changed`]: crate::EventCtx::children_changed
/// [`Event::should_propagate_to_hidden`]: Event::should_propagate_to_hidden
pub fn should_propagate_to_hidden(&self) -> bool {
match self {
InternalLifeCycle::RouteWidgetAdded
| InternalLifeCycle::RouteFocusChanged { .. }
| InternalLifeCycle::RouteDisabledChanged => true,
InternalLifeCycle::ParentWindowOrigin => false,
InternalLifeCycle::DebugRequestState { .. }
| InternalLifeCycle::DebugInspectState(_) => true,
}
}
}
pub(crate) use state_cell::{StateCell, StateCheckFn};
mod state_cell {
use crate::core::WidgetState;
use crate::WidgetId;
use std::{cell::RefCell, rc::Rc};
/// An interior-mutable struct for fetching BasteState.
#[derive(Clone, Default)]
pub struct StateCell(Rc<RefCell<Option<WidgetState>>>);
#[derive(Clone)]
pub struct StateCheckFn(Rc<dyn Fn(&WidgetState)>);
/// a hacky way of printing the widget id if we panic
struct WidgetDrop(bool, WidgetId);
impl Drop for WidgetDrop {
fn drop(&mut self) {
if self.0 {
eprintln!("panic in {:?}", self.1);
}
}
}
impl StateCell {
/// Set the state. This will panic if it is called twice.
pub(crate) fn set(&self, state: WidgetState) {
assert!(
self.0.borrow_mut().replace(state).is_none(),
"StateCell already set"
)
}
#[allow(dead_code)]
pub(crate) fn take(&self) -> Option<WidgetState> {
self.0.borrow_mut().take()
}
}
impl StateCheckFn {
#[cfg(not(target_arch = "wasm32"))]
pub(crate) fn new(f: impl Fn(&WidgetState) + 'static) -> Self {
StateCheckFn(Rc::new(f))
}
pub(crate) fn call(&self, state: &WidgetState) {
let mut panic_reporter = WidgetDrop(true, state.id);
(self.0)(state);
panic_reporter.0 = false;
}
}
impl std::fmt::Debug for StateCell {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
let inner = if self.0.borrow().is_some() {
"Some"
} else {
"None"
};
write!(f, "StateCell({})", inner)
}
}
impl std::fmt::Debug for StateCheckFn {
fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
write!(f, "StateCheckFn")
}
}
}