Struct druid::win_handler::DruidHandler

pub struct DruidHandler<T: Data + 'static + Default> {
    pub window_id: WindowId,
    pub phantom: PhantomData<T>,
}

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.

Fields

window_id: WindowId

The shared app state. The id for the current window.

phantom: PhantomData<T>

Methods

impl<T: Data + 'static + Default> DruidHandler<T>

pub(crate) fn new_shared(window_id: WindowId) -> DruidHandler<T>

Note: the root widget doesn't go in here, because it gets added to the app state.

fn do_event(&mut self, event: Event, win_ctx: &mut dyn WinCtx) -> bool

Send an event to the widget hierarchy.

Returns true if the event produced an action.

This is principally because in certain cases (such as keydown on Windows) the OS needs to know if an event was handled.

Trait Implementations

impl<T: Clone + Data + 'static + Default> Clone for DruidHandler<T>

fn clone(&self) -> DruidHandler<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Default + Data + 'static> Default for DruidHandler<T>

fn default() -> DruidHandler<T>

Returns the "default value" for a type.

impl<T: Data + 'static + Default> WinHandler<DruidHandler<T>> for DruidHandler<T>

fn paint(&mut self, piet: &mut Piet, ctx: &mut dyn WinCtx) -> bool

Request the handler to paint the window contents. Return value indicates whether window is animating, i.e. whether another paint should be scheduled for the next animation frame.

fn size(&mut self, width: u32, height: u32, ctx: &mut dyn WinCtx)

Provide the handler with a handle to the window so that it can invalidate or make other requests. Called when the size of the window is changed. Note that size is in physical pixels.

fn mouse_down(&mut self, event: &MouseEvent, ctx: &mut dyn WinCtx)

Called on mouse button down.

fn mouse_up(&mut self, event: &MouseEvent, ctx: &mut dyn WinCtx)

Called on mouse button up.

fn mouse_move(&mut self, _event: &MouseEvent, _ctx: &mut dyn WinCtx)

Called when the mouse moves.

fn got_focus(&mut self, ctx: &mut dyn WinCtx)

Called when this window becomes the focused window.

fn get_window_id(&self) -> WindowIdType

Return the Window ID for this WinHandler

fn add_handler(&self, window_id: WindowIdType, handler: DruidHandler<T>)

Add a Window Handler for the Data type

fn timer(&mut self, token: TimerToken, ctx: &mut dyn WinCtx)

Called on timer event.

fn destroy(&mut self, ctx: &mut dyn WinCtx)

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).