//! Decorate content and apply alignment. use crate::core::alignment::{self, Alignment}; use crate::core::event::{self, Event}; use crate::core::layout; use crate::core::mouse; use crate::core::overlay; use crate::core::renderer; use crate::core::widget::tree::{self, Tree}; use crate::core::widget::{self, Operation}; use crate::core::{ Background, Clipboard, Color, Element, Layout, Length, Padding, Pixels, Point, Rectangle, Shell, Size, Vector, Widget, }; use crate::runtime::Command; pub use iced_style::container::{Appearance, StyleSheet}; /// An element decorating some content. /// /// It is normally used for alignment purposes. #[allow(missing_debug_implementations)] pub struct Container<'a, Message, Renderer = crate::Renderer> where Renderer: crate::core::Renderer, Renderer::Theme: StyleSheet, { id: Option, padding: Padding, width: Length, height: Length, max_width: f32, max_height: f32, horizontal_alignment: alignment::Horizontal, vertical_alignment: alignment::Vertical, style: ::Style, content: Element<'a, Message, Renderer>, } impl<'a, Message, Renderer> Container<'a, Message, Renderer> where Renderer: crate::core::Renderer, Renderer::Theme: StyleSheet, { /// Creates an empty [`Container`]. pub fn new(content: T) -> Self where T: Into>, { Container { id: None, padding: Padding::ZERO, width: Length::Shrink, height: Length::Shrink, max_width: f32::INFINITY, max_height: f32::INFINITY, horizontal_alignment: alignment::Horizontal::Left, vertical_alignment: alignment::Vertical::Top, style: Default::default(), content: content.into(), } } /// Sets the [`Id`] of the [`Container`]. pub fn id(mut self, id: Id) -> Self { self.id = Some(id); self } /// Sets the [`Padding`] of the [`Container`]. pub fn padding>(mut self, padding: P) -> Self { self.padding = padding.into(); self } /// Sets the width of the [`Container`]. pub fn width(mut self, width: impl Into) -> Self { self.width = width.into(); self } /// Sets the height of the [`Container`]. pub fn height(mut self, height: impl Into) -> Self { self.height = height.into(); self } /// Sets the maximum width of the [`Container`]. pub fn max_width(mut self, max_width: impl Into) -> Self { self.max_width = max_width.into().0; self } /// Sets the maximum height of the [`Container`]. pub fn max_height(mut self, max_height: impl Into) -> Self { self.max_height = max_height.into().0; self } /// Sets the content alignment for the horizontal axis of the [`Container`]. pub fn align_x(mut self, alignment: alignment::Horizontal) -> Self { self.horizontal_alignment = alignment; self } /// Sets the content alignment for the vertical axis of the [`Container`]. pub fn align_y(mut self, alignment: alignment::Vertical) -> Self { self.vertical_alignment = alignment; self } /// Centers the contents in the horizontal axis of the [`Container`]. pub fn center_x(mut self) -> Self { self.horizontal_alignment = alignment::Horizontal::Center; self } /// Centers the contents in the vertical axis of the [`Container`]. pub fn center_y(mut self) -> Self { self.vertical_alignment = alignment::Vertical::Center; self } /// Sets the style of the [`Container`]. pub fn style( mut self, style: impl Into<::Style>, ) -> Self { self.style = style.into(); self } } impl<'a, Message, Renderer> Widget for Container<'a, Message, Renderer> where Renderer: crate::core::Renderer, Renderer::Theme: StyleSheet, { fn tag(&self) -> tree::Tag { self.content.as_widget().tag() } fn state(&self) -> tree::State { self.content.as_widget().state() } fn children(&self) -> Vec { self.content.as_widget().children() } fn diff(&self, tree: &mut Tree) { self.content.as_widget().diff(tree); } fn width(&self) -> Length { self.width } fn height(&self) -> Length { self.height } fn layout( &self, tree: &mut Tree, renderer: &Renderer, limits: &layout::Limits, ) -> layout::Node { layout( limits, self.width, self.height, self.max_width, self.max_height, self.padding, self.horizontal_alignment, self.vertical_alignment, |limits| self.content.as_widget().layout(tree, renderer, limits), ) } fn operate( &self, tree: &mut Tree, layout: Layout<'_>, renderer: &Renderer, operation: &mut dyn Operation, ) { operation.container( self.id.as_ref().map(|id| &id.0), layout.bounds(), &mut |operation| { self.content.as_widget().operate( tree, layout.children().next().unwrap(), 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.content.as_widget_mut().on_event( tree, event, layout.children().next().unwrap(), cursor, renderer, clipboard, shell, viewport, ) } fn mouse_interaction( &self, tree: &Tree, layout: Layout<'_>, cursor: mouse::Cursor, viewport: &Rectangle, renderer: &Renderer, ) -> mouse::Interaction { self.content.as_widget().mouse_interaction( tree, layout.children().next().unwrap(), cursor, viewport, renderer, ) } fn draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Renderer::Theme, renderer_style: &renderer::Style, layout: Layout<'_>, cursor: mouse::Cursor, viewport: &Rectangle, ) { let style = theme.appearance(&self.style); draw_background(renderer, &style, layout.bounds()); self.content.as_widget().draw( tree, renderer, theme, &renderer::Style { text_color: style .text_color .unwrap_or(renderer_style.text_color), }, layout.children().next().unwrap(), cursor, viewport, ); } fn overlay<'b>( &'b mut self, tree: &'b mut Tree, layout: Layout<'_>, renderer: &Renderer, ) -> Option> { self.content.as_widget_mut().overlay( tree, layout.children().next().unwrap(), renderer, ) } } impl<'a, Message, Renderer> From> for Element<'a, Message, Renderer> where Message: 'a, Renderer: 'a + crate::core::Renderer, Renderer::Theme: StyleSheet, { fn from( column: Container<'a, Message, Renderer>, ) -> Element<'a, Message, Renderer> { Element::new(column) } } /// Computes the layout of a [`Container`]. pub fn layout( limits: &layout::Limits, width: Length, height: Length, max_width: f32, max_height: f32, padding: Padding, horizontal_alignment: alignment::Horizontal, vertical_alignment: alignment::Vertical, layout_content: impl FnOnce(&layout::Limits) -> layout::Node, ) -> layout::Node { let limits = limits .loose() .max_width(max_width) .max_height(max_height) .width(width) .height(height); let mut content = layout_content(&limits.pad(padding).loose()); let padding = padding.fit(content.size(), limits.max()); let size = limits.pad(padding).resolve(content.size()); content.move_to(Point::new(padding.left, padding.top)); content.align( Alignment::from(horizontal_alignment), Alignment::from(vertical_alignment), size, ); layout::Node::with_children(size.pad(padding), vec![content]) } /// Draws the background of a [`Container`] given its [`Appearance`] and its `bounds`. pub fn draw_background( renderer: &mut Renderer, appearance: &Appearance, bounds: Rectangle, ) where Renderer: crate::core::Renderer, { if appearance.background.is_some() || appearance.border_width > 0.0 { renderer.fill_quad( renderer::Quad { bounds, border_radius: appearance.border_radius, border_width: appearance.border_width, border_color: appearance.border_color, }, appearance .background .unwrap_or(Background::Color(Color::TRANSPARENT)), ); } } /// The identifier of a [`Container`]. #[derive(Debug, Clone, PartialEq, Eq, Hash)] pub struct Id(widget::Id); impl Id { /// Creates a custom [`Id`]. pub fn new(id: impl Into>) -> Self { Self(widget::Id::new(id)) } /// Creates a unique [`Id`]. /// /// This function produces a different [`Id`] every time it is called. pub fn unique() -> Self { Self(widget::Id::unique()) } } impl From for widget::Id { fn from(id: Id) -> Self { id.0 } } /// Produces a [`Command`] that queries the visible screen bounds of the /// [`Container`] with the given [`Id`]. pub fn visible_bounds(id: Id) -> Command> { struct VisibleBounds { target: widget::Id, depth: usize, scrollables: Vec<(Vector, Rectangle, usize)>, bounds: Option, } impl Operation> for VisibleBounds { fn scrollable( &mut self, _state: &mut dyn widget::operation::Scrollable, _id: Option<&widget::Id>, bounds: Rectangle, translation: Vector, ) { match self.scrollables.last() { Some((last_translation, last_viewport, _depth)) => { let viewport = last_viewport .intersection(&(bounds - *last_translation)) .unwrap_or(Rectangle::new(Point::ORIGIN, Size::ZERO)); self.scrollables.push(( translation + *last_translation, viewport, self.depth, )); } None => { self.scrollables.push((translation, bounds, self.depth)); } } } fn container( &mut self, id: Option<&widget::Id>, bounds: Rectangle, operate_on_children: &mut dyn FnMut( &mut dyn Operation>, ), ) { if self.bounds.is_some() { return; } if id == Some(&self.target) { match self.scrollables.last() { Some((translation, viewport, _)) => { self.bounds = viewport.intersection(&(bounds - *translation)); } None => { self.bounds = Some(bounds); } } return; } self.depth += 1; operate_on_children(self); self.depth -= 1; match self.scrollables.last() { Some((_, _, depth)) if self.depth == *depth => { let _ = self.scrollables.pop(); } _ => {} } } fn finish(&self) -> widget::operation::Outcome> { widget::operation::Outcome::Some(self.bounds) } } Command::widget(VisibleBounds { target: id.into(), depth: 0, scrollables: Vec::new(), bounds: None, }) }