On this page

ui_edit.h

The one text edit model every text widget drives. For component authors and custom hosts, apps use the fields in controls.h.

#include "isolenui/ui/ui_edit.h". The guide starts at Text editing and IME.

Setup

Explained in Text editing and IME.

ui::editui::edit_initui::edit_freeui::edit_historyui::edit_limitui::edit_filterui::edit_filter_fnui::edit_dirui::edit_fontui::edit_viewui::edit_set_textui::edit_bindui::edit_rebindui::edit_stopui::edit_walk_at

Flags and results

Explained in Text editing and IME.

ui::edit_flagui::edit_multilineui::edit_wrapui::edit_read_onlyui::edit_numericui::edit_tabsui::edit_resultui::edit_changedui::edit_movedui::edit_submitui::edit_cancelui::edit_modui::edit_ctrlui::edit_shiftui::edit_altui::edit_cmd

Editing

Explained in Text editing and IME.

ui::edit_unitui::edit_caretui::edit_selectui::edit_select_allui::edit_selectionui::edit_moveui::edit_insertui::edit_eraseui::edit_undoui::edit_redoui::edit_seal

Driving and preedit

Explained in Text editing and IME.

ui::edit_keyui::edit_charui::edit_feedui::edit_applyui::edit_pressui::edit_dragui::edit_preeditui::edit_commitui::edit_end_preeditui::edit_drop_preeditui::edit_copyui::edit_cutui::edit_paste

Geometry and paint

Explained in Text editing and IME.

ui::edit_layoutui::edit_line_ofui::edit_penui::edit_hitui::edit_caret_boxui::edit_blinkui::edit_pen_walkui::edit_fix26ui::edit_lineui::edit_stepui::edit_visualui::edit_visui::edit_vis_glyphui::edit_lookui::edit_paintui::edit_draw_run

Example

notes.cpp
#include "isolenui/ui/ui.h"
#include "isolenui/ui/ui_edit.h"

// a notes pane that drives the edit core itself
struct notes {
    char text[4096] = "";
    alignas(8) unsigned char history[16384];
    ui::edit ed{};
    bool ready = false;
    const ui::ctx* u = nullptr;
};

static bool no_digits(uint32_t cp, void* user)
{
    (void)user;
    return cp < '0' || cp > '9';
}

static void paint_notes(gfx_list* l, lay_box box, void* user)
{
    notes* n = static_cast<notes*>(user);
    const ui::theme* t = ui::theme_of(n->u);
    const ui::edit_look look = { t->text, t->accent_dim, t->accent, t->text, 1.6f, t->text_px };
    float next = -1.0f;
    const bool caret = ui::edit_blink(&n->ed, ui::input_of(n->u)->now, &next);
    const float base = box.y + text_font_ascent(ui::font_of(n->u), t->text_px);
    ui::edit_paint(&n->ed, l, ui::font_handle(n->u), box.x, box.y, base, look, caret);
}

static void notes_view(ui::ctx* u, notes* n)
{
    const ui::theme* t = ui::theme_of(u);
    if (!n->ready) {
        ui::edit_init(&n->ed, n->text, sizeof(n->text), ui::edit_multiline | ui::edit_wrap);
        ui::edit_history(&n->ed, n->history, sizeof(n->history));
        ui::edit_limit(&n->ed, 0u, 2000u);
        ui::edit_filter(&n->ed, no_digits, nullptr);
        n->ready = true;
    }
    n->u = u;

    const lay_box last = ui::rect_of(u, ui::next_id(u));
    ui::canvas(u, ui::col().width(lay_grow(1.0f)).height(240.0f), paint_notes, n);
    const ui::hit h = ui::interact(u);
    ui::focusable(u);

    const ui::input* in = ui::input_of(u);
    ui::edit_font(&n->ed, ui::font_of(u), t->face_ui, t->text_px, 0.0f, 0.0f);
    ui::edit_view(&n->ed, last.w, last.h);
    if (h.pressed) {
        ui::edit_press(&n->ed, in->mouse_x - last.x, in->mouse_y - last.y, in->now,
                       in->double_clicked, in->shift);
    } else if (h.held) {
        ui::edit_drag(&n->ed, in->mouse_x - last.x, in->mouse_y - last.y, ui::dt(u));
    }
    if (ui::focused(u, ui::last_id(u))) {
        const uint32_t r = ui::edit_apply(&n->ed, *in, in->now);
        if (r & ui::edit_cancel) {
            ui::focus(u, 0u);
        }
        // tell the host where the caret is so the ime hangs its window there
        float cx = 0.0f, cy = 0.0f, ch = 0.0f;
        ui::edit_caret_box(&n->ed, &cx, &cy, &ch);
        ui::text_input(u, lay_box{ last.x + cx, last.y + cy, 1.0f, ch });
        float next = -1.0f;
        ui::edit_blink(&n->ed, in->now, &next);
        ui::redraw_after(u, next);
    }
}

Last updated 23 October 2026