Skip to main content

EventCtx

Struct EventCtx 

Source
pub struct EventCtx { /* private fields */ }

Implementations§

Source§

impl EventCtx

Source

pub const fn window_id(&self) -> WindowId

Examples found in repository?
examples/stateful_form.rs (line 59)
58fn refresh_window(ctx: &mut EventCtx) {
59    let target = InvalidationTarget::Window(ctx.window_id());
60    for kind in [
61        InvalidationKind::Measure,
62        InvalidationKind::Paint,
63        InvalidationKind::Semantics,
64    ] {
65        ctx.request(InvalidationRequest::new(target, kind));
66    }
67}
Source

pub const fn widget_id(&self) -> WidgetId

Source

pub fn observe<T, O>(&self, observable: &O, kind: InvalidationKind) -> T
where O: Observable<T> + ?Sized,

Read an observable and subscribe this widget to the requested invalidation kind.

Source

pub fn record_rebuild( &self, widget_name: &'static str, reason: impl Into<String>, )

Record a development diagnostic explaining a structural widget rebuild.

Source

pub const fn bounds(&self) -> Rect

Source

pub const fn dpi(&self) -> DpiInfo

Source

pub const fn current_time(&self) -> f64

Source

pub const fn phase(&self) -> EventPhase

Source

pub const fn focused_widget_id(&self) -> Option<WidgetId>

Source

pub fn is_focused(&self) -> bool

Source

pub const fn is_handled(&self) -> bool

Source

pub fn set_handled(&mut self)

Source

pub fn clipboard(&self) -> &Clipboard

Shared clipboard service for this window. Backed by the OS clipboard when the platform installed a native backend, otherwise by in-process storage shared across the runtime.

Source

pub fn clipboard_text(&self) -> Option<String>

Source

pub fn set_clipboard_text(&mut self, text: impl AsRef<str>)

Source

pub fn command_sender(&self) -> &CommandSender

Return the runtime’s cloneable typed command producer.

Widget callbacks can use this to address window or application controllers without routing through an ancestor widget. Delivery is queued until the current event dispatch completes.

Examples found in repository?
examples/commands.rs (line 34)
6fn main() -> Result<()> {
7    let worker_status = Signal::named(
8        "worker_status",
9        "Waiting for the background worker…".to_string(),
10    );
11    let application_status = Signal::named(
12        "application_status",
13        "No application multicast received yet.".to_string(),
14    );
15    let window_status = Signal::named(
16        "window_status",
17        "No window multicast received yet.".to_string(),
18    );
19
20    let worker_handler = worker_status.clone();
21    let application_handler = application_status.clone();
22    let window_handler = window_status.clone();
23    let root = Padding::all(
24        24.0,
25        Stack::vertical()
26            .spacing(12.0)
27            .alignment(Alignment::Stretch)
28            .with_child(Label::new("Typed commands"))
29            .with_child(Label::new("").text_from(worker_status))
30            .with_child(Label::new("").text_from(application_status))
31            .with_child(Label::new("").text_from(window_status))
32            .with_child(
33                Button::new("Broadcast announcement").on_press_with_ctx(|ctx| {
34                    ctx.command_sender().broadcast_application(
35                        ANNOUNCEMENT,
36                        "Hello from a widget callback".to_string(),
37                    );
38                }),
39            ),
40    );
41
42    App::new()
43        .on_command(WORK_FINISHED, move |ctx, message| {
44            worker_handler.set(format!("Worker result: {message}"));
45            ctx.set_handled();
46        })
47        .on_command(ANNOUNCEMENT, move |_, message| {
48            application_handler.set(format!("Application received: {message}"));
49        })
50        .window(
51            Window::new("Commands")
52                .on_command(ANNOUNCEMENT, move |_, message| {
53                    window_handler.set(format!("Window received: {message}"));
54                })
55                .root(root),
56        )
57        .run_with_handle(|ui| {
58            std::thread::spawn(move || {
59                // Replace this with blocking I/O or CPU work.
60                ui.send_application(WORK_FINISHED, "loaded".to_string());
61            });
62        })
63}
Source

pub fn post_event(&mut self, target: WidgetId, event: Event)

Queue an event for delivery to target after the current dispatch completes. Used to route commands (for example clipboard actions from a context menu) to a specific widget outside the normal hit-test or focus routing.

Source

pub fn post_command<T>( &mut self, target: WidgetId, key: CommandKey<T>, payload: T, )
where T: Send + Sync + 'static,

Queue a typed command for target-only delivery after the current widget dispatch completes.

Source

pub fn request_focus(&mut self)

Source

pub fn request_focus_for(&mut self, widget_id: WidgetId)

Request focus for a retained widget in the current window.

Containers use this to restore focus to a descendant after adaptive presentation changes. The target must be mounted in the widget graph by the time the current event dispatch completes.

Source

pub fn clear_focus(&mut self)

Source

pub fn schedule_timer_at(&mut self, deadline: f64) -> TimerToken

Source

pub fn schedule_timer_after(&mut self, delay: f64) -> TimerToken

Source

pub fn cancel_timer(&mut self, token: TimerToken)

Source

pub fn register_async_wakeup(&mut self) -> AsyncWakeToken

Source

pub fn unregister_async_wakeup(&mut self, token: AsyncWakeToken)

Source

pub fn request_animation_frame(&mut self)

Source

pub fn request_pointer_capture(&mut self, pointer_id: u64)

Source

pub fn release_pointer_capture(&mut self, pointer_id: u64)

Source

pub fn request_cursor_grab(&mut self, mode: CursorGrabMode)

Request host-level cursor grabbing for this widget.

The request is best effort. Desktop hosts try CursorGrabMode::Locked first and then fall back to CursorGrabMode::Confined. Relative mouse motion is routed to this widget while a grab is active. Request CursorGrabMode::None to release a grab owned by this widget.

Source

pub fn request_cursor_visibility(&mut self, visible: bool)

Request whether the host system cursor is visible for this widget.

Cursor visibility is independent of cursor grabbing. Focus loss always restores visibility.

Source

pub fn begin_drag( &mut self, scope_id: DragScopeId, pointer_id: u64, position: Point, payload: DragPayload, allowed_effect: DropEffect, preview_label: Option<String>, ) -> DragSessionId

Source

pub fn accept_drop(&mut self, effect: DropEffect)

Source

pub fn request(&mut self, request: InvalidationRequest)

Examples found in repository?
examples/stateful_form.rs (line 65)
58fn refresh_window(ctx: &mut EventCtx) {
59    let target = InvalidationTarget::Window(ctx.window_id());
60    for kind in [
61        InvalidationKind::Measure,
62        InvalidationKind::Paint,
63        InvalidationKind::Semantics,
64    ] {
65        ctx.request(InvalidationRequest::new(target, kind));
66    }
67}
Source

pub fn request_measure(&mut self)

Source

pub fn request_arrange(&mut self)

Source

pub fn request_ordering(&mut self)

Source

pub fn request_paint(&mut self)

Source

pub fn request_paint_rect(&mut self, rect: Rect)

Source

pub fn request_transform(&mut self)

Source

pub fn request_effect(&mut self)

Source

pub fn request_visibility(&mut self)

Source

pub fn request_hit_test(&mut self)

Source

pub fn request_text(&mut self)

Source

pub fn request_semantics(&mut self)

Source

pub fn request_resources(&mut self)

Source

pub fn invalidations(&self) -> &[InvalidationRequest]

Trait Implementations§

Source§

impl Clone for EventCtx

Source§

fn clone(&self) -> EventCtx

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EventCtx

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more