327 lines
8.9 KiB
Rust
327 lines
8.9 KiB
Rust
//! Distribute content horizontally.
|
|
use crate::core::event::{self, Event};
|
|
use crate::core::layout::{self, Layout};
|
|
use crate::core::mouse;
|
|
use crate::core::overlay;
|
|
use crate::core::renderer;
|
|
use crate::core::widget::{Operation, Tree};
|
|
use crate::core::{
|
|
Alignment, Clipboard, Element, Length, Padding, Pixels, Rectangle, Shell,
|
|
Size, Vector, Widget,
|
|
};
|
|
|
|
/// A container that distributes its contents horizontally.
|
|
#[allow(missing_debug_implementations)]
|
|
pub struct Row<'a, Message, Theme = crate::Theme, Renderer = crate::Renderer> {
|
|
spacing: f32,
|
|
padding: Padding,
|
|
width: Length,
|
|
height: Length,
|
|
align_items: Alignment,
|
|
clip: bool,
|
|
children: Vec<Element<'a, Message, Theme, Renderer>>,
|
|
}
|
|
|
|
impl<'a, Message, Theme, Renderer> Row<'a, Message, Theme, Renderer>
|
|
where
|
|
Renderer: crate::core::Renderer,
|
|
{
|
|
/// Creates an empty [`Row`].
|
|
pub fn new() -> Self {
|
|
Self::from_vec(Vec::new())
|
|
}
|
|
|
|
/// Creates a [`Row`] with the given capacity.
|
|
pub fn with_capacity(capacity: usize) -> Self {
|
|
Self::from_vec(Vec::with_capacity(capacity))
|
|
}
|
|
|
|
/// Creates a [`Row`] with the given elements.
|
|
pub fn with_children(
|
|
children: impl IntoIterator<Item = Element<'a, Message, Theme, Renderer>>,
|
|
) -> Self {
|
|
let iterator = children.into_iter();
|
|
|
|
Self::with_capacity(iterator.size_hint().0).extend(iterator)
|
|
}
|
|
|
|
/// Creates a [`Row`] from an already allocated [`Vec`].
|
|
///
|
|
/// Keep in mind that the [`Row`] will not inspect the [`Vec`], which means
|
|
/// it won't automatically adapt to the sizing strategy of its contents.
|
|
///
|
|
/// If any of the children have a [`Length::Fill`] strategy, you will need to
|
|
/// call [`Row::width`] or [`Row::height`] accordingly.
|
|
pub fn from_vec(
|
|
children: Vec<Element<'a, Message, Theme, Renderer>>,
|
|
) -> Self {
|
|
Self {
|
|
spacing: 0.0,
|
|
padding: Padding::ZERO,
|
|
width: Length::Shrink,
|
|
height: Length::Shrink,
|
|
align_items: Alignment::Start,
|
|
clip: false,
|
|
children,
|
|
}
|
|
}
|
|
|
|
/// Sets the horizontal spacing _between_ elements.
|
|
///
|
|
/// Custom margins per element do not exist in iced. You should use this
|
|
/// method instead! While less flexible, it helps you keep spacing between
|
|
/// elements consistent.
|
|
pub fn spacing(mut self, amount: impl Into<Pixels>) -> Self {
|
|
self.spacing = amount.into().0;
|
|
self
|
|
}
|
|
|
|
/// Sets the [`Padding`] of the [`Row`].
|
|
pub fn padding<P: Into<Padding>>(mut self, padding: P) -> Self {
|
|
self.padding = padding.into();
|
|
self
|
|
}
|
|
|
|
/// Sets the width of the [`Row`].
|
|
pub fn width(mut self, width: impl Into<Length>) -> Self {
|
|
self.width = width.into();
|
|
self
|
|
}
|
|
|
|
/// Sets the height of the [`Row`].
|
|
pub fn height(mut self, height: impl Into<Length>) -> Self {
|
|
self.height = height.into();
|
|
self
|
|
}
|
|
|
|
/// Sets the vertical alignment of the contents of the [`Row`] .
|
|
pub fn align_items(mut self, align: Alignment) -> Self {
|
|
self.align_items = align;
|
|
self
|
|
}
|
|
|
|
/// Sets whether the contents of the [`Row`] should be clipped on
|
|
/// overflow.
|
|
pub fn clip(mut self, clip: bool) -> Self {
|
|
self.clip = clip;
|
|
self
|
|
}
|
|
|
|
/// Adds an [`Element`] to the [`Row`].
|
|
pub fn push(
|
|
mut self,
|
|
child: impl Into<Element<'a, Message, Theme, Renderer>>,
|
|
) -> Self {
|
|
let child = child.into();
|
|
let child_size = child.as_widget().size_hint();
|
|
|
|
self.width = self.width.enclose(child_size.width);
|
|
self.height = self.height.enclose(child_size.height);
|
|
|
|
self.children.push(child);
|
|
self
|
|
}
|
|
|
|
/// Adds an element to the [`Row`], if `Some`.
|
|
pub fn push_maybe(
|
|
self,
|
|
child: Option<impl Into<Element<'a, Message, Theme, Renderer>>>,
|
|
) -> Self {
|
|
if let Some(child) = child {
|
|
self.push(child)
|
|
} else {
|
|
self
|
|
}
|
|
}
|
|
|
|
/// Extends the [`Row`] with the given children.
|
|
pub fn extend(
|
|
self,
|
|
children: impl IntoIterator<Item = Element<'a, Message, Theme, Renderer>>,
|
|
) -> Self {
|
|
children.into_iter().fold(self, Self::push)
|
|
}
|
|
}
|
|
|
|
impl<'a, Message, Renderer> Default for Row<'a, Message, Renderer>
|
|
where
|
|
Renderer: crate::core::Renderer,
|
|
{
|
|
fn default() -> Self {
|
|
Self::new()
|
|
}
|
|
}
|
|
|
|
impl<'a, Message, Theme, Renderer> Widget<Message, Theme, Renderer>
|
|
for Row<'a, Message, Theme, Renderer>
|
|
where
|
|
Renderer: crate::core::Renderer,
|
|
{
|
|
fn children(&self) -> Vec<Tree> {
|
|
self.children.iter().map(Tree::new).collect()
|
|
}
|
|
|
|
fn diff(&self, tree: &mut Tree) {
|
|
tree.diff_children(&self.children);
|
|
}
|
|
|
|
fn size(&self) -> Size<Length> {
|
|
Size {
|
|
width: self.width,
|
|
height: self.height,
|
|
}
|
|
}
|
|
|
|
fn layout(
|
|
&self,
|
|
tree: &mut Tree,
|
|
renderer: &Renderer,
|
|
limits: &layout::Limits,
|
|
) -> layout::Node {
|
|
layout::flex::resolve(
|
|
layout::flex::Axis::Horizontal,
|
|
renderer,
|
|
limits,
|
|
self.width,
|
|
self.height,
|
|
self.padding,
|
|
self.spacing,
|
|
self.align_items,
|
|
&self.children,
|
|
&mut tree.children,
|
|
)
|
|
}
|
|
|
|
fn operate(
|
|
&self,
|
|
tree: &mut Tree,
|
|
layout: Layout<'_>,
|
|
renderer: &Renderer,
|
|
operation: &mut dyn Operation<()>,
|
|
) {
|
|
operation.container(None, layout.bounds(), &mut |operation| {
|
|
self.children
|
|
.iter()
|
|
.zip(&mut tree.children)
|
|
.zip(layout.children())
|
|
.for_each(|((child, state), layout)| {
|
|
child
|
|
.as_widget()
|
|
.operate(state, layout, renderer, operation);
|
|
});
|
|
});
|
|
}
|
|
|
|
fn on_event(
|
|
&mut self,
|
|
tree: &mut Tree,
|
|
event: Event,
|
|
layout: Layout<'_>,
|
|
cursor: mouse::Cursor,
|
|
renderer: &Renderer,
|
|
clipboard: &mut dyn Clipboard,
|
|
shell: &mut Shell<'_, Message>,
|
|
viewport: &Rectangle,
|
|
) -> event::Status {
|
|
self.children
|
|
.iter_mut()
|
|
.zip(&mut tree.children)
|
|
.zip(layout.children())
|
|
.map(|((child, state), layout)| {
|
|
child.as_widget_mut().on_event(
|
|
state,
|
|
event.clone(),
|
|
layout,
|
|
cursor,
|
|
renderer,
|
|
clipboard,
|
|
shell,
|
|
viewport,
|
|
)
|
|
})
|
|
.fold(event::Status::Ignored, event::Status::merge)
|
|
}
|
|
|
|
fn mouse_interaction(
|
|
&self,
|
|
tree: &Tree,
|
|
layout: Layout<'_>,
|
|
cursor: mouse::Cursor,
|
|
viewport: &Rectangle,
|
|
renderer: &Renderer,
|
|
) -> mouse::Interaction {
|
|
self.children
|
|
.iter()
|
|
.zip(&tree.children)
|
|
.zip(layout.children())
|
|
.map(|((child, state), layout)| {
|
|
child.as_widget().mouse_interaction(
|
|
state, layout, cursor, viewport, renderer,
|
|
)
|
|
})
|
|
.max()
|
|
.unwrap_or_default()
|
|
}
|
|
|
|
fn draw(
|
|
&self,
|
|
tree: &Tree,
|
|
renderer: &mut Renderer,
|
|
theme: &Theme,
|
|
style: &renderer::Style,
|
|
layout: Layout<'_>,
|
|
cursor: mouse::Cursor,
|
|
viewport: &Rectangle,
|
|
) {
|
|
if let Some(clipped_viewport) = layout.bounds().intersection(viewport) {
|
|
for ((child, state), layout) in self
|
|
.children
|
|
.iter()
|
|
.zip(&tree.children)
|
|
.zip(layout.children())
|
|
{
|
|
child.as_widget().draw(
|
|
state,
|
|
renderer,
|
|
theme,
|
|
style,
|
|
layout,
|
|
cursor,
|
|
if self.clip {
|
|
&clipped_viewport
|
|
} else {
|
|
viewport
|
|
},
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
fn overlay<'b>(
|
|
&'b mut self,
|
|
tree: &'b mut Tree,
|
|
layout: Layout<'_>,
|
|
renderer: &Renderer,
|
|
translation: Vector,
|
|
) -> Option<overlay::Element<'b, Message, Theme, Renderer>> {
|
|
overlay::from_children(
|
|
&mut self.children,
|
|
tree,
|
|
layout,
|
|
renderer,
|
|
translation,
|
|
)
|
|
}
|
|
}
|
|
|
|
impl<'a, Message, Theme, Renderer> From<Row<'a, Message, Theme, Renderer>>
|
|
for Element<'a, Message, Theme, Renderer>
|
|
where
|
|
Message: 'a,
|
|
Theme: 'a,
|
|
Renderer: crate::core::Renderer + 'a,
|
|
{
|
|
fn from(row: Row<'a, Message, Theme, Renderer>) -> Self {
|
|
Self::new(row)
|
|
}
|
|
}
|