Search Results for

Show / Hide Table of Contents

# Namespace Terminal.Gui

### Classes

#### Application

A static, singleton class providing the main application driver for Terminal.Gui apps.

#### Application.ResizedEventArgs

Event arguments for the Resized event.

#### Application.RunState

Captures the execution state for the provided Toplevel view.

#### Attribute

Attributes are used as elements that contain both a foreground and a background or platform specific features

#### Autocomplete

Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options.

#### Border

Draws a border, background, or both around another element.

#### Border.ToplevelContainer

A sealed Toplevel derived class to implement Border feature. This is only a wrapper to get borders on a toplevel and is recommended using another derived, like Window where is possible to have borders with or without border line or spacing around.

#### BorderStyle

Specifies the border style for a View and to be used by the Border class.

#### Button

Button is a View that provides an item that invokes an System.Action when activated by the user.

#### CheckBox

The CheckBox View shows an on/off toggle that the user can set

#### Clipboard

Provides cut, copy, and paste support for the clipboard with OS interaction.

#### ClipboardBase

Shared abstract class to enforce rules from the implementation of the IClipboard interface.

#### Color

Basic colors that can be used to set the foreground and background colors in console applications.

#### ColorPicker

The ColorPicker View Color picker.

#### Colors

The default ColorSchemes for the application.

#### ColorScheme

Color scheme definitions, they cover some common scenarios and are used typically in containers such as Window and FrameView to set the scheme that is used by all the views contained inside.

#### ComboBox

Provides a drop-down list of items the user can select from.

#### Command

Actions which can be performed by the application or bound to keys in a View control.

#### ConsoleDriver

ConsoleDriver is an abstract class that defines the requirements for a console driver. There are currently three implementations: Terminal.Gui.CursesDriver (for Unix and Mac), Terminal.Gui.WindowsDriver, and Terminal.Gui.NetDriver that uses the .NET Console API.

#### ConsoleDriver.DiagnosticFlags

Enables diagnostic functions

#### ContextMenu

A context menu window derived from MenuBar containing menu items which can be opened in any position.

#### CursorVisibility

Cursors Visibility that are displayed

#### DateField

Simple Date editing View

#### DateTimeEventArgs<T>

Defines the event arguments for DateChanged and TimeChanged events.

#### Dialog

The Dialog View is a Window that by default is centered and contains one or more Buttons. It defaults to the Dialog color scheme and has a 1 cell padding around the edges.

#### Dialog.ButtonAlignments

Determines the horizontal alignment of the Dialog buttons.

#### Dim

Dim properties of a View to control the position.

#### DisplayModeLayout

Used for choose the display mode of this RadioGroup

#### FakeConsole

#### FakeDriver

Implements a mock ConsoleDriver for unit testing

#### FakeMainLoop

Mainloop intended to be used with the .NET System.Console API, and can be used on Windows and Unix, it is cross platform but lacks things like file descriptor monitoring.

#### FileDialog

Base class for the OpenDialog and the SaveDialog

#### FrameView

The FrameView is a container frame that draws a frame around the contents. It is similar to a GroupBox in Windows.

#### GraphView

Control for rendering graphs (bar, scatter etc)

#### HexView

An hex viewer and editor View over a System.IO.Stream

#### HexView.HexViewEventArgs

Defines the event arguments for PositionChanged event.

#### Key

The Key enumeration contains special encoding for some keys, but can also encode all the unicode values that can be passed.

#### KeyEvent

Describes a keyboard event.

#### KeyModifiers

Identifies the state of the "shift"-keys within a event.

#### Label

The Label View displays a string at a given position and supports multiple lines separated by newline characters. Multi-line Labels support word wrap.

#### LayoutStyle

Determines the LayoutStyle for a view, if Absolute, during LayoutSubviews, the value from the Frame will be used, if the value is Computed, then the Frame will be updated from the X, Y Pos objects and the Width and Height Dim objects.

#### LineView

A straight line control either horizontal or vertical

#### ListView

ListView View renders a scrollable list of data where each item can be activated to perform an action.

#### ListViewItemEventArgs

System.EventArgs for ListView events.

#### ListViewRowEventArgs

System.EventArgs used by the RowRender event.

#### ListWrapper

Implements an IListDataSource that renders arbitrary System.Collections.IList instances for ListView.

#### MainLoop

Simple main loop implementation that can be used to monitor file descriptor, run timers and idle handlers.

#### MainLoop.Timeout

Provides data for timers running manipulation.

#### MenuBar

Provides a menu bar with drop-down and cascading menus.

#### MenuBarItem

A MenuBarItem contains MenuBarItems or MenuItems.

#### MenuClosingEventArgs

An System.EventArgs which allows passing a cancelable menu closing event.

#### MenuItem

A MenuItem has a title, an associated help text, and an action to execute on activation.

#### MenuItemCheckStyle

Specifies how a MenuItem shows selection state.

#### MenuOpeningEventArgs

An System.EventArgs which allows passing a cancelable menu opening event or replacing with a new MenuBarItem.

#### MessageBox

MessageBox displays a modal message to the user, with a title, a message and a series of options that the user can choose from.

#### MouseEvent

Describes a mouse event

#### MouseFlags

Mouse flags reported in MouseEvent.

#### OpenDialog

The OpenDialogprovides an interactive dialog box for users to select files or directories.

#### OpenDialog.OpenMode

Determine which System.IO type to open.

#### PanelView

A container for single Child that will allow to drawn Border in two ways. If UsePanelFrame the borders and the child will be accommodated in the available panel size, otherwise the panel will be resized based on the child and borders thickness sizes.

#### Point

Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane.

#### PointF

Represents an ordered pair of x and y coordinates that define a point in a two-dimensional plane.

#### Pos

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.

#### ProgressBar

A Progress Bar view that can indicate progress of an activity visually.

#### ProgressBarFormat

Specifies the format that a ProgressBar uses to indicate the visual presentation.

#### ProgressBarStyle

Specifies the style that a ProgressBar uses to indicate the progress of an operation.

#### RadioGroup

Displays a group of labels each with a selected indicator. Only one of those can be selected at a given time.

#### Rect

Stores a set of four integers that represent the location and size of a rectangle

#### RectangleF

Stores the location and size of a rectangular region.

#### Responder

Responder base class implemented by objects that want to participate on keyboard and mouse input.

#### SaveDialog

The SaveDialog provides an interactive dialog box for users to pick a file to save.

#### ScrollBarView

ScrollBarViews are views that display a 1-character scrollbar, either horizontal or vertical

#### ScrollView

Scrollviews are views that present a window into a virtual space where subviews are added. Similar to the iOS UIScrollView.

#### SelectedItemChangedArgs

Event arguments for the SelectedItemChagned event.

#### ShortcutHelper

Represents a helper to manipulate shortcut keys used on views.

#### Size

Stores an ordered pair of integers, which specify a Height and Width.

#### SizeF

Represents the size of a rectangular region with an ordered pair of width and height.

#### StackExtensions

Extension of System.Collections.Generic.Stack<> helper to work with specific System.Collections.Generic.IEqualityComparer<>

#### StatusBar

A status bar is a View that snaps to the bottom of a Toplevel displaying set of StatusItems. 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 statusbar.

#### StatusItem

StatusItem objects are contained by StatusBar Views. Each StatusItem has a title, a shortcut (hotkey), and an Action that will be invoked when the Shortcut is pressed. The Shortcut will be a global hotkey for the application in the current context of the screen. The colour of the Title will be changed after each ~. A Title set to `~F1~ Help` will render as *F1* using HotNormal and *Help* as HotNormal.

#### TableView

View for tabular data based on a System.Data.DataTable. See TableView Deep Dive for more information.

#### TableView.CellActivatedEventArgs

Defines the event arguments for CellActivated event

#### TableView.CellColorGetterArgs

Arguments for a TableView.CellColorGetterDelegate. Describes a cell for which a rendering ColorScheme is being sought

#### TableView.CellColorGetterDelegate

Delegate for providing color to TableView cells based on the value being rendered

#### TableView.ColumnStyle

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.

#### TableView.RowColorGetterArgs

Arguments for TableView.RowColorGetterDelegate. Describes a row of data in a System.Data.DataTable for which ColorScheme is sought.

#### TableView.RowColorGetterDelegate

Delegate for providing color for a whole row of a TableView

#### TableView.SelectedCellChangedEventArgs

Defines the event arguments for SelectedCellChanged

#### TableView.TableSelection

Describes a selected region of the table

#### TableView.TableStyle

Defines rendering options that affect how the table is displayed. See TableView Deep Dive for more information.

#### TabView

Control that hosts multiple sub views, presenting a single one at once

#### TabView.Tab

A single tab in a TabView

#### TabView.TabChangedEventArgs

Describes a change in SelectedTab

#### TabView.TabStyle

Describes render stylistic selections of a TabView

#### TextAlignment

Text alignment enumeration, controls how text is displayed.

#### TextChangingEventArgs

An System.EventArgs which allows passing a cancelable new text value event.

#### TextDirection

Text direction enumeration, controls how text is displayed.

#### TextField

Single-line text entry View

#### TextFieldAutocomplete

Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options. An implementation on a TextField.

#### TextFormatter

Provides text formatting capabilities for console apps. Supports, hotkeys, horizontal alignment, multiple lines, and word-based line wrap.

#### TextValidateField

Text field that validates input through a ITextValidateProvider

#### TextView

Multi-line text editing View

#### TextViewAutocomplete

Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options. An implementation on a TextView.

#### Thickness

Describes the thickness of a frame around a rectangle. Four System.Int32 values describe the Left, Top, Right, and Bottom sides of the rectangle, respectively.

#### TimeField

Time editing View

#### Toplevel

Toplevel views can be modally executed. They are used for both an application's main view (filling the entire screeN and for pop-up views such as Dialog, MessageBox, and Wizard.

#### ToplevelClosingEventArgs

System.EventArgs implementation for the Closing event.

#### ToplevelComparer

Implements the System.Collections.Generic.IComparer<> to sort the Toplevel from the MdiChildes if needed.

#### ToplevelEqualityComparer

Implements the System.Collections.Generic.IEqualityComparer<> for comparing two Toplevels used by StackExtensions.

#### TreeView

Convenience implementation of generic TreeView<T> for any tree were all nodes implement ITreeNode. See TreeView Deep Dive for more information.

#### TreeView<T>

Hierarchical tree view with expandable branches. Branch objects are dynamically determined when expanded using a user defined ITreeBuilder<T> See TreeView Deep Dive for more information.

#### VerticalTextAlignment

Vertical text alignment enumeration, controls how text is displayed.

#### View

View is the base class for all views on the screen and represents a visible element that can render itself and contains zero or more nested views.

#### View.FocusEventArgs

Defines the event arguments for Terminal.Gui.View.SetFocus(Terminal.Gui.View)

#### View.KeyEventEventArgs

Defines the event arguments for KeyEvent

#### View.LayoutEventArgs

Event arguments for the LayoutComplete event.

#### View.MouseEventArgs

Specifies the event arguments for MouseEvent

#### Window

A Toplevel View that draws a border around its Frame with a Title at the top.

#### Window.TitleEventArgs

An System.EventArgs which allows passing a cancelable new Title value event.

#### Wizard

Provides navigation and a user interface (UI) to collect related data across multiple steps. Each step (Wizard.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.

#### Wizard.StepChangeEventArgs

System.EventArgs for Wizard.WizardStep events.

#### Wizard.WizardButtonEventArgs

System.EventArgs for Wizard.WizardStep transition events.

#### Wizard.WizardStep

Represents a basic step that is displayed in a Wizard. The Wizard.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.

#### Wizard.WizardStep.TitleEventArgs

An System.EventArgs which allows passing a cancelable new Title value event.

### Interfaces

#### IAutocomplete

Renders an overlay on another view at a given point that allows selecting from a range of 'autocomplete' options.

#### IClipboard

Definition to interact with the OS clipboard.

#### IListDataSource

Implement IListDataSource to provide custom rendering for a ListView.

#### IMainLoopDriver

Public interface to create your own platform specific main loop driver.

#### ITreeView

Interface for all non generic members of TreeView<T> See TreeView Deep Dive for more information.