Struct iced_native::Element
source · [−]pub struct Element<'a, Message, Renderer> { /* private fields */ }
Expand description
A generic Widget
.
It is useful to build composable user interfaces that do not leak implementation details in their view logic.
If you have a built-in widget, you should be able to use Into<Element>
to turn it into an Element
.
Implementations
sourceimpl<'a, Message, Renderer> Element<'a, Message, Renderer> where
Renderer: Renderer,
impl<'a, Message, Renderer> Element<'a, Message, Renderer> where
Renderer: Renderer,
sourcepub fn map<F, B>(self, f: F) -> Element<'a, B, Renderer> where
Message: 'static,
Renderer: 'a,
B: 'static,
F: 'static + Fn(Message) -> B,
pub fn map<F, B>(self, f: F) -> Element<'a, B, Renderer> where
Message: 'static,
Renderer: 'a,
B: 'static,
F: 'static + Fn(Message) -> B,
Applies a transformation to the produced message of the Element
.
This method is useful when you want to decouple different parts of your UI and make them composable.
Example
Imagine we want to use our counter. But instead of
showing a single counter, we want to display many of them. We can reuse
the Counter
type as it is!
We use composition to model the state of our new application:
use counter::Counter;
struct ManyCounters {
counters: Vec<Counter>,
}
We can store the state of multiple counters now. However, the messages we implemented before describe the user interactions of a single counter. Right now, we need to also identify which counter is receiving user interactions. Can we use composition again? Yes.
#[derive(Debug, Clone, Copy)]
pub enum Message {
Counter(usize, counter::Message)
}
We compose the previous messages with the index of the counter producing them. Let’s implement our view logic now:
use iced_native::Element;
use iced_native::widget::Row;
use iced_wgpu::Renderer;
impl ManyCounters {
pub fn view(&mut self) -> Row<Message, Renderer> {
// We can quickly populate a `Row` by folding over our counters
self.counters.iter_mut().enumerate().fold(
Row::new().spacing(20),
|row, (index, counter)| {
// We display the counter
let element: Element<counter::Message, Renderer> =
counter.view().into();
row.push(
// Here we turn our `Element<counter::Message>` into
// an `Element<Message>` by combining the `index` and the
// message of the `element`.
element.map(move |message| Message::Counter(index, message))
)
}
)
}
}
Finally, our update logic is pretty straightforward: simple delegation.
impl ManyCounters {
pub fn update(&mut self, message: Message) {
match message {
Message::Counter(index, counter_msg) => {
if let Some(counter) = self.counters.get_mut(index) {
counter.update(counter_msg);
}
}
}
}
}
sourcepub fn explain<C: Into<Color>>(self, color: C) -> Element<'a, Message, Renderer> where
Message: 'static,
Renderer: 'a,
pub fn explain<C: Into<Color>>(self, color: C) -> Element<'a, Message, Renderer> where
Message: 'static,
Renderer: 'a,
sourcepub fn on_event(
&mut self,
event: Event,
layout: Layout<'_>,
cursor_position: Point,
renderer: &Renderer,
clipboard: &mut dyn Clipboard,
shell: &mut Shell<'_, Message>
) -> Status
pub fn on_event(
&mut self,
event: Event,
layout: Layout<'_>,
cursor_position: Point,
renderer: &Renderer,
clipboard: &mut dyn Clipboard,
shell: &mut Shell<'_, Message>
) -> Status
Processes a runtime Event
.
sourcepub fn draw(
&self,
renderer: &mut Renderer,
style: &Style,
layout: Layout<'_>,
cursor_position: Point,
viewport: &Rectangle
)
pub fn draw(
&self,
renderer: &mut Renderer,
style: &Style,
layout: Layout<'_>,
cursor_position: Point,
viewport: &Rectangle
)
sourcepub fn mouse_interaction(
&self,
layout: Layout<'_>,
cursor_position: Point,
viewport: &Rectangle,
renderer: &Renderer
) -> Interaction
pub fn mouse_interaction(
&self,
layout: Layout<'_>,
cursor_position: Point,
viewport: &Rectangle,
renderer: &Renderer
) -> Interaction
Returns the current mouse::Interaction
of the Element
.
Trait Implementations
sourceimpl<'a, Message, Renderer> From<Button<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
Message: 'a + Clone,
Renderer: 'a + Renderer,
impl<'a, Message, Renderer> From<Button<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
Message: 'a + Clone,
Renderer: 'a + Renderer,
sourceimpl<'a, Message, Renderer> From<Checkbox<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
Renderer: 'a + Renderer,
Message: 'a,
impl<'a, Message, Renderer> From<Checkbox<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
Renderer: 'a + Renderer,
Message: 'a,
sourceimpl<'a, Message, Renderer> From<Column<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
Renderer: 'a + Renderer,
Message: 'a,
impl<'a, Message, Renderer> From<Column<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
Renderer: 'a + Renderer,
Message: 'a,
sourceimpl<'a, Message, Renderer> From<Container<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
Renderer: 'a + Renderer,
Message: 'a,
impl<'a, Message, Renderer> From<Container<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
Renderer: 'a + Renderer,
Message: 'a,
sourceimpl<'a, Message, Renderer, Handle> From<Image<Handle>> for Element<'a, Message, Renderer> where
Renderer: Renderer<Handle = Handle>,
Handle: Clone + Hash + 'a,
impl<'a, Message, Renderer, Handle> From<Image<Handle>> for Element<'a, Message, Renderer> where
Renderer: Renderer<Handle = Handle>,
Handle: Clone + Hash + 'a,
sourceimpl<'a, Message, Renderer> From<PaneGrid<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
Renderer: 'a + Renderer,
Message: 'a,
impl<'a, Message, Renderer> From<PaneGrid<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
Renderer: 'a + Renderer,
Message: 'a,
sourceimpl<'a, Message, Renderer> From<ProgressBar<'a>> for Element<'a, Message, Renderer> where
Renderer: 'a + Renderer,
Message: 'a,
impl<'a, Message, Renderer> From<ProgressBar<'a>> for Element<'a, Message, Renderer> where
Renderer: 'a + Renderer,
Message: 'a,
sourcefn from(progress_bar: ProgressBar<'a>) -> Element<'a, Message, Renderer>
fn from(progress_bar: ProgressBar<'a>) -> Element<'a, Message, Renderer>
Converts to this type from the input type.
sourceimpl<'a, Message, Renderer> From<Radio<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
Message: 'a + Clone,
Renderer: 'a + Renderer,
impl<'a, Message, Renderer> From<Radio<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
Message: 'a + Clone,
Renderer: 'a + Renderer,
sourceimpl<'a, Message, Renderer> From<Row<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
Renderer: 'a + Renderer,
Message: 'a,
impl<'a, Message, Renderer> From<Row<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
Renderer: 'a + Renderer,
Message: 'a,
sourceimpl<'a, Message, Renderer> From<Rule<'a>> for Element<'a, Message, Renderer> where
Renderer: 'a + Renderer,
Message: 'a,
impl<'a, Message, Renderer> From<Rule<'a>> for Element<'a, Message, Renderer> where
Renderer: 'a + Renderer,
Message: 'a,
sourceimpl<'a, Message, Renderer> From<Scrollable<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
Renderer: 'a + Renderer,
Message: 'a,
impl<'a, Message, Renderer> From<Scrollable<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
Renderer: 'a + Renderer,
Message: 'a,
sourcefn from(
scrollable: Scrollable<'a, Message, Renderer>
) -> Element<'a, Message, Renderer>
fn from(
scrollable: Scrollable<'a, Message, Renderer>
) -> Element<'a, Message, Renderer>
Converts to this type from the input type.
sourceimpl<'a, T, Message, Renderer> From<Slider<'a, T, Message>> for Element<'a, Message, Renderer> where
T: 'a + Copy + Into<f64> + FromPrimitive,
Message: 'a + Clone,
Renderer: 'a + Renderer,
impl<'a, T, Message, Renderer> From<Slider<'a, T, Message>> for Element<'a, Message, Renderer> where
T: 'a + Copy + Into<f64> + FromPrimitive,
Message: 'a + Clone,
Renderer: 'a + Renderer,
sourceimpl<'a, Message, Renderer> From<Space> for Element<'a, Message, Renderer> where
Renderer: Renderer,
Message: 'a,
impl<'a, Message, Renderer> From<Space> for Element<'a, Message, Renderer> where
Renderer: Renderer,
Message: 'a,
sourceimpl<'a, Message, Renderer> From<Svg> for Element<'a, Message, Renderer> where
Renderer: Renderer,
impl<'a, Message, Renderer> From<Svg> for Element<'a, Message, Renderer> where
Renderer: Renderer,
sourceimpl<'a, Message, Renderer> From<Text<Renderer>> for Element<'a, Message, Renderer> where
Renderer: Renderer + 'a,
impl<'a, Message, Renderer> From<Text<Renderer>> for Element<'a, Message, Renderer> where
Renderer: Renderer + 'a,
sourceimpl<'a, Message, Renderer> From<TextInput<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
Message: 'a + Clone,
Renderer: 'a + Renderer,
impl<'a, Message, Renderer> From<TextInput<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
Message: 'a + Clone,
Renderer: 'a + Renderer,
sourceimpl<'a, Message, Renderer> From<Toggler<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
Renderer: 'a + Renderer,
Message: 'a,
impl<'a, Message, Renderer> From<Toggler<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
Renderer: 'a + Renderer,
Message: 'a,
sourceimpl<'a, Message, Renderer> From<Tooltip<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
Renderer: 'a + Renderer,
Message: 'a,
impl<'a, Message, Renderer> From<Tooltip<'a, Message, Renderer>> for Element<'a, Message, Renderer> where
Renderer: 'a + Renderer,
Message: 'a,
sourceimpl<'a, Message, Renderer, Handle> From<Viewer<'a, Handle>> for Element<'a, Message, Renderer> where
Renderer: 'a + Renderer<Handle = Handle>,
Message: 'a,
Handle: Clone + Hash + 'a,
impl<'a, Message, Renderer, Handle> From<Viewer<'a, Handle>> for Element<'a, Message, Renderer> where
Renderer: 'a + Renderer<Handle = Handle>,
Message: 'a,
Handle: Clone + Hash + 'a,
Auto Trait Implementations
impl<'a, Message, Renderer> !RefUnwindSafe for Element<'a, Message, Renderer>
impl<'a, Message, Renderer> !Send for Element<'a, Message, Renderer>
impl<'a, Message, Renderer> !Sync for Element<'a, Message, Renderer>
impl<'a, Message, Renderer> Unpin for Element<'a, Message, Renderer>
impl<'a, Message, Renderer> !UnwindSafe for Element<'a, Message, Renderer>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more