Files
Terminal.Gui/docs/api/Terminal/Terminal.RadioGroup.html
Miguel de Icaza 58f99c0bd8 API doc update
2018-01-17 14:24:58 -05:00

589 lines
22 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>Class RadioGroup
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class RadioGroup
">
<meta name="generator" content="docfx 2.18.2.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="">
<meta property="docfx:tocrel" content="../toc.html">
</head>
<body data-spy="scroll" data-target="#affix">
<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="../../logo.svg" 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 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.RadioGroup">
<h1 id="Terminal_RadioGroup" data-uid="Terminal.RadioGroup">Class RadioGroup
</h1>
<div class="markdown level0 summary"><p>Radio group shows a group of labels, only one of those can be selected at a given time</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><a class="xref" href="Terminal.Responder.html">Responder</a></div>
<div class="level2"><a class="xref" href="Terminal.View.html">View</a></div>
<div class="level3"><span class="xref">RadioGroup</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Terminal.Responder.html#Terminal_Responder_CanFocus">Responder.CanFocus</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_Add_Terminal_View_">View.Add(View)</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_Add_Terminal_View___">View.Add(View[])</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_AddCh_System_Int32_System_Int32_System_Int32_">View.AddCh(Int32, Int32, Int32)</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_Bounds">View.Bounds</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_Clear">View.Clear()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_ColorScheme">View.ColorScheme</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_DrawFrame_Terminal_Rect_System_Boolean_">View.DrawFrame(Rect, Boolean)</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_DrawHotString_System_String_System_Boolean_Terminal_ColorScheme_">View.DrawHotString(String, Boolean, ColorScheme)</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_DrawHotString_System_String_Terminal_Attribute_Terminal_Attribute_">View.DrawHotString(String, Attribute, Attribute)</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_Driver">View.Driver</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_EnsureFocus">View.EnsureFocus()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_Focused">View.Focused</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_FocusFirst">View.FocusFirst()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_FocusLast">View.FocusLast()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_FocusNext">View.FocusNext()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_FocusPrev">View.FocusPrev()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_Frame">View.Frame</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_GetEnumerator">View.GetEnumerator()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_HasFocus">View.HasFocus</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_Id">View.Id</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_LayoutSubviews">View.LayoutSubviews()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_MostFocused">View.MostFocused</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_ProcessColdKey_Terminal_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_Remove_Terminal_View_">View.Remove(View)</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_RemoveAll">View.RemoveAll()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_SetFocus_Terminal_View_">View.SetFocus(View)</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_SetNeedsDisplay_Terminal_Rect_">View.SetNeedsDisplay(Rect)</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_Subviews">View.Subviews</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_SuperView">View.SuperView</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_ToString">View.ToString()</a>
</div>
<div>
<a class="xref" href="Terminal.View.html#Terminal_View_WantMousePositionReports">View.WantMousePositionReports</a>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="../Terminal.html">Terminal</a></h6>
<h6><strong>Assembly</strong>: Terminal.dll</h6>
<h5 id="Terminal_RadioGroup_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class RadioGroup : Terminal.View</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<a id="Terminal_RadioGroup__ctor_" data-uid="Terminal.RadioGroup.#ctor*"></a>
<h4 id="Terminal_RadioGroup__ctor_Terminal_Rect_System_String___System_Int32_" data-uid="Terminal.RadioGroup.#ctor(Terminal.Rect,System.String[],System.Int32)">RadioGroup(Rect, String[], Int32)</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Terminal.RadioGroup.html">RadioGroup</a> class
setting up the initial set of radio labels and the item that should be selected.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public RadioGroup (Terminal.Rect rect, string[] radioLabels, int selected = 0);</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.Rect.html">Rect</a></td>
<td><span class="parametername">rect</span></td>
<td><p>Boundaries for the radio group.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span>[]</td>
<td><span class="parametername">radioLabels</span></td>
<td><p>Radio labels, the strings can contain hotkeys using an undermine before the letter.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">selected</span></td>
<td><p>The item to be selected, the value is clamped to the number of items.</p>
</td>
</tr>
</tbody>
</table>
<a id="Terminal_RadioGroup__ctor_" data-uid="Terminal.RadioGroup.#ctor*"></a>
<h4 id="Terminal_RadioGroup__ctor_System_Int32_System_Int32_System_String___System_Int32_" data-uid="Terminal.RadioGroup.#ctor(System.Int32,System.Int32,System.String[],System.Int32)">RadioGroup(Int32, Int32, String[], Int32)</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Terminal.RadioGroup.html">RadioGroup</a> class
setting up the initial set of radio labels and the item that should be selected,
the view frame is computed from the provided radioLabels.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public RadioGroup (int x, int y, string[] radioLabels, int selected = 0);</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">x</span></td>
<td><p>The x coordinate.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">y</span></td>
<td><p>The y coordinate.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span>[]</td>
<td><span class="parametername">radioLabels</span></td>
<td><p>Radio labels, the strings can contain hotkeys using an undermine before the letter.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">selected</span></td>
<td><p>The item to be selected, the value is clamped to the number of items.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="fields">Fields
</h3>
<h4 id="Terminal_RadioGroup_SelectionChanged" data-uid="Terminal.RadioGroup.SelectionChanged">SelectionChanged</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Action&lt;int&gt; SelectionChanged;</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Action</span>&lt;<span class="xref">System.Int32</span>&gt;</td>
<td><p>To be added.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<a id="Terminal_RadioGroup_RadioLabels_" data-uid="Terminal.RadioGroup.RadioLabels*"></a>
<h4 id="Terminal_RadioGroup_RadioLabels" data-uid="Terminal.RadioGroup.RadioLabels">RadioLabels</h4>
<div class="markdown level1 summary"><p>The radio labels to display</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string[] RadioLabels { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span>[]</td>
<td><p>The radio labels.</p>
</td>
</tr>
</tbody>
</table>
<a id="Terminal_RadioGroup_Selected_" data-uid="Terminal.RadioGroup.Selected*"></a>
<h4 id="Terminal_RadioGroup_Selected" data-uid="Terminal.RadioGroup.Selected">Selected</h4>
<div class="markdown level1 summary"><p>The currently selected item from the list of radio labels</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int Selected { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><p>The selected.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<a id="Terminal_RadioGroup_MouseEvent_" data-uid="Terminal.RadioGroup.MouseEvent*"></a>
<h4 id="Terminal_RadioGroup_MouseEvent_Terminal_MouseEvent_" data-uid="Terminal.RadioGroup.MouseEvent(Terminal.MouseEvent)">MouseEvent(MouseEvent)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override bool MouseEvent (Terminal.MouseEvent me);</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.MouseEvent.html">MouseEvent</a></td>
<td><span class="parametername">me</span></td>
<td><p>To be added.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><p>To be added.</p>
</td>
</tr>
</tbody>
</table>
<a id="Terminal_RadioGroup_PositionCursor_" data-uid="Terminal.RadioGroup.PositionCursor*"></a>
<h4 id="Terminal_RadioGroup_PositionCursor" data-uid="Terminal.RadioGroup.PositionCursor">PositionCursor()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override void PositionCursor ();</code></pre>
</div>
<a id="Terminal_RadioGroup_ProcessHotKey_" data-uid="Terminal.RadioGroup.ProcessHotKey*"></a>
<h4 id="Terminal_RadioGroup_ProcessHotKey_Terminal_KeyEvent_" data-uid="Terminal.RadioGroup.ProcessHotKey(Terminal.KeyEvent)">ProcessHotKey(KeyEvent)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override bool ProcessHotKey (Terminal.KeyEvent kb);</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.KeyEvent.html">KeyEvent</a></td>
<td><span class="parametername">kb</span></td>
<td><p>To be added.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><p>To be added.</p>
</td>
</tr>
</tbody>
</table>
<a id="Terminal_RadioGroup_ProcessKey_" data-uid="Terminal.RadioGroup.ProcessKey*"></a>
<h4 id="Terminal_RadioGroup_ProcessKey_Terminal_KeyEvent_" data-uid="Terminal.RadioGroup.ProcessKey(Terminal.KeyEvent)">ProcessKey(KeyEvent)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override bool ProcessKey (Terminal.KeyEvent kb);</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.KeyEvent.html">KeyEvent</a></td>
<td><span class="parametername">kb</span></td>
<td><p>To be added.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><p>To be added.</p>
</td>
</tr>
</tbody>
</table>
<a id="Terminal_RadioGroup_Redraw_" data-uid="Terminal.RadioGroup.Redraw*"></a>
<h4 id="Terminal_RadioGroup_Redraw_Terminal_Rect_" data-uid="Terminal.RadioGroup.Redraw(Terminal.Rect)">Redraw(Rect)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override void Redraw (Terminal.Rect region);</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.Rect.html">Rect</a></td>
<td><span class="parametername">region</span></td>
<td><p>To be added.</p>
</td>
</tr>
</tbody>
</table>
</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">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</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>Copyright © 2015-2017 Microsoft<br>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>