Struct ComboBox

pub struct ComboBox<D: Display + Default> {
    pub handle: ControlHandle,
    /* private fields */
}

A combo box consists of a list and a selection field. The list presents the options that a user can select, and the selection field displays the current selection.

Requires the combobox feature.

Builder parameters:

• parent: Required. The combobox parent container.
• size: The combobox size.
• position: The combobox position.
• enabled: If the combobox can be used by the user. It also has a grayed out look if disabled.
• flags: A combination of the ComboBoxFlags values.
• ex_flags: A combination of win32 window extended flags. Unlike flags, ex_flags must be used straight from winapi
• font: The font used for the combobox text
• collection: The default collection of the combobox
• selected_index: The default selected index. None means no values are selected.
• focus: The control receive focus after being created

Control events:

• OnComboBoxClosed: When the combobox dropdown is closed
• OnComboBoxDropdown: When the combobox dropdown is opened
• OnComboxBoxSelection: When a new value in a combobox is choosen
• MousePress(_): Generic mouse press events on the checkbox
• OnMouseMove: Generic mouse mouse event
• OnMouseWheel: Generic mouse wheel event

use native_windows_gui as nwg;
fn build_combobox(combo: &mut nwg::ComboBox<&'static str>, window: &nwg::Window) {
    let data = vec!["one", "two"];
    
    nwg::ComboBox::builder()
        .size((200, 300))
        .collection(data)
        .selected_index(Some(0))
        .parent(window)
        .build(combo);
}

Fields

handle: ControlHandle

Implementations

impl<D: Display + Default> ComboBox<D>

pub fn builder<'a>() -> ComboBoxBuilder<'a, D>

Examples found in repository

examples/partials.rs (line 357)

        fn build_partial<W: Into<ControlHandle>>(data: &mut AnimalUi, parent: Option<W>) -> Result<(), NwgError> {
            let parent = parent.unwrap().into();

            nwg::Label::builder()
                .text("Name:")
                .h_align(nwg::HTextAlign::Right)
                .parent(&parent)
                .build(&mut data.label1)?;

            nwg::Label::builder()
                .text("Race:")
                .h_align(nwg::HTextAlign::Right)
                .parent(&parent)
                .build(&mut data.label2)?;

            nwg::Label::builder()
                .text("Is fluffy:")
                .h_align(nwg::HTextAlign::Right)
                .parent(&parent)
                .build(&mut data.label3)?;

            nwg::TextInput::builder()
                .text("Mittens")
                .parent(&parent)
                .build(&mut data.name_input)?;

            nwg::ComboBox::builder()
                .collection(vec!["Cat", "Dog", "Pidgeon", "Monkey"])
                .selected_index(Some(0))
                .parent(&parent)
                .build(&mut data.race_input)?;

            nwg::CheckBox::builder()
                .text("")
                .check_state(nwg::CheckBoxState::Checked)
                .parent(&parent)
                .build(&mut data.is_soft_input)?;

            nwg::Button::builder()
                .text("Save")
                .parent(&parent)
                .build(&mut data.save_btn)?;

            nwg::GridLayout::builder()
                .parent(&parent)
                .max_size([1000, 150])
                .min_size([100, 120])
                .child(0, 0, &data.label1)
                .child(0, 1, &data.label2)
                .child(0, 2, &data.label3)
                .child(1, 0, &data.name_input)
                .child(1, 1, &data.race_input)
                .child(1, 2, &data.is_soft_input)
                .build(&data.layout)?;

            nwg::GridLayout::builder()
                .min_size([100, 200])
                .max_column(Some(2))
                .max_row(Some(6))
                .child(1, 5, &data.save_btn)
                .parent(&parent)
                .build(&data.layout2)?;

            Ok(())
        }

pub fn remove(&self, index: usize) -> D

Remove the item at the selected index and returns it. Panic of the index is out of bounds

pub fn sort(&self)

Sort the inner collection by the display value of it’s items and update the view Internally this uses Vec.sort_unstable_by.

pub fn dropdown(&self, v: bool)

Show or hide the dropdown of the combox

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

Return the index of the currencty selected item. Return None if no item is selected.

pub fn selection_string(&self) -> Option<String>

Return the display value of the currenctly selected item Return None if no item is selected. This reads the visual value.

pub fn set_selection(&self, index: Option<usize>)

Set the currently selected item in the combobox. Does nothing if the index is out of bound If the value is None, remove the selected value

pub fn set_selection_string(&self, value: &str) -> Option<usize>

Search an item that begins by the value and select the first one found. The search is not case sensitive, so this string can contain any combination of uppercase and lowercase letters. Return the index of the selected string or None if the search was not successful

pub fn push(&self, item: D)

Add a new item to the combobox. Sort the collection if the combobox is sorted.

pub fn insert(&self, index: usize, item: D)

Insert an item in the collection and the control.

SPECIAL behaviour! If index is std::usize::MAX, the item is added at the end of the collection. The method will still panic if index > len with every other values.

pub fn sync(&self)

Update the visual of the control with the inner collection. This rebuild every item in the combobox and can take some time on big collections.

pub fn set_collection(&self, col: Vec<D>) -> Vec<D>

Set the item collection of the combobox. Return the old collection

pub fn len(&self) -> usize

Return the number of items in the control. NOT the inner rust collection

pub fn font(&self) -> Option<Font>

Return the font of the control

pub fn set_font(&self, font: Option<&Font>)

Set the font of the control

pub fn focus(&self) -> bool

Return true if the control currently has the keyboard focus

pub fn set_focus(&self)

Set the keyboard focus on the button.

pub fn enabled(&self) -> bool

Return true if the control user can interact with the control, return false otherwise

pub fn set_enabled(&self, v: bool)

Enable or disable the control

pub fn visible(&self) -> bool

Return true if the control is visible to the user. Will return true even if the control is outside of the parent client view (ex: at the position (10000, 10000))

pub fn set_visible(&self, v: bool)

Show or hide the control to the user

pub fn size(&self) -> (u32, u32)

Return the size of the button in the parent window

pub fn set_size(&self, x: u32, y: u32)

Set the size of the button in the parent window

pub fn position(&self) -> (i32, i32)

Return the position of the button in the parent window

pub fn set_position(&self, x: i32, y: i32)

Set the position of the button in the parent window

pub fn collection(&self) -> Ref<'_, Vec<D>>

Get read-only access to the inner collection of the combobox This call refcell.borrow under the hood. Be sure to drop the value before calling other combobox methods

pub fn collection_mut(&self) -> RefMut<'_, Vec<D>>

Get mutable access to the inner collection of the combobox. Does not update the visual control. Call sync to update the view. This call refcell.borrow_mut under the hood. Be sure to drop the value before calling other combobox methods

pub fn class_name(&self) -> &'static str

Winapi class name used during control creation

pub fn flags(&self) -> u32

Winapi base flags used during window creation

pub fn forced_flags(&self) -> u32

Winapi flags required by the control

Trait Implementations

impl<D: Default + Display + Default> Default for ComboBox<D>

fn default() -> ComboBox<D>

Returns the “default value” for a type.

impl<D: Display + Default> Drop for ComboBox<D>

fn drop(&mut self)

Executes the destructor for this type.

impl<D: Display + Default> From<&ComboBox<D>> for ControlHandle

fn from(control: &ComboBox<D>) -> Self

Converts to this type from the input type.

impl<D: Display + Default> PartialEq<ComboBox<D>> for ControlHandle

fn eq(&self, other: &ComboBox<D>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<D: Display + Default> PartialEq<ControlHandle> for ComboBox<D>

fn eq(&self, other: &ControlHandle) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<D: Display + Default> PartialEq for ComboBox<D>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.