Struct Child 

pub struct Child<T>
where
    T: Component,
{ /* private fields */ }

Available on crate feature winio only.

Helper to embed one component into another. It handles different types of messages and events.

Implementations

impl<T> Child<T>

where T: Component,

pub fn init<'a>(init: impl Into<<T as Component>::Init<'a>>) -> Child<T>

Create and initialize the child component.

Examples found in repository

examples/options/options.rs (line 39)

    fn init(mut init: Self::Init<'_>, sender: &ComponentSender<Self>) -> Self {
        let mut window = init.window(sender);
        // window.set_size(Size::new(800.0, 600.0));

        let mut enabled = Child::<CheckBox>::init(&window);
        enabled.set_text("Enable");

        let mut b = Child::<CheckBox>::init(&window);
        b.set_text("Switch");

        let mut e_label = Child::<Label>::init(&window);
        e_label.set_text("Mode:");
        let mut e = Child::<ComboBox>::init(&window);
        e.insert(0, "A");
        e.insert(1, "B");

        let mut s_label = Child::<Label>::init(&window);
        s_label.set_text("Message:");
        let mut s = Child::<Edit>::init(&window);

        HANDLER.with_app(|a| {
            let config = a.config();

            enabled.set_checked(config.enabled);
            b.set_checked(config.b);

            e.set_selection(Some(match config.e {
                Mode::A => 0,
                Mode::B => 1,
            }));

            s.set_text(&config.s);
        });

        sender.post(MainMessage::EnabledClick);

        window.show();

        Self {
            window,
            enabled,
            b,
            s_label,
            s,
            e_label,
            e,
        }
    }

pub async fn start<C>( &mut self, sender: &ComponentSender<C>, f: impl FnMut(<T as Component>::Event) -> Option<<C as Component>::Message>, propagate: impl FnMut() -> <C as Component>::Message, ) -> !

where C: Component,

Start to receive and interp the events of the child component.

Define a root component MainModel, and it contains a window: Child<Window>. The message of MainModel is defined as

enum MainMessage {
    Noop,
    Close,
}

In the MainModel::start, you should write

async fn start(&mut self, sender: &ComponentSender<Self>) {
    start! {
        sender, default: MainMessage::Noop,
        self.window => {
            WindowEvent::Close => MainMessage::Close,
        },
        // ...other children
    }
}

It is equivalent to

async fn start(&mut self, sender: &ComponentSender<Self>) {
    let fut_window = self.window.start(
        sender,
        |e| match e {
            WindowEvent::Close => Some(MainMessage::Close),
            // ignore other events
            _ => None,
        },
        // you should always propagate internal messages
        || MainMessage::Noop,
    );
    // ...other children
    futures_util::join!(fut_window, /* ... */);
}

pub async fn emit(&mut self, message: <T as Component>::Message) -> bool

Emit message to the child component.

Examples found in repository

examples/test/widgets.rs (line 203)

    async fn update(&mut self, message: Self::Message, sender: &ComponentSender<Self>) -> bool {
        futures_util::future::join(self.window.update(), self.canvas.update()).await;
        match message {
            MainMessage::Noop => false,
            MainMessage::Close => {
                sender.output(());
                false
            }
            MainMessage::Redraw => true,
            MainMessage::PasswordCheck => {
                self.pentry.set_password(!self.pcheck.is_checked());
                true
            }
            MainMessage::List(e) => {
                self.pop_button.set_enabled(!self.list.is_empty());
                self.combo
                    .emit(ComboBoxMessage::from_observable_vec_event(e))
                    .await
            }
            MainMessage::Select => {
                self.index = self.combo.selection();
                false
            }
            MainMessage::Push => {
                self.list.push(
                    match self.rindex {
                        0 => &self.r1,
                        1 => &self.r2,
                        2 => &self.r3,
                        _ => unreachable!(),
                    }
                    .text(),
                );
                false
            }
            MainMessage::Pop => {
                self.list.pop();
                false
            }
            MainMessage::RSelect(i) => {
                self.rindex = i;
                false
            }
            MainMessage::Show => {
                MessageBox::new()
                    .title("Show selected item")
                    .message(
                        self.index
                            .and_then(|index| self.list.get(index))
                            .map(|s| s.as_str())
                            .unwrap_or("No selection."),
                    )
                    .buttons(MessageBoxButton::Ok)
                    .show(&self.window)
                    .await;
                false
            }
            MainMessage::OptionsPage(m) => {
                tracing::debug!(?m, "Options page message");
                match m {
                    OptionsPageMessage::Save(config, tx) => {
                        config.s = self.mltext.text();
                        tx.send(config).unwrap()
                    }
                }
                false
            }
        }
    }

pub async fn update(&mut self) -> bool

Respond to the child message.

Examples found in repository

examples/options/options.rs (line 98)

    async fn update(&mut self, message: Self::Message, sender: &ComponentSender<Self>) -> bool {
        futures_util::join!(self.window.update());
        match message {
            MainMessage::Noop => false,
            MainMessage::Close => {
                sender.output(());
                false
            }
            MainMessage::Redraw => true,
            MainMessage::EnabledClick => {
                let enabled = self.enabled.is_checked();
                self.b.set_enabled(enabled);
                self.e.set_enabled(enabled);
                self.s.set_enabled(enabled);
                false
            }
            MainMessage::OptionsPage(m) => {
                tracing::debug!(?m, "Options page message");
                match m {
                    OptionsPageMessage::Save(config, tx) => {
                        config.enabled = self.enabled.is_checked();
                        config.b = self.b.is_checked();
                        config.e = match self.e.selection() {
                            Some(0) => Mode::A,
                            Some(1) => Mode::B,
                            _ => Default::default(),
                        };
                        config.s = self.s.text();
                        tx.send(config).unwrap()
                    }
                }
                false
            }
        }
    }

examples/test/widgets.rs (line 188)

    async fn update(&mut self, message: Self::Message, sender: &ComponentSender<Self>) -> bool {
        futures_util::future::join(self.window.update(), self.canvas.update()).await;
        match message {
            MainMessage::Noop => false,
            MainMessage::Close => {
                sender.output(());
                false
            }
            MainMessage::Redraw => true,
            MainMessage::PasswordCheck => {
                self.pentry.set_password(!self.pcheck.is_checked());
                true
            }
            MainMessage::List(e) => {
                self.pop_button.set_enabled(!self.list.is_empty());
                self.combo
                    .emit(ComboBoxMessage::from_observable_vec_event(e))
                    .await
            }
            MainMessage::Select => {
                self.index = self.combo.selection();
                false
            }
            MainMessage::Push => {
                self.list.push(
                    match self.rindex {
                        0 => &self.r1,
                        1 => &self.r2,
                        2 => &self.r3,
                        _ => unreachable!(),
                    }
                    .text(),
                );
                false
            }
            MainMessage::Pop => {
                self.list.pop();
                false
            }
            MainMessage::RSelect(i) => {
                self.rindex = i;
                false
            }
            MainMessage::Show => {
                MessageBox::new()
                    .title("Show selected item")
                    .message(
                        self.index
                            .and_then(|index| self.list.get(index))
                            .map(|s| s.as_str())
                            .unwrap_or("No selection."),
                    )
                    .buttons(MessageBoxButton::Ok)
                    .show(&self.window)
                    .await;
                false
            }
            MainMessage::OptionsPage(m) => {
                tracing::debug!(?m, "Options page message");
                match m {
                    OptionsPageMessage::Save(config, tx) => {
                        config.s = self.mltext.text();
                        tx.send(config).unwrap()
                    }
                }
                false
            }
        }
    }

pub fn render(&mut self)

Render the child component.

Examples found in repository

examples/options/options.rs (line 134)

    fn render(&mut self, _sender: &ComponentSender<Self>) {
        self.window.render();

        let csize = self.window.client_size();

        let m = Margin::new(5., 0., 5., 0.);
        let m_l = Margin::new(0., 5., 0., 0.);

        let mut form = layout! {
            Grid::from_str("auto,1*", "auto,auto").unwrap(),
            self.e_label => { column: 0, row: 0, margin: m_l, valign: VAlign::Center },
            self.e => { column: 1, row: 0, margin: m },
            self.s_label => { column: 0, row: 1, margin: m_l, valign: VAlign::Center },
            self.s => { column: 1, row: 1, margin: m },
        };

        let mut grid = layout! {
            Grid::from_str("auto,1*", "auto,auto,auto,1*").unwrap(),
            self.enabled => { column: 0, row: 0, margin: m },
            self.b => { column: 0, row: 1, margin: m },
            form => { column: 0, row: 2, margin: m },
        };
        grid.set_size(csize);
    }

Trait Implementations

impl<T> AsRawWidget for Child<T>

where T: AsRawWidget + Component,

fn as_raw_widget(&self) -> RawWidget

Get the raw window handle.

impl<T> AsRawWindow for Child<T>

where T: AsRawWindow + Component,

fn as_raw_window(&self) -> RawWindow

Get the raw window handle.

impl<T> AsWidget for Child<T>

where T: AsWidget + Component,

fn as_widget(&self) -> BorrowedWidget<'_>

Get the window handle.

impl<T> AsWindow for Child<T>

where T: AsWindow + Component,

fn as_window(&self) -> BorrowedWindow<'_>

Get the window handle.

impl<T> Debug for Child<T>

where T: Component + Debug,

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

Formats the value using the given formatter.

impl<T> Deref for Child<T>

where T: Component,

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &<Child<T> as Deref>::Target

Dereferences the value.

impl<T> DerefMut for Child<T>

where T: Component,

fn deref_mut(&mut self) -> &mut <Child<T> as Deref>::Target

Mutably dereferences the value.

impl<T> Layoutable for Child<T>

where T: Component + Layoutable,

fn loc(&self) -> Point2D<f64, LogicalSpace>

The left top location.

fn set_loc(&mut self, p: Point2D<f64, LogicalSpace>)

Move the location.

fn size(&self) -> Size2D<f64, LogicalSpace>

The size.

fn set_size(&mut self, s: Size2D<f64, LogicalSpace>)

Resize.

fn rect(&self) -> Rect<f64, LogicalSpace>

The bounding rectangle.

fn set_rect(&mut self, r: Rect<f64, LogicalSpace>)

Set the location and size.

fn preferred_size(&self) -> Size2D<f64, LogicalSpace>

The preferred size.

fn min_size(&self) -> Size2D<f64, LogicalSpace>

Min acceptable size.