Show / Hide Table of Contents

Namespace Terminal.Gui

Classes

Application

The application driver for gui.cs

Application.RunState

Captures the execution state for the provided TopLevel view.

Button

Button is a view that provides an item that invokes a callback when activated.

CheckBox

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

Clipboard

Colors

The default ColorSchemes for the application.

ColorScheme

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

ConsoleDriver

ConsoleDriver is an abstract class that defines the requirements for a console driver. One implementation if the CursesDriver, and another one uses the .NET Console one.

Dialog

The dialog box is a window that by default is centered and contains one or more buttons.

Dim

FileDialog

Base class for the OpenDialog and the SaveDialog

FrameView

The FrameView is a container frame that draws a frame around the contents

HexView

An Hex viewer an editor view over a System.IO.Stream

Label

Label view, displays a string at a given position, can include multiple lines.

ListView

ListView widget renders a list of data.

MenuBar

A menu bar for your application.

MenuBarItem

A menu bar item contains other menu items.

MenuItem

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

MessageBox

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

OpenDialog

The Open Dialog provides an interactive dialog box for users to select files or directories.

Pos

Describes a position 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

Progress bar can indicate progress of an activity visually.

RadioGroup

Radio group shows a group of labels, only one of those can be selected at a given time

Responder

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

SaveDialog

The save dialog 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 children views are added. Similar to the iOS UIScrollView.

TextField

Text data entry widget

TextView

Multi-line text editing view

Toplevel

Toplevel views can be modally executed.

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.

Window

A toplevel view that draws a frame around its region and has a "ContentView" subview where the contents are added.

Structs

Attribute

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

KeyEvent

Describes a keyboard event.

MouseEvent

Describes a mouse event

Point

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

Rect

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

Size

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

Interfaces

IListDataSource

Implement this interface to provide your own custom rendering for a list.

Enums

Color

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

Key

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

LayoutStyle

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

MouseFlags

Mouse flags reported in MouseEvent.

SpecialChar

Special characters that can be drawn with Driver.AddSpecial.

TextAlignment

Text alignment enumeration, controls how text is displayed.

Back to top Copyright © 2015-2017 Microsoft
Generated by DocFX