pub struct UiHandle { /* private fields */ }Expand description
Cloneable, thread-safe UI command handle for background work.
Each send returns the command’s sequence number, as
CommandSender’s do.
Implementations§
Source§impl UiHandle
impl UiHandle
Sourcepub fn request_exit(&self)
pub fn request_exit(&self)
Ask the application to exit. App::run returns once the platform
loop finishes its current turn; this may be called from any thread.
pub fn send<T>( &self, target: CommandTarget, key: CommandKey<T>, payload: T, ) -> u64
pub fn send_widget<T>( &self, window_id: WindowId, widget_id: WidgetId, key: CommandKey<T>, payload: T, ) -> u64
pub fn send_focused<T>( &self, window_id: WindowId, key: CommandKey<T>, payload: T, ) -> u64
pub fn send_window<T>( &self, window_id: WindowId, key: CommandKey<T>, payload: T, ) -> u64
Sourcepub fn send_application<T>(&self, key: CommandKey<T>, payload: T) -> u64
pub fn send_application<T>(&self, key: CommandKey<T>, payload: T) -> u64
Examples found in repository?
examples/commands.rs (line 60)
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 .gap(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}pub fn broadcast_window<T>( &self, window_id: WindowId, key: CommandKey<T>, payload: T, ) -> u64
pub fn broadcast_application<T>(&self, key: CommandKey<T>, payload: T) -> u64
Trait Implementations§
Auto Trait Implementations§
impl Forget for UiHandle
impl Freeze for UiHandle
impl Move for UiHandle
impl RefUnwindSafe for UiHandle
impl Send for UiHandle
impl Sync for UiHandle
impl Unpin for UiHandle
impl UnsafeUnpin for UiHandle
impl UnwindSafe for UiHandle
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
Mutably borrows from an owned value. Read more
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>
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>
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)
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)
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.