//! Text widgets display information through writing. //! //! # Example //! ```no_run //! # mod iced { pub mod widget { pub fn text(t: T) -> iced_core::widget::Text<'static, iced_core::Theme, ()> { unimplemented!() } } //! # pub use iced_core::color; } //! # pub type State = (); //! # pub type Element<'a, Message> = iced_core::Element<'a, Message, iced_core::Theme, ()>; //! use iced::widget::text; //! use iced::color; //! //! enum Message { //! // ... //! } //! //! fn view(state: &State) -> Element<'_, Message> { //! text("Hello, this is iced!") //! .size(20) //! .color(color!(0x0000ff)) //! .into() //! } //! ``` use crate::alignment; use crate::layout; use crate::mouse; use crate::renderer; use crate::text; use crate::text::paragraph::{self, Paragraph}; use crate::widget::tree::{self, Tree}; use crate::{ Color, Element, Layout, Length, Pixels, Point, Rectangle, Size, Theme, Widget, }; pub use text::{LineHeight, Shaping, Wrapping}; /// A bunch of text. /// /// # Example /// ```no_run /// # mod iced { pub mod widget { pub fn text(t: T) -> iced_core::widget::Text<'static, iced_core::Theme, ()> { unimplemented!() } } /// # pub use iced_core::color; } /// # pub type State = (); /// # pub type Element<'a, Message> = iced_core::Element<'a, Message, iced_core::Theme, ()>; /// use iced::widget::text; /// use iced::color; /// /// enum Message { /// // ... /// } /// /// fn view(state: &State) -> Element<'_, Message> { /// text("Hello, this is iced!") /// .size(20) /// .color(color!(0x0000ff)) /// .into() /// } /// ``` #[allow(missing_debug_implementations)] pub struct Text<'a, Theme, Renderer> where Theme: Catalog, Renderer: text::Renderer, { fragment: text::Fragment<'a>, size: Option, line_height: LineHeight, width: Length, height: Length, horizontal_alignment: alignment::Horizontal, vertical_alignment: alignment::Vertical, font: Option, shaping: Shaping, wrapping: Wrapping, class: Theme::Class<'a>, } impl<'a, Theme, Renderer> Text<'a, Theme, Renderer> where Theme: Catalog, Renderer: text::Renderer, { /// Create a new fragment of [`Text`] with the given contents. pub fn new(fragment: impl text::IntoFragment<'a>) -> Self { Text { fragment: fragment.into_fragment(), 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::default(), wrapping: Wrapping::default(), class: Theme::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 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 } /// Centers the [`Text`], both horizontally and vertically. pub fn center(self) -> Self { self.align_x(alignment::Horizontal::Center) .align_y(alignment::Vertical::Center) } /// Sets the [`alignment::Horizontal`] of the [`Text`]. pub fn align_x( mut self, alignment: impl Into, ) -> Self { self.horizontal_alignment = alignment.into(); self } /// Sets the [`alignment::Vertical`] of the [`Text`]. pub fn align_y( mut self, alignment: impl Into, ) -> Self { self.vertical_alignment = alignment.into(); self } /// Sets the [`Shaping`] strategy of the [`Text`]. pub fn shaping(mut self, shaping: Shaping) -> Self { self.shaping = shaping; self } /// Sets the [`Wrapping`] strategy of the [`Text`]. pub fn wrapping(mut self, wrapping: Wrapping) -> Self { self.wrapping = wrapping; self } /// Sets the style of the [`Text`]. #[must_use] pub fn style(mut self, style: impl Fn(&Theme) -> Style + 'a) -> Self where Theme::Class<'a>: From>, { self.class = (Box::new(style) as StyleFn<'a, Theme>).into(); self } /// Sets the [`Color`] of the [`Text`]. pub fn color(self, color: impl Into) -> Self where Theme::Class<'a>: From>, { self.color_maybe(Some(color)) } /// Sets the [`Color`] of the [`Text`], if `Some`. pub fn color_maybe(self, color: Option>) -> Self where Theme::Class<'a>: From>, { let color = color.map(Into::into); self.style(move |_theme| Style { color }) } /// Sets the style class of the [`Text`]. #[cfg(feature = "advanced")] #[must_use] pub fn class(mut self, class: impl Into>) -> Self { self.class = class.into(); self } } /// The internal state of a [`Text`] widget. #[derive(Debug, Default)] pub struct State(pub paragraph::Plain

); impl Widget for Text<'_, Theme, Renderer> where Theme: Catalog, Renderer: text::Renderer, { fn tag(&self) -> tree::Tag { tree::Tag::of::>() } fn state(&self) -> tree::State { tree::State::new(State::( paragraph::Plain::default(), )) } fn size(&self) -> Size { Size { width: self.width, height: 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.fragment, self.line_height, self.size, self.font, self.horizontal_alignment, self.vertical_alignment, self.shaping, self.wrapping, ) } fn draw( &self, tree: &Tree, renderer: &mut Renderer, theme: &Theme, defaults: &renderer::Style, layout: Layout<'_>, _cursor_position: mouse::Cursor, viewport: &Rectangle, ) { let state = tree.state.downcast_ref::>(); let style = theme.style(&self.class); draw(renderer, defaults, layout, state.0.raw(), style, viewport); } fn operate( &self, _state: &mut Tree, layout: Layout<'_>, _renderer: &Renderer, operation: &mut dyn super::Operation, ) { operation.text(None, layout.bounds(), &self.fragment); } } /// 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, wrapping: Wrapping, ) -> layout::Node where Renderer: text::Renderer, { layout::sized(limits, width, height, |limits| { let bounds = limits.max(); let size = size.unwrap_or_else(|| renderer.default_size()); let font = font.unwrap_or_else(|| renderer.default_font()); let State(paragraph) = state; paragraph.update(text::Text { content, bounds, size, line_height, font, horizontal_alignment, vertical_alignment, shaping, wrapping, }); paragraph.min_bounds() }) } /// 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<'_>, paragraph: &Renderer::Paragraph, appearance: Style, viewport: &Rectangle, ) where Renderer: text::Renderer, { 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), *viewport, ); } impl<'a, Message, Theme, Renderer> From> for Element<'a, Message, Theme, Renderer> where Theme: Catalog + 'a, Renderer: text::Renderer + 'a, { fn from( text: Text<'a, Theme, Renderer>, ) -> Element<'a, Message, Theme, Renderer> { Element::new(text) } } impl<'a, Theme, Renderer> From<&'a str> for Text<'a, Theme, Renderer> where Theme: Catalog + 'a, Renderer: text::Renderer, { fn from(content: &'a str) -> Self { Self::new(content) } } impl<'a, Message, Theme, Renderer> From<&'a str> for Element<'a, Message, Theme, Renderer> where Theme: Catalog + 'a, Renderer: text::Renderer + 'a, { fn from(content: &'a str) -> Self { Text::from(content).into() } } /// The appearance of some text. #[derive(Debug, Clone, Copy, PartialEq, Default)] pub struct Style { /// The [`Color`] of the text. /// /// The default, `None`, means using the inherited color. pub color: Option, } /// The theme catalog of a [`Text`]. pub trait Catalog: Sized { /// The item class of this [`Catalog`]. type Class<'a>; /// The default class produced by this [`Catalog`]. fn default<'a>() -> Self::Class<'a>; /// The [`Style`] of a class with the given status. fn style(&self, item: &Self::Class<'_>) -> Style; } /// A styling function for a [`Text`]. /// /// This is just a boxed closure: `Fn(&Theme, Status) -> Style`. pub type StyleFn<'a, Theme> = Box Style + 'a>; impl Catalog for Theme { type Class<'a> = StyleFn<'a, Self>; fn default<'a>() -> Self::Class<'a> { Box::new(|_theme| Style::default()) } fn style(&self, class: &Self::Class<'_>) -> Style { class(self) } } /// The default text styling; color is inherited. pub fn default(_theme: &Theme) -> Style { Style { color: None } } /// Text with the default base color. pub fn base(theme: &Theme) -> Style { Style { color: Some(theme.palette().text), } } /// Text conveying some important information, like an action. pub fn primary(theme: &Theme) -> Style { Style { color: Some(theme.palette().primary), } } /// Text conveying some secondary information, like a footnote. pub fn secondary(theme: &Theme) -> Style { Style { color: Some(theme.extended_palette().secondary.strong.color), } } /// Text conveying some positive information, like a successful event. pub fn success(theme: &Theme) -> Style { Style { color: Some(theme.palette().success), } } /// Text conveying some negative information, like an error. pub fn danger(theme: &Theme) -> Style { Style { color: Some(theme.palette().danger), } }