Struct PickList

pub struct PickList<'a, T, L, V, Message, Theme = Theme, Renderer = Renderer>
where
    T: ToString + PartialEq + Clone,
    L: Borrow<[T]> + 'a,
    V: Borrow<T> + 'a,
    Theme: Catalog,
    Renderer: Renderer,
{ /* private fields */ }

A widget for selecting a single value from a list of options.

Example

use iced::widget::pick_list;

struct State {
   favorite: Option<Fruit>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum Fruit {
    Apple,
    Orange,
    Strawberry,
    Tomato,
}

#[derive(Debug, Clone)]
enum Message {
    FruitSelected(Fruit),
}

fn view(state: &State) -> Element<'_, Message> {
    let fruits = [
        Fruit::Apple,
        Fruit::Orange,
        Fruit::Strawberry,
        Fruit::Tomato,
    ];

    pick_list(
        fruits,
        state.favorite,
        Message::FruitSelected,
    )
    .placeholder("Select your favorite fruit...")
    .into()
}

fn update(state: &mut State, message: Message) {
    match message {
        Message::FruitSelected(fruit) => {
            state.favorite = Some(fruit);
        }
    }
}

impl std::fmt::Display for Fruit {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(match self {
            Self::Apple => "Apple",
            Self::Orange => "Orange",
            Self::Strawberry => "Strawberry",
            Self::Tomato => "Tomato",
        })
    }
}

Implementations

impl<'a, T, L, V, Message, Theme, Renderer> PickList<'a, T, L, V, Message, Theme, Renderer>

where T: ToString + PartialEq + Clone, L: Borrow<[T]> + 'a, V: Borrow<T> + 'a, Message: Clone, Theme: Catalog, Renderer: Renderer,

pub fn new( options: L, selected: Option<V>, on_select: impl Fn(T) -> Message + 'a, ) -> PickList<'a, T, L, V, Message, Theme, Renderer>

Creates a new PickList with the given list of options, the current selected value, and the message to produce when an option is selected.

pub fn placeholder( self, placeholder: impl Into<String>, ) -> PickList<'a, T, L, V, Message, Theme, Renderer>

Sets the placeholder of the PickList.

pub fn width( self, width: impl Into<Length>, ) -> PickList<'a, T, L, V, Message, Theme, Renderer>

Sets the width of the PickList.

pub fn padding<P>( self, padding: P, ) -> PickList<'a, T, L, V, Message, Theme, Renderer>

where P: Into<Padding>,

Sets the Padding of the PickList.

pub fn text_size( self, size: impl Into<Pixels>, ) -> PickList<'a, T, L, V, Message, Theme, Renderer>

Sets the text size of the PickList.

pub fn text_line_height( self, line_height: impl Into<LineHeight>, ) -> PickList<'a, T, L, V, Message, Theme, Renderer>

Sets the text text::LineHeight of the PickList.

pub fn text_shaping( self, shaping: Shaping, ) -> PickList<'a, T, L, V, Message, Theme, Renderer>

Sets the text::Shaping strategy of the PickList.

pub fn text_wrap( self, wrap: Wrapping, ) -> PickList<'a, T, L, V, Message, Theme, Renderer>

Sets the text::Wrapping mode of the PickList.

pub fn font( self, font: impl Into<<Renderer as Renderer>::Font>, ) -> PickList<'a, T, L, V, Message, Theme, Renderer>

Sets the font of the PickList.

pub fn handle( self, handle: Handle<<Renderer as Renderer>::Font>, ) -> PickList<'a, T, L, V, Message, Theme, Renderer>

Sets the Handle of the PickList.

pub fn on_open( self, on_open: Message, ) -> PickList<'a, T, L, V, Message, Theme, Renderer>

Sets the message that will be produced when the PickList is opened.

pub fn on_close( self, on_close: Message, ) -> PickList<'a, T, L, V, Message, Theme, Renderer>

Sets the message that will be produced when the PickList is closed.

pub fn style( self, style: impl Fn(&Theme, Status) -> Style + 'a, ) -> PickList<'a, T, L, V, Message, Theme, Renderer>

where <Theme as Catalog>::Class<'a>: From<Box<dyn Fn(&Theme, Status) -> Style + 'a>>,

Sets the style of the PickList.

pub fn menu_style( self, style: impl Fn(&Theme) -> Style + 'a, ) -> PickList<'a, T, L, V, Message, Theme, Renderer>

where <Theme as Catalog>::Class<'a>: From<Box<dyn Fn(&Theme) -> Style + 'a>>,

Sets the style of the Menu.

pub fn class( self, class: impl Into<<Theme as Catalog>::Class<'a>>, ) -> PickList<'a, T, L, V, Message, Theme, Renderer>

Sets the style class of the PickList.

pub fn menu_class( self, class: impl Into<<Theme as Catalog>::Class<'a>>, ) -> PickList<'a, T, L, V, Message, Theme, Renderer>

Sets the style class of the Menu.

Trait Implementations

impl<'a, T, L, V, Message, Theme, Renderer> From<PickList<'a, T, L, V, Message, Theme, Renderer>> for Element<'a, Message, Theme, Renderer>

where T: Clone + ToString + PartialEq + 'a, L: Borrow<[T]> + 'a, V: Borrow<T> + 'a, Message: Clone + 'a, Theme: Catalog + 'a, Renderer: Renderer + 'a,

fn from( pick_list: PickList<'a, T, L, V, Message, Theme, Renderer>, ) -> Element<'a, Message, Theme, Renderer>

Converts to this type from the input type.

impl<'a, T, L, V, Message, Theme, Renderer> Widget<Message, Theme, Renderer> for PickList<'a, T, L, V, Message, Theme, Renderer>

where T: Clone + ToString + PartialEq + 'a, L: Borrow<[T]>, V: Borrow<T>, Message: Clone + 'a, Theme: Catalog + 'a, Renderer: Renderer + 'a,

fn tag(&self) -> Tag

Returns the Tag of the Widget.

fn state(&self) -> State

Returns the State of the Widget.

fn size(&self) -> Size<Length>

Returns the Size of the Widget in lengths.

fn layout(&self, tree: &mut Tree, renderer: &Renderer, limits: &Limits) -> Node

Returns the layout::Node of the Widget.

fn on_event( &mut self, tree: &mut Tree, event: Event, layout: Layout<'_>, cursor: Cursor, _renderer: &Renderer, _clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, Message>, _viewport: &Rectangle, ) -> Status

Processes a runtime Event.

fn mouse_interaction( &self, _tree: &Tree, layout: Layout<'_>, cursor: Cursor, _viewport: &Rectangle, _renderer: &Renderer, ) -> Interaction

Returns the current mouse::Interaction of the Widget.

fn draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Theme, _style: &Style, layout: Layout<'_>, cursor: Cursor, viewport: &Rectangle, )

Draws the Widget using the associated Renderer.

fn overlay<'b>( &'b mut self, tree: &'b mut Tree, layout: Layout<'_>, renderer: &Renderer, translation: Vector, ) -> Option<Element<'b, Message, Theme, Renderer>>

Returns the overlay of the Widget, if there is any.

fn size_hint(&self) -> Size<Length>

Returns a Size hint for laying out the Widget.

fn children(&self) -> Vec<Tree>

Returns the state Tree of the children of the Widget.

fn diff(&mut self, _tree: &mut Tree)

Reconciliates the Widget with the provided Tree.

fn operate( &self, _state: &mut Tree, _layout: Layout<'_>, _renderer: &Renderer, _operation: &mut dyn Operation, )

Applies an Operation to the Widget.

fn a11y_nodes( &self, _layout: Layout<'_>, _state: &Tree, _cursor: Cursor, ) -> A11yTree

get the a11y nodes for the widget and its children

fn id(&self) -> Option<Id>

Returns the id of the widget

fn set_id(&mut self, _id: Id)

Sets the id of the widget This may be called while diffing the widget tree

fn drag_destinations( &self, _state: &Tree, _layout: Layout<'_>, _renderer: &Renderer, _dnd_rectangles: &mut DndDestinationRectangles, )

Adds the drag destination rectangles of the widget. Runs after the layout phase for each widget in the tree.