Files
Terminal.Gui/docfx/api/Terminal/Terminal.RadioGroup.yml
Miguel de Icaza e1b1b52e99 Added docs
2018-01-15 22:54:27 -05:00

703 lines
20 KiB
YAML

### YamlMime:ManagedReference
items:
- uid: Terminal.RadioGroup
id: RadioGroup
children:
- Terminal.RadioGroup.#ctor(Terminal.Rect,System.String[],System.Int32)
- Terminal.RadioGroup.#ctor(System.Int32,System.Int32,System.String[],System.Int32)
- Terminal.RadioGroup.MouseEvent(Terminal.MouseEvent)
- Terminal.RadioGroup.PositionCursor
- Terminal.RadioGroup.ProcessHotKey(Terminal.KeyEvent)
- Terminal.RadioGroup.ProcessKey(Terminal.KeyEvent)
- Terminal.RadioGroup.RadioLabels
- Terminal.RadioGroup.Redraw(Terminal.Rect)
- Terminal.RadioGroup.Selected
- Terminal.RadioGroup.SelectionChanged
langs:
- csharp
name: RadioGroup
nameWithType: RadioGroup
fullName: Terminal.RadioGroup
type: Class
assemblies:
- Terminal
namespace: Terminal
summary: Radio group shows a group of labels, only one of those can be selected at a given time
syntax:
content: 'public class RadioGroup : Terminal.View'
inheritance:
- System.Object
- Terminal.Responder
- Terminal.View
implements: []
inheritedMembers:
- Terminal.Responder.CanFocus
- Terminal.View.Add(Terminal.View)
- Terminal.View.Add(Terminal.View[])
- Terminal.View.AddCh(System.Int32,System.Int32,System.Int32)
- Terminal.View.Bounds
- Terminal.View.ChildNeedsDisplay
- Terminal.View.Clear
- Terminal.View.ClearNeedsDisplay
- Terminal.View.DrawFrame(Terminal.Rect,System.Boolean)
- Terminal.View.DrawHotString(System.String,System.Boolean,Terminal.ColorScheme)
- Terminal.View.DrawHotString(System.String,Terminal.Attribute,Terminal.Attribute)
- Terminal.View.Driver
- Terminal.View.empty
- Terminal.View.EnsureFocus
- Terminal.View.Focused
- Terminal.View.FocusFirst
- Terminal.View.FocusLast
- Terminal.View.FocusNext
- Terminal.View.FocusPrev
- Terminal.View.Frame
- Terminal.View.GetEnumerator
- Terminal.View.HasFocus
- Terminal.View.Id
- Terminal.View.LayoutSubviews
- Terminal.View.MostFocused
- Terminal.View.Move(System.Int32,System.Int32)
- Terminal.View.ProcessColdKey(Terminal.KeyEvent)
- Terminal.View.Remove(Terminal.View)
- Terminal.View.RemoveAll
- Terminal.View.ScreenToView(System.Int32,System.Int32)
- Terminal.View.SetFocus(Terminal.View)
- Terminal.View.SetNeedsDisplay
- Terminal.View.SetNeedsDisplay(Terminal.Rect)
- Terminal.View.Subviews
- Terminal.View.SuperView
- Terminal.View.ToString
- Terminal.View.WantMousePositionReports
- uid: Terminal.RadioGroup.#ctor(Terminal.Rect,System.String[],System.Int32)
id: '#ctor(Terminal.Rect,System.String[],System.Int32)'
parent: Terminal.RadioGroup
langs:
- csharp
name: RadioGroup(Rect, String[], Int32)
nameWithType: RadioGroup.RadioGroup(Rect, String[], Int32)
fullName: RadioGroup.RadioGroup(Rect, String[], Int32)
type: Constructor
assemblies:
- Terminal
namespace: Terminal
summary: >-
Initializes a new instance of the <xref href="Terminal.RadioGroup"></xref> class
setting up the initial set of radio labels and the item that should be selected.
syntax:
content: public RadioGroup (Terminal.Rect rect, string[] radioLabels, int selected = 0);
parameters:
- id: rect
type: Terminal.Rect
description: Boundaries for the radio group.
- id: radioLabels
type: System.String[]
description: Radio labels, the strings can contain hotkeys using an undermine before the letter.
- id: selected
type: System.Int32
description: The item to be selected, the value is clamped to the number of items.
overload: Terminal.RadioGroup.#ctor*
exceptions: []
- uid: Terminal.RadioGroup.#ctor(System.Int32,System.Int32,System.String[],System.Int32)
id: '#ctor(System.Int32,System.Int32,System.String[],System.Int32)'
parent: Terminal.RadioGroup
langs:
- csharp
name: RadioGroup(Int32, Int32, String[], Int32)
nameWithType: RadioGroup.RadioGroup(Int32, Int32, String[], Int32)
fullName: RadioGroup.RadioGroup(Int32, Int32, String[], Int32)
type: Constructor
assemblies:
- Terminal
namespace: Terminal
syntax:
content: public RadioGroup (int x, int y, string[] radioLabels, int selected = 0);
parameters:
- id: x
type: System.Int32
description: To be added.
- id: y
type: System.Int32
description: To be added.
- id: radioLabels
type: System.String[]
description: To be added.
- id: selected
type: System.Int32
description: To be added.
overload: Terminal.RadioGroup.#ctor*
exceptions: []
- uid: Terminal.RadioGroup.MouseEvent(Terminal.MouseEvent)
id: MouseEvent(Terminal.MouseEvent)
parent: Terminal.RadioGroup
langs:
- csharp
name: MouseEvent(MouseEvent)
nameWithType: RadioGroup.MouseEvent(MouseEvent)
fullName: RadioGroup.MouseEvent(MouseEvent)
type: Method
assemblies:
- Terminal
namespace: Terminal
syntax:
content: public override bool MouseEvent (Terminal.MouseEvent me);
parameters:
- id: me
type: Terminal.MouseEvent
description: To be added.
return:
type: System.Boolean
description: To be added.
overload: Terminal.RadioGroup.MouseEvent*
exceptions: []
- uid: Terminal.RadioGroup.PositionCursor
id: PositionCursor
parent: Terminal.RadioGroup
langs:
- csharp
name: PositionCursor()
nameWithType: RadioGroup.PositionCursor()
fullName: RadioGroup.PositionCursor()
type: Method
assemblies:
- Terminal
namespace: Terminal
syntax:
content: public override void PositionCursor ();
parameters: []
overload: Terminal.RadioGroup.PositionCursor*
exceptions: []
- uid: Terminal.RadioGroup.ProcessHotKey(Terminal.KeyEvent)
id: ProcessHotKey(Terminal.KeyEvent)
parent: Terminal.RadioGroup
langs:
- csharp
name: ProcessHotKey(KeyEvent)
nameWithType: RadioGroup.ProcessHotKey(KeyEvent)
fullName: RadioGroup.ProcessHotKey(KeyEvent)
type: Method
assemblies:
- Terminal
namespace: Terminal
syntax:
content: public override bool ProcessHotKey (Terminal.KeyEvent kb);
parameters:
- id: kb
type: Terminal.KeyEvent
description: To be added.
return:
type: System.Boolean
description: To be added.
overload: Terminal.RadioGroup.ProcessHotKey*
exceptions: []
- uid: Terminal.RadioGroup.ProcessKey(Terminal.KeyEvent)
id: ProcessKey(Terminal.KeyEvent)
parent: Terminal.RadioGroup
langs:
- csharp
name: ProcessKey(KeyEvent)
nameWithType: RadioGroup.ProcessKey(KeyEvent)
fullName: RadioGroup.ProcessKey(KeyEvent)
type: Method
assemblies:
- Terminal
namespace: Terminal
syntax:
content: public override bool ProcessKey (Terminal.KeyEvent kb);
parameters:
- id: kb
type: Terminal.KeyEvent
description: To be added.
return:
type: System.Boolean
description: To be added.
overload: Terminal.RadioGroup.ProcessKey*
exceptions: []
- uid: Terminal.RadioGroup.RadioLabels
id: RadioLabels
parent: Terminal.RadioGroup
langs:
- csharp
name: RadioLabels
nameWithType: RadioGroup.RadioLabels
fullName: RadioGroup.RadioLabels
type: Property
assemblies:
- Terminal
namespace: Terminal
summary: The radio labels to display
syntax:
content: public string[] RadioLabels { get; set; }
return:
type: System.String[]
description: The radio labels.
overload: Terminal.RadioGroup.RadioLabels*
exceptions: []
- uid: Terminal.RadioGroup.Redraw(Terminal.Rect)
id: Redraw(Terminal.Rect)
parent: Terminal.RadioGroup
langs:
- csharp
name: Redraw(Rect)
nameWithType: RadioGroup.Redraw(Rect)
fullName: RadioGroup.Redraw(Rect)
type: Method
assemblies:
- Terminal
namespace: Terminal
syntax:
content: public override void Redraw (Terminal.Rect region);
parameters:
- id: region
type: Terminal.Rect
description: To be added.
overload: Terminal.RadioGroup.Redraw*
exceptions: []
- uid: Terminal.RadioGroup.Selected
id: Selected
parent: Terminal.RadioGroup
langs:
- csharp
name: Selected
nameWithType: RadioGroup.Selected
fullName: RadioGroup.Selected
type: Property
assemblies:
- Terminal
namespace: Terminal
summary: The currently selected item from the list of radio labels
syntax:
content: public int Selected { get; set; }
return:
type: System.Int32
description: The selected.
overload: Terminal.RadioGroup.Selected*
exceptions: []
- uid: Terminal.RadioGroup.SelectionChanged
id: SelectionChanged
parent: Terminal.RadioGroup
langs:
- csharp
name: SelectionChanged
nameWithType: RadioGroup.SelectionChanged
fullName: RadioGroup.SelectionChanged
type: Field
assemblies:
- Terminal
namespace: Terminal
syntax:
content: public Action<int> SelectionChanged;
return:
type: System.Action{System.Int32}
description: To be added.
exceptions: []
references:
- uid: Terminal.View
parent: Terminal
isExternal: false
name: View
nameWithType: View
fullName: Terminal.View
- uid: Terminal.RadioGroup.#ctor(Terminal.Rect,System.String[],System.Int32)
parent: Terminal.RadioGroup
isExternal: false
name: RadioGroup(Rect, String[], Int32)
nameWithType: RadioGroup.RadioGroup(Rect, String[], Int32)
fullName: RadioGroup.RadioGroup(Rect, String[], Int32)
- uid: Terminal.Rect
parent: Terminal
isExternal: false
name: Rect
nameWithType: Rect
fullName: Terminal.Rect
- uid: System.String
name: String
nameWithType: String
fullName: System.String
- uid: System.String[]
parent: System
isExternal: true
name: String[]
nameWithType: String[]
fullName: System.String[]
spec.csharp:
- uid: System.String
name: String
nameWithType: String
fullName: System.String
- name: '[]'
nameWithType: '[]'
fullName: '[]'
- uid: System.Int32
parent: System
isExternal: true
name: Int32
nameWithType: Int32
fullName: System.Int32
- uid: Terminal.RadioGroup.#ctor(System.Int32,System.Int32,System.String[],System.Int32)
parent: Terminal.RadioGroup
isExternal: false
name: RadioGroup(Int32, Int32, String[], Int32)
nameWithType: RadioGroup.RadioGroup(Int32, Int32, String[], Int32)
fullName: RadioGroup.RadioGroup(Int32, Int32, String[], Int32)
- uid: Terminal.RadioGroup.MouseEvent(Terminal.MouseEvent)
parent: Terminal.RadioGroup
isExternal: false
name: MouseEvent(MouseEvent)
nameWithType: RadioGroup.MouseEvent(MouseEvent)
fullName: RadioGroup.MouseEvent(MouseEvent)
- uid: System.Boolean
parent: System
isExternal: true
name: Boolean
nameWithType: Boolean
fullName: System.Boolean
- uid: Terminal.MouseEvent
parent: Terminal
isExternal: false
name: MouseEvent
nameWithType: MouseEvent
fullName: Terminal.MouseEvent
- uid: Terminal.RadioGroup.PositionCursor
parent: Terminal.RadioGroup
isExternal: false
name: PositionCursor()
nameWithType: RadioGroup.PositionCursor()
fullName: RadioGroup.PositionCursor()
- uid: Terminal.RadioGroup.ProcessHotKey(Terminal.KeyEvent)
parent: Terminal.RadioGroup
isExternal: false
name: ProcessHotKey(KeyEvent)
nameWithType: RadioGroup.ProcessHotKey(KeyEvent)
fullName: RadioGroup.ProcessHotKey(KeyEvent)
- uid: Terminal.KeyEvent
parent: Terminal
isExternal: false
name: KeyEvent
nameWithType: KeyEvent
fullName: Terminal.KeyEvent
- uid: Terminal.RadioGroup.ProcessKey(Terminal.KeyEvent)
parent: Terminal.RadioGroup
isExternal: false
name: ProcessKey(KeyEvent)
nameWithType: RadioGroup.ProcessKey(KeyEvent)
fullName: RadioGroup.ProcessKey(KeyEvent)
- uid: Terminal.RadioGroup.RadioLabels
parent: Terminal.RadioGroup
isExternal: false
name: RadioLabels
nameWithType: RadioGroup.RadioLabels
fullName: RadioGroup.RadioLabels
- uid: Terminal.RadioGroup.Redraw(Terminal.Rect)
parent: Terminal.RadioGroup
isExternal: false
name: Redraw(Rect)
nameWithType: RadioGroup.Redraw(Rect)
fullName: RadioGroup.Redraw(Rect)
- uid: Terminal.RadioGroup.Selected
parent: Terminal.RadioGroup
isExternal: false
name: Selected
nameWithType: RadioGroup.Selected
fullName: RadioGroup.Selected
- uid: Terminal.RadioGroup.SelectionChanged
parent: Terminal.RadioGroup
isExternal: false
name: SelectionChanged
nameWithType: RadioGroup.SelectionChanged
fullName: RadioGroup.SelectionChanged
- uid: System.Action`1
name: Action
nameWithType: Action
fullName: System.Action
- uid: System.Action{System.Int32}
parent: System
isExternal: true
name: Action<Int32>
nameWithType: Action<Int32>
fullName: System.Action<System.Int32>
spec.csharp:
- uid: System.Action`1
name: Action
nameWithType: Action
fullName: System.Action
- name: <
nameWithType: <
fullName: <
- uid: System.Int32
name: Int32
nameWithType: Int32
fullName: System.Int32
- name: '>'
nameWithType: '>'
fullName: '>'
- uid: Terminal.RadioGroup.#ctor*
parent: Terminal.RadioGroup
isExternal: false
name: RadioGroup
nameWithType: RadioGroup.RadioGroup
fullName: RadioGroup.RadioGroup
- uid: Terminal.RadioGroup.MouseEvent*
parent: Terminal.RadioGroup
isExternal: false
name: MouseEvent
nameWithType: RadioGroup.MouseEvent
fullName: RadioGroup.MouseEvent
- uid: Terminal.RadioGroup.PositionCursor*
parent: Terminal.RadioGroup
isExternal: false
name: PositionCursor
nameWithType: RadioGroup.PositionCursor
fullName: RadioGroup.PositionCursor
- uid: Terminal.RadioGroup.ProcessHotKey*
parent: Terminal.RadioGroup
isExternal: false
name: ProcessHotKey
nameWithType: RadioGroup.ProcessHotKey
fullName: RadioGroup.ProcessHotKey
- uid: Terminal.RadioGroup.ProcessKey*
parent: Terminal.RadioGroup
isExternal: false
name: ProcessKey
nameWithType: RadioGroup.ProcessKey
fullName: RadioGroup.ProcessKey
- uid: Terminal.RadioGroup.RadioLabels*
parent: Terminal.RadioGroup
isExternal: false
name: RadioLabels
nameWithType: RadioGroup.RadioLabels
fullName: RadioGroup.RadioLabels
- uid: Terminal.RadioGroup.Redraw*
parent: Terminal.RadioGroup
isExternal: false
name: Redraw
nameWithType: RadioGroup.Redraw
fullName: RadioGroup.Redraw
- uid: Terminal.RadioGroup.Selected*
parent: Terminal.RadioGroup
isExternal: false
name: Selected
nameWithType: RadioGroup.Selected
fullName: RadioGroup.Selected
- uid: Terminal.Responder.CanFocus
parent: Terminal.Responder
isExternal: false
name: CanFocus
nameWithType: Responder.CanFocus
fullName: Responder.CanFocus
- uid: Terminal.View.HasFocus
parent: Terminal.View
isExternal: false
name: HasFocus
nameWithType: View.HasFocus
fullName: View.HasFocus
- uid: Terminal.View.ProcessColdKey(Terminal.KeyEvent)
parent: Terminal.View
isExternal: false
name: ProcessColdKey(KeyEvent)
nameWithType: View.ProcessColdKey(KeyEvent)
fullName: View.ProcessColdKey(KeyEvent)
- uid: Terminal.View.Add(Terminal.View)
parent: Terminal.View
isExternal: false
name: Add(View)
nameWithType: View.Add(View)
fullName: View.Add(View)
- uid: Terminal.View.Add(Terminal.View[])
parent: Terminal.View
isExternal: false
name: Add(View[])
nameWithType: View.Add(View[])
fullName: View.Add(View[])
- uid: Terminal.View.AddCh(System.Int32,System.Int32,System.Int32)
parent: Terminal.View
isExternal: false
name: AddCh(Int32, Int32, Int32)
nameWithType: View.AddCh(Int32, Int32, Int32)
fullName: View.AddCh(Int32, Int32, Int32)
- uid: Terminal.View.Bounds
parent: Terminal.View
isExternal: false
name: Bounds
nameWithType: View.Bounds
fullName: View.Bounds
- uid: Terminal.View.ChildNeedsDisplay
parent: Terminal.View
isExternal: false
name: ChildNeedsDisplay()
nameWithType: View.ChildNeedsDisplay()
fullName: View.ChildNeedsDisplay()
- uid: Terminal.View.Clear
parent: Terminal.View
isExternal: false
name: Clear()
nameWithType: View.Clear()
fullName: View.Clear()
- uid: Terminal.View.ClearNeedsDisplay
parent: Terminal.View
isExternal: false
name: ClearNeedsDisplay()
nameWithType: View.ClearNeedsDisplay()
fullName: View.ClearNeedsDisplay()
- uid: Terminal.View.DrawFrame(Terminal.Rect,System.Boolean)
parent: Terminal.View
isExternal: false
name: DrawFrame(Rect, Boolean)
nameWithType: View.DrawFrame(Rect, Boolean)
fullName: View.DrawFrame(Rect, Boolean)
- uid: Terminal.View.DrawHotString(System.String,Terminal.Attribute,Terminal.Attribute)
parent: Terminal.View
isExternal: false
name: DrawHotString(String, Attribute, Attribute)
nameWithType: View.DrawHotString(String, Attribute, Attribute)
fullName: View.DrawHotString(String, Attribute, Attribute)
- uid: Terminal.View.DrawHotString(System.String,System.Boolean,Terminal.ColorScheme)
parent: Terminal.View
isExternal: false
name: DrawHotString(String, Boolean, ColorScheme)
nameWithType: View.DrawHotString(String, Boolean, ColorScheme)
fullName: View.DrawHotString(String, Boolean, ColorScheme)
- uid: Terminal.View.Driver
parent: Terminal.View
isExternal: false
name: Driver
nameWithType: View.Driver
fullName: View.Driver
- uid: Terminal.View.empty
parent: Terminal.View
isExternal: false
name: empty
nameWithType: View.empty
fullName: View.empty
- uid: Terminal.View.EnsureFocus
parent: Terminal.View
isExternal: false
name: EnsureFocus()
nameWithType: View.EnsureFocus()
fullName: View.EnsureFocus()
- uid: Terminal.View.Focused
parent: Terminal.View
isExternal: false
name: Focused
nameWithType: View.Focused
fullName: View.Focused
- uid: Terminal.View.FocusFirst
parent: Terminal.View
isExternal: false
name: FocusFirst()
nameWithType: View.FocusFirst()
fullName: View.FocusFirst()
- uid: Terminal.View.FocusLast
parent: Terminal.View
isExternal: false
name: FocusLast()
nameWithType: View.FocusLast()
fullName: View.FocusLast()
- uid: Terminal.View.FocusNext
parent: Terminal.View
isExternal: false
name: FocusNext()
nameWithType: View.FocusNext()
fullName: View.FocusNext()
- uid: Terminal.View.FocusPrev
parent: Terminal.View
isExternal: false
name: FocusPrev()
nameWithType: View.FocusPrev()
fullName: View.FocusPrev()
- uid: Terminal.View.Frame
parent: Terminal.View
isExternal: false
name: Frame
nameWithType: View.Frame
fullName: View.Frame
- uid: Terminal.View.GetEnumerator
parent: Terminal.View
isExternal: false
name: GetEnumerator()
nameWithType: View.GetEnumerator()
fullName: View.GetEnumerator()
- uid: Terminal.View.Id
parent: Terminal.View
isExternal: false
name: Id
nameWithType: View.Id
fullName: View.Id
- uid: Terminal.View.LayoutSubviews
parent: Terminal.View
isExternal: false
name: LayoutSubviews()
nameWithType: View.LayoutSubviews()
fullName: View.LayoutSubviews()
- uid: Terminal.View.MostFocused
parent: Terminal.View
isExternal: false
name: MostFocused
nameWithType: View.MostFocused
fullName: View.MostFocused
- uid: Terminal.View.Move(System.Int32,System.Int32)
parent: Terminal.View
isExternal: false
name: Move(Int32, Int32)
nameWithType: View.Move(Int32, Int32)
fullName: View.Move(Int32, Int32)
- uid: Terminal.View.Remove(Terminal.View)
parent: Terminal.View
isExternal: false
name: Remove(View)
nameWithType: View.Remove(View)
fullName: View.Remove(View)
- uid: Terminal.View.RemoveAll
parent: Terminal.View
isExternal: false
name: RemoveAll()
nameWithType: View.RemoveAll()
fullName: View.RemoveAll()
- uid: Terminal.View.ScreenToView(System.Int32,System.Int32)
parent: Terminal.View
isExternal: false
name: ScreenToView(Int32, Int32)
nameWithType: View.ScreenToView(Int32, Int32)
fullName: View.ScreenToView(Int32, Int32)
- uid: Terminal.View.SetFocus(Terminal.View)
parent: Terminal.View
isExternal: false
name: SetFocus(View)
nameWithType: View.SetFocus(View)
fullName: View.SetFocus(View)
- uid: Terminal.View.SetNeedsDisplay
parent: Terminal.View
isExternal: false
name: SetNeedsDisplay()
nameWithType: View.SetNeedsDisplay()
fullName: View.SetNeedsDisplay()
- uid: Terminal.View.SetNeedsDisplay(Terminal.Rect)
parent: Terminal.View
isExternal: false
name: SetNeedsDisplay(Rect)
nameWithType: View.SetNeedsDisplay(Rect)
fullName: View.SetNeedsDisplay(Rect)
- uid: Terminal.View.Subviews
parent: Terminal.View
isExternal: false
name: Subviews
nameWithType: View.Subviews
fullName: View.Subviews
- uid: Terminal.View.SuperView
parent: Terminal.View
isExternal: false
name: SuperView
nameWithType: View.SuperView
fullName: View.SuperView
- uid: Terminal.View.ToString
parent: Terminal.View
isExternal: false
name: ToString()
nameWithType: View.ToString()
fullName: View.ToString()
- uid: Terminal.View.WantMousePositionReports
parent: Terminal.View
isExternal: false
name: WantMousePositionReports
nameWithType: View.WantMousePositionReports
fullName: View.WantMousePositionReports