Struct widgetry::event_ctx::EventCtx

pub struct EventCtx<'a> {
    pub(crate) fake_mouseover: bool,
    pub input: UserInput,
    pub canvas: &'a mut Canvas,
    pub prerender: &'a Prerender,
    pub(crate) style: &'a mut Style,
    pub(crate) updates_requested: Vec<UpdateType>,
    pub(crate) canvas_movement_called: bool,
    pub(crate) focus_owned_by: Option<String>,
    pub(crate) next_focus_owned_by: Option<String>,
}

Fields

fake_mouseover: bool

input: UserInput

canvas: &'a mut Canvas

prerender: &'a Prerender

style: &'a mut Style

updates_requested: Vec<UpdateType>

canvas_movement_called: bool

focus_owned_by: Option<String>

This widget (in some panel) exclusively owns focus. Don’t modify.

next_focus_owned_by: Option<String>

While handling an event, this widget (in some panel) this widget declared that it owns focus. This will become focus_owned_by during the next event.

Implementations

impl<'a> EventCtx<'a>

pub fn loading_screen<O, S: Into<String>, F: FnOnce(&mut EventCtx<'_>, &mut Timer<'_>) -> O>( &mut self, raw_timer_name: S, f: F ) -> O

pub fn request_update(&mut self, update_type: UpdateType)

pub fn canvas_movement(&mut self) -> bool

Allow panning and zooming on the canvas. Exactly which controls are active (click-and-drag, auto-pan at the edge of the screen, using arrow keys, etc) depend on options set. Returns true if the canvas moved at all.

pub fn no_op_event<O, F: FnMut(&mut EventCtx<'_>) -> O>( &mut self, fake_mouseover: bool, cb: F ) -> O

pub fn redo_mouseover(&self) -> bool

pub fn normal_left_click(&mut self) -> bool

pub fn is_key_down(&self, key: Key) -> bool

pub fn default_line_height(&self) -> f64

pub fn upload(&self, batch: GeomBatch) -> Drawable

pub(crate) fn cursor_clickable(&mut self)

pub(crate) fn cursor_grabbable(&mut self)

pub(crate) fn cursor_grabbing(&mut self)

pub fn style(&self) -> &Style

pub fn set_style(&mut self, style: Style)

pub fn make_loading_screen(&mut self, txt: Text) -> Panel

pub fn is_font_loaded(&self, filename: &str) -> bool

Checks if an extra font has previously been loaded with load_font. Returns false for built-in system fonts.

pub fn load_font(&mut self, filename: &str, bytes: Vec<u8>)

Loads an extra font, used only for automatic fallback of missing glyphs.

pub fn hide_cursor(&self)

pub fn show_cursor(&self)

pub fn set_scale_factor(&mut self, scale_factor: f64)

The app will need to recreate its panels for this to take effect

pub fn set_texture( &mut self, sprite_bytes: Vec<u8>, sprite_dims: (u32, u32), texture_scale: (f32, f32) )

Only one texture can be loaded at a time; this overwrites anything previously set

Trait Implementations

impl AsRef<Assets> for EventCtx<'_>

fn as_ref(&self) -> &Assets

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Prerender> for EventCtx<'_>

fn as_ref(&self) -> &Prerender

Converts this type into a shared reference of the (usually inferred) input type.