Struct druid::DruidHandler

pub struct DruidHandler<T> { /* private fields */ }

The struct implements the druid-shell WinHandler trait.

One DruidHandler exists per window.

This is something of an internal detail and possibly we don’t want to surface it publicly.

Trait Implementations

impl<T: Data> WinHandler for DruidHandler<T>

fn connect(&mut self, handle: &WindowHandle)

Provide the handler with a handle to the window so that it can invalidate or make other requests.

fn prepare_paint(&mut self)

Request the handler to prepare to paint the window contents. In particular, if there are any regions that need to be repainted on the next call to paint, the handler should invalidate those regions by calling WindowHandle::invalidate_rect or WindowHandle::invalidate.

fn paint(&mut self, piet: &mut Piet<'_>, region: &Region)

Request the handler to paint the window contents. invalid is the region in display points that needs to be repainted; painting outside the invalid region will have no effect.

fn size(&mut self, size: Size)

Called when the size of the window has changed.

fn scale(&mut self, scale: Scale)

Called when the scale of the window has changed.

fn command(&mut self, id: u32)

Called when a menu item is selected.

fn save_as(&mut self, token: FileDialogToken, file_info: Option<FileInfo>)

Called when a “Save As” dialog is closed.

fn open_file(&mut self, token: FileDialogToken, file_info: Option<FileInfo>)

Called when an “Open” dialog is closed.

fn open_files(&mut self, token: FileDialogToken, file_info: Vec<FileInfo>)

Called when an “Open” dialog with multiple selection is closed.

fn mouse_down(&mut self, event: &MouseEvent)

Called on mouse button down.

fn mouse_up(&mut self, event: &MouseEvent)

Called on mouse button up.

fn mouse_move(&mut self, event: &MouseEvent)

Called when the mouse moves.

fn mouse_leave(&mut self)

Called when the mouse cursor has left the application window

fn key_down(&mut self, event: KeyEvent) -> bool

Called on a key down event.

fn key_up(&mut self, event: KeyEvent)

Called when a key is released. This corresponds to the WM_KEYUP message on Windows, or keyUp(withEvent:) on macOS.

fn wheel(&mut self, event: &MouseEvent)

Called on a mouse wheel event.

fn zoom(&mut self, delta: f64)

Called when a platform-defined zoom gesture occurs (such as pinching on the trackpad).

fn got_focus(&mut self)

Called when this window becomes the focused window.

fn timer(&mut self, token: TimerToken)

Called on timer event.

fn idle(&mut self, token: IdleToken)

Called when a idle token is requested by IdleHandle::schedule_idle() call.

fn as_any(&mut self) -> &mut dyn Any

Get a reference to the handler state. Used mostly by idle handlers.

fn acquire_input_lock( &mut self, token: TextFieldToken, mutable: bool ) -> Box<dyn InputHandler>

Take a lock for the text document specified by token.

fn release_input_lock(&mut self, token: TextFieldToken)

Release a lock previously acquired by acquire_input_lock.

fn request_close(&mut self)

Called when the shell requests to close the window, for example because the user clicked the little “X” in the titlebar.

fn destroy(&mut self)

Called when the window is being destroyed. Note that this happens earlier in the sequence than drop (at WM_DESTROY, while the latter is WM_NCDESTROY).

fn rebuild_resources(&mut self)

Called when the resources need to be rebuilt.

fn lost_focus(&mut self)

Called when this window stops being the focused window.