[epaint] Add more text wrapping options (#1291)

egui/src/widget_text.rs

@@ -563,14 +563,14 @@ impl WidgetText {
             Self::RichText(text) => {
                 let valign = ui.layout().vertical_align();
                 let mut text_job = text.into_text_job(ui.style(), fallback_font.into(), valign);
-                text_job.job.wrap_width = wrap_width;
+                text_job.job.wrap.max_width = wrap_width;
                 WidgetTextGalley {
                     galley: ui.fonts().layout_job(text_job.job),
                     galley_has_color: text_job.job_has_color,
                 }
             }
             Self::LayoutJob(mut job) => {
-                job.wrap_width = wrap_width;
+                job.wrap.max_width = wrap_width;
                 WidgetTextGalley {
                     galley: ui.fonts().layout_job(job),
                     galley_has_color: true,

egui/src/widgets/label.rs

@@ -103,7 +103,7 @@ impl Label {
             let first_row_indentation = available_width - ui.available_size_before_wrap().x;
             egui_assert!(first_row_indentation.is_finite());
 
-            text_job.job.wrap_width = available_width;
+            text_job.job.wrap.max_width = available_width;
             text_job.job.first_row_min_height = cursor.height();
             text_job.job.halign = Align::Min;
             text_job.job.justify = false;
@@ -129,9 +129,9 @@ impl Label {
             (pos, text_galley, response)
         } else {
             if should_wrap {
-                text_job.job.wrap_width = available_width;
+                text_job.job.wrap.max_width = available_width;
             } else {
-                text_job.job.wrap_width = f32::INFINITY;
+                text_job.job.wrap.max_width = f32::INFINITY;
             };
 
             if ui.is_grid() {

egui/src/widgets/text_edit/builder.rs

@@ -182,7 +182,7 @@ impl<'t> TextEdit<'t> {
     /// # fn my_memoized_highlighter(s: &str) -> egui::text::LayoutJob { Default::default() }
     /// let mut layouter = |ui: &egui::Ui, string: &str, wrap_width: f32| {
     ///     let mut layout_job: egui::text::LayoutJob = my_memoized_highlighter(string);
-    ///     layout_job.wrap_width = wrap_width;
+    ///     layout_job.wrap.max_width = wrap_width;
     ///     ui.fonts().layout_job(layout_job)
     /// };
     /// ui.add(egui::TextEdit::multiline(&mut my_code).layouter(&mut layouter));

egui_demo_lib/src/apps/demo/code_editor.rs

@@ -78,7 +78,7 @@ impl super::View for CodeEditor {
         let mut layouter = |ui: &egui::Ui, string: &str, wrap_width: f32| {
             let mut layout_job =
                 crate::syntax_highlighting::highlight(ui.ctx(), &theme, string, language);
-            layout_job.wrap_width = wrap_width;
+            layout_job.wrap.max_width = wrap_width;
             ui.fonts().layout_job(layout_job)
         };
 

egui_demo_lib/src/apps/demo/misc_demo_window.rs

@@ -1,12 +1,17 @@
 use super::*;
-use egui::{color::*, *};
+use crate::LOREM_IPSUM;
+use egui::{color::*, epaint::text::TextWrapping, *};
 
 /// Showcase some ui code
 #[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
 #[cfg_attr(feature = "serde", serde(default))]
 pub struct MiscDemoWindow {
     num_columns: usize,
 
+    break_anywhere: bool,
+    max_rows: usize,
+    overflow_character: Option<char>,
+
     widgets: Widgets,
     colors: ColorWidgets,
     tree: Tree,
@@ -18,6 +23,10 @@ impl Default for MiscDemoWindow {
         MiscDemoWindow {
             num_columns: 2,
 
+            max_rows: 2,
+            break_anywhere: false,
+            overflow_character: Some('…'),
+
             widgets: Default::default(),
             colors: Default::default(),
             tree: Tree::demo(),
@@ -53,7 +62,12 @@ impl View for MiscDemoWindow {
         CollapsingHeader::new("Text layout")
             .default_open(false)
             .show(ui, |ui| {
-                text_layout_ui(ui);
+                text_layout_ui(
+                    ui,
+                    &mut self.max_rows,
+                    &mut self.break_anywhere,
+                    &mut self.overflow_character,
+                );
             });
 
         CollapsingHeader::new("Colors")
@@ -401,7 +415,12 @@ impl SubTree {
 
 // ----------------------------------------------------------------------------
 
-fn text_layout_ui(ui: &mut egui::Ui) {
+fn text_layout_ui(
+    ui: &mut egui::Ui,
+    max_rows: &mut usize,
+    break_anywhere: &mut bool,
+    overflow_character: &mut Option<char>,
+) {
     use egui::text::LayoutJob;
 
     let mut job = LayoutJob::default();
@@ -556,6 +575,30 @@ fn text_layout_ui(ui: &mut egui::Ui) {
 
     ui.label(job);
 
+    ui.separator();
+
+    ui.horizontal(|ui| {
+        ui.add(DragValue::new(max_rows));
+        ui.label("Max rows");
+    });
+    ui.checkbox(break_anywhere, "Break anywhere");
+    ui.horizontal(|ui| {
+        ui.selectable_value(overflow_character, None, "None");
+        ui.selectable_value(overflow_character, Some('…'), "…");
+        ui.selectable_value(overflow_character, Some('—'), "—");
+        ui.selectable_value(overflow_character, Some('-'), "  -  ");
+        ui.label("Overflow character");
+    });
+
+    let mut job = LayoutJob::single_section(LOREM_IPSUM.to_string(), TextFormat::default());
+    job.wrap = TextWrapping {
+        max_rows: *max_rows,
+        break_anywhere: *break_anywhere,
+        overflow_character: *overflow_character,
+        ..Default::default()
+    };
+    ui.label(job);
+
     ui.vertical_centered(|ui| {
         ui.add(crate::__egui_github_link_file_line!());
     });

egui_demo_lib/src/apps/http_app.rs

@@ -244,7 +244,7 @@ impl ColoredText {
             // Selectable text:
             let mut layouter = |ui: &egui::Ui, _string: &str, wrap_width: f32| {
                 let mut layout_job = self.0.clone();
-                layout_job.wrap_width = wrap_width;
+                layout_job.wrap.max_width = wrap_width;
                 ui.fonts().layout_job(layout_job)
             };
 
@@ -257,7 +257,7 @@ impl ColoredText {
             );
         } else {
             let mut job = self.0.clone();
-            job.wrap_width = ui.available_width();
+            job.wrap.max_width = ui.available_width();
             let galley = ui.fonts().layout_job(job);
             let (response, painter) = ui.allocate_painter(galley.size(), egui::Sense::hover());
             painter.add(egui::Shape::galley(response.rect.min, galley));

egui_demo_lib/src/easy_mark/easy_mark_editor.rs

@@ -85,7 +85,7 @@ impl EasyMarkEditor {
         let response = if self.highlight_editor {
             let mut layouter = |ui: &egui::Ui, easymark: &str, wrap_width: f32| {
                 let mut layout_job = highlighter.highlight(ui.style(), easymark);
-                layout_job.wrap_width = wrap_width;
+                layout_job.wrap.max_width = wrap_width;
                 ui.fonts().layout_job(layout_job)
             };
 

egui_demo_lib/src/syntax_highlighting.rs

@@ -7,7 +7,7 @@ pub fn code_view_ui(ui: &mut egui::Ui, mut code: &str) {
 
     let mut layouter = |ui: &egui::Ui, string: &str, _wrap_width: f32| {
         let layout_job = highlight(ui.ctx(), &theme, string, language);
-        // layout_job.wrap_width = wrap_width; // no wrapping
+        // layout_job.wrap.max_width = wrap_width; // no wrapping
         ui.fonts().layout_job(layout_job)
     };
 

epaint/CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to the epaint crate will be documented in this file.
 
 ## Unreleased
 * Add `Shape::Callback` for backend-specific painting ([#1351](https://github.com/emilk/egui/pull/1351)).
+* Added more text wrapping options ([#1291](https://github.com/emilk/egui/pull/1291)):
+  * Added `TextWrapping` struct containing all wrapping options.
+  * Added `LayoutJob::wrap` field containing these options.
+  * Moved `LayoutJob::wrap_width` to `TextWrapping::max_width`.
+  * Added `TextWrapping::max_rows` to limit amount of rows the text should have.
+  * Added `TextWrapping::break_anywhere` to control should the text break at appropriate places or not.
+  * Added `TextWrapping::overflow_character` to specify what character should be used to represent clipped text.
 * Removed the `single_threaded/multi_threaded` flags - epaint is now always thread-safe ([#1390](https://github.com/emilk/egui/pull/1390)).
 * `Tessellator::from_options` is now `Tessellator::new` ([#1408](https://github.com/emilk/egui/pull/1408)).
 * Renamed `TessellationOptions::anti_alias` to `feathering` ([#1408](https://github.com/emilk/egui/pull/1408)).