feat: add Ellipsize to widgets

Author: hojjatabdollahi

core/src/text.rs

@@ -44,6 +44,9 @@ pub struct Text<Content = String, Font = crate::Font> {
 
     /// The [`Wrapping`] strategy of the [`Text`].
     pub wrapping: Wrapping,
+
+    /// The  [`Ellipsize`] strategy of the [`Text`].
+    pub ellipsize: Ellipsize,
 }
 
 /// The shaping strategy of some text.
@@ -86,6 +89,31 @@ pub enum Wrapping {
     WordOrGlyph,
 }
 
+/// The ellipsizing strategy of some text.
+#[derive(Debug, Clone, Copy, PartialEq, Default)]
+pub enum Ellipsize {
+    /// No ellipsizing.
+    ///
+    /// This is the default.
+    #[default]
+    None,
+    /// Ellipsize at the start of the text.
+    Start(EllipsizeHeightLimit),
+    /// Ellipsize in the middle of the text.
+    Middle(EllipsizeHeightLimit),
+    /// Ellipsize at the end of the text.
+    End(EllipsizeHeightLimit),
+}
+
+/// The ellipsizing strategy of some text when it exceeds a certain height.
+#[derive(Debug, Clone, Copy, PartialEq)]
+pub enum EllipsizeHeightLimit {
+    /// The number of lines after which ellipsizing should occur.
+    Lines(usize),
+    /// The height limit in pixels
+    Height(f32),
+}
+
 /// The height of a line of text in a paragraph.
 #[derive(Debug, Clone, Copy, PartialEq)]
 pub enum LineHeight {

core/src/text/paragraph.rs

@@ -96,6 +96,7 @@ impl<P: Paragraph> Plain<P> {
             vertical_alignment: text.vertical_alignment,
             shaping: text.shaping,
             wrapping: text.wrapping,
+            ellipsize: text.ellipsize,
         }) {
             Difference::None => {}
             Difference::Bounds => {

core/src/widget/text.rs

@@ -32,7 +32,7 @@ use crate::{
     Widget,
 };
 
-pub use text::{LineHeight, Shaping, Wrapping};
+pub use text::{Ellipsize, LineHeight, Shaping, Wrapping};
 
 /// A bunch of text.
 ///
@@ -73,6 +73,7 @@ where
     font: Option<Renderer::Font>,
     shaping: Shaping,
     wrapping: Wrapping,
+    ellipsize: Ellipsize,
     class: Theme::Class<'a>,
 }
 
@@ -95,6 +96,7 @@ where
             vertical_alignment: alignment::Vertical::Top,
             shaping: Shaping::default(),
             wrapping: Wrapping::default(),
+            ellipsize: Ellipsize::default(),
             class: Theme::default(),
         }
     }
@@ -167,6 +169,12 @@ where
         self
     }
 
+    // Sets the [`Ellipsize`] strategy of the [`Text`].
+    pub fn ellipsize(mut self, ellipsize: Ellipsize) -> Self {
+        self.ellipsize = ellipsize;
+        self
+    }
+
     /// Sets the style of the [`Text`].
     #[must_use]
     pub fn style(mut self, style: impl Fn(&Theme) -> Style + 'a) -> Self
@@ -251,6 +259,7 @@ where
             self.vertical_alignment,
             self.shaping,
             self.wrapping,
+            self.ellipsize,
         )
     }
 
@@ -330,6 +339,7 @@ pub fn layout<Renderer>(
     vertical_alignment: alignment::Vertical,
     shaping: Shaping,
     wrapping: Wrapping,
+    ellipsize: Ellipsize,
 ) -> layout::Node
 where
     Renderer: text::Renderer,
@@ -352,6 +362,7 @@ where
             vertical_alignment,
             shaping,
             wrapping,
+            ellipsize,
         });
 
         paragraph.min_bounds()

graphics/src/text.rs

@@ -323,6 +323,37 @@ pub fn to_wrap(wrapping: Wrapping) -> cosmic_text::Wrap {
     }
 }
 
+/// Converts some [`Ellipsize`] strategy to a [`cosmic_text::Ellipsize`] strategy.
+pub fn to_ellipsize(
+    ellipsize: crate::core::text::Ellipsize,
+) -> cosmic_text::Ellipsize {
+    match ellipsize {
+        crate::core::text::Ellipsize::None => cosmic_text::Ellipsize::None,
+        crate::core::text::Ellipsize::Start(limit) => {
+            cosmic_text::Ellipsize::Start(to_ellipsize_height_limit(limit))
+        }
+        crate::core::text::Ellipsize::Middle(limit) => {
+            cosmic_text::Ellipsize::Middle(to_ellipsize_height_limit(limit))
+        }
+        crate::core::text::Ellipsize::End(limit) => {
+            cosmic_text::Ellipsize::End(to_ellipsize_height_limit(limit))
+        }
+    }
+}
+
+pub fn to_ellipsize_height_limit(
+    limit: crate::core::text::EllipsizeHeightLimit,
+) -> cosmic_text::EllipsizeHeightLimit {
+    match limit {
+        crate::core::text::EllipsizeHeightLimit::Lines(lines) => {
+            cosmic_text::EllipsizeHeightLimit::Lines(lines)
+        }
+        crate::core::text::EllipsizeHeightLimit::Height(height) => {
+            cosmic_text::EllipsizeHeightLimit::Height(height)
+        }
+    }
+}
+
 /// Converts some [`Color`] to a [`cosmic_text::Color`].
 pub fn to_color(color: Color) -> cosmic_text::Color {
     let [r, g, b, a] = color.into_rgba8();

graphics/src/text/paragraph.rs

@@ -81,6 +81,10 @@ impl core::text::Paragraph for Paragraph {
         );
 
         buffer.set_wrap(font_system.raw(), text::to_wrap(text.wrapping));
+        buffer.set_ellipsize(
+            font_system.raw(),
+            text::to_ellipsize(text.ellipsize),
+        );
 
         buffer.set_text(
             font_system.raw(),

wgpu/src/lib.rs

@@ -410,6 +410,7 @@ impl Renderer {
                         vertical_alignment: alignment::Vertical::Top,
                         shaping: core::text::Shaping::Advanced,
                         wrapping: core::text::Wrapping::Word,
+                        ellipsize: core::text::Ellipsize::None,
                     };
 
                     renderer.fill_text(

widget/src/checkbox.rs

@@ -108,6 +108,7 @@ pub struct Checkbox<
     text_line_height: text::LineHeight,
     text_shaping: text::Shaping,
     text_wrapping: text::Wrapping,
+    text_ellipsize: text::Ellipsize,
     font: Option<Renderer::Font>,
     icon: Icon<Renderer::Font>,
     class: Theme::Class<'a>,
@@ -147,6 +148,7 @@ where
             text_line_height: text::LineHeight::default(),
             text_shaping: text::Shaping::default(),
             text_wrapping: text::Wrapping::default(),
+            text_ellipsize: text::Ellipsize::default(),
             font: None,
             icon: Icon {
                 font: Renderer::ICON_FONT,
@@ -340,6 +342,7 @@ where
                     alignment::Vertical::Top,
                     self.text_shaping,
                     self.text_wrapping,
+                    self.text_ellipsize,
                 )
             },
         )
@@ -450,6 +453,7 @@ where
                         vertical_alignment: alignment::Vertical::Center,
                         shaping: *shaping,
                         wrapping: text::Wrapping::default(),
+                        ellipsize: text::Ellipsize::default(),
                     },
                     bounds.center(),
                     style.icon_color,

widget/src/overlay/menu.rs

@@ -544,6 +544,7 @@ where
                     vertical_alignment: alignment::Vertical::Center,
                     shaping: self.text_shaping,
                     wrapping: text::Wrapping::default(),
+                    ellipsize: text::Ellipsize::default(),
                 },
                 Point::new(bounds.x + self.padding.left, bounds.center_y()),
                 if is_selected {

widget/src/pick_list.rs

@@ -172,6 +172,7 @@ pub struct PickList<
     text_line_height: text::LineHeight,
     text_shaping: text::Shaping,
     text_wrap: text::Wrapping,
+    text_ellipsize: text::Ellipsize,
     font: Option<Renderer::Font>,
     handle: Handle<Renderer::Font>,
     class: <Theme as Catalog>::Class<'a>,
@@ -208,6 +209,7 @@ where
             text_line_height: text::LineHeight::default(),
             text_shaping: text::Shaping::Advanced,
             text_wrap: text::Wrapping::default(),
+            text_ellipsize: text::Ellipsize::default(),
             font: None,
             handle: Handle::default(),
             class: <Theme as Catalog>::default(),
@@ -383,6 +385,7 @@ where
             vertical_alignment: alignment::Vertical::Center,
             shaping: self.text_shaping,
             wrapping: self.text_wrap,
+            ellipsize: self.text_ellipsize,
         };
 
         for (option, paragraph) in options.iter().zip(state.options.iter_mut())
@@ -603,6 +606,7 @@ where
                 text::LineHeight::default(),
                 text::Shaping::Basic,
                 text::Wrapping::default(),
+                text::Ellipsize::default(),
             )),
             Handle::Static(Icon {
                 font,
@@ -611,9 +615,16 @@ where
                 line_height,
                 shaping,
                 wrap,
-            }) => {
-                Some((*font, *code_point, *size, *line_height, *shaping, *wrap))
-            }
+                ellipsize,
+            }) => Some((
+                *font,
+                *code_point,
+                *size,
+                *line_height,
+                *shaping,
+                *wrap,
+                *ellipsize,
+            )),
             Handle::Dynamic { open, closed } => {
                 if state.is_open {
                     Some((
@@ -623,6 +634,7 @@ where
                         open.line_height,
                         open.shaping,
                         open.wrap,
+                        open.ellipsize,
                     ))
                 } else {
                     Some((
@@ -632,14 +644,22 @@ where
                         closed.line_height,
                         closed.shaping,
                         closed.wrap,
+                        closed.ellipsize,
                     ))
                 }
             }
             Handle::None => None,
         };
 
-        if let Some((font, code_point, size, line_height, shaping, wrap)) =
-            handle
+        if let Some((
+            font,
+            code_point,
+            size,
+            line_height,
+            shaping,
+            wrap,
+            ellipsize,
+        )) = handle
         {
             let size = size.unwrap_or_else(|| renderer.default_size());
 
@@ -657,6 +677,7 @@ where
                     vertical_alignment: alignment::Vertical::Center,
                     shaping,
                     wrapping: wrap,
+                    ellipsize: ellipsize,
                 },
                 Point::new(
                     bounds.x + bounds.width - self.padding.right,
@@ -687,6 +708,7 @@ where
                     vertical_alignment: alignment::Vertical::Center,
                     shaping: self.text_shaping,
                     wrapping: self.text_wrap,
+                    ellipsize: self.text_ellipsize,
                 },
                 Point::new(bounds.x + self.padding.left, bounds.center_y()),
                 if is_selected {
@@ -834,6 +856,8 @@ pub struct Icon<Font> {
     pub shaping: text::Shaping,
     /// The wrap mode of the icon.
     pub wrap: text::Wrapping,
+    /// The ellipsize mode of the icon.
+    pub ellipsize: text::Ellipsize,
 }
 
 /// The possible status of a [`PickList`].

widget/src/radio.rs

@@ -145,6 +145,7 @@ where
     text_line_height: text::LineHeight,
     text_shaping: text::Shaping,
     text_wrapping: text::Wrapping,
+    text_ellipsize: text::Ellipsize,
     font: Option<Renderer::Font>,
     class: Theme::Class<'a>,
 }
@@ -190,6 +191,7 @@ where
             text_line_height: text::LineHeight::default(),
             text_shaping: text::Shaping::Advanced,
             text_wrapping: text::Wrapping::default(),
+            text_ellipsize: text::Ellipsize::default(),
             font: None,
             class: Theme::default(),
         }
@@ -240,6 +242,12 @@ where
         self
     }
 
+    /// Sets the [`text::Ellipsize`] strategy of the [`Radio`] button.
+    pub fn text_ellipsize(mut self, ellipsize: text::Ellipsize) -> Self {
+        self.text_ellipsize = ellipsize;
+        self
+    }
+
     /// Sets the text font of the [`Radio`] button.
     pub fn font(mut self, font: impl Into<Renderer::Font>) -> Self {
         self.font = Some(font.into());
@@ -316,6 +324,7 @@ where
                     alignment::Vertical::Top,
                     self.text_shaping,
                     self.text_wrapping,
+                    self.text_ellipsize,
                 )
             },
         )