mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-27 16:27:55 +01:00
539 lines
29 KiB
HTML
539 lines
29 KiB
HTML
<!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.56.7.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">
|
|
<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, singelton class provding 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 <span class="xref">Terminal.Gui.Application.RunState.Toplevel</span> view.
|
|
</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.CellActivatedEventArgs.html">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.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.
|
|
NOTE: Currently not implemented.
|
|
</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.ColumnStyle.html">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.ColumnStyle.html#Terminal_Gui_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.ComboBox.html">ComboBox</a></h4>
|
|
<section>
|
|
ComboBox 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.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.DelegateTreeBuilder-1.html">DelegateTreeBuilder<T></a></h4>
|
|
<section>
|
|
Implementation of <a class="xref" href="Terminal.Gui.ITreeBuilder-1.html">ITreeBuilder<T></a> that uses user defined functions
|
|
</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.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.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.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.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 separted by newline characters. Multi-line Labels support word wrap.
|
|
</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.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.MenuBar.html">MenuBar</a></h4>
|
|
<section>
|
|
The MenuBar provides a menu for Terminal.Gui applications.
|
|
</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.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.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.ObjectActivatedEventArgs-1.html">ObjectActivatedEventArgs<T></a></h4>
|
|
<section>
|
|
Event args for the <a class="xref" href="Terminal.Gui.TreeView-1.html#Terminal_Gui_TreeView_1_ObjectActivated">ObjectActivated</a> event
|
|
</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.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.RadioGroup.html">RadioGroup</a></h4>
|
|
<section>
|
|
<a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a> shows a group of radio labels, only one of those can be selected at a given time
|
|
</section>
|
|
<h4><a class="xref" href="Terminal.Gui.RadioGroup.SelectedItemChangedArgs.html">RadioGroup.SelectedItemChangedArgs</a></h4>
|
|
<section>
|
|
Event arguments for the SelectedItemChagned event.
|
|
</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.SelectedCellChangedEventArgs.html">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.SelectionChangedEventArgs-1.html">SelectionChangedEventArgs<T></a></h4>
|
|
<section>
|
|
Event arguments describing a change in selected object in a tree view
|
|
</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.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.TableSelection.html">TableSelection</a></h4>
|
|
<section>
|
|
Describes a selected region of the table
|
|
</section>
|
|
<h4><a class="xref" href="Terminal.Gui.TableStyle.html">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.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.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.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.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.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.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.
|
|
</section>
|
|
<h4><a class="xref" href="Terminal.Gui.TreeBuilder-1.html">TreeBuilder<T></a></h4>
|
|
<section>
|
|
Abstract implementation of <a class="xref" href="Terminal.Gui.ITreeBuilder-1.html">ITreeBuilder<T></a>.
|
|
</section>
|
|
<h4><a class="xref" href="Terminal.Gui.TreeNode.html">TreeNode</a></h4>
|
|
<section>
|
|
Simple class for representing nodes, use with regular (non generic) <a class="xref" href="Terminal.Gui.TreeView.html">TreeView</a>.
|
|
</section>
|
|
<h4><a class="xref" href="Terminal.Gui.TreeNodeBuilder.html">TreeNodeBuilder</a></h4>
|
|
<section>
|
|
<a class="xref" href="Terminal.Gui.ITreeBuilder-1.html">ITreeBuilder<T></a> implementation for <a class="xref" href="Terminal.Gui.ITreeNode.html">ITreeNode</a> objects
|
|
</section>
|
|
<h4><a class="xref" href="Terminal.Gui.TreeStyle.html">TreeStyle</a></h4>
|
|
<section>
|
|
Defines rendering options that affect how the tree is displayed
|
|
</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.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.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.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>
|
|
<h3 id="structs">Structs
|
|
</h3>
|
|
<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.MouseEvent.html">MouseEvent</a></h4>
|
|
<section>
|
|
Describes a mouse event
|
|
</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.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.Size.html">Size</a></h4>
|
|
<section>
|
|
Stores an ordered pair of integers, which specify a Height and Width.
|
|
</section>
|
|
<h3 id="interfaces">Interfaces
|
|
</h3>
|
|
<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.ITreeBuilder-1.html">ITreeBuilder<T></a></h4>
|
|
<section>
|
|
Interface for supplying data to a <a class="xref" href="Terminal.Gui.TreeView-1.html">TreeView<T></a> on demand as root level nodes
|
|
are expanded by the user
|
|
</section>
|
|
<h4><a class="xref" href="Terminal.Gui.ITreeNode.html">ITreeNode</a></h4>
|
|
<section>
|
|
Interface to implement when you want the regular (non generic) <a class="xref" href="Terminal.Gui.TreeView.html">TreeView</a>
|
|
to automatically determine children for your class (without having to specify
|
|
an <a class="xref" href="Terminal.Gui.ITreeBuilder-1.html">ITreeBuilder<T></a>)
|
|
</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>
|
|
<h3 id="enums">Enums
|
|
</h3>
|
|
<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.ConsoleDriver.DiagnosticFlags.html">ConsoleDriver.DiagnosticFlags</a></h4>
|
|
<section>
|
|
Enables diagnostic functions
|
|
</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.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.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.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.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.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.TextAlignment.html">TextAlignment</a></h4>
|
|
<section>
|
|
Text alignment enumeration, controls how text is displayed.
|
|
</section>
|
|
<h3 id="delegates">Delegates
|
|
</h3>
|
|
<h4><a class="xref" href="Terminal.Gui.AspectGetterDelegate-1.html">AspectGetterDelegate<T></a></h4>
|
|
<section>
|
|
Delegates of this type are used to fetch string representations of user's model objects
|
|
</section>
|
|
</article>
|
|
</div>
|
|
|
|
<div class="hidden-sm col-md-2" role="complementary">
|
|
<div class="sideaffix">
|
|
<div class="contribution">
|
|
<ul class="nav">
|
|
</ul>
|
|
</div>
|
|
<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>
|