migrations/egui
1
0
Fork 0
mirror of https://github.com/emilk/egui.git synced 2026-09-01 14:20:04 -04:00
Code Activity

Add StyleProvider support for TextEdit, and classes for DragValue

Browse Source
This commit is contained in:
Lucas Meurer
2026-08-21 14:18:57 +02:00
parent bae0f65d81
commit 56df5335e4
4 changed files with 158 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
crates/egui/src/theme/default_style.rs
View File

@@ -1,13 +1,13 @@
use emath::Vec2;
use epaint::Margin;
use epaint::{Color32, Margin};
use crate::{
Button, Context, Frame, TextStyle,
Button, Context, Frame, TextEdit, TextStyle,
class::HasClasses as _,
theme::StyleProvider,
widget_style::{
AtomLayoutStyle, ButtonStyle, CheckboxStyle, SeparatorStyle, StyleArgs, TextVisuals,
WidgetState,
AtomLayoutStyle, ButtonStyle, CheckboxStyle, SeparatorStyle, StyleArgs, TextEditStyle,
TextVisuals, WidgetState,
},
};
@@ -25,6 +25,7 @@ impl DefaultStyle {
ctx.add_widget_theme::<ButtonStyle>(Self);
ctx.add_widget_theme::<SeparatorStyle>(Self);
ctx.add_widget_theme::<CheckboxStyle>(Self);
ctx.add_widget_theme::<TextEditStyle>(Self);
}
}
@@ -85,7 +86,7 @@ impl StyleProvider<ButtonStyle> for DefaultStyle {
let image_tint = if classes.has_class(&Button::CLASS_IMAGE_TINT_FOLLOWS_TEXT_COLOR) {
text_style.color
} else {
crate::Color32::WHITE
Color32::WHITE
};
ButtonStyle {
@@ -105,6 +106,65 @@ impl StyleProvider<ButtonStyle> for DefaultStyle {
}
}
impl StyleProvider<TextEditStyle> for DefaultStyle {
fn style(&mut self, modifiers: &StyleArgs<'_>) -> TextEditStyle {
let StyleArgs {
classes,
style,
state,
..
} = modifiers;
let widget_visuals = match state {
WidgetState::Noninteractive => style.visuals.widgets.noninteractive,
WidgetState::Inactive => style.visuals.widgets.inactive,
WidgetState::Hovered => style.visuals.widgets.hovered,
WidgetState::Active => style.visuals.widgets.active,
};
// A text edit over an immutable buffer is painted without a background.
let (fill, stroke) = if classes.has_class(&TextEdit::CLASS_READ_ONLY) {
let visuals = &style.visuals.widgets.inactive;
(Color32::TRANSPARENT, visuals.bg_stroke)
} else if *state == WidgetState::Active {
// While focused, the frame is outlined in the selection color.
(
style.visuals.text_edit_bg_color(),
style.visuals.selection.stroke,
)
} else {
(style.visuals.text_edit_bg_color(), widget_visuals.bg_stroke)
};
// The text of a text edit doesn't brighten on hover — that would be distracting while
// typing — so it keeps the inactive color no matter the state.
let text = TextVisuals::from_widget_visuals(
style,
TextStyle::Body,
&style.visuals.widgets.inactive,
);
TextEditStyle {
atom_layout: AtomLayoutStyle {
frame: Frame {
fill,
stroke,
corner_radius: widget_visuals.corner_radius,
// The stroke is painted centered on the frame edge, so half of it eats into
// the padding; compensate, like the other widgets do.
inner_margin: Margin::symmetric(4, 2)
+ Margin::same((widget_visuals.expansion - stroke.width).round() as i8),
outer_margin: Margin::same(-(widget_visuals.expansion as i8)),
..Default::default()
},
text_style: text,
..Default::default()
},
hint_text_color: style.visuals.weak_text_color(),
}
}
}
impl StyleProvider<CheckboxStyle> for DefaultStyle {
fn style(&mut self, modifiers: &StyleArgs<'_>) -> CheckboxStyle {
let StyleArgs { style, state, .. } = modifiers;

15
crates/egui/src/widget_style/mod.rs
View File

@@ -127,6 +127,21 @@ pub struct ButtonStyle {
impl WidgetStyle for ButtonStyle {}
/// Dedicated text edit style
#[derive(Debug, Clone)]
pub struct TextEditStyle {
/// Style of the field's atom layout.
///
/// [`AtomLayoutStyle::frame`] surrounds the text, including its padding, and
/// [`AtomLayoutStyle::text_style`] is the text being edited.
pub atom_layout: AtomLayoutStyle,
/// The color of the hint text shown while the buffer is empty.
pub hint_text_color: Color32,
}
impl WidgetStyle for TextEditStyle {}
/// Dedicated checkbox style
#[derive(Debug, Clone)]
pub struct CheckboxStyle {

16
crates/egui/src/widgets/drag_value.rs
View File

@@ -2,6 +2,7 @@ use crate::{
Atom, AtomExt as _, AtomKind, Atoms, Button, CursorIcon, Id, IntoAtoms, Key, MINUS_CHAR_STR,
Modifiers, NumExt as _, Response, RichText, Sense, TextEdit, TextWrapMode, Ui, Widget,
WidgetInfo, emath, text,
widget_style::{Classes, HasClasses},
};
use core::{cmp::Ordering, ops::RangeInclusive};
use emath::Vec2;
@@ -63,6 +64,7 @@ pub struct DragValue<'a> {
custom_formatter: Option<NumFormatter<'a>>,
custom_parser: Option<NumParser<'a>>,
update_while_editing: bool,
classes: Classes,
}
impl<'a> DragValue<'a> {
@@ -97,6 +99,7 @@ impl<'a> DragValue<'a> {
custom_formatter: None,
custom_parser: None,
update_while_editing: true,
classes: Classes::default(),
}
}
@@ -449,6 +452,7 @@ impl Widget for DragValue<'_> {
custom_formatter,
custom_parser,
update_while_editing,
classes,
} = self;
let mut prefix_text = String::new();
@@ -583,6 +587,7 @@ impl Widget for DragValue<'_> {
.map_or_else(|| value_text.clone(), |edit_state| edit_state.text);
let response = ui.add(
TextEdit::singleline(&mut value_text)
.with_classes(classes)
.clip_text(false)
.horizontal_align(ui.layout().horizontal_align())
.vertical_align(ui.layout().vertical_align())
@@ -634,6 +639,7 @@ impl Widget for DragValue<'_> {
}
});
let button = Button::new(atoms)
.with_classes(classes)
.wrap_mode(TextWrapMode::Extend)
.sense(Sense::click_and_drag())
.gap(0.0)
@@ -864,3 +870,13 @@ mod tests {
);
}
}
impl HasClasses for DragValue<'_> {
fn classes(&self) -> &Classes {
&self.classes
}
fn classes_mut(&mut self) -> &mut Classes {
&mut self.classes
}
}

124
crates/egui/src/widgets/text_edit/builder.rs
View File

@@ -17,6 +17,7 @@ use crate::{
self, CCursorRange, text_cursor_state::cursor_rect, visuals::paint_text_selection,
},
vec2,
widget_style::{AtomLayoutStyle, ClassName, Classes, HasClasses, TextEditStyle},
};
use super::{TextEditOutput, TextEditState};
@@ -79,7 +80,7 @@ pub struct TextEdit<'t> {
layouter: Option<LayouterFn<'t>>,
password: bool,
frame: Option<Frame>,
margin: Margin,
margin: Option<Margin>,
multiline: bool,
interactive: bool,
desired_width: Option<f32>,
@@ -92,6 +93,7 @@ pub struct TextEdit<'t> {
char_limit: usize,
return_key: Option<KeyboardShortcut>,
background_color: Option<Color32>,
classes: Classes,
}
impl WidgetWithState for TextEdit<'_> {
@@ -99,6 +101,9 @@ impl WidgetWithState for TextEdit<'_> {
}
impl TextEdit<'_> {
/// Present on a text edit whose buffer can't be edited.
pub const CLASS_READ_ONLY: ClassName = ClassName::from_static("egui::text_edit::read_only");
pub fn load_state(ctx: &Context, id: Id) -> Option<TextEditState> {
TextEditState::load(ctx, id)
}
@@ -133,7 +138,7 @@ impl<'t> TextEdit<'t> {
layouter: None,
password: false,
frame: None,
margin: Margin::symmetric(4, 2),
margin: None,
multiline: true,
interactive: true,
desired_width: None,
@@ -152,6 +157,7 @@ impl<'t> TextEdit<'t> {
char_limit: usize::MAX,
return_key: Some(KeyboardShortcut::new(Modifiers::NONE, Key::Enter)),
background_color: None,
classes: Classes::default(),
}
}
@@ -308,10 +314,10 @@ impl<'t> TextEdit<'t> {
self
}
/// Set margin of text. Default is `Margin::symmetric(4.0, 2.0)`
/// Override the padding around the text, which otherwise comes from the theme.
#[inline]
pub fn margin(mut self, margin: impl Into<Margin>) -> Self {
self.margin = margin.into();
self.margin = Some(margin.into());
self
}
@@ -417,6 +423,16 @@ impl Widget for TextEdit<'_> {
}
}
impl HasClasses for TextEdit<'_> {
fn classes(&self) -> &Classes {
&self.classes
}
fn classes_mut(&mut self) -> &mut Classes {
&mut self.classes
}
}
impl TextEdit<'_> {
/// Show the [`TextEdit`], returning a rich [`TextEditOutput`].
///
@@ -459,17 +475,42 @@ impl TextEdit<'_> {
char_limit,
return_key,
background_color,
mut classes,
} = self;
let id = id.unwrap_or_else(|| {
if let Some(id_salt) = id_salt {
ui.make_persistent_id(id_salt)
} else {
// Since we are only storing the cursor a persistent Id is not super important
let id = ui.next_auto_id();
ui.skip_ahead_auto_ids(1);
id
}
});
classes.add_class_if(Self::CLASS_READ_ONLY, !text.is_mutable());
let TextEditStyle {
atom_layout:
AtomLayoutStyle {
frame: styled_frame,
text_style: text_visuals,
..
},
hint_text_color,
} = ui.widget_style(id, &classes);
let text_color = text_color
.or_else(|| ui.visuals().override_text_color)
// .unwrap_or_else(|| ui.style().interact(&response).text_color()); // too bright
.unwrap_or_else(|| ui.visuals().widgets.inactive.text_color());
.unwrap_or(text_visuals.color);
let prev_text = text.as_str().to_owned();
let hint_text_str = hint_text.text().unwrap_or_default().to_string();
let font_id = font_selection.resolve(ui.style());
let font_id = match font_selection {
FontSelection::Default => text_visuals.font_id.clone(),
font_selection => font_selection.resolve(ui.style()),
};
let row_height = ui.fonts_mut(|f| f.row_height(&font_id));
let line_height = row_height + ui.spacing().extra_text_line_spacing;
@@ -504,17 +545,6 @@ impl TextEdit<'_> {
let min_inner_height = (desired_height_rows.at_least(1) as f32) * line_height;
let id = id.unwrap_or_else(|| {
if let Some(id_salt) = id_salt {
ui.make_persistent_id(id_salt)
} else {
// Since we are only storing the cursor a persistent Id is not super important
let id = ui.next_auto_id();
ui.skip_ahead_auto_ids(1);
id
}
});
// On touch screens (e.g. mobile in `eframe` web), should
// dragging select text, or scroll the enclosing [`ScrollArea`] (if any)?
// Since currently copying selected text in not supported on `eframe` web,
@@ -550,7 +580,6 @@ impl TextEdit<'_> {
}
let mut text_changed = false;
let text_mutable = text.is_mutable();
let mut handle_events = |ui: &Ui, galley: &mut Arc<Galley>, layouter, wrap_width, text| {
if interactive && ui.memory(|mem| mem.has_focus(id)) {
@@ -592,6 +621,17 @@ impl TextEdit<'_> {
// We need to calculate the galley within the atom closure, so we can calculate it based on
// the available width (in case of wrapping multiline text edits). But we show it later,
// so we can clip it to the available size. Thus, extract it from the atom closure here.
let frame = frame.unwrap_or_else(|| {
let mut frame = styled_frame;
if let Some(margin) = margin {
frame.inner_margin = margin;
}
if let Some(background_color) = background_color {
frame.fill = background_color;
}
frame
});
let mut get_galley = None;
let inner_rect_id = Id::new("text_edit_rect");
let mut response = {
@@ -613,7 +653,7 @@ impl TextEdit<'_> {
// Since we can't set a fallback color per atom, we have to override it here.
// Sucks, since it means users won't be able to override it.
hint_text.map_texts(|t| t.color(ui.style().visuals.weak_text_color()));
hint_text.map_texts(|t| t.color(hint_text_color));
for mut atom in hint_text {
if !shrunk && matches!(atom.kind, AtomKind::Text(_)) {
@@ -638,7 +678,7 @@ impl TextEdit<'_> {
// Calculate the empty galley, so it can be read later. The available width is
// technically wrong, but doesn't matter since the galley is empty
let available_width = allocate_width - margin.sum().x;
let available_width = allocate_width - frame.total_margin().sum().x;
let galley = layouter(ui, text, available_width);
// We can't update the galley immediately here, since it would show both hint text
@@ -693,9 +733,6 @@ impl TextEdit<'_> {
atoms.push_right(atom);
}
let custom_frame = frame.is_some();
let frame = frame.unwrap_or_else(|| Frame::new().inner_margin(margin));
let min_height = (min_inner_height + frame.total_margin().sum().y).at_least(min_size.y);
// This wrap mode only affects the hint_text
@@ -705,7 +742,7 @@ impl TextEdit<'_> {
TextWrapMode::Truncate
};
let mut allocated = AtomLayout::new(atoms)
let allocated = AtomLayout::new(atoms)
.id(id)
.min_size(Vec2::new(allocate_width, min_height))
.max_width(allocate_width)
@@ -715,43 +752,6 @@ impl TextEdit<'_> {
.wrap_mode(wrap_mode)
.allocate(ui);
allocated.frame = if custom_frame {
allocated.frame
} else {
let visuals = ui.style().interact(&allocated.response);
let background_color =
background_color.unwrap_or_else(|| ui.visuals().text_edit_bg_color());
let (corner_radius, background_color, stroke) = if text_mutable {
if allocated.response.has_focus() {
(
visuals.corner_radius,
background_color,
ui.visuals().selection.stroke,
)
} else {
(visuals.corner_radius, background_color, visuals.bg_stroke)
}
} else {
let visuals = &ui.style().visuals.widgets.inactive;
(
visuals.corner_radius,
Color32::TRANSPARENT,
visuals.bg_stroke,
)
};
allocated
.frame
.fill(background_color)
.corner_radius(corner_radius)
.inner_margin(
allocated.frame.inner_margin
+ Margin::same((visuals.expansion - stroke.width).round() as i8),
)
.outer_margin(Margin::same(-(visuals.expansion as i8)))
.stroke(stroke)
};
allocated.paint(ui)
};