mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2026-01-02 01:03:29 +01:00
256 lines
11 KiB
XML
256 lines
11 KiB
XML
<Type Name="RadioGroup" FullName="Terminal.Gui.RadioGroup">
|
|
<TypeSignature Language="C#" Value="public class RadioGroup : Terminal.Gui.View" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit RadioGroup extends Terminal.Gui.View" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>Terminal.Gui</AssemblyName>
|
|
<AssemblyVersion>1.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>Terminal.Gui.View</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Docs>
|
|
<summary>
|
|
Radio group shows a group of labels, only one of those can be selected at a given time
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public RadioGroup (string[] radioLabels, int selected = 0);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string[] radioLabels, int32 selected) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Parameters>
|
|
<Parameter Name="radioLabels" Type="System.String[]" />
|
|
<Parameter Name="selected" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="radioLabels">Radio labels, the strings can contain hotkeys using an undermine before the letter.</param>
|
|
<param name="selected">The item to be selected, the value is clamped to the number of items.</param>
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Terminal.Gui.RadioGroup" /> class
|
|
setting up the initial set of radio labels and the item that should be selected.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public RadioGroup (Terminal.Gui.Rect rect, string[] radioLabels, int selected = 0);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Terminal.Gui.Rect rect, string[] radioLabels, int32 selected) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Parameters>
|
|
<Parameter Name="rect" Type="Terminal.Gui.Rect" />
|
|
<Parameter Name="radioLabels" Type="System.String[]" />
|
|
<Parameter Name="selected" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="rect">Boundaries for the radio group.</param>
|
|
<param name="radioLabels">Radio labels, the strings can contain hotkeys using an undermine before the letter.</param>
|
|
<param name="selected">The item to be selected, the value is clamped to the number of items.</param>
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Terminal.Gui.RadioGroup" /> class
|
|
setting up the initial set of radio labels and the item that should be selected and uses
|
|
an absolute layout for the result.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public RadioGroup (int x, int y, string[] radioLabels, int selected = 0);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 x, int32 y, string[] radioLabels, int32 selected) cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Parameters>
|
|
<Parameter Name="x" Type="System.Int32" />
|
|
<Parameter Name="y" Type="System.Int32" />
|
|
<Parameter Name="radioLabels" Type="System.String[]" />
|
|
<Parameter Name="selected" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="x">The x coordinate.</param>
|
|
<param name="y">The y coordinate.</param>
|
|
<param name="radioLabels">Radio labels, the strings can contain hotkeys using an undermine before the letter.</param>
|
|
<param name="selected">The item to be selected, the value is clamped to the number of items.</param>
|
|
<summary>
|
|
Initializes a new instance of the <see cref="T:Terminal.Gui.RadioGroup" /> 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.
|
|
</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Cursor">
|
|
<MemberSignature Language="C#" Value="public int Cursor { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance int32 Cursor" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
The location of the cursor in the radio group
|
|
</summary>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="MouseEvent">
|
|
<MemberSignature Language="C#" Value="public override bool MouseEvent (Terminal.Gui.MouseEvent me);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool MouseEvent(valuetype Terminal.Gui.MouseEvent me) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="me" Type="Terminal.Gui.MouseEvent" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="me">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="PositionCursor">
|
|
<MemberSignature Language="C#" Value="public override void PositionCursor ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void PositionCursor() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ProcessColdKey">
|
|
<MemberSignature Language="C#" Value="public override bool ProcessColdKey (Terminal.Gui.KeyEvent kb);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool ProcessColdKey(valuetype Terminal.Gui.KeyEvent kb) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="kb" Type="Terminal.Gui.KeyEvent" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="kb">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="ProcessKey">
|
|
<MemberSignature Language="C#" Value="public override bool ProcessKey (Terminal.Gui.KeyEvent kb);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool ProcessKey(valuetype Terminal.Gui.KeyEvent kb) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="kb" Type="Terminal.Gui.KeyEvent" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="kb">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<returns>To be added.</returns>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="RadioLabels">
|
|
<MemberSignature Language="C#" Value="public string[] RadioLabels { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance string[] RadioLabels" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.String[]</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
The radio labels to display
|
|
</summary>
|
|
<value>The radio labels.</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Redraw">
|
|
<MemberSignature Language="C#" Value="public override void Redraw (Terminal.Gui.Rect region);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Redraw(valuetype Terminal.Gui.Rect region) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="region" Type="Terminal.Gui.Rect" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="region">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Selected">
|
|
<MemberSignature Language="C#" Value="public int Selected { get; set; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance int32 Selected" />
|
|
<MemberType>Property</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>
|
|
The currently selected item from the list of radio labels
|
|
</summary>
|
|
<value>The selected.</value>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SelectionChanged">
|
|
<MemberSignature Language="C#" Value="public Action<int> SelectionChanged;" />
|
|
<MemberSignature Language="ILAsm" Value=".field public class System.Action`1<int32> SelectionChanged" />
|
|
<MemberType>Field</MemberType>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>1.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<ReturnValue>
|
|
<ReturnType>System.Action<System.Int32></ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type>
|