Skip to main content

ComboBox

Struct ComboBox 

Source
pub struct ComboBox { /* private fields */ }
Available on crate feature winio only.
Expand description

A simple combo box.

Implementations§

Source§

impl ComboBox

Source

pub fn selection(&self) -> Result<Option<usize>, Error>

The selection index.

Examples found in repository?
examples/options/options.rs (line 127)
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 195)
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 set_selection(&mut self, i: usize) -> Result<(), Error>

Set the selection.

Examples found in repository?
examples/options/options.rs (lines 64-67)
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 is_editable(&self) -> Result<bool, Error>

If the combo box is editable.

Source

pub fn set_editable(&mut self, v: bool) -> Result<(), Error>

Set if the combo box is editable.

Source

pub fn len(&self) -> Result<usize, Error>

The length of list.

Source

pub fn is_empty(&self) -> Result<bool, Error>

If the list is empty.

Source

pub fn clear(&mut self) -> Result<(), Error>

Clear the list.

Source

pub fn get(&self, i: usize) -> Result<String, Error>

Get the item by index.

Source

pub fn set(&mut self, i: usize, s: impl AsRef<str>) -> Result<(), Error>

Set the item by index.

Source

pub fn insert(&mut self, i: usize, s: impl AsRef<str>) -> Result<(), Error>

Insert an item by index.

Examples found in repository?
examples/options/options.rs (line 51)
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 remove(&mut self, i: usize) -> Result<(), Error>

Remove the item by index.

Source

pub fn push(&mut self, s: impl AsRef<str>) -> Result<(), Error>

Push an item to the end of the list.

Source

pub fn set_items<U>( &mut self, items: impl IntoIterator<Item = U>, ) -> Result<(), Error>
where U: Into<String>,

Clears all items, and appends the new items one by one.

Trait Implementations§

Source§

impl AsWidget for ComboBox

Source§

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

Get the widget handle.
Source§

impl Component for ComboBox

Source§

type Error = Error

The error type.
Source§

type Event = ComboBoxEvent

The output event type to the parent.
Source§

type Init<'a> = BorrowedContainer<'a>

Initial parameter type.
Source§

type Message = ComboBoxMessage

The input message type to update.
Source§

async fn init( init: <ComboBox as Component>::Init<'_>, _sender: &ComponentSender<ComboBox>, ) -> Result<ComboBox, Error>

Create the initial component.
Source§

async fn start(&mut self, sender: &ComponentSender<ComboBox>) -> !

Start the event listening.
Source§

async fn update( &mut self, message: <ComboBox as Component>::Message, _sender: &ComponentSender<ComboBox>, ) -> Result<bool, Error>

Respond to the message. Return true if need render.
Source§

fn render(&mut self, sender: &ComponentSender<Self>) -> Result<(), Self::Error>

Render the widgets.
Source§

async fn update_children(&mut self) -> Result<bool, Self::Error>

Update the children components. Return true if any child needs render.
Source§

fn render_children(&mut self) -> Result<(), Self::Error>

Render the children components. It will be called if any child or self needs render.
Source§

impl Debug for ComboBox

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Enable for ComboBox

Source§

fn is_enabled(&self) -> Result<bool, Error>

If the widget is enabled.
Source§

fn set_enabled(&mut self, v: bool) -> Result<(), Error>

Set if the widget is enabled.
Source§

fn enable(&mut self) -> Result<(), Self::Error>

Enable the widget.
Source§

fn disable(&mut self) -> Result<(), Self::Error>

Disable the widget.
Source§

impl Failable for ComboBox

Source§

type Error = Error

The error type associated.
Source§

impl Layoutable for ComboBox

Source§

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

The left top location.
Source§

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

Move the location.
Source§

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

The size.
Source§

fn set_size(&mut self, v: Size2D<f64, LogicalSpace>) -> Result<(), Error>

Resize.
Source§

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

The preferred size.
Source§

fn rect(&self) -> Result<Rect<f64, LogicalSpace>, Self::Error>

The bounding rectangle.
Source§

fn set_rect(&mut self, r: Rect<f64, LogicalSpace>) -> Result<(), Self::Error>

Set the location and size.
Source§

fn min_size(&self) -> Result<Size2D<f64, LogicalSpace>, Self::Error>

Min acceptable size.
Source§

impl TextWidget for ComboBox

Source§

fn text(&self) -> Result<String, Error>

Get the text of the widget.
Source§

fn set_text(&mut self, s: impl AsRef<str>) -> Result<(), Error>

Set the text of the widget. Read more
Source§

impl ToolTip for ComboBox

Source§

fn tooltip(&self) -> Result<String, Error>

Get the tooltip text of the widget.
Source§

fn set_tooltip(&mut self, s: impl AsRef<str>) -> Result<(), Error>

Set the tooltip text of the widget.
Source§

impl Visible for ComboBox

Source§

fn is_visible(&self) -> Result<bool, Error>

If the widget is visible.
Source§

fn set_visible(&mut self, v: bool) -> Result<(), Error>

Set the visibility.
Source§

fn show(&mut self) -> Result<(), Self::Error>

Show the widget.
Source§

fn hide(&mut self) -> Result<(), Self::Error>

Hide the widget.

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