123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708 |
- <!DOCTYPE html>
- <!--[if IE]><![endif]-->
- <html>
-
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
- <title>Namespace Terminal.Gui
- </title>
- <meta name="viewport" content="width=device-width">
- <meta name="title" content="Namespace Terminal.Gui
- ">
- <meta name="generator" content="docfx 2.59.3.0">
-
- <link rel="shortcut icon" href="../../favicon.ico">
- <link rel="stylesheet" href="../../styles/docfx.vendor.css">
- <link rel="stylesheet" href="../../styles/docfx.css">
- <link rel="stylesheet" href="../../styles/main.css">
- <link href="https://fonts.googleapis.com/css?family=Source Sans Pro" rel="stylesheet">
- <link href="https://fonts.googleapis.com/css?family=Source Code Pro" rel="stylesheet">
- <meta property="docfx:navrel" content="../../toc.html">
- <meta property="docfx:tocrel" content="toc.html">
-
- <meta property="docfx:rel" content="../../">
-
- </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
- <div id="wrapper">
- <header>
-
- <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
- <div class="container">
- <div class="navbar-header">
- <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
- <span class="sr-only">Toggle navigation</span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
-
- <a class="navbar-brand" href="../../index.html">
- <img id="logo" class="svg" src="../../images/logo48.png" alt="">
- </a>
- </div>
- <div class="collapse navbar-collapse" id="navbar">
- <form class="navbar-form navbar-right" role="search" id="search">
- <div class="form-group">
- <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
- </div>
- </form>
- </div>
- </div>
- </nav>
-
- <div class="subnav navbar navbar-default">
- <div class="container hide-when-search" id="breadcrumb">
- <ul class="breadcrumb">
- <li></li>
- </ul>
- </div>
- </div>
- </header>
- <div class="container body-content">
-
- <div id="search-results">
- <div class="search-list">Search Results for <span></span></div>
- <div class="sr-items">
- <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
- </div>
- <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
- </div>
- </div>
- <div role="main" class="container body-content hide-when-search">
-
- <div class="sidenav hide-when-search">
- <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
- <div class="sidetoggle collapse" id="sidetoggle">
- <div id="sidetoc"></div>
- </div>
- </div>
- <div class="article row grid-right">
- <div class="col-md-10">
- <article class="content wrap" id="_content" data-uid="Terminal.Gui">
-
- <h1 id="Terminal_Gui" data-uid="Terminal.Gui" class="text-break">Namespace Terminal.Gui
- </h1>
- <div class="markdown level0 summary"></div>
- <div class="markdown level0 conceptual"></div>
- <div class="markdown level0 remarks"></div>
- <h3 id="classes">Classes
- </h3>
- <h4><a class="xref" href="Terminal.Gui.Application.html">Application</a></h4>
- <section>
- A static, singleton class providing the main application driver for Terminal.Gui apps.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Application.ResizedEventArgs.html">Application.ResizedEventArgs</a></h4>
- <section>
- Event arguments for the <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_Resized">Resized</a> event.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Application.RunState.html">Application.RunState</a></h4>
- <section>
- Captures the execution state for the provided <a class="xref" href="Terminal.Gui.Application.RunState.html#Terminal_Gui_Application_RunState_Toplevel">Toplevel</a> view.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></h4>
- <section>
- Attributes are used as elements that contain both a foreground and a background or platform specific features
- </section>
- <h4><a class="xref" href="Terminal.Gui.Autocomplete.html">Autocomplete</a></h4>
- <section>
- Renders an overlay on another view at a given point that allows selecting
- from a range of 'autocomplete' options.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Border.html">Border</a></h4>
- <section>
- Draws a border, background, or both around another element.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Border.ToplevelContainer.html">Border.ToplevelContainer</a></h4>
- <section>
- A sealed <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> derived class to implement <a class="xref" href="Terminal.Gui.Border.ToplevelContainer.html#Terminal_Gui_Border_ToplevelContainer_Border">Border</a> feature.
- This is only a wrapper to get borders on a toplevel and is recommended using another
- derived, like <a class="xref" href="Terminal.Gui.Window.html">Window</a> where is possible to have borders with or without
- border line or spacing around.
- </section>
- <h4><a class="xref" href="Terminal.Gui.BorderStyle.html">BorderStyle</a></h4>
- <section>
- Specifies the border style for a <a class="xref" href="Terminal.Gui.View.html">View</a> and to be used by the <a class="xref" href="Terminal.Gui.Border.html">Border</a> class.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Button.html">Button</a></h4>
- <section>
- Button is a <a class="xref" href="Terminal.Gui.View.html">View</a> that provides an item that invokes an <span class="xref">System.Action</span> when activated by the user.
- </section>
- <h4><a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a></h4>
- <section>
- The <a class="xref" href="Terminal.Gui.CheckBox.html">CheckBox</a> <a class="xref" href="Terminal.Gui.View.html">View</a> shows an on/off toggle that the user can set
- </section>
- <h4><a class="xref" href="Terminal.Gui.Clipboard.html">Clipboard</a></h4>
- <section>
- Provides cut, copy, and paste support for the clipboard with OS interaction.
- </section>
- <h4><a class="xref" href="Terminal.Gui.ClipboardBase.html">ClipboardBase</a></h4>
- <section>
- Shared abstract class to enforce rules from the implementation of the <a class="xref" href="Terminal.Gui.IClipboard.html">IClipboard</a> interface.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Color.html">Color</a></h4>
- <section>
- Basic colors that can be used to set the foreground and background colors in console applications.
- </section>
- <h4><a class="xref" href="Terminal.Gui.ColorPicker.html">ColorPicker</a></h4>
- <section>
- The <a class="xref" href="Terminal.Gui.ColorPicker.html">ColorPicker</a> <a class="xref" href="Terminal.Gui.View.html">View</a> Color picker.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Colors.html">Colors</a></h4>
- <section>
- The default <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a>s for the application.
- </section>
- <h4><a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a></h4>
- <section>
- Color scheme definitions, they cover some common scenarios and are used
- typically in containers such as <a class="xref" href="Terminal.Gui.Window.html">Window</a> and <a class="xref" href="Terminal.Gui.FrameView.html">FrameView</a> to set the scheme that is used by all the
- views contained inside.
- </section>
- <h4><a class="xref" href="Terminal.Gui.ComboBox.html">ComboBox</a></h4>
- <section>
- Provides a drop-down list of items the user can select from.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Command.html">Command</a></h4>
- <section>
- Actions which can be performed by the application or bound to keys in a <a class="xref" href="Terminal.Gui.View.html">View</a> control.
- </section>
- <h4><a class="xref" href="Terminal.Gui.ConsoleDriver.html">ConsoleDriver</a></h4>
- <section>
- ConsoleDriver is an abstract class that defines the requirements for a console driver.
- There are currently three implementations: <span class="xref">Terminal.Gui.CursesDriver</span> (for Unix and Mac), <span class="xref">Terminal.Gui.WindowsDriver</span>, and <span class="xref">Terminal.Gui.NetDriver</span> that uses the .NET Console API.
- </section>
- <h4><a class="xref" href="Terminal.Gui.ConsoleDriver.DiagnosticFlags.html">ConsoleDriver.DiagnosticFlags</a></h4>
- <section>
- Enables diagnostic functions
- </section>
- <h4><a class="xref" href="Terminal.Gui.ContextMenu.html">ContextMenu</a></h4>
- <section>
- A context menu window derived from <a class="xref" href="Terminal.Gui.ContextMenu.html#Terminal_Gui_ContextMenu_MenuBar">MenuBar</a> containing menu items
- which can be opened in any position.
- </section>
- <h4><a class="xref" href="Terminal.Gui.CursorVisibility.html">CursorVisibility</a></h4>
- <section>
- Cursors Visibility that are displayed
- </section>
- <h4><a class="xref" href="Terminal.Gui.DateField.html">DateField</a></h4>
- <section>
- Simple Date editing <a class="xref" href="Terminal.Gui.View.html">View</a>
- </section>
- <h4><a class="xref" href="Terminal.Gui.DateTimeEventArgs-1.html">DateTimeEventArgs<T></a></h4>
- <section>
- Defines the event arguments for <a class="xref" href="Terminal.Gui.DateField.html#Terminal_Gui_DateField_DateChanged">DateChanged</a> and <a class="xref" href="Terminal.Gui.TimeField.html#Terminal_Gui_TimeField_TimeChanged">TimeChanged</a> events.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a></h4>
- <section>
- The <a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a> <a class="xref" href="Terminal.Gui.View.html">View</a> is a <a class="xref" href="Terminal.Gui.Window.html">Window</a> that by default is centered and contains one
- or more <a class="xref" href="Terminal.Gui.Button.html">Button</a>s. It defaults to the <a class="xref" href="Terminal.Gui.Colors.html#Terminal_Gui_Colors_Dialog">Dialog</a> color scheme and has a 1 cell padding around the edges.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Dialog.ButtonAlignments.html">Dialog.ButtonAlignments</a></h4>
- <section>
- Determines the horizontal alignment of the Dialog buttons.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Dim.html">Dim</a></h4>
- <section>
- Dim properties of a <a class="xref" href="Terminal.Gui.View.html">View</a> to control the position.
- </section>
- <h4><a class="xref" href="Terminal.Gui.DisplayModeLayout.html">DisplayModeLayout</a></h4>
- <section>
- Used for choose the display mode of this <a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a>
- </section>
- <h4><a class="xref" href="Terminal.Gui.FakeConsole.html">FakeConsole</a></h4>
- <section>
- </section>
- <h4><a class="xref" href="Terminal.Gui.FakeDriver.html">FakeDriver</a></h4>
- <section>
- Implements a mock ConsoleDriver for unit testing
- </section>
- <h4><a class="xref" href="Terminal.Gui.FakeMainLoop.html">FakeMainLoop</a></h4>
- <section>
- 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.
- </section>
- <h4><a class="xref" href="Terminal.Gui.FileDialog.html">FileDialog</a></h4>
- <section>
- Base class for the <a class="xref" href="Terminal.Gui.OpenDialog.html">OpenDialog</a> and the <a class="xref" href="Terminal.Gui.SaveDialog.html">SaveDialog</a>
- </section>
- <h4><a class="xref" href="Terminal.Gui.FrameView.html">FrameView</a></h4>
- <section>
- The FrameView is a container frame that draws a frame around the contents. It is similar to
- a GroupBox in Windows.
- </section>
- <h4><a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a></h4>
- <section>
- Control for rendering graphs (bar, scatter etc)
- </section>
- <h4><a class="xref" href="Terminal.Gui.HexView.html">HexView</a></h4>
- <section>
- An hex viewer and editor <a class="xref" href="Terminal.Gui.View.html">View</a> over a <span class="xref">System.IO.Stream</span>
- </section>
- <h4><a class="xref" href="Terminal.Gui.HexView.HexViewEventArgs.html">HexView.HexViewEventArgs</a></h4>
- <section>
- Defines the event arguments for <a class="xref" href="Terminal.Gui.HexView.html#Terminal_Gui_HexView_PositionChanged">PositionChanged</a> event.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Key.html">Key</a></h4>
- <section>
- The <a class="xref" href="Terminal.Gui.Key.html">Key</a> enumeration contains special encoding for some keys, but can also
- encode all the unicode values that can be passed.
- </section>
- <h4><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></h4>
- <section>
- Describes a keyboard event.
- </section>
- <h4><a class="xref" href="Terminal.Gui.KeyModifiers.html">KeyModifiers</a></h4>
- <section>
- Identifies the state of the "shift"-keys within a event.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Label.html">Label</a></h4>
- <section>
- The Label <a class="xref" href="Terminal.Gui.View.html">View</a> displays a string at a given position and supports multiple lines separated by newline characters.
- Multi-line Labels support word wrap.
- </section>
- <h4><a class="xref" href="Terminal.Gui.LayoutStyle.html">LayoutStyle</a></h4>
- <section>
- 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.
- </section>
- <h4><a class="xref" href="Terminal.Gui.LineView.html">LineView</a></h4>
- <section>
- A straight line control either horizontal or vertical
- </section>
- <h4><a class="xref" href="Terminal.Gui.ListView.html">ListView</a></h4>
- <section>
- ListView <a class="xref" href="Terminal.Gui.View.html">View</a> renders a scrollable list of data where each item can be activated to perform an action.
- </section>
- <h4><a class="xref" href="Terminal.Gui.ListViewItemEventArgs.html">ListViewItemEventArgs</a></h4>
- <section>
- <span class="xref">System.EventArgs</span> for <a class="xref" href="Terminal.Gui.ListView.html">ListView</a> events.
- </section>
- <h4><a class="xref" href="Terminal.Gui.ListViewRowEventArgs.html">ListViewRowEventArgs</a></h4>
- <section>
- <span class="xref">System.EventArgs</span> used by the <a class="xref" href="Terminal.Gui.ListView.html#Terminal_Gui_ListView_RowRender">RowRender</a> event.
- </section>
- <h4><a class="xref" href="Terminal.Gui.ListWrapper.html">ListWrapper</a></h4>
- <section>
- Implements an <a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a> that renders arbitrary <span class="xref">System.Collections.IList</span> instances for <a class="xref" href="Terminal.Gui.ListView.html">ListView</a>.
- </section>
- <h4><a class="xref" href="Terminal.Gui.MainLoop.html">MainLoop</a></h4>
- <section>
- Simple main loop implementation that can be used to monitor
- file descriptor, run timers and idle handlers.
- </section>
- <h4><a class="xref" href="Terminal.Gui.MainLoop.Timeout.html">MainLoop.Timeout</a></h4>
- <section>
- Provides data for timers running manipulation.
- </section>
- <h4><a class="xref" href="Terminal.Gui.MenuBar.html">MenuBar</a></h4>
- <section>
- Provides a menu bar with drop-down and cascading menus.
- </section>
- <h4><a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a></h4>
- <section>
- A <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a> contains <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a>s or <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a>s.
- </section>
- <h4><a class="xref" href="Terminal.Gui.MenuClosingEventArgs.html">MenuClosingEventArgs</a></h4>
- <section>
- An <span class="xref">System.EventArgs</span> which allows passing a cancelable menu closing event.
- </section>
- <h4><a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a></h4>
- <section>
- A <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> has a title, an associated help text, and an action to execute on activation.
- </section>
- <h4><a class="xref" href="Terminal.Gui.MenuItemCheckStyle.html">MenuItemCheckStyle</a></h4>
- <section>
- Specifies how a <a class="xref" href="Terminal.Gui.MenuItem.html">MenuItem</a> shows selection state.
- </section>
- <h4><a class="xref" href="Terminal.Gui.MenuOpeningEventArgs.html">MenuOpeningEventArgs</a></h4>
- <section>
- An <span class="xref">System.EventArgs</span> which allows passing a cancelable menu opening event or replacing with a new <a class="xref" href="Terminal.Gui.MenuBarItem.html">MenuBarItem</a>.
- </section>
- <h4><a class="xref" href="Terminal.Gui.MessageBox.html">MessageBox</a></h4>
- <section>
- MessageBox displays a modal message to the user, with a title, a message and a series of options that the user can choose from.
- </section>
- <h4><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></h4>
- <section>
- Describes a mouse event
- </section>
- <h4><a class="xref" href="Terminal.Gui.MouseFlags.html">MouseFlags</a></h4>
- <section>
- Mouse flags reported in <a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a>.
- </section>
- <h4><a class="xref" href="Terminal.Gui.OpenDialog.html">OpenDialog</a></h4>
- <section>
- The <a class="xref" href="Terminal.Gui.OpenDialog.html">OpenDialog</a>provides an interactive dialog box for users to select files or directories.
- </section>
- <h4><a class="xref" href="Terminal.Gui.OpenDialog.OpenMode.html">OpenDialog.OpenMode</a></h4>
- <section>
- Determine which <span class="xref">System.IO</span> type to open.
- </section>
- <h4><a class="xref" href="Terminal.Gui.PanelView.html">PanelView</a></h4>
- <section>
- A container for single <a class="xref" href="Terminal.Gui.PanelView.html#Terminal_Gui_PanelView_Child">Child</a> that will allow to drawn <a class="xref" href="Terminal.Gui.PanelView.html#Terminal_Gui_PanelView_Border">Border</a> in
- two ways. If <a class="xref" href="Terminal.Gui.PanelView.html#Terminal_Gui_PanelView_UsePanelFrame">UsePanelFrame</a> 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.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Point.html">Point</a></h4>
- <section>
- Represents an ordered pair of integer x- and y-coordinates that defines a point in a two-dimensional plane.
- </section>
- <h4><a class="xref" href="Terminal.Gui.PointF.html">PointF</a></h4>
- <section>
- Represents an ordered pair of x and y coordinates that define a point in a two-dimensional plane.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Pos.html">Pos</a></h4>
- <section>
- Describes the position of a <a class="xref" href="Terminal.Gui.View.html">View</a> which can be an absolute value, a percentage, centered, or
- relative to the ending dimension. Integer values are implicitly convertible to
- an absolute <a class="xref" href="Terminal.Gui.Pos.html">Pos</a>. These objects are created using the static methods Percent,
- AnchorEnd, and Center. The <a class="xref" href="Terminal.Gui.Pos.html">Pos</a> objects can be combined with the addition and
- subtraction operators.
- </section>
- <h4><a class="xref" href="Terminal.Gui.ProgressBar.html">ProgressBar</a></h4>
- <section>
- A Progress Bar view that can indicate progress of an activity visually.
- </section>
- <h4><a class="xref" href="Terminal.Gui.ProgressBarFormat.html">ProgressBarFormat</a></h4>
- <section>
- Specifies the format that a <a class="xref" href="Terminal.Gui.ProgressBar.html">ProgressBar</a> uses to indicate the visual presentation.
- </section>
- <h4><a class="xref" href="Terminal.Gui.ProgressBarStyle.html">ProgressBarStyle</a></h4>
- <section>
- Specifies the style that a <a class="xref" href="Terminal.Gui.ProgressBar.html">ProgressBar</a> uses to indicate the progress of an operation.
- </section>
- <h4><a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a></h4>
- <section>
- Displays a group of labels each with a selected indicator. Only one of those can be selected at a given time.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></h4>
- <section>
- Stores a set of four integers that represent the location and size of a rectangle
- </section>
- <h4><a class="xref" href="Terminal.Gui.RectangleF.html">RectangleF</a></h4>
- <section>
- Stores the location and size of a rectangular region.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></h4>
- <section>
- Responder base class implemented by objects that want to participate on keyboard and mouse input.
- </section>
- <h4><a class="xref" href="Terminal.Gui.SaveDialog.html">SaveDialog</a></h4>
- <section>
- The <a class="xref" href="Terminal.Gui.SaveDialog.html">SaveDialog</a> provides an interactive dialog box for users to pick a file to
- save.
- </section>
- <h4><a class="xref" href="Terminal.Gui.ScrollBarView.html">ScrollBarView</a></h4>
- <section>
- ScrollBarViews are views that display a 1-character scrollbar, either horizontal or vertical
- </section>
- <h4><a class="xref" href="Terminal.Gui.ScrollView.html">ScrollView</a></h4>
- <section>
- Scrollviews are views that present a window into a virtual space where subviews are added. Similar to the iOS UIScrollView.
- </section>
- <h4><a class="xref" href="Terminal.Gui.SelectedItemChangedArgs.html">SelectedItemChangedArgs</a></h4>
- <section>
- Event arguments for the SelectedItemChagned event.
- </section>
- <h4><a class="xref" href="Terminal.Gui.ShortcutHelper.html">ShortcutHelper</a></h4>
- <section>
- Represents a helper to manipulate shortcut keys used on views.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Size.html">Size</a></h4>
- <section>
- Stores an ordered pair of integers, which specify a Height and Width.
- </section>
- <h4><a class="xref" href="Terminal.Gui.SizeF.html">SizeF</a></h4>
- <section>
- Represents the size of a rectangular region with an ordered pair of width and height.
- </section>
- <h4><a class="xref" href="Terminal.Gui.StackExtensions.html">StackExtensions</a></h4>
- <section>
- Extension of <span class="xref">System.Collections.Generic.Stack<></span> helper to work with specific <span class="xref">System.Collections.Generic.IEqualityComparer<></span>
- </section>
- <h4><a class="xref" href="Terminal.Gui.StatusBar.html">StatusBar</a></h4>
- <section>
- A status bar is a <a class="xref" href="Terminal.Gui.View.html">View</a> that snaps to the bottom of a <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> displaying set of <a class="xref" href="Terminal.Gui.StatusItem.html">StatusItem</a>s.
- The <a class="xref" href="Terminal.Gui.StatusBar.html">StatusBar</a> 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.
- </section>
- <h4><a class="xref" href="Terminal.Gui.StatusItem.html">StatusItem</a></h4>
- <section>
- <a class="xref" href="Terminal.Gui.StatusItem.html">StatusItem</a> objects are contained by <a class="xref" href="Terminal.Gui.StatusBar.html">StatusBar</a> <a class="xref" href="Terminal.Gui.View.html">View</a>s.
- Each <a class="xref" href="Terminal.Gui.StatusItem.html">StatusItem</a> has a title, a shortcut (hotkey), and an <a class="xref" href="Terminal.Gui.StatusItem.html#Terminal_Gui_StatusItem_Action">Action</a> that will be invoked when the
- <a class="xref" href="Terminal.Gui.StatusItem.html#Terminal_Gui_StatusItem_Shortcut">Shortcut</a> is pressed.
- The <a class="xref" href="Terminal.Gui.StatusItem.html#Terminal_Gui_StatusItem_Shortcut">Shortcut</a> will be a global hotkey for the application in the current context of the screen.
- The colour of the <a class="xref" href="Terminal.Gui.StatusItem.html#Terminal_Gui_StatusItem_Title">Title</a> will be changed after each ~.
- A <a class="xref" href="Terminal.Gui.StatusItem.html#Terminal_Gui_StatusItem_Title">Title</a> set to `~F1~ Help` will render as *F1* using <a class="xref" href="Terminal.Gui.ColorScheme.html#Terminal_Gui_ColorScheme_HotNormal">HotNormal</a> and
- *Help* as <a class="xref" href="Terminal.Gui.ColorScheme.html#Terminal_Gui_ColorScheme_HotNormal">HotNormal</a>.
- </section>
- <h4><a class="xref" href="Terminal.Gui.TableView.html">TableView</a></h4>
- <section>
- View for tabular data based on a <span class="xref">System.Data.DataTable</span>.
- <a href="https://migueldeicaza.github.io/gui.cs/articles/tableview.html">See TableView Deep Dive for more information</a>.
- </section>
- <h4><a class="xref" href="Terminal.Gui.TableView.CellActivatedEventArgs.html">TableView.CellActivatedEventArgs</a></h4>
- <section>
- Defines the event arguments for <a class="xref" href="Terminal.Gui.TableView.html#Terminal_Gui_TableView_CellActivated">CellActivated</a> event
- </section>
- <h4><a class="xref" href="Terminal.Gui.TableView.CellColorGetterArgs.html">TableView.CellColorGetterArgs</a></h4>
- <section>
- Arguments for a <a class="xref" href="Terminal.Gui.TableView.CellColorGetterDelegate.html">TableView.CellColorGetterDelegate</a>. Describes a cell for which a rendering
- <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a> is being sought
- </section>
- <h4><a class="xref" href="Terminal.Gui.TableView.CellColorGetterDelegate.html">TableView.CellColorGetterDelegate</a></h4>
- <section>
- Delegate for providing color to <a class="xref" href="Terminal.Gui.TableView.html">TableView</a> cells based on the value being rendered
- </section>
- <h4><a class="xref" href="Terminal.Gui.TableView.ColumnStyle.html">TableView.ColumnStyle</a></h4>
- <section>
- Describes how to render a given column in a <a class="xref" href="Terminal.Gui.TableView.html">TableView</a> including <a class="xref" href="Terminal.Gui.TableView.ColumnStyle.html#Terminal_Gui_TableView_ColumnStyle_Alignment">Alignment</a>
- and textual representation of cells (e.g. date formats)
- <a href="https://migueldeicaza.github.io/gui.cs/articles/tableview.html">See TableView Deep Dive for more information</a>.
- </section>
- <h4><a class="xref" href="Terminal.Gui.TableView.RowColorGetterArgs.html">TableView.RowColorGetterArgs</a></h4>
- <section>
- Arguments for <a class="xref" href="Terminal.Gui.TableView.RowColorGetterDelegate.html">TableView.RowColorGetterDelegate</a>. Describes a row of data in a <span class="xref">System.Data.DataTable</span>
- for which <a class="xref" href="Terminal.Gui.ColorScheme.html">ColorScheme</a> is sought.
- </section>
- <h4><a class="xref" href="Terminal.Gui.TableView.RowColorGetterDelegate.html">TableView.RowColorGetterDelegate</a></h4>
- <section>
- Delegate for providing color for a whole row of a <a class="xref" href="Terminal.Gui.TableView.html">TableView</a>
- </section>
- <h4><a class="xref" href="Terminal.Gui.TableView.SelectedCellChangedEventArgs.html">TableView.SelectedCellChangedEventArgs</a></h4>
- <section>
- Defines the event arguments for <a class="xref" href="Terminal.Gui.TableView.html#Terminal_Gui_TableView_SelectedCellChanged">SelectedCellChanged</a>
- </section>
- <h4><a class="xref" href="Terminal.Gui.TableView.TableSelection.html">TableView.TableSelection</a></h4>
- <section>
- Describes a selected region of the table
- </section>
- <h4><a class="xref" href="Terminal.Gui.TableView.TableStyle.html">TableView.TableStyle</a></h4>
- <section>
- Defines rendering options that affect how the table is displayed.
- <a href="https://migueldeicaza.github.io/gui.cs/articles/tableview.html">See TableView Deep Dive for more information</a>.
- </section>
- <h4><a class="xref" href="Terminal.Gui.TabView.html">TabView</a></h4>
- <section>
- Control that hosts multiple sub views, presenting a single one at once
- </section>
- <h4><a class="xref" href="Terminal.Gui.TabView.Tab.html">TabView.Tab</a></h4>
- <section>
- A single tab in a <a class="xref" href="Terminal.Gui.TabView.html">TabView</a>
- </section>
- <h4><a class="xref" href="Terminal.Gui.TabView.TabChangedEventArgs.html">TabView.TabChangedEventArgs</a></h4>
- <section>
- Describes a change in <a class="xref" href="Terminal.Gui.TabView.html#Terminal_Gui_TabView_SelectedTab">SelectedTab</a>
- </section>
- <h4><a class="xref" href="Terminal.Gui.TabView.TabStyle.html">TabView.TabStyle</a></h4>
- <section>
- Describes render stylistic selections of a <a class="xref" href="Terminal.Gui.TabView.html">TabView</a>
- </section>
- <h4><a class="xref" href="Terminal.Gui.TextAlignment.html">TextAlignment</a></h4>
- <section>
- Text alignment enumeration, controls how text is displayed.
- </section>
- <h4><a class="xref" href="Terminal.Gui.TextChangingEventArgs.html">TextChangingEventArgs</a></h4>
- <section>
- An <span class="xref">System.EventArgs</span> which allows passing a cancelable new text value event.
- </section>
- <h4><a class="xref" href="Terminal.Gui.TextDirection.html">TextDirection</a></h4>
- <section>
- Text direction enumeration, controls how text is displayed.
- </section>
- <h4><a class="xref" href="Terminal.Gui.TextField.html">TextField</a></h4>
- <section>
- Single-line text entry <a class="xref" href="Terminal.Gui.View.html">View</a>
- </section>
- <h4><a class="xref" href="Terminal.Gui.TextFieldAutocomplete.html">TextFieldAutocomplete</a></h4>
- <section>
- Renders an overlay on another view at a given point that allows selecting
- from a range of 'autocomplete' options.
- An implementation on a TextField.
- </section>
- <h4><a class="xref" href="Terminal.Gui.TextFormatter.html">TextFormatter</a></h4>
- <section>
- Provides text formatting capabilities for console apps. Supports, hotkeys, horizontal alignment, multiple lines, and word-based line wrap.
- </section>
- <h4><a class="xref" href="Terminal.Gui.TextValidateField.html">TextValidateField</a></h4>
- <section>
- Text field that validates input through a <a class="xref" href="Terminal.Gui.TextValidateProviders.ITextValidateProvider.html">ITextValidateProvider</a>
- </section>
- <h4><a class="xref" href="Terminal.Gui.TextView.html">TextView</a></h4>
- <section>
- Multi-line text editing <a class="xref" href="Terminal.Gui.View.html">View</a>
- </section>
- <h4><a class="xref" href="Terminal.Gui.TextViewAutocomplete.html">TextViewAutocomplete</a></h4>
- <section>
- Renders an overlay on another view at a given point that allows selecting
- from a range of 'autocomplete' options.
- An implementation on a TextView.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Thickness.html">Thickness</a></h4>
- <section>
- Describes the thickness of a frame around a rectangle. Four <span class="xref">System.Int32</span> values describe
- the <a class="xref" href="Terminal.Gui.Thickness.html#Terminal_Gui_Thickness_Left">Left</a>, <a class="xref" href="Terminal.Gui.Thickness.html#Terminal_Gui_Thickness_Top">Top</a>, <a class="xref" href="Terminal.Gui.Thickness.html#Terminal_Gui_Thickness_Right">Right</a>, and <a class="xref" href="Terminal.Gui.Thickness.html#Terminal_Gui_Thickness_Bottom">Bottom</a> sides
- of the rectangle, respectively.
- </section>
- <h4><a class="xref" href="Terminal.Gui.TimeField.html">TimeField</a></h4>
- <section>
- Time editing <a class="xref" href="Terminal.Gui.View.html">View</a>
- </section>
- <h4><a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a></h4>
- <section>
- 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 <a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a>, <a class="xref" href="Terminal.Gui.MessageBox.html">MessageBox</a>, and <a class="xref" href="Terminal.Gui.Wizard.html">Wizard</a>.
- </section>
- <h4><a class="xref" href="Terminal.Gui.ToplevelClosingEventArgs.html">ToplevelClosingEventArgs</a></h4>
- <section>
- <span class="xref">System.EventArgs</span> implementation for the <a class="xref" href="Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Closing">Closing</a> event.
- </section>
- <h4><a class="xref" href="Terminal.Gui.ToplevelComparer.html">ToplevelComparer</a></h4>
- <section>
- Implements the <span class="xref">System.Collections.Generic.IComparer<></span> to sort the <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a>
- from the <a class="xref" href="Terminal.Gui.Application.html#Terminal_Gui_Application_MdiChildes">MdiChildes</a> if needed.
- </section>
- <h4><a class="xref" href="Terminal.Gui.ToplevelEqualityComparer.html">ToplevelEqualityComparer</a></h4>
- <section>
- Implements the <span class="xref">System.Collections.Generic.IEqualityComparer<></span> for comparing two <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a>s
- used by <a class="xref" href="Terminal.Gui.StackExtensions.html">StackExtensions</a>.
- </section>
- <h4><a class="xref" href="Terminal.Gui.TreeView.html">TreeView</a></h4>
- <section>
- Convenience implementation of generic <a class="xref" href="Terminal.Gui.TreeView-1.html">TreeView<T></a> for any tree were all nodes
- implement <a class="xref" href="Terminal.Gui.Trees.ITreeNode.html">ITreeNode</a>.
- <a href="https://migueldeicaza.github.io/gui.cs/articles/treeview.html">See TreeView Deep Dive for more information</a>.
- </section>
- <h4><a class="xref" href="Terminal.Gui.TreeView-1.html">TreeView<T></a></h4>
- <section>
- Hierarchical tree view with expandable branches. Branch objects are dynamically determined
- when expanded using a user defined <a class="xref" href="Terminal.Gui.Trees.ITreeBuilder-1.html">ITreeBuilder<T></a>
- <a href="https://migueldeicaza.github.io/gui.cs/articles/treeview.html">See TreeView Deep Dive for more information</a>.
- </section>
- <h4><a class="xref" href="Terminal.Gui.VerticalTextAlignment.html">VerticalTextAlignment</a></h4>
- <section>
- Vertical text alignment enumeration, controls how text is displayed.
- </section>
- <h4><a class="xref" href="Terminal.Gui.View.html">View</a></h4>
- <section>
- 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.
- </section>
- <h4><a class="xref" href="Terminal.Gui.View.FocusEventArgs.html">View.FocusEventArgs</a></h4>
- <section>
- Defines the event arguments for <span class="xref">Terminal.Gui.View.SetFocus(Terminal.Gui.View)</span>
- </section>
- <h4><a class="xref" href="Terminal.Gui.View.KeyEventEventArgs.html">View.KeyEventEventArgs</a></h4>
- <section>
- Defines the event arguments for <a class="xref" href="Terminal.Gui.View.KeyEventEventArgs.html#Terminal_Gui_View_KeyEventEventArgs_KeyEvent">KeyEvent</a>
- </section>
- <h4><a class="xref" href="Terminal.Gui.View.LayoutEventArgs.html">View.LayoutEventArgs</a></h4>
- <section>
- Event arguments for the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">LayoutComplete</a> event.
- </section>
- <h4><a class="xref" href="Terminal.Gui.View.MouseEventArgs.html">View.MouseEventArgs</a></h4>
- <section>
- Specifies the event arguments for <a class="xref" href="Terminal.Gui.View.MouseEventArgs.html#Terminal_Gui_View_MouseEventArgs_MouseEvent">MouseEvent</a>
- </section>
- <h4><a class="xref" href="Terminal.Gui.Window.html">Window</a></h4>
- <section>
- A <a class="xref" href="Terminal.Gui.Toplevel.html">Toplevel</a> <a class="xref" href="Terminal.Gui.View.html">View</a> that draws a border around its <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> with a <a class="xref" href="Terminal.Gui.Window.html#Terminal_Gui_Window_Title">Title</a> at the top.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Window.TitleEventArgs.html">Window.TitleEventArgs</a></h4>
- <section>
- An <span class="xref">System.EventArgs</span> which allows passing a cancelable new <a class="xref" href="Terminal.Gui.Window.html#Terminal_Gui_Window_Title">Title</a> value event.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Wizard.html">Wizard</a></h4>
- <section>
- Provides navigation and a user interface (UI) to collect related data across multiple steps. Each step (<a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a>) can host
- arbitrary <a class="xref" href="Terminal.Gui.View.html">View</a>s, much like a <a class="xref" href="Terminal.Gui.Dialog.html">Dialog</a>. 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.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Wizard.StepChangeEventArgs.html">Wizard.StepChangeEventArgs</a></h4>
- <section>
- <span class="xref">System.EventArgs</span> for <a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a> events.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Wizard.WizardButtonEventArgs.html">Wizard.WizardButtonEventArgs</a></h4>
- <section>
- <span class="xref">System.EventArgs</span> for <a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a> transition events.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a></h4>
- <section>
- Represents a basic step that is displayed in a <a class="xref" href="Terminal.Gui.Wizard.html">Wizard</a>. The <a class="xref" href="Terminal.Gui.Wizard.WizardStep.html">Wizard.WizardStep</a> view is divided horizontally in two. On the left is the
- content view where <a class="xref" href="Terminal.Gui.View.html">View</a>s can be added, On the right is the help for the step.
- Set <a class="xref" href="Terminal.Gui.Wizard.WizardStep.html#Terminal_Gui_Wizard_WizardStep_HelpText">HelpText</a> 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 <a class="xref" href="Terminal.Gui.Wizard.WizardStep.html#Terminal_Gui_Wizard_WizardStep_HelpText">HelpText</a> (if not empty) will fill the wizard step.
- </section>
- <h4><a class="xref" href="Terminal.Gui.Wizard.WizardStep.TitleEventArgs.html">Wizard.WizardStep.TitleEventArgs</a></h4>
- <section>
- An <span class="xref">System.EventArgs</span> which allows passing a cancelable new <a class="xref" href="Terminal.Gui.Wizard.WizardStep.html#Terminal_Gui_Wizard_WizardStep_Title">Title</a> value event.
- </section>
- <h3 id="interfaces">Interfaces
- </h3>
- <h4><a class="xref" href="Terminal.Gui.IAutocomplete.html">IAutocomplete</a></h4>
- <section>
- Renders an overlay on another view at a given point that allows selecting
- from a range of 'autocomplete' options.
- </section>
- <h4><a class="xref" href="Terminal.Gui.IClipboard.html">IClipboard</a></h4>
- <section>
- Definition to interact with the OS clipboard.
- </section>
- <h4><a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a></h4>
- <section>
- Implement <a class="xref" href="Terminal.Gui.IListDataSource.html">IListDataSource</a> to provide custom rendering for a <a class="xref" href="Terminal.Gui.ListView.html">ListView</a>.
- </section>
- <h4><a class="xref" href="Terminal.Gui.IMainLoopDriver.html">IMainLoopDriver</a></h4>
- <section>
- Public interface to create your own platform specific main loop driver.
- </section>
- <h4><a class="xref" href="Terminal.Gui.ITreeView.html">ITreeView</a></h4>
- <section>
- Interface for all non generic members of <a class="xref" href="Terminal.Gui.TreeView-1.html">TreeView<T></a>
- <a href="https://migueldeicaza.github.io/gui.cs/articles/treeview.html">See TreeView Deep Dive for more information</a>.
- </section>
- </article>
- </div>
-
- <div class="hidden-sm col-md-2" role="complementary">
- <div class="sideaffix">
- <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
- <h5>In This Article</h5>
- <div></div>
- </nav>
- </div>
- </div>
- </div>
- </div>
-
- <footer>
- <div class="grad-bottom"></div>
- <div class="footer">
- <div class="container">
- <span class="pull-right">
- <a href="#top">Back to top</a>
- </span>
-
- <span>Generated by <strong>DocFX</strong></span>
- </div>
- </div>
- </footer>
- </div>
-
- <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
- <script type="text/javascript" src="../../styles/docfx.js"></script>
- <script type="text/javascript" src="../../styles/main.js"></script>
- </body>
- </html>
|