Files
Terminal.Gui/docfx/api/Terminal/Terminal.Label.yml
Miguel de Icaza f3f32f6a24 Update docs
2018-01-15 23:17:12 -05:00

591 lines
17 KiB
YAML

### YamlMime:ManagedReference
items:
- uid: Terminal.Label
id: Label
children:
- Terminal.Label.#ctor(Terminal.Rect,System.String)
- Terminal.Label.#ctor(System.Int32,System.Int32,System.String)
- Terminal.Label.MeasureLines(System.String,System.Int32)
- Terminal.Label.Redraw(Terminal.Rect)
- Terminal.Label.Text
- Terminal.Label.TextAlignment
- Terminal.Label.TextColor
langs:
- csharp
name: Label
nameWithType: Label
fullName: Terminal.Label
type: Class
assemblies:
- Terminal
namespace: Terminal
summary: Label widget, displays a string at a given position, can include multiple lines.
syntax:
content: 'public class Label : Terminal.View'
inheritance:
- System.Object
- Terminal.Responder
- Terminal.View
implements: []
inheritedMembers:
- Terminal.Responder.CanFocus
- Terminal.Responder.MouseEvent(Terminal.MouseEvent)
- 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.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.PositionCursor
- Terminal.View.ProcessColdKey(Terminal.KeyEvent)
- Terminal.View.ProcessHotKey(Terminal.KeyEvent)
- Terminal.View.ProcessKey(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.Label.#ctor(Terminal.Rect,System.String)
id: '#ctor(Terminal.Rect,System.String)'
parent: Terminal.Label
langs:
- csharp
name: Label(Rect, String)
nameWithType: Label.Label(Rect, String)
fullName: Label.Label(Rect, String)
type: Constructor
assemblies:
- Terminal
namespace: Terminal
summary: >-
Public constructor: creates a label at the given
coordinate with the given string and uses the specified
frame for the string.
syntax:
content: public Label (Terminal.Rect rect, string text);
parameters:
- id: rect
type: Terminal.Rect
description: To be added.
- id: text
type: System.String
description: To be added.
overload: Terminal.Label.#ctor*
exceptions: []
- uid: Terminal.Label.#ctor(System.Int32,System.Int32,System.String)
id: '#ctor(System.Int32,System.Int32,System.String)'
parent: Terminal.Label
langs:
- csharp
name: Label(Int32, Int32, String)
nameWithType: Label.Label(Int32, Int32, String)
fullName: Label.Label(Int32, Int32, String)
type: Constructor
assemblies:
- Terminal
namespace: Terminal
summary: >-
Public constructor: creates a label at the given
coordinate with the given string, computes the bounding box
based on the size of the string, assumes that the string contains
newlines for multiple lines, no special breaking rules are used.
syntax:
content: public Label (int x, int y, string text);
parameters:
- id: x
type: System.Int32
description: To be added.
- id: y
type: System.Int32
description: To be added.
- id: text
type: System.String
description: To be added.
overload: Terminal.Label.#ctor*
exceptions: []
- uid: Terminal.Label.MeasureLines(System.String,System.Int32)
id: MeasureLines(System.String,System.Int32)
parent: Terminal.Label
langs:
- csharp
name: MeasureLines(String, Int32)
nameWithType: Label.MeasureLines(String, Int32)
fullName: Label.MeasureLines(String, Int32)
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Computes the number of lines needed to render the specified text by the Label control
syntax:
content: public static int MeasureLines (string text, int width);
parameters:
- id: text
type: System.String
description: Text, may contain newlines.
- id: width
type: System.Int32
description: The width for the text.
return:
type: System.Int32
description: Number of lines.
overload: Terminal.Label.MeasureLines*
exceptions: []
- uid: Terminal.Label.Redraw(Terminal.Rect)
id: Redraw(Terminal.Rect)
parent: Terminal.Label
langs:
- csharp
name: Redraw(Rect)
nameWithType: Label.Redraw(Rect)
fullName: Label.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.Label.Redraw*
exceptions: []
- uid: Terminal.Label.Text
id: Text
parent: Terminal.Label
langs:
- csharp
name: Text
nameWithType: Label.Text
fullName: Label.Text
type: Property
assemblies:
- Terminal
namespace: Terminal
summary: The text displayed by this widget.
syntax:
content: public virtual string Text { get; set; }
return:
type: System.String
description: To be added.
overload: Terminal.Label.Text*
exceptions: []
- uid: Terminal.Label.TextAlignment
id: TextAlignment
parent: Terminal.Label
langs:
- csharp
name: TextAlignment
nameWithType: Label.TextAlignment
fullName: Label.TextAlignment
type: Property
assemblies:
- Terminal
namespace: Terminal
summary: Controls the text-alignemtn property of the label, changing it will redisplay the label.
syntax:
content: public Terminal.TextAlignment TextAlignment { get; set; }
return:
type: Terminal.TextAlignment
description: The text alignment.
overload: Terminal.Label.TextAlignment*
exceptions: []
- uid: Terminal.Label.TextColor
id: TextColor
parent: Terminal.Label
langs:
- csharp
name: TextColor
nameWithType: Label.TextColor
fullName: Label.TextColor
type: Property
assemblies:
- Terminal
namespace: Terminal
summary: The color used for the label
syntax:
content: public Terminal.Attribute TextColor { get; set; }
return:
type: Terminal.Attribute
description: To be added.
overload: Terminal.Label.TextColor*
exceptions: []
references:
- uid: Terminal.View
parent: Terminal
isExternal: false
name: View
nameWithType: View
fullName: Terminal.View
- uid: Terminal.Label.#ctor(Terminal.Rect,System.String)
parent: Terminal.Label
isExternal: false
name: Label(Rect, String)
nameWithType: Label.Label(Rect, String)
fullName: Label.Label(Rect, String)
- uid: Terminal.Rect
parent: Terminal
isExternal: false
name: Rect
nameWithType: Rect
fullName: Terminal.Rect
- uid: System.String
parent: System
isExternal: true
name: String
nameWithType: String
fullName: System.String
- uid: Terminal.Label.#ctor(System.Int32,System.Int32,System.String)
parent: Terminal.Label
isExternal: false
name: Label(Int32, Int32, String)
nameWithType: Label.Label(Int32, Int32, String)
fullName: Label.Label(Int32, Int32, String)
- uid: System.Int32
parent: System
isExternal: true
name: Int32
nameWithType: Int32
fullName: System.Int32
- uid: Terminal.Label.MeasureLines(System.String,System.Int32)
parent: Terminal.Label
isExternal: false
name: MeasureLines(String, Int32)
nameWithType: Label.MeasureLines(String, Int32)
fullName: Label.MeasureLines(String, Int32)
- uid: Terminal.Label.Redraw(Terminal.Rect)
parent: Terminal.Label
isExternal: false
name: Redraw(Rect)
nameWithType: Label.Redraw(Rect)
fullName: Label.Redraw(Rect)
- uid: Terminal.Label.Text
parent: Terminal.Label
isExternal: false
name: Text
nameWithType: Label.Text
fullName: Label.Text
- uid: Terminal.Label.TextAlignment
parent: Terminal.Label
isExternal: false
name: TextAlignment
nameWithType: Label.TextAlignment
fullName: Label.TextAlignment
- uid: Terminal.TextAlignment
parent: Terminal
isExternal: false
name: TextAlignment
nameWithType: TextAlignment
fullName: Terminal.TextAlignment
- uid: Terminal.Label.TextColor
parent: Terminal.Label
isExternal: false
name: TextColor
nameWithType: Label.TextColor
fullName: Label.TextColor
- uid: Terminal.Attribute
parent: Terminal
isExternal: false
name: Attribute
nameWithType: Attribute
fullName: Terminal.Attribute
- uid: Terminal.Label.#ctor*
parent: Terminal.Label
isExternal: false
name: Label
nameWithType: Label.Label
fullName: Label.Label
- uid: Terminal.Label.MeasureLines*
parent: Terminal.Label
isExternal: false
name: MeasureLines
nameWithType: Label.MeasureLines
fullName: Label.MeasureLines
- uid: Terminal.Label.Redraw*
parent: Terminal.Label
isExternal: false
name: Redraw
nameWithType: Label.Redraw
fullName: Label.Redraw
- uid: Terminal.Label.Text*
parent: Terminal.Label
isExternal: false
name: Text
nameWithType: Label.Text
fullName: Label.Text
- uid: Terminal.Label.TextAlignment*
parent: Terminal.Label
isExternal: false
name: TextAlignment
nameWithType: Label.TextAlignment
fullName: Label.TextAlignment
- uid: Terminal.Label.TextColor*
parent: Terminal.Label
isExternal: false
name: TextColor
nameWithType: Label.TextColor
fullName: Label.TextColor
- 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.Responder.MouseEvent(Terminal.MouseEvent)
parent: Terminal.Responder
isExternal: false
name: MouseEvent(MouseEvent)
nameWithType: Responder.MouseEvent(MouseEvent)
fullName: Responder.MouseEvent(MouseEvent)
- 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.ProcessHotKey(Terminal.KeyEvent)
parent: Terminal.View
isExternal: false
name: ProcessHotKey(KeyEvent)
nameWithType: View.ProcessHotKey(KeyEvent)
fullName: View.ProcessHotKey(KeyEvent)
- uid: Terminal.View.ProcessKey(Terminal.KeyEvent)
parent: Terminal.View
isExternal: false
name: ProcessKey(KeyEvent)
nameWithType: View.ProcessKey(KeyEvent)
fullName: View.ProcessKey(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.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.PositionCursor
parent: Terminal.View
isExternal: false
name: PositionCursor()
nameWithType: View.PositionCursor()
fullName: View.PositionCursor()
- 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