Namespace Terminal.Gui | Terminal.Gui v2 (original) (raw)
Classes
Adornments are a special form of View that appear outside the Viewport:Margin, Border, and Padding. They are defined using theThickness class, which specifies the thickness of the sides of a rectangle.
The event arguments for AdvanceFocus(NavigationDirection, TabBehavior?) events.
Aligns items within a container based on the specified Alignment. Both horizontal and vertical alignments are supported.
Describes a requirement on what FileInfo can be selected. This can be combined with otherIAllowedType in a FileDialog to for example show only .csv files but let user change to open any if they want.
IAllowedType that allows selection of any types (.).
Color name resolver for ColorName16.
Describes an Ansi escape sequence. This is a 'blueprint'. If you want to send the sequence you should instead use AnsiEscapeSequenceRequest
Describes an ongoing ANSI request sent to the console. Use ResponseReceived to handle the response when console answers the request.
Parses ANSI escape sequence strings that describe keyboard activity into Key.
Base class for ANSI keyboard parsing patterns.
Parses mouse ansi escape sequences into MouseEventArgsincluding support for pressed, released and mouse wheel.
Manages AnsiEscapeSequenceRequest made to an IAnsiResponseParser. Ensures there are not 2+ outstanding requests with the same terminator, throttles request sends to prevent console becoming unresponsive and handles evicting ignored requests (no reply from terminal).
The Scope class for application-defined configuration settings.
Autocomplete for a TextField which shows suggestions within the box. Displayed suggestions can be completed using the tab key.
A static, singleton class representing the application. This class is the entry point for the application.
Original Terminal.Gui implementation of core Application methods.
Helper class for Application navigation. Held by Navigation
Helper class for support of IPopover views for Application. Held byPopover
Implementation of IApplication that boots the new 'v2' main loop architecture.
Abstract implementation of IAutocomplete allows for tailoring how autocomplete is rendered/interacted with.
Describes the current state of a View which is proposing autocomplete. Suggestions are based on this state.
Renders a continuous line with grid line ticks and labels
A location on an axis of a GraphView that may or may not have a label associated with it
Provides a horizontally or vertically oriented container for Shortcuts to be used as a menu, toolbar, or status bar.
Series of bars positioned at regular intervals
A single bar in a BarSeries
The Border for a View. Accessed via Border
A button View that can be pressed with the mouse or keyboard.
EventArgs for events that convey changes to a property of type T.
Defines the event arguments for CellActivated event
Arguments for a CellColorGetterDelegate. Describes a cell for which a renderingColorScheme is being sought
Event args for the CellToggled event.
A scrollable map of the Unicode codepoints.
Shows a checkbox that can be cycled between two or three states.
CheckBoxTableSourceWrapperBase
ITableSource for a TableView which adds a checkbox column as an additional column in the table.
CheckBoxTableSourceWrapperByIndex
Implementation of CheckBoxTableSourceWrapperBase which records toggled rows by their row number.
CheckBoxTableSourceWrapperByObject
Implementation of CheckBoxTableSourceWrapperBase which records toggled rows by a property on row objects.
Provides cut, copy, and paste support for the OS clipboard.
Shared abstract class to enforce rules from the implementation of the IClipboard interface.
Event arguments for the Color events.
An exception thrown when something goes wrong when trying to parse a Color.
True color picker using HSL
The ColorPicker16 View Color picker.
Contains style settings for ColorPicker e.g. which ColorModelto use.
Translates colors in an image into a Palette of up to MaxColors colors (typically 256).
Defines a standard set of Attributes for common visible elements in a View.
Provides a mapping between Color and the W3C standard color name strings.
Holds the ColorSchemes that define the Attributes that are used by views to render themselves.
Describes how to render a given column in a TableView including Alignment and textual representation of cells (e.g. date formats)See TableView Deep Dive for more information.
Provides a drop-down list of items the user can select from.
Event arguments for Command events.
Holds a property's value and the PropertyInfo that allows ConfigurationManager to get and set the property's value.
Provides settings and configuration management for Terminal.Gui applications.
Users can set Terminal.Gui settings on a global or per-application basis by providing JSON formatted configuration files. The configuration files can be placed in at .tui folder in the user's home directory (e.g. C:/Users/username/.tui, or /usr/username/.tui), the folder where the Terminal.Gui application was launched from (e.g. ./.tui ), or as a resource within the Terminal.Gui application's main assembly.
Settings are defined in JSON format, according to this schema: https://gui-cs.github.io/Terminal.GuiV2Docs/schemas/tui-config-schema.json
Settings that will apply to all applications (global settings) reside in files named config.json. Settings that will apply to a specific Terminal.Gui application reside in files namedappname.config.json, where appname is the assembly name of the application (e.g.UICatalog.config.json).
Settings are applied using the following precedence (higher precedence settings overwrite lower precedence settings):
1. Application configuration found in the users' home directory (~/.tui/appname.config.json) -- Highest precedence
2. Application configuration found in the directory the app was launched from (./.tui/appname.config.json).
3. Application configuration found in the applications' resources (Resources/config.json).
4. Global configuration found in the user's home directory (~/.tui/config.json).
5. Global configuration found in the directory the app was launched from (./.tui/config.json).
6. Global configuration in Terminal.Gui.dll's resources (Terminal.Gui.Resources.config.json) -- Lowest Precedence.
Event arguments for the ConfigurationManager events.
Base class for Terminal.Gui IConsoleDriver implementations.
Base class for reading console input in perpetual loop
Event arguments for events for when the contents of the TextView change. E.g. theContentsChanged event.
Detects ansi escape sequences in strings that have been read from the terminal (see IAnsiResponseParser). This pattern handles keys that begin Esc[ e.g. Esc[A - cursor up
ITableSource implementation that wraps a DataTable. This class is mutable: changes are permitted to the wrapped DataTable.
Simple Date editing View
The DatePicker View Date Picker.
Defines the event arguments for DateChanged and TimeChangedevents.
Default file operation handlers using modal dialogs.
Implementation of ITreeBuilder that uses user defined functions
The Dialog View is a Window that by default is centered and contains one or more Buttons. It defaults to the Colors.ColorSchemes ["Dialog"] color scheme and has a 1 cell padding around the edges.
A Dim object describes the dimensions of a View. Dim is the type of theWidth and Height properties of View.
Integer values are implicitly convertible to an absolute Dim. These objects are created using the static methods described below. The Dim objects can be combined with the addition and subtraction operators.
Represents a dimension that is a fixed size.
Represents a dimension that automatically sizes the view to fit all the view's Content, SubViews, and/or Text.
Represents a dimension that is a combination of two other dimensions.
Represents a dimension that fills the dimension, leaving the specified margin.
Represents a function Dim object that computes the dimension by executing the provided function.
Represents a dimension that is a percentage of the width or height of the SuperView.
Represents a dimension that tracks the Height or Width of the specified View.
Tracks the region that has been drawn during Draw(DrawContext?). This is primarily in support of Transparent.
Event args for draw events
Event args for the DrawLine event
ITableSource implementation that wraps arbitrary data.
Represents the status of an ANSI escape sequence request made to the terminal usingEscSeqRequests.
Manages ANSI Escape Sequence requests and responses. The list of EscSeqReqStatuscontains the status of the request. Each request is identified by the terminator (e.g. ESC[8t ... t is the terminator).
Provides a platform-independent API for managing ANSI escape sequences.
Calculates the distance between two colors using Euclidean distance in 3D RGB space. This measures the straight-line distance between the two points representing the colors.
Euclidean distance in RGB space is calculated as:
√((R2 - R1)² + (G2 - G1)² + (B2 - B1)²)Values vary from 0 to ~441.67 linearly This distance metric is commonly used for comparing colors in RGB space, though it doesn't account for perceptual differences in color.
EventArgs for events that convey changes to a property of type T.
Implements a mock IConsoleDriver for unit testing
Modal dialog for selecting files/directories. Has auto-complete and expandable navigation pane (Recent, Root drives etc).
Stores style settings for FileDialog.
Provides a way to get the color of a file or directory.
Determines which symbol to use to represent files and directories.
TreeView builder for creating file system based trees.
Event args for the FilesSelected event
Describes a pair of IFill which cooperate in creatingAttribute. One gives foreground color while other gives background.
Provides a user interface for displaying and selecting flags. Flags can be set from a dictionary or directly from an enum type.
Provides a user interface for displaying and selecting flags. Flags can be set from a dictionary or directly from an enum type.
A non-overlapped container for other views with a border and optional title.
Defines the standard set of glyphs used to draw checkboxes, lines, borders, etc...
Args GrabMouse related events.
Describes a Spectrum of colors that can be combined to make a color gradient. Use BuildCoordinateColorMapping(int, int, GradientDirection)to create into gradient fill area maps.
Implementation of IFill that uses a color gradient (including radial, diagonal etc.).
Describes how to render a single row/column of a GraphView based on the value(s) inISeries at that location
View for rendering graphs (bar, scatter, etc...).
The event arguments for HasFocus events.
Hex viewer and editor View over a Stream
Defines the event arguments for Edited event.
Defines the event arguments for PositionChanged event.
The horizontal (x-axis) of a GraphView
InputBindings<TEvent, TBinding>
Abstract class for KeyBindings and MouseBindings.
Processes the queued input buffer contents - which must be of Type T. Is responsible for ProcessQueue() and translating into common Terminal.Gui events and data models.
Event arguments for the Iteration event.
Provides an abstraction for common keyboard operations and state. Used for processing keyboard input and raising keyboard events.
Provides a collection of Keys bound to Commands.
Event args for when a Key is changed from one value to a new value (e.g. inHotKeyChanged)
Support for Key in JSON in the form of "Ctrl-X" or "Alt-Shift-F1".
Event arguments for the Terminal.Gui.CollectionNavigatorBase.SearchStringChanged event.
The Label View displays text that describes the View next in the SubViews. When Label receives a HotKey command it will pass it to the next View inSubViews.
Event arguments for the SubViewsLaidOut event.
Represents an exception that is thrown when a layout operation fails.
A box containing symbol definitions e.g. meanings for colors in a graph. The 'Key' to the graph
Draws a single line using the LineStyle specified by BorderStyle.
Facilitates box drawing and line intersection detection and rendering. Does not support diagonal lines.
Describes two points in graph space and a line between them
A straight line control either horizontal or vertical
Defines rendering options that affect how the view is displayed.
ITableSource implementation that wraps a IList. This class is mutable: changes are permitted to the wrapped IList.
ListView View renders a scrollable list of data where each item can be activated to perform an action.
EventArgs for ListView events.
EventArgs used by the RowRender event.
Provides a default implementation of IListDataSource that renders ListView items using ToString().
Singleton logging instance class. Do not use console loggers with this class as it will interfere with Terminal.Gui screen output (i.e. use a file logger).
The MainLoop monitors timers and idle handlers.
Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.
The Margin for a View. Accessed via Margin
Provides a menu bar that spans the top of a Toplevel View with drop-down and cascading menus.
By default, any sub-sub-menus (sub-menus of the MenuItems added to MenuBarItems) are displayed in a cascading manner, where each sub-sub-menu pops out of the sub-menu frame (either to the right or left, depending on where the sub-menu is relative to the edge of the screen). By settingUseSubMenusSingleFrame to true, this behavior can be changed such that all sub-sub-menus are drawn within a single frame below the MenuBar.
MenuBarItem is a menu item on MenuBar. MenuBarItems do not supportShortcutKey.
A Shortcut-derived object to be used as items in a MenuBarv2. MenuBarItems hold a PopoverMenu instead of a SubMenu.
A horizontal list of MenuBarItemv2s. Each MenuBarItemv2 can have aPopoverMenu that is shown when the MenuBarItemv2 is selected.
An EventArgs which allows passing a cancelable menu closing event.
A MenuItem has title, an associated help text, and an action to execute on activation. MenuItems can also have a checked indicator (see Checked).
A Shortcut-derived object to be used as a menu item in a Menuv2. Has title, an A Shortcut-derived object to be used as a menu item in a Menuv2. Has title, an associated help text, and an action to execute on activation.
Defines arguments for the MenuOpened event
An EventArgs which allows passing a cancelable menu opening event or replacing with a newMenuBarItem.
A Bar-derived object to be used as a vertically-oriented menu. Each subview is a MenuItemv2.
MessageBox displays a modal message to the user, with a title, a message and a series of options that the user can choose from.
Provides a collection of MouseBinding objects bound to a combination of MouseFlags.
Specifies the event arguments for MouseEventArgs. This is a higher-level construct than the wrapped MouseEventArgs class and is used for the events defined onView and subclasses of View (e.g. MouseEnter and MouseClick).
Args for events that describe a change in MouseFlags
Collection of BarSeries in which bars are clustered by category
MultiStandardColorNameResolver
Backwards compatible(-ish) color name resolver prioritizing ANSI 4-bit (16) colors with fallback to W3C colors.
Console input implementation that uses native dotnet methods e.g. Console.
Input processor for NetInput, deals in ConsoleKeyInfo stream
Implementation of IConsoleOutput that uses native dotnet methods e.g. Console
Thrown when user code attempts to access a property or perform a method that is only supported after Initialization e.g. of an IMainLoop
Enables the user to increase or decrease an int by clicking on the up or down buttons.
Enables the user to increase or decrease a value with the mouse or keyboard.
Event args for the ObjectActivated event
The OpenDialogprovides an interactive dialog box for users to select files or directories.
Provides a user interface for displaying and selecting a single item from a list of options. Each option is represented by a checkbox, but only one can be selected at a time.
Helper class for implementing IOrientation.
Stores the desired output state for the whole application. This is updated during draw operations before being flushed to the console as part of MainLoopoperation
The Padding for a View. Accessed via Padding
Sequence of lines to connect points e.g. of a ScatterSeries
Abstract base class for Popover Views.
Provides a cascading menu that pops over all other content. Can be used as a context menu or a drop-down all other content. Can be used as a context menu or a drop-down menu as part of MenuBarv2 as part of MenuBarv2.
Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options.
Describes the position of a View which can be an absolute value, a percentage, centered, or relative to the ending dimension. Integer values are implicitly convertible to an absolute Pos. These objects are created using the static methods Percent, AnchorEnd, and Center. The Pos objects can be combined with the addition and subtraction operators.
Represents an absolute position in the layout. This is used to specify a fixed position in the layout.
Enables alignment of a set of views.
Represents a position anchored to the end (right side or bottom).
Represents a position that is centered.
Represents a position that is a combination of two other positions.
Represents a position that is computed by executing a function that returns an integer position.
Represents a position that is a percentage of the width or height of the SuperView.
Represents a position that is anchored to the side of another view.
A Progress Bar view that can indicate progress of an activity visually.
Displays a list of mutually-exclusive items. Each items can have its own hotkey.
Represents a region composed of one or more rectangles, providing methods for geometric set operations such as union, intersection, exclusion, and complement. This class is designed for use in graphical or terminal-based user interfaces where regions need to be manipulated to manage screen areas, clipping, or drawing boundaries.
Arguments for RowColorGetterDelegate. Describes a row of data in a ITableSourcefor which ColorScheme is sought.
The execution state for a Toplevel view.
Event arguments for events about RunState
Extends Rune to support TUI text manipulation.
The SaveDialog provides an interactive dialog box for users to pick a file to save.
Series composed of any number of discrete data points
Defines a configuration settings scope. Classes that inherit from this abstract class can be used to define scopes for configuration settings. Each scope is a JSON object that contains a set of configuration settings.
Indicates the size of scrollable content and controls the position of the visible content, either vertically or horizontally. Two Buttons are provided, one to scroll up or left and one to scroll down or right. Between the buttons is a ScrollSlider that can be dragged to control the position of the visible content. The ScrollSlier is sized to show the proportion of the scrollable content to the size of the Viewport.
The ScrollSlider can be dragged with the mouse, constrained by the size of the Viewport of it's superview. The ScrollSlider can be oriented either vertically or horizontally.
Defines the event arguments for SelectedCellChanged
Event arguments for the SelectedItemChanged event.
Event arguments describing a change in selected object in a tree view
SerializableConfigurationProperty
An attribute that can be applied to a property to indicate that it should be included in the configuration file.
The root object of Terminal.Gui configuration settings / JSON schema. Contains only properties attributed withSettingsScope.
Displays a command, help text, and a key binding. When the key specified by Key is pressed, the command will be invoked. Useful for displaying a command in Bar such as a menu, toolbar, or status bar.
A helper class used by Shortcut to display the key. Reverses the Normal and HotNormal colors.
ISuggestionGenerator which suggests from a collection of words those that match theAutocompleteContext. You can update AllSuggestions at any time to change candidates considered for autocomplete.
Encodes a images into the sixel console image output format.
Uses Ansi escape sequences to detect whether sixel is supported by the terminal.
Describes the discovered state of sixel support and ancillary information e.g. Resolution. You can use any SixelSupportDetectorto discover this information.
Describes a request to render a given SixelData at a given ScreenPosition. Requires that the terminal and IConsoleDriver both support sixel.
Args for events about Size (e.g. Resized)
Slider control.
Slider Legend Style
EventArgs for Slider SliderOption events.
Represents an option in a Slider .
Slider Style
Provides a slider control letting the user navigate from a set of typed options in a linear manner using the keyboard or mouse.
IFill implementation that uses a solid color for all points
SpinnerStyles used in a SpinnerView.
SpinnerStyle.SimpleDotsScrolling
A View which displays (by default) a spinning line character.
Provides data for TileView events.
Parser for SS3 terminal escape sequences. These describe specific keys e.g.EscOP is F1.
Extension of Stack helper to work with specific IEqualityComparer
A status bar is a View that snaps to the bottom of a Toplevel displaying set ofShortcuts. The StatusBar should be context sensitive. This means, if the main menu and an open text editor are visible, the items probably shown will be ~F1~ Help ~F2~ Save ~F3~ Load. While a dialog to ask a file to load is executed, the remaining commands will probably be ~F1~ Help. So for each context must be a new instance of a status bar.
EventArgs for WizardStep events.
A line between two points on a horizontal or vertical Orientation and a given style/color.
Extension methods for StraightLine (including collections).
Extensions to string to support TUI text manipulation.
A replacement suggestion made by IAutocomplete
Args for events where the SuperView of a View is changed (e.g.Removed).
A single tab in a TabView.
Describes a change in SelectedTab
Describes a mouse event over a specific Tab in a TabView.
Describes render stylistic selections of a TabView
Control that hosts multiple sub views, presenting a single one at once.
Describes a selected region of the table
Defines rendering options that affect how the table is displayed.See TableView Deep Dive for more information.
View for tabular data based on a ITableSource.See TableView Deep Dive for more information.
Displays text at a given position (in screen space or graph space)
Single-line text entry View
Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options. An implementation on a TextField.
Provides text formatting. Supports HotKeys, horizontal and vertical alignment, text direction, multiple lines, and word-based line wrap.
Text field that validates input through a ITextValidateProvider
Multi-line text editing View.
Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options. An implementation on a TextView.
Contains a dictionary of the Themes for a Terminal.Gui application.
Event arguments for the ThemeManager events.
The root object for a Theme. A Theme is a set of settings that are applied to the runningApplication as a group.
A single ContentView presented in a TileView. To create new instances useRebuildForTileCount(int) or InsertTile(int).
A View consisting of a moveable bar that divides the display area into resizeableTiles.
Time editing View
Handles timeouts and idles
Provides data for timers running manipulation.
EventArgs for timeout events (e.g. TimeoutAdded)
Toplevel views are used for both an application's main view (filling the entire screen and for modal (pop-up) views such as Dialog, MessageBox, and Wizard).
EventArgs implementation for the Closing event.
Implements the IEqualityComparer for comparing two Toplevels used byStackExtensions.
Args for events that relate to a specific Toplevel.
Handles bespoke behaviours that occur when application top level changes.
Abstract implementation of ITreeBuilder.
Simple class for representing nodes, use with regular (non-generic) TreeView.
ITreeBuilder implementation for ITreeNode objects
Defines rendering options that affect how the tree is displayed.
An ITableSource with expandable rows.
Convenience implementation of generic TreeView for any tree were all nodes implementITreeNode. See TreeView Deep Dive for more information.
ITreeViewFilter implementation which searches the AspectGetter of the model for the given Text.
Hierarchical tree view with expandable branches. Branch objects are dynamically determined when expanded using a user defined ITreeBuilder.See TreeView Deep Dive for more information.
Represents all of the Uniicode ranges.from System.Text.Unicode.UnicodeRange plus the non-BMP ranges not included.
The vertical (i.e. Y axis) of a GraphView
View is the base class all visible elements. View can render itself and contains zero or more nested views, called SubViews. View provides basic functionality for layout, arrangement, and drawing. In addition, View provides keyboard and mouse event handling.
See the View Deep Dive for more.
Args for events that relate to specific View
W3C color name resolver.
An overlapped container for other views with a border and optional title.
Provides navigation and a user interface (UI) to collect related data across multiple steps. Each step (WizardStep) can host arbitrary Views, much like a Dialog. Each step also has a pane for help text. Along the bottom of the Wizard view are customizable buttons enabling the user to navigate forward and backward through the Wizard.
EventArgs for WizardStep transition events.
Represents a basic step that is displayed in a Wizard. The WizardStep view is divided horizontally in two. On the left is the content view where Views can be added, On the right is the help for the step. Set HelpText to set the help text. If the help text is empty the help pane will not be shown. If there are no Views added to the WizardStep the HelpText (if not empty) will fill the wizard step.
Structs
Attributes represent how text is styled when displayed in the terminal.
Represents a single row/column in a Terminal.Gui rendering surface (e.g. LineCanvas andIConsoleDriver).
Args for events that relate to a specific Cell.
Represents a 24-bit color encoded in ARGB32 format.
Provides context for a Command invocation.
Provides a collection of Command objects stored in KeyBindings.
Provides a collection of MouseFlags bound to Commands.
Describes the thickness of a frame around a rectangle. Four int values describe theLeft, Top, Right, and Bottom sides of the rectangle, respectively.
Interfaces
Interface for FileDialog restrictions on which file type(s) the user is allowed to select/enter.
Describes an overlay element that is rendered either before or after a series.
Annotations can be positioned either in screen space (e.g. a legend) or in graph space (e.g. a line showing high point)
Unlike ISeries, annotations are allowed to draw into graph margins
When implemented in a derived class, allows watching an input stream of characters (i.e. console input) for ANSI response sequences (mouse input, cursor, query responses etc.).
Interface for instances that provide backing functionality to static gateway class Application.
Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options.
Definition to interact with the OS clipboard.
Navigates a collection of items using keystrokes. The keystrokes are used to build a search string. TheSearchString is used to find the next item in the collection that matches the search string whenGetNextMatchingItem(int, char) is called.
If the user types keystrokes that can't be found in the collection, the search string is cleared and the next item is found that starts with the last keystroke.
If the user pauses keystrokes for a short time (see TypingDelay), the search string is cleared.
Determines which keys trigger collection manager navigation and how to match typed strings to objects in the collection. Default implementation is Terminal.Gui.DefaultCollectionNavigatorMatcher.
Interface for algorithms that compute the relative distance between pairs of colors. This is used for color matching to a limited palette, such as in Sixel rendering.
When implemented by a class, allows mapping Color to human understandable name (e.g. w3c color names) and vice versa.
Describes the context in which a Command is being invoked. CommandContext inherits from this interface. When a Command is invoked, a context object is passed to Command handlers as an ICommandContext reference.
Base interface for Terminal.Gui ConsoleDriver implementations.
Interface for v2 driver abstraction layer
Interface for reading console input indefinitely - i.e. in an infinite loop. The class is responsible only for reading and storing the input in a thread safe input buffer which is then processed downstream e.g. on main UI thread.
Interface for writing console output
An interface to support custom formatting and parsing of Color values.
Interface declaring common functionality useful for designer implementations.
Interface for all ITableSource which present an object per row (of type T).
Interface for defining how to handle file/directory deletion, rename and newing attempts inFileDialog.
Describes an area fill (e.g. solid color or gradient).
Describes an input binding. Used to bind a set of Command objects to a specific input event.
Interface for main loop class that will process the queued input buffer contents. Is responsible for ProcessQueue() and translating into common Terminal.Gui events and data models.
Interface for subcomponent of a InputProcessor which can translate the raw console input type T (which typically varies by driver) to the shared Terminal.Gui Key class.
ICollectionNavigator sub-interface for ListView and TreeView. See alsoKeystrokeNavigator / TreeView.KeystrokeNavigator
Implement IListDataSource to provide custom rendering for a ListView.
Interface for main Terminal.Gui loop manager in v2.
Interface for main loop that runs the core Terminal.Gui UI loop.
Implement this interface to provide orientation support.
Describes the screen state that you want the console to be in. Is designed to be drawn to repeatedly then manifest into the console once at the end of iteration after all drawing is finalized.
Builds a palette of a given size for a given set of input colors.
Interface identifying a View as being capable of being a Popover.
Defines whether a given file/directory matches a set of search terms.
Describes a series of data that can be rendered into a GraphView>
Generates autocomplete Suggestion based on a given cursor location within a string
Tabular matrix of data to be displayed in a TableView.
Manages timers and idles
Interface for class that handles bespoke behaviours that occur when application top level changes.
Interface for supplying data to a TreeView on demand as root level nodes are expanded by the user
Interface to implement when you want the regular (non-generic) TreeView to automatically determine children for your class (without having to specify an ITreeBuilder)
Interface for all non-generic members of TreeView.See TreeView Deep Dive for more information.
Provides filtering for a TreeView.
Interface for classes responsible for reporting the current size of the terminal window.
Enums
Describes whether an operation should add or subtract values.
Determines the position of items when arranged in a container.
Determines alignment modes for Alignment.
The 16 foreground color codes used by ANSI Esc sequences for 256 color terminals. Add 10 to these values for background color.
Describes the current state of an IAnsiResponseParser
Determines the settings for Border.
Represents the state of a CheckBox.
Describes away of modelling color e.g. Hue Saturation Lightness.
Defines the 16 legacy color names and values that can be used to set the foreground and background colors in Terminal.Gui apps. Used with Color.
Actions which can be performed by a View.
Describes the location of the configuration files. The constants can be combined (bitwise) to specify multiple locations. The more significant the bit, the higher the priority meaning that the last location will override the earlier ones.
Terminal Cursor Visibility settings.
Specifies how Auto(DimAutoStyle, Dim?, Dim?) will compute the dimension.
Indicates the mode for a DimPercent object.
Indicates the dimension for Dim operations.
EscSeqUtils.ClearScreenOptions
Options for ANSI ESC "[xJ" - Clears part of the screen.
Styles for ANSI ESC "[x q" - Set Cursor Style
Styles for FlagSelector.
Describes the pattern that a Gradient results in e.g. Vertical,Horizontal etc
Describes the highlight style of a view when the mouse is over it.
The KeyCode enumeration encodes key information from IConsoleDrivers and provides a consistent way for application code to specify keys and receive key events.
The Key class provides a higher-level abstraction, with helper methods and properties for common operations. For example, IsAlt and IsCtrl provide a convenient way to check whether the Alt or Ctrl modifier keys were pressed when a key was pressed.
Defines the style of lines for a LineCanvas.
Specifies how a MenuItem shows selection state.
Mouse flags reported in MouseEventArgs.
Indicates navigation direction.
Determine which System.IO type to open.
Direction of an element (horizontal or vertical)
Specifies the format that a ProgressBar uses to indicate the visual presentation.
Specifies the style that a ProgressBar uses to indicate the progress of an operation.
Specifies the operation to perform when combining two regions or a Region with aRectangle>, defining how their rectangular areas are merged, intersected, or subtracted.
Defines the style of shadow to be drawn on the right and bottom sides of the View.
Indicates the side for Pos operations.
Slider Types
Describes how TabStop behaves. A TabStop is a stop-point for keyboard navigation between Views.
Text direction enumeration, controls how text is displayed.
Describes what user actions are enabled for arranging a View within it's SuperView. See Arrangement.
Enables diagnostic functions for View.
Settings for how the Viewport behaves.
Represents the W3C color names with their RGB values.
Delegates
Delegates of this type are used to fetch string representations of user's model objects
Delegate for providing color to TableView cells based on the value being rendered
Delegate for custom formatting of axis labels. Determines what should be displayed at a given label
Delegate for providing color for a whole row of a TableView
Represents a method that will handle splitter events.
Function signature commands.