Enum Message 

pub enum Message {
    CharacterInput(char),
    Backspace,
    Delete,
    Enter,
    Tab,
    ArrowKey(ArrowDirection, bool),
    MouseClick(Point),
    MouseDrag(Point),
    MouseHover(Point),
    MouseRelease,
    Copy,
    Paste(String),
    DeleteSelection,
    Tick,
    PageUp,
    PageDown,
    Home(bool),
    End(bool),
    CtrlHome,
    CtrlEnd,
    GotoPosition(usize, usize),
    Scrolled(Viewport),
    HorizontalScrolled(Viewport),
    Undo,
    Redo,
    OpenSearch,
    OpenSearchReplace,
    CloseSearch,
    SearchQueryChanged(String),
    ReplaceQueryChanged(String),
    ToggleCaseSensitive,
    FindNext,
    FindPrevious,
    ReplaceNext,
    ReplaceAll,
    SearchDialogTab,
    SearchDialogShiftTab,
    FocusNavigationTab,
    FocusNavigationShiftTab,
    CanvasFocusGained,
    CanvasFocusLost,
    JumpClick(Point),
    ImeOpened,
    ImePreedit(String, Option<Range<usize>>),
    ImeCommit(String),
    ImeClosed,
}

Messages emitted by the code editor

Variants

CharacterInput(char)

Character typed

Backspace

Backspace pressed

Delete

Delete pressed

Enter

Enter pressed

Tab

Tab pressed (inserts 4 spaces)

ArrowKey(ArrowDirection, bool)

Arrow key pressed (direction, shift_pressed)

MouseClick(Point)

Mouse clicked at position

MouseDrag(Point)

Mouse drag for selection

MouseHover(Point)

Mouse moved within the editor without dragging

MouseRelease

Mouse released

Copy

Copy selected text (Ctrl+C)

Paste(String)

Paste text from clipboard (Ctrl+V)

DeleteSelection

Delete selected text (Shift+Delete)

Tick

Request redraw for cursor blink

PageUp

Page Up pressed

PageDown

Page Down pressed

Home(bool)

Home key pressed (move to start of line, shift_pressed)

End(bool)

End key pressed (move to end of line, shift_pressed)

CtrlHome

Ctrl+Home pressed (move to start of document)

CtrlEnd

Ctrl+End pressed (move to end of document)

GotoPosition(usize, usize)

Go to an explicit logical position (line, column), both 0-based.

Scrolled(Viewport)

Viewport scrolled - track scroll position

HorizontalScrolled(Viewport)

Horizontal scrollbar scrolled (only when wrap is disabled)

Undo

Undo last operation (Ctrl+Z)

Redo

Redo last undone operation (Ctrl+Y)

OpenSearch

Open search dialog (Ctrl+F)

OpenSearchReplace

Open search and replace dialog (Ctrl+H)

CloseSearch

Close search dialog (Escape)

SearchQueryChanged(String)

Search query text changed

ReplaceQueryChanged(String)

Replace text changed

ToggleCaseSensitive

Toggle case sensitivity

FindNext

Find next match (F3)

FindPrevious

Find previous match (Shift+F3)

ReplaceNext

Replace current match

ReplaceAll

Replace all matches

SearchDialogTab

Tab pressed in search dialog (cycle forward)

SearchDialogShiftTab

Shift+Tab pressed in search dialog (cycle backward)

FocusNavigationTab

Tab pressed for focus navigation (when search dialog is not open)

FocusNavigationShiftTab

Shift+Tab pressed for focus navigation (when search dialog is not open)

CanvasFocusGained

Canvas gained focus (mouse click)

CanvasFocusLost

Canvas lost focus (external widget interaction)

JumpClick(Point)

Triggered when the user performs a Ctrl+Click (or Cmd+Click on macOS) on the editor content, intending to jump to the definition of the symbol under the cursor.

ImeOpened

IME input method opened

ImePreedit(String, Option<Range<usize>>)

IME pre-edit update (content, selection range)

ImeCommit(String)

IME commit text

ImeClosed

IME input method closed

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Message

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Program<Message> for CodeEditor

fn draw( &self, _state: &Self::State, renderer: &Renderer, _theme: &Theme, bounds: Rectangle, _cursor: Cursor, ) -> Vec<Geometry>

Renders the code editor’s visual elements on the canvas, including text layout, syntax highlighting, cursor positioning, and other graphical aspects.

Arguments

• state - The current state of the canvas
• renderer - The renderer used for drawing
• theme - The theme for styling
• bounds - The rectangle bounds of the canvas
• cursor - The mouse cursor position

Returns

A vector of Geometry objects representing the drawn elements

fn update( &self, _state: &mut Self::State, event: &Event, bounds: Rectangle, cursor: Cursor, ) -> Option<Action<Message>>

Handles Canvas trait events, specifically keyboard input events and focus management for the code editor widget.

Arguments

• _state - The mutable state of the canvas (unused in this implementation)
• event - The input event to handle, such as keyboard presses
• bounds - The rectangle bounds of the canvas widget
• cursor - The current mouse cursor position and status

Returns

An optional Action<Message> to perform, such as sending a message or redrawing the canvas

type State = ()

The internal state mutated by the Program.

fn mouse_interaction( &self, _state: &Self::State, _bounds: Rectangle, _cursor: Cursor, ) -> Interaction

Returns the current mouse interaction of the Program.