Skip to main content

ComponentSender

Struct ComponentSender 

Source
pub struct ComponentSender<T>(/* private fields */)
where
    T: Component;
Available on crate feature winio only.
Expand description

Sender of input messages and output events.

Implementations§

Source§

impl<T> ComponentSender<T>
where T: Component,

Source

pub fn post(&self, message: <T as Component>::Message)

Post the message to the queue.

Examples found in repository?
examples/options/options.rs (line 72)
35    async fn init(
36        mut init: Self::Init<'_>,
37        sender: &ComponentSender<Self>,
38    ) -> Result<Self, Self::Error> {
39        let mut window = init.window(sender).await?;
40        // window.set_size(Size::new(800.0, 600.0));
41
42        let mut enabled = Child::<CheckBox>::init(&window).await?;
43        enabled.set_text("Enable");
44
45        let mut b = Child::<CheckBox>::init(&window).await?;
46        b.set_text("Switch");
47
48        let mut e_label = Child::<Label>::init(&window).await?;
49        e_label.set_text("Mode:");
50        let mut e = Child::<ComboBox>::init(&window).await?;
51        e.insert(0, "A");
52        e.insert(1, "B");
53
54        let mut s_label = Child::<Label>::init(&window).await?;
55        s_label.set_text("Message:");
56        let mut s = Child::<Edit>::init(&window).await?;
57
58        HANDLER.with_app(|a| {
59            let config = a.config();
60
61            enabled.set_checked(config.enabled);
62            b.set_checked(config.b);
63
64            e.set_selection(match config.e {
65                Mode::A => 0,
66                Mode::B => 1,
67            });
68
69            s.set_text(&config.s);
70        });
71
72        sender.post(MainMessage::EnabledClick);
73
74        window.show();
75
76        Ok(Self {
77            window,
78            enabled,
79            b,
80            s_label,
81            s,
82            e_label,
83            e,
84        })
85    }
Source

pub fn output(&self, event: <T as Component>::Event)

Post the event to the queue.

Examples found in repository?
examples/options/options.rs (line 121)
101    async fn update(
102        &mut self,
103        message: Self::Message,
104        sender: &ComponentSender<Self>,
105    ) -> Result<bool, Self::Error> {
106        // futures_util::join!(self.window.update());
107        Ok(match message {
108            MainMessage::Noop => false,
109            MainMessage::EnabledClick => {
110                let enabled = self.enabled.is_checked()?;
111                self.b.set_enabled(enabled);
112                self.e.set_enabled(enabled);
113                self.s.set_enabled(enabled);
114                false
115            }
116            MainMessage::OptionsPage(m) => {
117                tracing::debug!(?m, "Options page message");
118                match m {
119                    OptionsPageMessage::Redraw => true,
120                    OptionsPageMessage::Close => {
121                        sender.output(());
122                        false
123                    }
124                    OptionsPageMessage::Save(config, tx) => {
125                        config.enabled = self.enabled.is_checked()?;
126                        config.b = self.b.is_checked()?;
127                        config.e = match self.e.selection()? {
128                            Some(0) => Mode::A,
129                            Some(1) => Mode::B,
130                            _ => Default::default(),
131                        };
132                        config.s = self.s.text()?;
133                        tx.send(config).unwrap();
134                        false
135                    }
136                }
137            }
138        })
139    }
More examples
Hide additional examples
examples/test/widgets.rs (line 230)
176    async fn update(
177        &mut self,
178        message: Self::Message,
179        sender: &ComponentSender<Self>,
180    ) -> Result<bool, Self::Error> {
181        // futures_util::future::join(self.window.update(), self.canvas.update()).await;
182        Ok(match message {
183            MainMessage::Noop => false,
184            MainMessage::PasswordCheck => {
185                self.pentry.set_password(!self.pcheck.is_checked()?);
186                true
187            }
188            MainMessage::List(e) => {
189                self.pop_button.set_enabled(!self.list.is_empty());
190                self.combo
191                    .emit(ComboBoxMessage::from_observable_vec_event(e))
192                    .await?
193            }
194            MainMessage::Select => {
195                self.index = self.combo.selection()?;
196                false
197            }
198            MainMessage::Push => {
199                self.list.push(self.radio_group[self.rindex].text()?);
200                false
201            }
202            MainMessage::Pop => {
203                self.list.pop();
204                false
205            }
206            MainMessage::RSelect(i) => {
207                self.rindex = i;
208                false
209            }
210            MainMessage::Show => {
211                MessageBox::new()
212                    .title("Show selected item")
213                    .message(
214                        self.index
215                            .and_then(|index| self.list.get(index))
216                            .map(|s| s.as_str())
217                            .unwrap_or("No selection."),
218                    )
219                    .buttons(MessageBoxButton::Ok)
220                    // https://github.com/compio-rs/winio/issues/105
221                    .show(unsafe { BorrowedWindow::win32(self.window.as_container().as_win32()) })
222                    .await;
223                false
224            }
225            MainMessage::OptionsPage(m) => {
226                tracing::debug!(?m, "Options page message");
227                match m {
228                    OptionsPageMessage::Redraw => true,
229                    OptionsPageMessage::Close => {
230                        sender.output(());
231                        false
232                    }
233                    OptionsPageMessage::Save(config, tx) => {
234                        config.s = self.mltext.text()?;
235                        tx.send(config).unwrap();
236                        false
237                    }
238                }
239            }
240        })
241    }
Source

pub fn cast<U>(&self) -> &ComponentSender<U>
where U: Component<Message = <T as Component>::Message, Event = <T as Component>::Event>,

Cast the sender for a different component type with the same message and event types.

Trait Implementations§

Source§

impl<T> Clone for ComponentSender<T>
where T: Component,

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T> Debug for ComponentSender<T>
where T: Debug + Component, <T as Component>::Message: Debug, <T as Component>::Event: Debug,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for ComponentSender<T>

§

impl<T> RefUnwindSafe for ComponentSender<T>

§

impl<T> Send for ComponentSender<T>
where <T as Component>::Message: Send, <T as Component>::Event: Send,

§

impl<T> Sync for ComponentSender<T>
where <T as Component>::Message: Send, <T as Component>::Event: Send,

§

impl<T> Unpin for ComponentSender<T>

§

impl<T> UnsafeUnpin for ComponentSender<T>

§

impl<T> UnwindSafe for ComponentSender<T>

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<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> 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Src, Dest> IntoTuple<Dest> for Src
where Dest: FromTuple<Src>,

Source§

fn into_tuple(self) -> Dest

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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