//! Write some text for your users to read. use crate::alignment; use crate::layout; use crate::mouse; use crate::renderer; use crate::text::{self, Paragraph}; use crate::widget::tree::{self, Tree}; use crate::{Color, Element, Layout, Length, Pixels, Point, Rectangle, Widget}; use std::borrow::Cow; pub use text::{LineHeight, Shaping}; /// A paragraph of text. #[allow(missing_debug_implementations)] pub struct Text<'a, Renderer> where Renderer: text::Renderer, Renderer::Theme: StyleSheet, { content: Cow<'a, str>, size: Option, line_height: LineHeight, width: Length, height: Length, horizontal_alignment: alignment::Horizontal, vertical_alignment: alignment::Vertical, font: Option, shaping: Shaping, style: ::Style, } impl<'a, Renderer> Text<'a, Renderer> where Renderer: text::Renderer, Renderer::Theme: StyleSheet, { /// Create a new fragment of [`Text`] with the given contents. pub fn new(content: impl Into>) -> Self { Text { content: content.into(), size: None, line_height: LineHeight::default(), font: None, width: Length::Shrink, height: Length::Shrink, horizontal_alignment: alignment::Horizontal::Left, vertical_alignment: alignment::Vertical::Top, shaping: Shaping::Basic, style: Default::default(), } } /// Sets the size of the [`Text`]. pub fn size(mut self, size: impl Into) -> Self { self.size = Some(size.into()); self } /// Sets the [`LineHeight`] of the [`Text`]. pub fn line_height(mut self, line_height: impl Into) -> Self { self.line_height = line_height.into(); self } /// Sets the [`Font`] of the [`Text`]. /// /// [`Font`]: crate::text::Renderer::Font pub fn font(mut self, font: impl Into) -> Self { self.font = Some(font.into()); self } /// Sets the style of the [`Text`]. pub fn style( mut self, style: impl Into<::Style>, ) -> Self { self.style = style.into(); self } /// Sets the width of the [`Text`] boundaries. pub fn width(mut self, width: impl Into) -> Self { self.width = width.into(); self } /// Sets the height of the [`Text`] boundaries. pub fn height(mut self, height: impl Into) -> Self { self.height = height.into(); self } /// Sets the [`alignment::Horizontal`] of the [`Text`]. pub fn horizontal_alignment( mut self, alignment: alignment::Horizontal, ) -> Self { self.horizontal_alignment = alignment; self } /// Sets the [`alignment::Vertical`] of the [`Text`]. pub fn vertical_alignment( mut self, alignment: alignment::Vertical, ) -> Self { self.vertical_alignment = alignment; self } /// Sets the [`Shaping`] strategy of the [`Text`]. pub fn shaping(mut self, shaping: Shaping) -> Self { self.shaping = shaping; self } } /// The internal state of a [`Text`] widget. #[derive(Debug, Default)] pub struct State(P); impl<'a, Message, Renderer> Widget for Text<'a, Renderer> where Renderer: text::Renderer, Renderer::Theme: StyleSheet, { fn tag(&self) -> tree::Tag { tree::Tag::of::>() } fn state(&self) -> tree::State { tree::State::new(State(Renderer::Paragraph::default())) } 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( tree.state.downcast_mut::>(), renderer, limits, self.width, self.height, &self.content, self.line_height, self.size, self.font, self.horizontal_alignment, self.vertical_alignment, self.shaping, ) } fn draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Renderer::Theme, style: &renderer::Style, layout: Layout<'_>, _cursor_position: mouse::Cursor, _viewport: &Rectangle, ) { let state = tree.state.downcast_ref::>(); draw( renderer, style, layout, state, theme.appearance(self.style.clone()), ); } } /// Produces the [`layout::Node`] of a [`Text`] widget. pub fn layout( state: &mut State, renderer: &Renderer, limits: &layout::Limits, width: Length, height: Length, content: &str, line_height: LineHeight, size: Option, font: Option, horizontal_alignment: alignment::Horizontal, vertical_alignment: alignment::Vertical, shaping: Shaping, ) -> layout::Node where Renderer: text::Renderer, { let limits = limits.width(width).height(height); let bounds = limits.max(); let size = size.unwrap_or_else(|| renderer.default_size()); let font = font.unwrap_or_else(|| renderer.default_font()); let State(ref mut paragraph) = state; paragraph.update(text::Text { content, bounds, size, line_height, font, horizontal_alignment, vertical_alignment, shaping, }); let size = limits.resolve(paragraph.min_bounds()); layout::Node::new(size) } /// Draws text using the same logic as the [`Text`] widget. /// /// Specifically: /// /// * If no `size` is provided, the default text size of the `Renderer` will be /// used. /// * If no `color` is provided, the [`renderer::Style::text_color`] will be /// used. /// * The alignment attributes do not affect the position of the bounds of the /// [`Layout`]. pub fn draw( renderer: &mut Renderer, style: &renderer::Style, layout: Layout<'_>, state: &State, appearance: Appearance, ) where Renderer: text::Renderer, { let State(ref paragraph) = state; let bounds = layout.bounds(); let x = match paragraph.horizontal_alignment() { alignment::Horizontal::Left => bounds.x, alignment::Horizontal::Center => bounds.center_x(), alignment::Horizontal::Right => bounds.x + bounds.width, }; let y = match paragraph.vertical_alignment() { alignment::Vertical::Top => bounds.y, alignment::Vertical::Center => bounds.center_y(), alignment::Vertical::Bottom => bounds.y + bounds.height, }; renderer.fill_paragraph( paragraph, Point::new(x, y), appearance.color.unwrap_or(style.text_color), ); } impl<'a, Message, Renderer> From> for Element<'a, Message, Renderer> where Renderer: text::Renderer + 'a, Renderer::Theme: StyleSheet, { fn from(text: Text<'a, Renderer>) -> Element<'a, Message, Renderer> { Element::new(text) } } impl<'a, Renderer> Clone for Text<'a, Renderer> where Renderer: text::Renderer, Renderer::Theme: StyleSheet, { fn clone(&self) -> Self { Self { content: self.content.clone(), size: self.size, line_height: self.line_height, width: self.width, height: self.height, horizontal_alignment: self.horizontal_alignment, vertical_alignment: self.vertical_alignment, font: self.font, style: self.style.clone(), shaping: self.shaping, } } } impl<'a, Renderer> From<&'a str> for Text<'a, Renderer> where Renderer: text::Renderer, Renderer::Theme: StyleSheet, { fn from(content: &'a str) -> Self { Self::new(content) } } impl<'a, Message, Renderer> From<&'a str> for Element<'a, Message, Renderer> where Renderer: text::Renderer + 'a, Renderer::Theme: StyleSheet, { fn from(content: &'a str) -> Self { Text::from(content).into() } } /// The style sheet of some text. pub trait StyleSheet { /// The supported style of the [`StyleSheet`]. type Style: Default + Clone; /// Produces the [`Appearance`] of some text. fn appearance(&self, style: Self::Style) -> Appearance; } /// The apperance of some text. #[derive(Debug, Clone, Copy, Default)] pub struct Appearance { /// The [`Color`] of the text. /// /// The default, `None`, means using the inherited color. pub color: Option, }