Struct nih_plug_iced::widgets::generic_ui::GenericUi

pub struct GenericUi<'a, W: ParamWidget> { /* private fields */ }

A list of scrollable widgets for every paramter in a Params object. The ParamWidget type determines what widget to use for this.

TODO: There’s no way to configure the individual widgets.

Implementations

impl<'a, W> GenericUi<'a, W>where W: ParamWidget,

pub fn new(state: &'a mut State<W>, params: Arc<dyn Params>) -> Self

Creates a new GenericUi for all provided parameters.

pub fn width(self, width: Length) -> Self

Sets the width of the GenericUi.

pub fn height(self, height: Length) -> Self

Sets the height of the GenericUi.

pub fn max_width(self, width: u32) -> Self

Sets the maximum width of the GenericUi.

pub fn max_height(self, height: u32) -> Self

Sets the maximum height of the GenericUi.

pub fn pad_scrollbar(self) -> Self

Include additional room on the right for the scroll bar.

impl<'a, W: ParamWidget> GenericUi<'a, W>

pub fn map<Message, F>(self, f: F) -> Element<'a, Message>where Message: 'static, F: Fn(ParamMessage) -> Message + 'static,

Convert this GenericUi into an [Element] with the correct message. You should have a variant on your own message type that wraps around ParamMessage so you can forward those messages to IcedEditor::handle_param_message().

Trait Implementations

impl<'a, W> From<GenericUi<'a, W>> for Element<'a, ParamMessage>where W: ParamWidget,

fn from(widget: GenericUi<'a, W>) -> Self

Converts to this type from the input type.

impl<'a, W> Widget<ParamMessage, Renderer<Backend>> for GenericUi<'a, W>where W: ParamWidget,

fn width(&self) -> Length

Returns the width of the [Widget].

fn height(&self) -> Length

Returns the height of the [Widget].

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

Returns the Node of the [Widget].

fn draw( &self, renderer: &mut Renderer, style: &Style, layout: Layout<'_>, cursor_position: Point, viewport: &Rectangle )

Draws the [Widget] using the associated Renderer.

fn on_event( &mut self, event: Event, layout: Layout<'_>, cursor_position: Point, renderer: &Renderer, clipboard: &mut dyn Clipboard, shell: &mut Shell<'_, ParamMessage> ) -> Status

Processes a runtime [Event].

fn mouse_interaction( &self, _layout: Layout<'_>, _cursor_position: Point, _viewport: &Rectangle<f32>, _renderer: &Renderer ) -> Interaction

Returns the current [mouse::Interaction] of the [Widget].

fn overlay( &mut self, _layout: Layout<'_>, _renderer: &Renderer ) -> Option<Element<'_, Message, Renderer>>

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