gui-cs.Terminal.Gui/Terminal.Gui/Input/Command.cs

// These classes use a keybinding system based on the design implemented in Scintilla.Net which is an
// MIT licensed open source project https://github.com/jacobslusser/ScintillaNET/blob/master/src/ScintillaNET/Command.cs

namespace Terminal.Gui;

/// <summary>
/// Actions which can be performed by the application or bound to keys in a <see cref="View"/> control.
/// </summary>
public enum Command {
	/// <summary>
	/// The default command. For <see cref="View"/> this focuses the view.
	/// </summary>
	Default,

	/// <summary>
	/// Moves down one item (cell, line, etc...).
	/// </summary>
	LineDown,

	/// <summary>
	/// Extends the selection down one (cell, line, etc...).
	/// </summary>
	LineDownExtend,

	/// <summary>
	/// Moves down to the last child node of the branch that holds the current selection.
	/// </summary>
	LineDownToLastBranch,

	/// <summary>
	/// Scrolls down one (cell, line, etc...) (without changing the selection).
	/// </summary>
	ScrollDown,

	// --------------------------------------------------------------------

	/// <summary>
	/// Moves up one (cell, line, etc...).
	/// </summary>
	LineUp,

	/// <summary>
	/// Extends the selection up one item (cell, line, etc...).
	/// </summary>
	LineUpExtend,

	/// <summary>
	/// Moves up to the first child node of the branch that holds the current selection.
	/// </summary>
	LineUpToFirstBranch,

	/// <summary>
	/// Scrolls up one item (cell, line, etc...) (without changing the selection).
	/// </summary>
	ScrollUp,

	/// <summary>
	/// Moves the selection left one by the minimum increment supported by the <see cref="View"/> e.g. single character, cell, item etc.
	/// </summary>
	Left,

	/// <summary>
	/// Scrolls one item (cell, character, etc...) to the left
	/// </summary>
	ScrollLeft,

	/// <summary>
	/// Extends the selection left one by the minimum increment supported by the view e.g. single character, cell, item etc.
	/// </summary>
	LeftExtend,

	/// <summary>
	/// Moves the selection right one by the minimum increment supported by the view e.g. single character, cell, item etc.
	/// </summary>
	Right,

	/// <summary>
	/// Scrolls one item (cell, character, etc...) to the right.
	/// </summary>
	ScrollRight,

	/// <summary>
	/// Extends the selection right one by the minimum increment supported by the view e.g. single character, cell, item etc.
	/// </summary>
	RightExtend,

	/// <summary>
	/// Moves the caret to the start of the previous word.
	/// </summary>
	WordLeft,

	/// <summary>
	/// Extends the selection to the start of the previous word.
	/// </summary>
	WordLeftExtend,

	/// <summary>
	/// Moves the caret to the start of the next word.
	/// </summary>
	WordRight,

	/// <summary>
	/// Extends the selection to the start of the next word.
	/// </summary>
	WordRightExtend,

	/// <summary>
	/// Cuts to the clipboard the characters from the current position to the end of the line.
	/// </summary>
	CutToEndLine,

	/// <summary>
	/// Cuts to the clipboard the characters from the current position to the start of the line.
	/// </summary>
	CutToStartLine,

	/// <summary>
	/// Deletes the characters forwards.
	/// </summary>
	KillWordForwards,

	/// <summary>
	/// Deletes the characters backwards.
	/// </summary>
	KillWordBackwards,

	/// <summary>
	/// Toggles overwrite mode such that newly typed text overwrites the text that is
	/// already there (typically associated with the Insert key).
	/// </summary>
	ToggleOverwrite,

	/// <summary>
	/// Enables overwrite mode such that newly typed text overwrites the text that is
	/// already there (typically associated with the Insert key).
	/// </summary>
	EnableOverwrite,

	/// <summary>
	/// Disables overwrite mode (<see cref="EnableOverwrite"/>)
	/// </summary>
	DisableOverwrite,

	/// <summary>
	/// Move one page down.
	/// </summary>
	PageDown,

	/// <summary>
	/// Move one page page extending the selection to cover revealed objects/characters.
	/// </summary>
	PageDownExtend,

	/// <summary>
	/// Move one page up.
	/// </summary>
	PageUp,

	/// <summary>
	/// Move one page up extending the selection to cover revealed objects/characters.
	/// </summary>
	PageUpExtend,

	/// <summary>
	/// Moves to the top/home.
	/// </summary>
	TopHome,

	/// <summary>
	/// Extends the selection to the top/home.
	/// </summary>
	TopHomeExtend,

	/// <summary>
	/// Moves to the bottom/end.
	/// </summary>
	BottomEnd,

	/// <summary>
	/// Extends the selection to the bottom/end.
	/// </summary>
	BottomEndExtend,

	/// <summary>
	/// Open the selected item.
	/// </summary>
	OpenSelectedItem,

	/// <summary>
	/// Toggle the checked state.
	/// </summary>
	ToggleChecked,

	/// <summary>
	/// Accepts the current state (e.g. selection, button press etc).
	/// </summary>
	Accept,

	/// <summary>
	/// Toggles the Expanded or collapsed state of a a list or item (with subitems).
	/// </summary>
	ToggleExpandCollapse,

	/// <summary>
	/// Expands a list or item (with subitems).
	/// </summary>
	Expand,

	/// <summary>
	/// Recursively Expands all child items and their child items (if any).
	/// </summary>
	ExpandAll,

	/// <summary>
	/// Collapses a list or item (with subitems).
	/// </summary>
	Collapse,

	/// <summary>
	/// Recursively collapses a list items of their children (if any).
	/// </summary>
	CollapseAll,

	/// <summary>
	/// Cancels an action or any temporary states on the control e.g. expanding
	/// a combo list.
	/// </summary>
	Cancel,

	/// <summary>
	/// Unix emulation.
	/// </summary>
	UnixEmulation,

	/// <summary>
	/// Deletes the character on the right.
	/// </summary>
	DeleteCharRight,

	/// <summary>
	/// Deletes the character on the left.
	/// </summary>
	DeleteCharLeft,

	/// <summary>
	/// Selects all objects.
	/// </summary>
	SelectAll,

	/// <summary>
	/// Deletes all objects.
	/// </summary>
	DeleteAll,

	/// <summary>
	/// Moves the cursor to the start of line.
	/// </summary>
	StartOfLine,

	/// <summary>
	/// Extends the selection to the start of line.
	/// </summary>
	StartOfLineExtend,

	/// <summary>
	/// Moves the cursor to the end of line.
	/// </summary>
	EndOfLine,

	/// <summary>
	/// Extends the selection to the end of line.
	/// </summary>
	EndOfLineExtend,

	/// <summary>
	/// Moves the cursor to the top of page.
	/// </summary>
	StartOfPage,

	/// <summary>
	/// Moves the cursor to the bottom of page.
	/// </summary>
	EndOfPage,

	/// <summary>
	/// Moves to the left page.
	/// </summary>
	PageLeft,

	/// <summary>
	/// Moves to the right page.
	/// </summary>
	PageRight,

	/// <summary>
	/// Moves to the left begin.
	/// </summary>
	LeftHome,

	/// <summary>
	/// Extends the selection to the left begin.
	/// </summary>
	LeftHomeExtend,

	/// <summary>
	/// Moves to the right end.
	/// </summary>
	RightEnd,

	/// <summary>
	/// Extends the selection to the right end.
	/// </summary>
	RightEndExtend,

	/// <summary>
	/// Undo changes.
	/// </summary>
	Undo,

	/// <summary>
	/// Redo changes.
	/// </summary>
	Redo,

	/// <summary>
	/// Copies the current selection.
	/// </summary>
	Copy,

	/// <summary>
	/// Cuts the current selection.
	/// </summary>
	Cut,

	/// <summary>
	/// Pastes the current selection.
	/// </summary>
	Paste,

	/// <summary>
	/// Quit a <see cref="Toplevel"/>.
	/// </summary>
	QuitToplevel,

	/// <summary>
	/// Suspend a application (Only implemented in <see cref="CursesDriver"/>).
	/// </summary>
	Suspend,

	/// <summary>
	/// Moves focus to the next view.
	/// </summary>
	NextView,

	/// <summary>
	/// Moves focuss to the previous view.
	/// </summary>
	PreviousView,

	/// <summary>
	/// Moves focus to the next view or Toplevel (case of Overlapped).
	/// </summary>
	NextViewOrTop,

	/// <summary>
	/// Moves focus to the next previous or Toplevel (case of Overlapped).
	/// </summary>
	PreviousViewOrTop,

	/// <summary>
	/// Refresh.
	/// </summary>
	Refresh,

	/// <summary>
	/// Toggles the selection.
	/// </summary>
	ToggleExtend,

	/// <summary>
	/// Inserts a new item.
	/// </summary>
	NewLine,

	/// <summary>
	/// Tabs to the next item.
	/// </summary>
	Tab,

	/// <summary>
	/// Tabs back to the previous item.
	/// </summary>
	BackTab,

	/// <summary>
	/// Saves the current document.
	/// </summary>
	Save,

	/// <summary>
	/// Saves the current document with a new name.
	/// </summary>
	SaveAs,

	/// <summary>
	/// Creates a new document.
	/// </summary>
	New,

	/// <summary>
	/// Moves selection to an item (e.g. highlighting a different menu item) without necessarily accepting it.
	/// </summary>
	Select,

	/// <summary>
	/// Shows context about the item (e.g. a context menu).
	/// </summary>
	ShowContextMenu
}