pub struct EventCtx { /* private fields */ }Implementations§
Source§impl EventCtx
impl EventCtx
pub const fn widget_id(&self) -> WidgetId
Sourcepub fn observe<T, O>(&self, observable: &O, kind: InvalidationKind) -> Twhere
O: Observable<T> + ?Sized,
pub fn observe<T, O>(&self, observable: &O, kind: InvalidationKind) -> Twhere
O: Observable<T> + ?Sized,
Read an observable and subscribe this widget to the requested invalidation kind.
Sourcepub fn record_rebuild(
&self,
widget_name: &'static str,
reason: impl Into<String>,
)
pub fn record_rebuild( &self, widget_name: &'static str, reason: impl Into<String>, )
Record a development diagnostic explaining a structural widget rebuild.
pub const fn bounds(&self) -> Rect
pub const fn dpi(&self) -> DpiInfo
pub const fn current_time(&self) -> f64
pub const fn phase(&self) -> EventPhase
pub const fn focused_widget_id(&self) -> Option<WidgetId>
pub fn is_focused(&self) -> bool
pub const fn is_handled(&self) -> bool
pub fn set_handled(&mut self)
Sourcepub fn clipboard(&self) -> &Clipboard
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.
pub fn clipboard_text(&self) -> Option<String>
pub fn set_clipboard_text(&mut self, text: impl AsRef<str>)
Sourcepub fn command_sender(&self) -> &CommandSender
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?
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}Sourcepub fn post_event(&mut self, target: WidgetId, event: Event)
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.
Sourcepub fn post_command<T>(
&mut self,
target: WidgetId,
key: CommandKey<T>,
payload: T,
)
pub fn post_command<T>( &mut self, target: WidgetId, key: CommandKey<T>, payload: T, )
Queue a typed command for target-only delivery after the current widget dispatch completes.
pub fn request_focus(&mut self)
Sourcepub fn request_focus_for(&mut self, widget_id: WidgetId)
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.
pub fn clear_focus(&mut self)
pub fn schedule_timer_at(&mut self, deadline: f64) -> TimerToken
pub fn schedule_timer_after(&mut self, delay: f64) -> TimerToken
pub fn cancel_timer(&mut self, token: TimerToken)
pub fn register_async_wakeup(&mut self) -> AsyncWakeToken
pub fn unregister_async_wakeup(&mut self, token: AsyncWakeToken)
pub fn request_animation_frame(&mut self)
pub fn request_pointer_capture(&mut self, pointer_id: u64)
pub fn release_pointer_capture(&mut self, pointer_id: u64)
pub fn begin_drag( &mut self, scope_id: DragScopeId, pointer_id: u64, position: Point, payload: DragPayload, allowed_effect: DropEffect, preview_label: Option<String>, ) -> DragSessionId
pub fn accept_drop(&mut self, effect: DropEffect)
Sourcepub fn request(&mut self, request: InvalidationRequest)
pub fn request(&mut self, request: InvalidationRequest)
pub fn request_measure(&mut self)
pub fn request_arrange(&mut self)
pub fn request_ordering(&mut self)
pub fn request_paint(&mut self)
pub fn request_paint_rect(&mut self, rect: Rect)
pub fn request_transform(&mut self)
pub fn request_effect(&mut self)
pub fn request_visibility(&mut self)
pub fn request_hit_test(&mut self)
pub fn request_text(&mut self)
pub fn request_semantics(&mut self)
pub fn request_resources(&mut self)
pub fn invalidations(&self) -> &[InvalidationRequest]
Trait Implementations§
Auto Trait Implementations§
impl !RefUnwindSafe for EventCtx
impl !Send for EventCtx
impl !Sync for EventCtx
impl !UnwindSafe for EventCtx
impl Freeze for EventCtx
impl Unpin for EventCtx
impl UnsafeUnpin for EventCtx
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
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>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
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)
fn as_any(&self) -> &(dyn Any + 'static)
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.