Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make text cursor always appear on click #5420

Merged
merged 6 commits into from
Dec 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions crates/egui/src/text_selection/visuals.rs
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,19 @@ pub fn paint_text_selection(
pub fn paint_cursor_end(painter: &Painter, visuals: &Visuals, cursor_rect: Rect) {
let stroke = visuals.text_cursor.stroke;

let top = cursor_rect.center_top();
let bottom = cursor_rect.center_bottom();
// Ensure the cursor is aligned to the pixel grid for whole number widths.
// See https://github.com/emilk/egui/issues/5164
let (top, bottom) = if (stroke.width as usize) % 2 == 0 {
(
painter.round_pos_to_pixels(cursor_rect.center_top()),
painter.round_pos_to_pixels(cursor_rect.center_bottom()),
)
} else {
(
painter.round_pos_to_pixel_center(cursor_rect.center_top()),
painter.round_pos_to_pixel_center(cursor_rect.center_bottom()),
)
};
Comment on lines +101 to +111
Copy link
Contributor Author

@juancampa juancampa Nov 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would think it's safe to assume that everyone will be using either 1px or 2px cursor thickness. This should make it pixel-perfect for all whole-number thickness values.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will this work when the scale is 150%?

Also it'd be nice to have a screenshot test that shows the cursor, maybe you can add one?

Comment on lines +101 to +111
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could use a comment explaining what is going on, and ideally with a link to #5164 so we can remember to update this code if we move the rounding to epaint

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment added!


painter.line_segment([top, bottom], (stroke.width, stroke.color));

Expand All @@ -121,14 +132,14 @@ pub fn paint_text_cursor(
ui: &Ui,
painter: &Painter,
primary_cursor_rect: Rect,
time_since_last_edit: f64,
time_since_last_interaction: f64,
) {
if ui.visuals().text_cursor.blink {
let on_duration = ui.visuals().text_cursor.on_duration;
let off_duration = ui.visuals().text_cursor.off_duration;
let total_duration = on_duration + off_duration;

let time_in_cycle = (time_since_last_edit % (total_duration as f64)) as f32;
let time_in_cycle = (time_since_last_interaction % (total_duration as f64)) as f32;

let wake_in = if time_in_cycle < on_duration {
// Cursor is visible
Expand Down
6 changes: 4 additions & 2 deletions crates/egui/src/widgets/text_edit/builder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -603,6 +603,8 @@ impl<'t> TextEdit<'t> {

if did_interact || response.clicked() {
ui.memory_mut(|mem| mem.request_focus(response.id));

state.last_interaction_time = ui.ctx().input(|i| i.time);
}
}
}
Expand Down Expand Up @@ -746,7 +748,7 @@ impl<'t> TextEdit<'t> {
if text.is_mutable() && interactive {
let now = ui.ctx().input(|i| i.time);
if response.changed || selection_changed {
state.last_edit_time = now;
state.last_interaction_time = now;
}

// Only show (and blink) cursor if the egui viewport has focus.
Expand All @@ -759,7 +761,7 @@ impl<'t> TextEdit<'t> {
ui,
&painter,
primary_cursor_rect,
now - state.last_edit_time,
now - state.last_interaction_time,
);
}

Expand Down
4 changes: 2 additions & 2 deletions crates/egui/src/widgets/text_edit/state.rs
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,10 @@ pub struct TextEditState {
#[cfg_attr(feature = "serde", serde(skip))]
pub(crate) singleline_offset: f32,

/// When did the user last press a key?
/// When did the user last press a key or click on the `TextEdit`.
/// Used to pause the cursor animation when typing.
#[cfg_attr(feature = "serde", serde(skip))]
pub(crate) last_edit_time: f64,
pub(crate) last_interaction_time: f64,
}

impl TextEditState {
Expand Down
Loading