Safe Haskell	None
Language	GHC2024

NanoUI.Widgets.TextEditor

Contents

Commands
Editors
Key bindings
History

Description

The editing core every text field shares: a document, a selection and an undo history, changed only by TextCommands. Keys and menu rows map onto commands, and an app can run the same commands on a field.

Synopsis

data TextCommand
- = InsertText !Text
- | Delete !TextMotion
- | Move !TextMotion !Bool
- | SelectAll
- | Select !Cursor !Cursor
- | Replace !Cursor !Cursor !Text
- | ReplaceAll !Text
- | Undo
- | Redo
- | Cut
- | Copy
- | Paste
data TextMotion
- = CharLeft
- | CharRight
- | WordLeft
- | WordRight
- | LineStart
- | LineEnd
- | LineUp
- | LineDown
- | DocumentStart
- | DocumentEnd
data Editor = Editor {
- editorBuffer :: !TextBuffer
- editorAnchor :: !Cursor
- editorHistory :: !EditHistory
}
data EditorMode = EditorMode {
- modeMultiLine :: !Bool
- modeEditable :: !Bool
- modeCopyable :: !Bool
}
singleLineMode :: EditorMode
multiLineMode :: EditorMode
editorModeCode :: EditorMode -> Int
editorModeFromCode :: Int -> Maybe EditorMode
editorFromBuffer :: TextBuffer -> Editor
editorSelection :: Editor -> (Cursor, Cursor)
hasSelection :: Editor -> Bool
runCommand :: EditorMode -> TextCommand -> Editor -> Editor
runCommandIO :: Context -> EditorMode -> TextCommand -> Editor -> IO Editor
inputTextCommands :: EditorMode -> Input -> [TextCommand]
keyCommand :: EditorMode -> Modifiers -> Key -> Maybe TextCommand
data EditHistory = EditHistory {
- historyUndo :: ![EditGroup]
- historyRedo :: ![EditGroup]
- historyDepth :: !Int
- historyOpen :: !Bool
}
data EditGroup = EditGroup {
- groupKind :: !EditKind
- groupEdits :: ![StoredEdit]
- groupBefore :: !(Cursor, Cursor)
- groupAfter :: !(Cursor, Cursor)
}
data StoredEdit = StoredEdit !Cursor !ShortText !ShortText
data EditKind
- = EditTyping
- | EditDeleting
- | EditOther
emptyHistory :: EditHistory
sealHistory :: EditHistory -> EditHistory
canUndo :: EditHistory -> Bool
canRedo :: EditHistory -> Bool

Commands

data TextCommand Source #

Something done to a text field. Commands that change text are undoable and replace the selection where one exists.

Constructors

InsertText !Text	Replace the selection with text (typing, a snippet).
Delete !TextMotion	Delete the selection, or from the cursor to where the motion lands: `Delete CharLeft` is Backspace, `Delete WordRight` Ctrl+Delete.
Move !TextMotion !Bool	Move the cursor, extending the selection when the flag is set.
SelectAll
Select !Cursor !Cursor	Select from the first position (the anchor) to the second (the cursor), clamped into the document.
Replace !Cursor !Cursor !Text	Replace the text between two positions, leaving the cursor after it.
ReplaceAll !Text	Replace the whole document as one undoable edit.
Undo
Redo
Cut
Copy
Paste

Instances

Instances details

Eq TextCommand Source #
Instance details Defined in NanoUI.Widgets.TextCommand Methods (==) :: TextCommand -> TextCommand -> Bool # (/=) :: TextCommand -> TextCommand -> Bool #
Show TextCommand Source #
Instance details Defined in NanoUI.Widgets.TextCommand Methods showsPrec :: Int -> TextCommand -> ShowS # show :: TextCommand -> String # showList :: [TextCommand] -> ShowS #

data TextMotion Source #

Where a motion takes the cursor.

Constructors

CharLeft
CharRight
WordLeft
WordRight
LineStart
LineEnd
LineUp
LineDown
DocumentStart
DocumentEnd

Instances

Instances details

Eq TextMotion Source #
Instance details Defined in NanoUI.Widgets.TextCommand Methods (==) :: TextMotion -> TextMotion -> Bool # (/=) :: TextMotion -> TextMotion -> Bool #
Bounded TextMotion Source #
Instance details Defined in NanoUI.Widgets.TextCommand Methods minBound :: TextMotion # maxBound :: TextMotion #
Enum TextMotion Source #
Instance details Defined in NanoUI.Widgets.TextCommand Methods succ :: TextMotion -> TextMotion # pred :: TextMotion -> TextMotion # toEnum :: Int -> TextMotion # fromEnum :: TextMotion -> Int # enumFrom :: TextMotion -> [TextMotion] # enumFromThen :: TextMotion -> TextMotion -> [TextMotion] # enumFromTo :: TextMotion -> TextMotion -> [TextMotion] # enumFromThenTo :: TextMotion -> TextMotion -> TextMotion -> [TextMotion] #
Show TextMotion Source #
Instance details Defined in NanoUI.Widgets.TextCommand Methods showsPrec :: Int -> TextMotion -> ShowS # show :: TextMotion -> String # showList :: [TextMotion] -> ShowS #

Editors

data Editor Source #

A document with its selection (the cursor is the buffer's, the anchor the other end) and history.

Constructors

Editor
Fields editorBuffer :: !TextBuffer editorAnchor :: !Cursor editorHistory :: !EditHistory

Instances

Instances details

Show Editor Source #
Instance details Defined in NanoUI.Widgets.TextEditor Methods showsPrec :: Int -> Editor -> ShowS # show :: Editor -> String # showList :: [Editor] -> ShowS #

data EditorMode Source #

How a field lets its document be changed.

Constructors

EditorMode
Fields modeMultiLine :: !Bool modeEditable :: !Bool Off for selectable labels: only motion, selection and copy apply. modeCopyable :: !Bool Off for passwords: nothing reaches the clipboard.

Instances

Instances details

Eq EditorMode Source #
Instance details Defined in NanoUI.Widgets.TextEditor Methods (==) :: EditorMode -> EditorMode -> Bool # (/=) :: EditorMode -> EditorMode -> Bool #
Show EditorMode Source #
Instance details Defined in NanoUI.Widgets.TextEditor Methods showsPrec :: Int -> EditorMode -> ShowS # show :: EditorMode -> String # showList :: [EditorMode] -> ShowS #

singleLineMode :: EditorMode Source #

multiLineMode :: EditorMode Source #

editorModeCode :: EditorMode -> Int Source #

A mode as a store integer, so a command sent to a widget id between frames knows what kind of field it edits.

editorModeFromCode :: Int -> Maybe EditorMode Source #

editorFromBuffer :: TextBuffer -> Editor Source #

editorSelection :: Editor -> (Cursor, Cursor) Source #

(anchor, cursor).

hasSelection :: Editor -> Bool Source #

runCommand :: EditorMode -> TextCommand -> Editor -> Editor Source #

Run a command that needs no clipboard. Cut, Copy and Paste do nothing here; runCommandIO runs them.

runCommandIO :: Context -> EditorMode -> TextCommand -> Editor -> IO Editor Source #

runCommand, with the clipboard commands going through the context's clipboard.

Key bindings

inputTextCommands :: EditorMode -> Input -> [TextCommand] Source #

This frame's typing and keys as commands, typed characters first. Ctrl turns characters into shortcuts. Ctrl with Alt is AltGr on many layouts, so its characters are typed like plain ones.

keyCommand :: EditorMode -> Modifiers -> Key -> Maybe TextCommand Source #

The command a key runs. Ctrl or Alt turns character and deletion keys into word motions, and Shift extends the selection.

History

data EditHistory Source #

Constructors

EditHistory
Fields historyUndo :: ![EditGroup] historyRedo :: ![EditGroup] historyDepth :: !Int Length of `historyUndo`. historyOpen :: !Bool Whether the next edit may join the newest group. Undo, redo, cursor moves and commands from outside the field close it.

Instances

Instances details

Eq EditHistory Source #
Instance details Defined in NanoUI.Widgets.TextEditor Methods (==) :: EditHistory -> EditHistory -> Bool # (/=) :: EditHistory -> EditHistory -> Bool #
Show EditHistory Source #
Instance details Defined in NanoUI.Widgets.TextEditor Methods showsPrec :: Int -> EditHistory -> ShowS # show :: EditHistory -> String # showList :: [EditHistory] -> ShowS #

data EditGroup Source #

Edits undone and redone as one step.

Constructors

EditGroup
Fields groupKind :: !EditKind groupEdits :: ![StoredEdit] Newest first. groupBefore :: !(Cursor, Cursor) Anchor and cursor before the first edit. groupAfter :: !(Cursor, Cursor) Anchor and cursor after the last edit.

Instances

Instances details

Eq EditGroup Source #
Instance details Defined in NanoUI.Widgets.TextEditor Methods (==) :: EditGroup -> EditGroup -> Bool # (/=) :: EditGroup -> EditGroup -> Bool #
Show EditGroup Source #
Instance details Defined in NanoUI.Widgets.TextEditor Methods showsPrec :: Int -> EditGroup -> ShowS # show :: EditGroup -> String # showList :: [EditGroup] -> ShowS #

data StoredEdit Source #

An edit as history keeps it. Undo steps live for the life of a field and are rarely replayed, so their texts are compact copies: they cost two words less than a Text, and never keep alive the larger text a slice was cut from.

Constructors

StoredEdit !Cursor !ShortText !ShortText

Instances

Instances details

Eq StoredEdit Source #
Instance details Defined in NanoUI.Widgets.TextEditor Methods (==) :: StoredEdit -> StoredEdit -> Bool # (/=) :: StoredEdit -> StoredEdit -> Bool #
Show StoredEdit Source #
Instance details Defined in NanoUI.Widgets.TextEditor Methods showsPrec :: Int -> StoredEdit -> ShowS # show :: StoredEdit -> String # showList :: [StoredEdit] -> ShowS #

data EditKind Source #

What started a group of edits, which decides what may join it.

Constructors

EditTyping
EditDeleting
EditOther

Instances

Instances details

Eq EditKind Source #
Instance details Defined in NanoUI.Widgets.TextEditor Methods (==) :: EditKind -> EditKind -> Bool # (/=) :: EditKind -> EditKind -> Bool #
Show EditKind Source #
Instance details Defined in NanoUI.Widgets.TextEditor Methods showsPrec :: Int -> EditKind -> ShowS # show :: EditKind -> String # showList :: [EditKind] -> ShowS #

emptyHistory :: EditHistory Source #

sealHistory :: EditHistory -> EditHistory Source #

Start the next edit in a group of its own.

canUndo :: EditHistory -> Bool Source #

canRedo :: EditHistory -> Bool Source #