PolytreeDE/rofi
1
0
Fork 0
mirror of https://github.com/davatorium/rofi.git synced 2025-03-10 17:06:37 -04:00
Code Releases Activity

Add theming to hide text cursor if no text is put in (#2106)

Browse source 
* Add theming to hide text cursor if no text is put in

* rename "hide-empty-cursor" to "hide-cursor-on-empty"

* update docs
This commit is contained in:
J0hannes101 2025-02-25 18:50:25 +01:00 • committed by GitHub
parent 22a0e39b9b
commit e70e3906cc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 51 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc/rofi-theme.5.markdown
View file

@ -132,18 +132,18 @@ element-text {
└─────────────────────────────────────────────────────────────────────┘
```
We can also specify the color and width of the cursor. You could, for example,
create a crimson block cursor like this:
We can also customize the cursor's color, width, and choose to hide it when the input box is empty. You could, for example, create a crimson block cursor that only appears when text is entered, like this:
```css
entry {
cursor-color: rgb(220,20,60);
cursor-width: 8px;
hide-cursor-on-empty: true;
}
```
By default, the `cursor-color` will be the same as the `text-color`. The
`cursor-width` will always default to 2 pixels.
`cursor-width` will always default to 2 pixels and `hide-cursor-on-empty` is set to false.
If you want to see the complete theme, including the modification you can run:
@ -1068,6 +1068,9 @@ The following properties are currently supported:
- **cursor-color**: The color used to draw the cursor.
- **hide-cursor-on-empty**: Hides the cursor when the search field is empty.
(Boolean)
- **cursor-outline**: Enable a border (outline) around the cursor.
(Boolean)

87
source/widgets/textbox.c
View file

@ -552,51 +552,54 @@ static void textbox_draw(widget *wid, cairo_t *draw) {
if (tb->flags & TB_EDITABLE) {
// We want to place the cursor based on the text shown.
const char *text = pango_layout_get_text(tb->layout);
// Clamp the position, should not be needed, but we are paranoid.
size_t cursor_offset;
// hide the cursor, if no text is entered and hide-empty-cursor is set to true
if (!(tb->text[0] == '\0' && rofi_theme_get_boolean(WIDGET(tb), "hide-cursor-on-empty", FALSE) == TRUE)){
// Clamp the position, should not be needed, but we are paranoid.
size_t cursor_offset;
if ((tb->flags & TB_PASSWORD) == TB_PASSWORD) {
// Calculate cursor position based on mask length
size_t mask_len = strlen(tb->password_mask_char);
cursor_offset = MIN(tb->cursor * mask_len, strlen(text));
} else {
cursor_offset = MIN(tb->cursor, g_utf8_strlen(text, -1));
// convert to byte location.
char *offset = g_utf8_offset_to_pointer(text, cursor_offset);
cursor_offset = offset - text;
}
PangoRectangle pos;
pango_layout_get_cursor_pos(tb->layout, cursor_offset, &pos, NULL);
int cursor_x = pos.x / PANGO_SCALE;
int cursor_y = pos.y / PANGO_SCALE;
int cursor_height = pos.height / PANGO_SCALE;
RofiDistance cursor_width =
rofi_theme_get_distance(WIDGET(tb), "cursor-width", 2);
int cursor_pixel_width =
distance_get_pixel(cursor_width, ROFI_ORIENTATION_HORIZONTAL);
if ((x + cursor_x) != tb->cursor_x_pos) {
tb->cursor_x_pos = x + cursor_x;
}
if (tb->blink) {
// This save/restore state is necessary to render the text in the
// correct color when `cursor-color` is set
cairo_save(draw);
// use text color as fallback for themes that don't specify the cursor
// color
rofi_theme_get_color(WIDGET(tb), "cursor-color", draw);
cairo_rectangle(draw, x + cursor_x, y + cursor_y, cursor_pixel_width,
cursor_height);
if (rofi_theme_get_boolean(WIDGET(tb), "cursor-outline", FALSE)) {
cairo_fill_preserve(draw);
rofi_theme_get_color(WIDGET(tb), "cursor-outline-color", draw);
double width =
rofi_theme_get_double(WIDGET(tb), "cursor-outline-width", 0.5);
cairo_set_line_width(draw, width);
cairo_stroke(draw);
if ((tb->flags & TB_PASSWORD) == TB_PASSWORD) {
// Calculate cursor position based on mask length
size_t mask_len = strlen(tb->password_mask_char);
cursor_offset = MIN(tb->cursor * mask_len, strlen(text));
} else {
cairo_fill(draw);
cursor_offset = MIN(tb->cursor, g_utf8_strlen(text, -1));
// convert to byte location.
char *offset = g_utf8_offset_to_pointer(text, cursor_offset);
cursor_offset = offset - text;
}
PangoRectangle pos;
pango_layout_get_cursor_pos(tb->layout, cursor_offset, &pos, NULL);
int cursor_x = pos.x / PANGO_SCALE;
int cursor_y = pos.y / PANGO_SCALE;
int cursor_height = pos.height / PANGO_SCALE;
RofiDistance cursor_width =
rofi_theme_get_distance(WIDGET(tb), "cursor-width", 2);
int cursor_pixel_width =
distance_get_pixel(cursor_width, ROFI_ORIENTATION_HORIZONTAL);
if ((x + cursor_x) != tb->cursor_x_pos) {
tb->cursor_x_pos = x + cursor_x;
}
if (tb->blink) {
// This save/restore state is necessary to render the text in the
// correct color when `cursor-color` is set
cairo_save(draw);
// use text color as fallback for themes that don't specify the cursor
// color
rofi_theme_get_color(WIDGET(tb), "cursor-color", draw);
cairo_rectangle(draw, x + cursor_x, y + cursor_y, cursor_pixel_width,
cursor_height);
if (rofi_theme_get_boolean(WIDGET(tb), "cursor-outline", FALSE)) {
cairo_fill_preserve(draw);
rofi_theme_get_color(WIDGET(tb), "cursor-outline-color", draw);
double width =
rofi_theme_get_double(WIDGET(tb), "cursor-outline-width", 0.5);
cairo_set_line_width(draw, width);
cairo_stroke(draw);
} else {
cairo_fill(draw);
}
cairo_restore(draw);
}
cairo_restore(draw);
}
}