diff --git a/docfx/README.md b/docfx/README.md index 42477bcd9..c12d87a75 100644 --- a/docfx/README.md +++ b/docfx/README.md @@ -4,9 +4,9 @@ The API documentation is generated using the [DocFX tool](https://github.com/dot ## To Generate the Docs -1. Do a `Release` build on `master`. This will cause all `/// ` references to be updated. -2. Change in to the `docfx/` directory. -3. Type `docfx --metadata` to generate metadata -4. Type `docfx --serve` to generate the docs and start a local webserver for testing. +0. Install DotFX https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html +1. Change to the `./docfx` folder and run `./build.ps1` +2. Browse to http://localhost:8080 and verify everything looks good. +3. Hit ctrl-c to stop the script. If `docfx` fails with a `Stackoverflow` error. Just run it again. And again. Sometimes it takes a few times. If that doesn't work, create a fresh clone or delete the `docfx/api`, `docfx/obj`, and `docs/` folders and run the steps above again. diff --git a/docfx/build.ps1 b/docfx/build.ps1 new file mode 100644 index 000000000..568687fe6 --- /dev/null +++ b/docfx/build.ps1 @@ -0,0 +1,9 @@ +# Builds the Terminal.gui API documentation using docfx + +dotnet build --configuration Release ../Terminal.sln + +rm ../docs -Recurse -Force + +docfx --metadata + +docfx --serve \ No newline at end of file diff --git a/docs/README.html b/docs/README.html index 08a3e8b58..b732397af 100644 --- a/docs/README.html +++ b/docs/README.html @@ -71,13 +71,15 @@
-

This folder generates the API docs for Terminal.Gui

+

This folder generates the API docs for Terminal.Gui.

+

The API documentation is generated using the DocFX tool. The output of docfx gets put into the ./docs folder which is then checked in. The ./docs folder is then picked up by Github Pages and published to Miguel's Github Pages (https://migueldeicaza.github.io/gui.cs/).

To Generate the Docs

    -
  1. Do a Release build on master. This will cause all /// <inheritdoc/> references to be updated.
    2. -
  2. Change in to the docfx/ directory.
    3. -
  3. Type docfx --metadata to generate metadata
    4. -
  4. Type docfx --serve to generate the docs and start a local webserver for testing.
    5. +
  5. Install DotFX https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html
    6. +
  6. From the solution root type ../docfx/build.ps1
    7. +
  7. Browse to http://localhost:8080 and verify everything looks good.
    8. +
  8. Hit ctrl-c to stop the script.
    9. +
  9. Commit to git.

If docfx fails with a Stackoverflow error. Just run it again. And again. Sometimes it takes a few times. If that doesn't work, create a fresh clone or delete the docfx/api, docfx/obj, and docs/ folders and run the steps above again.

diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Button.html b/docs/api/Terminal.Gui/Terminal.Gui.Button.html index 5d1cb2a73..ca4c4e386 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.Button.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.Button.html @@ -97,7 +97,6 @@ Button is a View that provides
Implements
System.IDisposable
-
System.Collections.IEnumerable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
@@ -130,6 +129,9 @@ Button is a View that provides
View.HotKeySpecifier
+
+ View.Data +
View.Driver
@@ -163,9 +165,6 @@ Button is a View that provides
View.Frame
-
- View.GetEnumerator() -
View.LayoutStyle
@@ -349,6 +348,9 @@ Button is a View that provides
View.OnMouseEvent(MouseEvent)
+
+ View.OnMouseClick(View.MouseEventArgs) +
View.Dispose(Boolean)
@@ -387,7 +389,7 @@ Button is a View that provides
Assembly: Terminal.Gui.dll
Syntax
- 
public class Button : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize
+ 
public class Button : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
Remarks
@@ -564,41 +566,6 @@ in a Dialog will implicitly
The width of the Button is computed based on the text length. The height will always be 1. -
-

Fields -

- - -

Clicked

-
-Clicked System.Action, raised when the user clicks the primary mouse button within the Bounds of this View -or if the user presses the action key while this view is focused. (TODO: IsDefault) -
-
-
Declaration
-
- 
public Action Clicked
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action
-
Remarks
-
-Client code can hook up to this event, it is -raised when the button is activated either with -the mouse or the keyboard.

Properties

@@ -913,14 +880,46 @@ chance to process the keystroke. derive directly from View, but you should if you derive other View subclasses.

+
+

Events +

+ + +

Clicked

+
+Clicked System.Action, raised when the user clicks the primary mouse button within the Bounds of this View +or if the user presses the action key while this view is focused. (TODO: IsDefault) +
+
+
Declaration
+
+ 
public event Action Clicked
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action
+
Remarks
+
+Client code can hook up to this event, it is +raised when the button is activated either with +the mouse or the keyboard.

Implements

System.IDisposable
-
- System.Collections.IEnumerable -
System.ComponentModel.ISupportInitializeNotification
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.CheckBox.html b/docs/api/Terminal.Gui/Terminal.Gui.CheckBox.html index 5f6734a6d..441f62f3c 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.CheckBox.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.CheckBox.html @@ -97,7 +97,6 @@ The CheckBox
Implements
System.IDisposable
-
System.Collections.IEnumerable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
@@ -130,6 +129,9 @@ The CheckBox View.HotKeySpecifier +
+ View.Data +
View.Driver
@@ -163,9 +165,6 @@ The CheckBox View.Frame -
- View.GetEnumerator() -
View.LayoutStyle
@@ -352,6 +351,9 @@ The CheckBox View.OnMouseEvent(MouseEvent) +
+ View.OnMouseClick(View.MouseEventArgs) +
View.Dispose(Boolean)
@@ -390,7 +392,7 @@ The CheckBox Syntax
- 
public class CheckBox : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize
+ 
public class CheckBox : View, IDisposable, ISupportInitializeNotification, ISupportInitialize

Constructors

@@ -532,40 +534,6 @@ Initializes a new instance of
The size of CheckBox is computed based on the text length. -
-

Fields -

- - -

Toggled

-
-Toggled event, raised when the CheckBox is toggled. -
-
-
Declaration
-
- 
public Action<bool> Toggled
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action<System.Boolean>
-
Remarks
-
-Client code can hook up to this event, it is -raised when the CheckBox is activated either with -the mouse or the keyboard. The passed bool contains the previous state.

Properties

@@ -824,14 +792,45 @@ Redraws this view and its subviews; only redraws the views that have been flagge Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter.

+ +

Events +

+ + +

Toggled

+
+Toggled event, raised when the CheckBox is toggled. +
+
+
Declaration
+
+ 
public event Action<bool> Toggled
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action<System.Boolean>
+
Remarks
+
+Client code can hook up to this event, it is +raised when the CheckBox is activated either with +the mouse or the keyboard. The passed bool contains the previous state.

Implements

System.IDisposable
-
- System.Collections.IEnumerable -
System.ComponentModel.ISupportInitializeNotification
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ComboBox.html b/docs/api/Terminal.Gui/Terminal.Gui.ComboBox.html index 9582c5851..770cdd654 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.ComboBox.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.ComboBox.html @@ -97,7 +97,6 @@ ComboBox control
Implements
System.IDisposable
-
System.Collections.IEnumerable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
@@ -130,6 +129,9 @@ ComboBox control
View.HotKeySpecifier
+
+ View.Data +
View.Driver
@@ -163,9 +165,6 @@ ComboBox control
View.Frame
-
- View.GetEnumerator() -
View.LayoutStyle
@@ -346,6 +345,9 @@ ComboBox control
View.OnMouseEvent(MouseEvent)
+
+ View.OnMouseClick(View.MouseEventArgs) +
View.Dispose(Boolean)
@@ -384,7 +386,7 @@ ComboBox control
Assembly: Terminal.Gui.dll
Syntax
- 
public class ComboBox : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize
+ 
public class ComboBox : View, IDisposable, ISupportInitializeNotification, ISupportInitialize

Constructors

@@ -463,60 +465,6 @@ Public constructor -

Fields -

- - -

OpenSelectedItem

-
-This event is raised when the user Double Clicks on an item or presses ENTER to open the selected item. -
-
-
Declaration
-
- 
public Action<ListViewItemEventArgs> OpenSelectedItem
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action<ListViewItemEventArgs>
- - -

SelectedItemChanged

-
-This event is raised when the selected item in the ComboBox has changed. -
-
-
Declaration
-
- 
public Action<ListViewItemEventArgs> SelectedItemChanged
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action<ListViewItemEventArgs>

Properties

@@ -967,13 +915,64 @@ Sets the source of the ComboBo
Use the Source property to set a new IListDataSource source and use custome rendering.
+

Events +

+ + +

OpenSelectedItem

+
+This event is raised when the user Double Clicks on an item or presses ENTER to open the selected item. +
+
+
Declaration
+
+ 
public event Action<ListViewItemEventArgs> OpenSelectedItem
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action<ListViewItemEventArgs>
+ + +

SelectedItemChanged

+
+This event is raised when the selected item in the ComboBox has changed. +
+
+
Declaration
+
+ 
public event Action<ListViewItemEventArgs> SelectedItemChanged
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action<ListViewItemEventArgs>

Implements

System.IDisposable
-
- System.Collections.IEnumerable -
System.ComponentModel.ISupportInitializeNotification
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.DateField.html b/docs/api/Terminal.Gui/Terminal.Gui.DateField.html index d6d85e155..1b389d41e 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.DateField.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.DateField.html @@ -98,7 +98,6 @@ Simple Date editing View
Implements
System.IDisposable
-
System.Collections.IEnumerable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
@@ -185,6 +184,9 @@ Simple Date editing View
View.HotKeySpecifier
+
+ View.Data +
View.Driver
@@ -212,9 +214,6 @@ Simple Date editing View
View.WantContinuousButtonPressed
-
- View.GetEnumerator() -
View.LayoutStyle
@@ -398,6 +397,9 @@ Simple Date editing View
View.OnMouseEvent(MouseEvent)
+
+ View.OnMouseClick(View.MouseEventArgs) +
View.Dispose(Boolean)
@@ -436,7 +438,7 @@ Simple Date editing View
Assembly: Terminal.Gui.dll
Syntax
- 
public class DateField : TextField, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize
+ 
public class DateField : TextField, IDisposable, ISupportInitializeNotification, ISupportInitialize
Remarks
@@ -529,38 +531,6 @@ Initializes a new instance of -

Fields -

- - -

DateChanged

-
-DateChanged event, raised when the Date property has changed. -
-
-
Declaration
-
- 
public Action<DateTimeEventArgs<DateTime>> DateChanged
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action<DateTimeEventArgs<System.DateTime>>
-
Remarks
-
-This event is raised when the Date property changes. -

Properties

@@ -747,14 +717,43 @@ Processes key presses for the The TextField control responds to the following keys:
KeysFunction
Delete, BackspaceDeletes the character before cursor.
+
+

Events +

+ + +

DateChanged

+
+DateChanged event, raised when the Date property has changed. +
+
+
Declaration
+
+ 
public event Action<DateTimeEventArgs<DateTime>> DateChanged
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action<DateTimeEventArgs<System.DateTime>>
+
Remarks
+
+This event is raised when the Date property changes.

Implements

System.IDisposable
-
- System.Collections.IEnumerable -
System.ComponentModel.ISupportInitializeNotification
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Dialog.html b/docs/api/Terminal.Gui/Terminal.Gui.Dialog.html index f46767b3f..e397f0e36 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.Dialog.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.Dialog.html @@ -103,16 +103,12 @@ or more Buttons. It defaults
System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
-
System.Collections.IEnumerable
Inherited Members
Window.Title
-
- Window.GetEnumerator() -
Window.Add(View)
@@ -191,6 +187,9 @@ or more Buttons. It defaults
View.HotKeySpecifier
+
+ View.Data +
View.Driver
@@ -392,6 +391,9 @@ or more Buttons. It defaults
View.OnMouseEvent(MouseEvent)
+
+ View.OnMouseClick(View.MouseEventArgs) +
View.Dispose(Boolean)
@@ -430,7 +432,7 @@ or more Buttons. It defaults
Assembly: Terminal.Gui.dll
Syntax
- 
public class Dialog : Window, IDisposable, ISupportInitializeNotification, ISupportInitialize, IEnumerable
+ 
public class Dialog : Window, IDisposable, ISupportInitializeNotification, ISupportInitialize
Remarks
@@ -660,9 +662,6 @@ chance to process the keystroke.
System.ComponentModel.ISupportInitialize
-
- System.Collections.IEnumerable -
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.FileDialog.html b/docs/api/Terminal.Gui/Terminal.Gui.FileDialog.html index 59dae4fbe..17e71694c 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.FileDialog.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.FileDialog.html @@ -104,7 +104,6 @@ Base class for the OpenDialo
System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
-
System.Collections.IEnumerable
Inherited Members
@@ -117,9 +116,6 @@ Base class for the OpenDialo
Window.Title
-
- Window.GetEnumerator() -
Window.Add(View)
@@ -195,6 +191,9 @@ Base class for the OpenDialo
View.HotKeySpecifier
+
+ View.Data +
View.Driver
@@ -396,6 +395,9 @@ Base class for the OpenDialo
View.OnMouseEvent(MouseEvent)
+
+ View.OnMouseClick(View.MouseEventArgs) +
View.Dispose(Boolean)
@@ -434,7 +436,7 @@ Base class for the OpenDialo
Assembly: Terminal.Gui.dll
Syntax
- 
public class FileDialog : Dialog, IDisposable, ISupportInitializeNotification, ISupportInitialize, IEnumerable
+ 
public class FileDialog : Dialog, IDisposable, ISupportInitializeNotification, ISupportInitialize

Constructors

@@ -793,9 +795,6 @@ the views have been laid out, and before the views are drawn for the first time.
System.ComponentModel.ISupportInitialize
-
- System.Collections.IEnumerable -
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.FrameView.html b/docs/api/Terminal.Gui/Terminal.Gui.FrameView.html index e1abf2432..bb1af6400 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.FrameView.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.FrameView.html @@ -98,7 +98,6 @@ a GroupBox in Windows.
Implements
System.IDisposable
-
System.Collections.IEnumerable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
@@ -131,6 +130,9 @@ a GroupBox in Windows.
View.HotKeySpecifier
+
+ View.Data +
View.Driver
@@ -164,9 +166,6 @@ a GroupBox in Windows.
View.Frame
-
- View.GetEnumerator() -
View.LayoutStyle
@@ -347,6 +346,9 @@ a GroupBox in Windows.
View.OnMouseEvent(MouseEvent)
+
+ View.OnMouseClick(View.MouseEventArgs) +
View.Dispose(Boolean)
@@ -388,7 +390,7 @@ a GroupBox in Windows.
Assembly: Terminal.Gui.dll
Syntax
- 
public class FrameView : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize
+ 
public class FrameView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize

Constructors

@@ -726,9 +728,6 @@ Removes all Views from this co
System.IDisposable
-
- System.Collections.IEnumerable -
System.ComponentModel.ISupportInitializeNotification
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.HexView.html b/docs/api/Terminal.Gui/Terminal.Gui.HexView.html index 560d3e7d1..e8a021e8f 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.HexView.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.HexView.html @@ -97,7 +97,6 @@ An hex viewer and editor View
Implements
System.IDisposable
-
System.Collections.IEnumerable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
@@ -130,6 +129,9 @@ An hex viewer and editor View
View.HotKeySpecifier
+
+ View.Data +
View.Driver
@@ -160,9 +162,6 @@ An hex viewer and editor View
View.WantContinuousButtonPressed
-
- View.GetEnumerator() -
View.LayoutStyle
@@ -352,6 +351,9 @@ An hex viewer and editor View
View.OnMouseEvent(MouseEvent)
+
+ View.OnMouseClick(View.MouseEventArgs) +
View.Dispose(Boolean)
@@ -393,7 +395,7 @@ An hex viewer and editor View
Assembly: Terminal.Gui.dll
Syntax
- 
public class HexView : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize
+ 
public class HexView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
Remarks
@@ -755,9 +757,6 @@ Redraws this view and its subviews; only redraws the views that have been flagge
System.IDisposable
-
- System.Collections.IEnumerable -
System.ComponentModel.ISupportInitializeNotification
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Label.html b/docs/api/Terminal.Gui/Terminal.Gui.Label.html index 611e2e501..6a9bede8a 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.Label.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.Label.html @@ -97,7 +97,6 @@ The Label View displays a stri
Implements
System.IDisposable
-
System.Collections.IEnumerable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
@@ -130,6 +129,9 @@ The Label View displays a stri
View.HotKeySpecifier
+
+ View.Data +
View.Driver
@@ -163,9 +165,6 @@ The Label View displays a stri
View.Frame
-
- View.GetEnumerator() -
View.LayoutStyle
@@ -361,6 +360,9 @@ The Label View displays a stri
View.OnMouseLeave(MouseEvent)
+
+ View.OnMouseClick(View.MouseEventArgs) +
View.Dispose(Boolean)
@@ -402,7 +404,7 @@ The Label View displays a stri
Assembly: Terminal.Gui.dll
Syntax
- 
public class Label : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize
+ 
public class Label : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
Remarks
@@ -589,41 +591,6 @@ Initializes a new instance of View

If rect.Height is greater than one, word wrapping is provided.

-
-

Fields -

- - -

Clicked

-
-Clicked System.Action, raised when the user clicks the primary mouse button within the Bounds of this View -or if the user presses the action key while this view is focused. (TODO: IsDefault) -
-
-
Declaration
-
- 
public Action Clicked
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action
-
Remarks
-
-Client code can hook up to this event, it is -raised when the button is activated either with -the mouse or the keyboard.

Methods

@@ -673,13 +640,45 @@ Method invoked when a mouse event is generated
Overrides
View.OnMouseEvent(MouseEvent)
+

Events +

+ + +

Clicked

+
+Clicked System.Action, raised when the user clicks the primary mouse button within the Bounds of this View +or if the user presses the action key while this view is focused. (TODO: IsDefault) +
+
+
Declaration
+
+ 
public event Action Clicked
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action
+
Remarks
+
+Client code can hook up to this event, it is +raised when the button is activated either with +the mouse or the keyboard. +

Implements

System.IDisposable
-
- System.Collections.IEnumerable -
System.ComponentModel.ISupportInitializeNotification
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ListView.html b/docs/api/Terminal.Gui/Terminal.Gui.ListView.html index 112dc3d3e..9a0ad929a 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.ListView.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.ListView.html @@ -97,7 +97,6 @@ ListView View renders a scroll
Implements
System.IDisposable
-
System.Collections.IEnumerable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
@@ -130,6 +129,9 @@ ListView View renders a scroll
View.HotKeySpecifier
+
+ View.Data +
View.Driver
@@ -163,9 +165,6 @@ ListView View renders a scroll
View.Frame
-
- View.GetEnumerator() -
View.LayoutStyle
@@ -349,6 +348,9 @@ ListView View renders a scroll
View.OnMouseEvent(MouseEvent)
+
+ View.OnMouseClick(View.MouseEventArgs) +
View.Dispose(Boolean)
@@ -387,7 +389,7 @@ ListView View renders a scroll
Assembly: Terminal.Gui.dll
Syntax
- 
public class ListView : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize
+ 
public class ListView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
Remarks
@@ -561,60 +563,6 @@ Initializes a new instance of -

Fields -

- - -

OpenSelectedItem

-
-This event is raised when the user Double Clicks on an item or presses ENTER to open the selected item. -
-
-
Declaration
-
- 
public Action<ListViewItemEventArgs> OpenSelectedItem
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action<ListViewItemEventArgs>
- - -

SelectedItemChanged

-
-This event is raised when the selected item in the ListView has changed. -
-
-
Declaration
-
- 
public Action<ListViewItemEventArgs> SelectedItemChanged
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action<ListViewItemEventArgs>

Properties

@@ -1378,13 +1326,64 @@ Sets the source to an System.Collections.IList value a
Use the Source property to set a new IListDataSource source and use custome rendering.
+

Events +

+ + +

OpenSelectedItem

+
+This event is raised when the user Double Clicks on an item or presses ENTER to open the selected item. +
+
+
Declaration
+
+ 
public event Action<ListViewItemEventArgs> OpenSelectedItem
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action<ListViewItemEventArgs>
+ + +

SelectedItemChanged

+
+This event is raised when the selected item in the ListView has changed. +
+
+
Declaration
+
+ 
public event Action<ListViewItemEventArgs> SelectedItemChanged
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action<ListViewItemEventArgs>

Implements

System.IDisposable
-
- System.Collections.IEnumerable -
System.ComponentModel.ISupportInitializeNotification
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.MenuBar.html b/docs/api/Terminal.Gui/Terminal.Gui.MenuBar.html index 47b3759d7..033f6c812 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.MenuBar.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.MenuBar.html @@ -97,7 +97,6 @@ The MenuBar provides a menu for Terminal.Gui applications.
Implements
System.IDisposable
-
System.Collections.IEnumerable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
@@ -130,6 +129,9 @@ The MenuBar provides a menu for Terminal.Gui applications.
View.HotKeySpecifier
+
+ View.Data +
View.Driver
@@ -163,9 +165,6 @@ The MenuBar provides a menu for Terminal.Gui applications.
View.Frame
-
- View.GetEnumerator() -
View.LayoutStyle
@@ -343,6 +342,9 @@ The MenuBar provides a menu for Terminal.Gui applications.
View.OnMouseEvent(MouseEvent)
+
+ View.OnMouseClick(View.MouseEventArgs) +
View.Dispose(Boolean)
@@ -381,7 +383,7 @@ The MenuBar provides a menu for Terminal.Gui applications.
Assembly: Terminal.Gui.dll
Syntax
- 
public class MenuBar : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize
+ 
public class MenuBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
Remarks
@@ -435,60 +437,6 @@ Initializes a new instance of the Fields - - - -

MenuClosing

-
-Raised when a menu is closing. -
-
-
Declaration
-
- 
public Action MenuClosing
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action
- - -

MenuOpening

-
-Raised as a menu is opening. -
-
-
Declaration
-
- 
public Action MenuOpening
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action

Properties

@@ -1019,13 +967,64 @@ Redraws this view and its subviews; only redraws the views that have been flagge larger than the region parameter.

+

Events +

+ + +

MenuClosing

+
+Raised when a menu is closing. +
+
+
Declaration
+
+ 
public event Action MenuClosing
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action
+ + +

MenuOpening

+
+Raised as a menu is opening. +
+
+
Declaration
+
+ 
public event Action MenuOpening
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action

Implements

System.IDisposable
-
- System.Collections.IEnumerable -
System.ComponentModel.ISupportInitializeNotification
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.MenuBarItem.html b/docs/api/Terminal.Gui/Terminal.Gui.MenuBarItem.html index 277ea2c0a..48bcf84d7 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.MenuBarItem.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.MenuBarItem.html @@ -98,9 +98,6 @@ A MenuBarItem contains
MenuItem.HotKey
-
- MenuItem.ShortCut -
MenuItem.Title
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.MenuItem.html b/docs/api/Terminal.Gui/Terminal.Gui.MenuItem.html index 6c41440eb..bd660a408 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.MenuItem.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.MenuItem.html @@ -216,32 +216,6 @@ if the ShortCut is set to "Control-N", this would be a global hotkey t - - -

ShortCut

-
-This is the global setting that can be used as a global shortcut to invoke the action on the menu. -
-
-
Declaration
-
- 
public Key ShortCut
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
Key

Properties

diff --git a/docs/api/Terminal.Gui/Terminal.Gui.MouseFlags.html b/docs/api/Terminal.Gui/Terminal.Gui.MouseFlags.html index 7d9a59ed2..5496e0460 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.MouseFlags.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.MouseFlags.html @@ -262,6 +262,18 @@ The mouse position is being reported in this event. WheeledDown Vertical button wheeled up. + + + + WheeledLeft + +Vertical button wheeled up while pressing ButtonShift. + + + + WheeledRight + +Vertical button wheeled down while pressing ButtonShift. diff --git a/docs/api/Terminal.Gui/Terminal.Gui.OpenDialog.html b/docs/api/Terminal.Gui/Terminal.Gui.OpenDialog.html index 7234a6a54..20eb9a92d 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.OpenDialog.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.OpenDialog.html @@ -103,7 +103,6 @@ The OpenDialogprovides a
System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
-
System.Collections.IEnumerable
Inherited Members
@@ -149,9 +148,6 @@ The OpenDialogprovides a
Window.Title
-
- Window.GetEnumerator() -
Window.Add(View)
@@ -227,6 +223,9 @@ The OpenDialogprovides a
View.HotKeySpecifier
+
+ View.Data +
View.Driver
@@ -428,6 +427,9 @@ The OpenDialogprovides a
View.OnMouseEvent(MouseEvent)
+
+ View.OnMouseClick(View.MouseEventArgs) +
View.Dispose(Boolean)
@@ -466,7 +468,7 @@ The OpenDialogprovides a
Assembly: Terminal.Gui.dll
Syntax
- 
public class OpenDialog : FileDialog, IDisposable, ISupportInitializeNotification, ISupportInitialize, IEnumerable
+ 
public class OpenDialog : FileDialog, IDisposable, ISupportInitializeNotification, ISupportInitialize
Remarks
@@ -652,9 +654,6 @@ Returns the selected files, or an empty list if nothing has been selected
System.ComponentModel.ISupportInitialize
-
- System.Collections.IEnumerable -
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ProgressBar.html b/docs/api/Terminal.Gui/Terminal.Gui.ProgressBar.html index b50569586..aa69b5115 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.ProgressBar.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.ProgressBar.html @@ -97,7 +97,6 @@ A Progress Bar view that can indicate progress of an activity visually.
Implements
System.IDisposable
-
System.Collections.IEnumerable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
@@ -130,6 +129,9 @@ A Progress Bar view that can indicate progress of an activity visually.
View.HotKeySpecifier
+
+ View.Data +
View.Driver
@@ -163,9 +165,6 @@ A Progress Bar view that can indicate progress of an activity visually.
View.Frame
-
- View.GetEnumerator() -
View.LayoutStyle
@@ -361,6 +360,9 @@ A Progress Bar view that can indicate progress of an activity visually.
View.OnMouseEvent(MouseEvent)
+
+ View.OnMouseClick(View.MouseEventArgs) +
View.Dispose(Boolean)
@@ -402,7 +404,7 @@ A Progress Bar view that can indicate progress of an activity visually.
Assembly: Terminal.Gui.dll
Syntax
- 
public class ProgressBar : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize
+ 
public class ProgressBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
Remarks
@@ -555,9 +557,6 @@ Redraws this view and its subviews; only redraws the views that have been flagge
System.IDisposable
-
- System.Collections.IEnumerable -
System.ComponentModel.ISupportInitializeNotification
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.RadioGroup.html b/docs/api/Terminal.Gui/Terminal.Gui.RadioGroup.html index d75cf13f1..7ec6ff824 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.RadioGroup.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.RadioGroup.html @@ -97,7 +97,6 @@
Implements
System.IDisposable
-
System.Collections.IEnumerable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
@@ -130,6 +129,9 @@
View.HotKeySpecifier
+
+ View.Data +
View.Driver
@@ -163,9 +165,6 @@
View.Frame
-
- View.GetEnumerator() -
View.LayoutStyle
@@ -352,6 +351,9 @@
View.OnMouseEvent(MouseEvent)
+
+ View.OnMouseClick(View.MouseEventArgs) +
View.Dispose(Boolean)
@@ -390,7 +392,7 @@
Assembly: Terminal.Gui.dll
Syntax
- 
public class RadioGroup : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize
+ 
public class RadioGroup : View, IDisposable, ISupportInitializeNotification, ISupportInitialize

Constructors

@@ -524,34 +526,6 @@ Initializes a new instance of the Fields - - - -

SelectedItemChanged

-
-Invoked when the selected radio label has changed. -
-
-
Declaration
-
- 
public Action<RadioGroup.SelectedItemChangedArgs> SelectedItemChanged
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action<RadioGroup.SelectedItemChangedArgs>

Properties

@@ -934,13 +908,50 @@ Redraws this view and its subviews; only redraws the views that have been flagge larger than the region parameter.

+ + + +

Refresh()

+
+Allow to invoke the SelectedItemChanged after their creation. +
+
+
Declaration
+
+ 
public void Refresh()
+
+

Events +

+ + +

SelectedItemChanged

+
+Invoked when the selected radio label has changed. +
+
+
Declaration
+
+ 
public event Action<RadioGroup.SelectedItemChangedArgs> SelectedItemChanged
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action<RadioGroup.SelectedItemChangedArgs>

Implements

System.IDisposable
-
- System.Collections.IEnumerable -
System.ComponentModel.ISupportInitializeNotification
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.SaveDialog.html b/docs/api/Terminal.Gui/Terminal.Gui.SaveDialog.html index a2c100d69..9f390a28a 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.SaveDialog.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.SaveDialog.html @@ -104,7 +104,6 @@ save.
System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
-
System.Collections.IEnumerable
Inherited Members
@@ -150,9 +149,6 @@ save.
Window.Title
-
- Window.GetEnumerator() -
Window.Add(View)
@@ -228,6 +224,9 @@ save.
View.HotKeySpecifier
+
+ View.Data +
View.Driver
@@ -429,6 +428,9 @@ save.
View.OnMouseEvent(MouseEvent)
+
+ View.OnMouseClick(View.MouseEventArgs) +
View.Dispose(Boolean)
@@ -467,7 +469,7 @@ save.
Assembly: Terminal.Gui.dll
Syntax
- 
public class SaveDialog : FileDialog, IDisposable, ISupportInitializeNotification, ISupportInitialize, IEnumerable
+ 
public class SaveDialog : FileDialog, IDisposable, ISupportInitializeNotification, ISupportInitialize
Remarks
@@ -566,9 +568,6 @@ if the user canceled the Sav
System.ComponentModel.ISupportInitialize
-
- System.Collections.IEnumerable -
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ScrollBarView.html b/docs/api/Terminal.Gui/Terminal.Gui.ScrollBarView.html index 94b79cd62..2b4866607 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.ScrollBarView.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.ScrollBarView.html @@ -97,7 +97,6 @@ ScrollBarViews are views that display a 1-character scrollbar, either horizontal
Implements
System.IDisposable
-
System.Collections.IEnumerable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
@@ -130,6 +129,9 @@ ScrollBarViews are views that display a 1-character scrollbar, either horizontal
View.HotKeySpecifier
+
+ View.Data +
View.Driver
@@ -163,9 +165,6 @@ ScrollBarViews are views that display a 1-character scrollbar, either horizontal
View.Frame
-
- View.GetEnumerator() -
View.LayoutStyle
@@ -361,6 +360,9 @@ ScrollBarViews are views that display a 1-character scrollbar, either horizontal
View.OnMouseEvent(MouseEvent)
+
+ View.OnMouseClick(View.MouseEventArgs) +
View.Dispose(Boolean)
@@ -399,7 +401,7 @@ ScrollBarViews are views that display a 1-character scrollbar, either horizontal
Assembly: Terminal.Gui.dll
Syntax
- 
public class ScrollBarView : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize
+ 
public class ScrollBarView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
Remarks
@@ -538,20 +540,21 @@ Initializes a new instance of the Fields +

Properties

-

ChangedPosition

+ +

Host

-This event is raised when the position on the scrollbar has changed. +Get or sets the view that host this ScrollView
Declaration
- 
public Action ChangedPosition
+ 
public ScrollView Host { get; }
-
Field Value
+
Property Value
@@ -561,13 +564,11 @@ This event is raised when the position on the scrollbar has changed. - +
System.ActionScrollView
-

Properties -

@@ -745,13 +746,38 @@ Redraws this view and its subviews; only redraws the views that have been flagge larger than the region parameter.

+

Events +

+ + +

ChangedPosition

+
+This event is raised when the position on the scrollbar has changed. +
+
+
Declaration
+
+ 
public event Action ChangedPosition
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action

Implements

System.IDisposable
-
- System.Collections.IEnumerable -
System.ComponentModel.ISupportInitializeNotification
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.ScrollView.html b/docs/api/Terminal.Gui/Terminal.Gui.ScrollView.html index 2defd0603..4c12a0de0 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.ScrollView.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.ScrollView.html @@ -97,7 +97,6 @@ Scrollviews are views that present a window into a virtual space where subviews
Implements
System.IDisposable
-
System.Collections.IEnumerable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
@@ -130,6 +129,9 @@ Scrollviews are views that present a window into a virtual space where subviews
View.HotKeySpecifier
+
+ View.Data +
View.Driver
@@ -163,9 +165,6 @@ Scrollviews are views that present a window into a virtual space where subviews
View.Frame
-
- View.GetEnumerator() -
View.LayoutStyle
@@ -349,6 +348,9 @@ Scrollviews are views that present a window into a virtual space where subviews
View.OnMouseEvent(MouseEvent)
+
+ View.OnMouseClick(View.MouseEventArgs) +
View.BeginInit()
@@ -384,7 +386,7 @@ Scrollviews are views that present a window into a virtual space where subviews
Assembly: Terminal.Gui.dll
Syntax
- 
public class ScrollView : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize
+ 
public class ScrollView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
Remarks
@@ -525,6 +527,33 @@ Represents the contents of the data shown inside the scrolview + +

KeepContentAlwaysInViewport

+
+Get or sets if the view-port is kept always visible in the area of this ScrollView +
+
+
Declaration
+
+ 
public bool KeepContentAlwaysInViewport { get; set; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
System.Boolean
+ +

ShowHorizontalScrollIndicator

@@ -1018,9 +1047,6 @@ Scrolls the view up.
System.IDisposable
-
- System.Collections.IEnumerable -
System.ComponentModel.ISupportInitializeNotification
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.StatusBar.html b/docs/api/Terminal.Gui/Terminal.Gui.StatusBar.html index 0fbeca351..8f59f5fd5 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.StatusBar.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.StatusBar.html @@ -100,7 +100,6 @@ So for each context must be a new instance of a statusbar.
Implements
System.IDisposable
-
System.Collections.IEnumerable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
@@ -133,6 +132,9 @@ So for each context must be a new instance of a statusbar. +
+ View.Data +
@@ -166,9 +168,6 @@ So for each context must be a new instance of a statusbar. - @@ -361,6 +360,9 @@ So for each context must be a new instance of a statusbar. + @@ -396,7 +398,7 @@ So for each context must be a new instance of a statusbar.
Assembly: Terminal.Gui.dll
Syntax
- 
public class StatusBar : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize
+ 
public class StatusBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize

Constructors

@@ -673,9 +675,6 @@ Redraws this view and its subviews; only redraws the views that have been flagge
System.IDisposable
-
- System.Collections.IEnumerable -
System.ComponentModel.ISupportInitializeNotification
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TextField.html b/docs/api/Terminal.Gui/Terminal.Gui.TextField.html index ea20ad9d2..8c5b793b9 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.TextField.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.TextField.html @@ -99,7 +99,6 @@ Single-line text entry View
Implements
System.IDisposable
-
System.Collections.IEnumerable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
@@ -132,6 +131,9 @@ Single-line text entry View +
+ View.Data +
@@ -159,9 +161,6 @@ Single-line text entry View - @@ -345,6 +344,9 @@ Single-line text entry View + @@ -383,7 +385,7 @@ Single-line text entry View
Assembly: Terminal.Gui.dll
Syntax
- 
public class TextField : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize
+ 
public class TextField : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
Remarks
@@ -505,38 +507,6 @@ Initializes a new instance of the Fields - - - -

TextChanged

-
-Changed event, raised when the text has changed. -
-
-
Declaration
-
- 
public Action<ustring> TextChanged
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action<NStack.ustring>
-
Remarks
-
-This event is raised when the Text changes. -

Properties

@@ -1081,14 +1051,43 @@ Redraws this view and its subviews; only redraws the views that have been flagge Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter.

+
+

Events +

+ + +

TextChanged

+
+Changed event, raised when the text has changed. +
+
+
Declaration
+
+ 
public event Action<ustring> TextChanged
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action<NStack.ustring>
+
Remarks
+
+This event is raised when the Text changes.

Implements

System.IDisposable
-
- System.Collections.IEnumerable -
System.ComponentModel.ISupportInitializeNotification
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TextFormatter.html b/docs/api/Terminal.Gui/Terminal.Gui.TextFormatter.html index 716509c9a..9471aa435 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.TextFormatter.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.TextFormatter.html @@ -153,6 +153,33 @@ Controls the horizontal text-alignment property. + +

CursorPosition

+
+Gets the cursor position from HotKey. If the HotKey is defined, the cursor will be positioned over it. +
+
+
Declaration
+
+ 
public int CursorPosition { get; set; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
System.Int32
+ +

HotKey

diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TextView.html b/docs/api/Terminal.Gui/Terminal.Gui.TextView.html index ce43c6025..5a1a26676 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.TextView.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.TextView.html @@ -97,7 +97,6 @@ Multi-line text editing View
Implements
System.IDisposable
-
System.Collections.IEnumerable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
@@ -130,6 +129,9 @@ Multi-line text editing View +
+ View.Data +
@@ -160,9 +162,6 @@ Multi-line text editing View - @@ -349,6 +348,9 @@ Multi-line text editing View + @@ -387,7 +389,7 @@ Multi-line text editing View
Assembly: Terminal.Gui.dll
Syntax
- 
public class TextView : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize
+ 
public class TextView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
Remarks
@@ -412,6 +414,10 @@ keys. Moves the cursor to the beginning of the line. End key, Control-e Moves the cursor to the end of the line. +Control-Home + Scrolls to the first line and moves the cursor there. +Control-End + Scrolls to the last line and moves the cursor there. Delete, Control-d Deletes the character in front of the cursor. Backspace @@ -477,34 +483,6 @@ Initializes a TextView on
Remarks
-

Fields -

- - -

TextChanged

-
-Raised when the Text of the TextView changes. -
-
-
Declaration
-
- 
public Action TextChanged
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action

Properties

@@ -799,6 +777,30 @@ Method invoked when a mouse event is generated + +

MoveEnd()

+
+Will scroll the TextView to the last line and position the cursor there. +
+
+
Declaration
+
+ 
public void MoveEnd()
+
+ + + +

MoveHome()

+
+Will scroll the TextView to the first line and position the cursor there. +
+
+
Declaration
+
+ 
public void MoveHome()
+
+ +

PositionCursor()

@@ -951,13 +953,38 @@ Will scroll the TextView t +

Events +

+ + +

TextChanged

+
+Raised when the Text of the TextView changes. +
+
+
Declaration
+
+ 
public event Action TextChanged
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action

Implements

System.IDisposable
-
- System.Collections.IEnumerable -
System.ComponentModel.ISupportInitializeNotification
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.TimeField.html b/docs/api/Terminal.Gui/Terminal.Gui.TimeField.html index 433fff390..c116cd3df 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.TimeField.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.TimeField.html @@ -98,7 +98,6 @@ Time editing View
Implements
System.IDisposable
-
System.Collections.IEnumerable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
@@ -185,6 +184,9 @@ Time editing View +
+ View.Data +
@@ -212,9 +214,6 @@ Time editing View - @@ -398,6 +397,9 @@ Time editing View + @@ -436,7 +438,7 @@ Time editing View
Assembly: Terminal.Gui.dll
Syntax
- 
public class TimeField : TextField, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize
+ 
public class TimeField : TextField, IDisposable, ISupportInitializeNotification, ISupportInitialize
Remarks
@@ -529,38 +531,6 @@ Initializes a new instance of -

Fields -

- - -

TimeChanged

-
-TimeChanged event, raised when the Date has changed. -
-
-
Declaration
-
- 
public Action<DateTimeEventArgs<TimeSpan>> TimeChanged
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action<DateTimeEventArgs<System.TimeSpan>>
-
Remarks
-
-This event is raised when the Time changes. -

Properties

@@ -747,14 +717,43 @@ Processes key presses for the The TextField control responds to the following keys:
KeysFunction
Delete, BackspaceDeletes the character before cursor.
+
+

Events +

+ + +

TimeChanged

+
+TimeChanged event, raised when the Date has changed. +
+
+
Declaration
+
+ 
public event Action<DateTimeEventArgs<TimeSpan>> TimeChanged
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action<DateTimeEventArgs<System.TimeSpan>>
+
Remarks
+
+This event is raised when the Time changes.

Implements

System.IDisposable
-
- System.Collections.IEnumerable -
System.ComponentModel.ISupportInitializeNotification
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Toplevel.html b/docs/api/Terminal.Gui/Terminal.Gui.Toplevel.html index 7c321d2c4..6f1202bec 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.Toplevel.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.Toplevel.html @@ -98,7 +98,6 @@ Toplevel views can be modally executed.
Implements
System.IDisposable
-
System.Collections.IEnumerable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
@@ -131,6 +130,9 @@ Toplevel views can be modally executed. +
+ View.Data +
@@ -161,9 +163,6 @@ Toplevel views can be modally executed. - @@ -341,6 +340,9 @@ Toplevel views can be modally executed. + @@ -382,7 +384,7 @@ Toplevel views can be modally executed.
Assembly: Terminal.Gui.dll
Syntax
- 
public class Toplevel : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize
+ 
public class Toplevel : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
Remarks
@@ -454,36 +456,6 @@ Initializes a new instance of the Fields - - - -

Ready

-
-Fired once the Toplevel's MainLoop has started it's first iteration. -Subscribe to this event to perform tasks when the Toplevel has been laid out and focus has been set. -changes. A Ready event handler is a good place to finalize initialization after calling `Run()(topLevel)`. -
-
-
Declaration
-
- 
public Action Ready
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action

Properties

@@ -953,13 +925,40 @@ the views have been laid out, and before the views are drawn for the first time. 
public virtual void WillPresent()
+

Events +

+ + +

Ready

+
+Fired once the Toplevel's MainLoop has started it's first iteration. +Subscribe to this event to perform tasks when the Toplevel has been laid out and focus has been set. +changes. A Ready event handler is a good place to finalize initialization after calling `Run()(topLevel)`. +
+
+
Declaration
+
+ 
public event Action Ready
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action

Implements

System.IDisposable
-
- System.Collections.IEnumerable -
System.ComponentModel.ISupportInitializeNotification
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.View.html b/docs/api/Terminal.Gui/Terminal.Gui.View.html index e008dd739..f6a7af11a 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.View.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.View.html @@ -112,7 +112,6 @@ View is the base class for all views on the screen and represents a visible elem
Implements
System.IDisposable
-
System.Collections.IEnumerable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
@@ -147,7 +146,7 @@ View is the base class for all views on the screen and represents a visible elem
Assembly: Terminal.Gui.dll
Syntax
- 
public class View : Responder, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize
+ 
public class View : Responder, IDisposable, ISupportInitializeNotification, ISupportInitialize
Remarks
@@ -421,363 +420,6 @@ Initializes a new instance of View If rect.Height is greater than one, word wrapping is provided.

-

Fields -

- - -

Added

-
-Event fired when a subview is being added to this view. -
-
-
Declaration
-
- 
public Action<View> Added
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action<View>
- - -

DrawContent

-
-Event invoked when the content area of the View is to be drawn. -
-
-
Declaration
-
- 
public Action<Rect> DrawContent
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action<Rect>
-
Remarks
-
-

-Will be invoked before any subviews added with Add(View) have been drawn. -

-

-Rect provides the view-relative rectangle describing the currently visible viewport into the View. -

-
- - -

Enter

-
-Event fired when the view gets focus. -
-
-
Declaration
-
- 
public Action<View.FocusEventArgs> Enter
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action<View.FocusEventArgs>
- - -

KeyDown

-
-Invoked when a key is pressed -
-
-
Declaration
-
- 
public Action<View.KeyEventEventArgs> KeyDown
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action<View.KeyEventEventArgs>
- - -

KeyPress

-
-Invoked when a character key is pressed and occurs after the key up event. -
-
-
Declaration
-
- 
public Action<View.KeyEventEventArgs> KeyPress
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action<View.KeyEventEventArgs>
- - -

KeyUp

-
-Invoked when a key is released -
-
-
Declaration
-
- 
public Action<View.KeyEventEventArgs> KeyUp
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action<View.KeyEventEventArgs>
- - -

LayoutComplete

-
-Fired after the Views's LayoutSubviews() method has completed. -
-
-
Declaration
-
- 
public Action<View.LayoutEventArgs> LayoutComplete
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action<View.LayoutEventArgs>
-
Remarks
-
-Subscribe to this event to perform tasks when the View has been resized or the layout has otherwise changed. -
- - -

LayoutStarted

-
-Fired after the Views's LayoutSubviews() method has completed. -
-
-
Declaration
-
- 
public Action<View.LayoutEventArgs> LayoutStarted
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action<View.LayoutEventArgs>
-
Remarks
-
-Subscribe to this event to perform tasks when the View has been resized or the layout has otherwise changed. -
- - -

Leave

-
-Event fired when the view looses focus. -
-
-
Declaration
-
- 
public Action<View.FocusEventArgs> Leave
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action<View.FocusEventArgs>
- - -

MouseClick

-
-Event fired when a mouse event is generated. -
-
-
Declaration
-
- 
public Action<View.MouseEventArgs> MouseClick
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action<View.MouseEventArgs>
- - -

MouseEnter

-
-Event fired when the view receives the mouse event for the first time. -
-
-
Declaration
-
- 
public Action<View.MouseEventArgs> MouseEnter
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action<View.MouseEventArgs>
- - -

MouseLeave

-
-Event fired when the view receives a mouse event for the last time. -
-
-
Declaration
-
- 
public Action<View.MouseEventArgs> MouseLeave
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action<View.MouseEventArgs>
- - -

Removed

-
-Event fired when a subview is being removed from this view. -
-
-
Declaration
-
- 
public Action<View> Removed
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Action<View>

Properties

@@ -879,6 +521,35 @@ color scheme. + +

Data

+
+Gets or sets arbitrary data for the view. +
+
+
Declaration
+
+ 
public object Data { get; set; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
System.Object
+
Remarks
+
This property is not used internally.
+ +

Driver

@@ -2154,33 +1825,6 @@ Focuses the previous view. - -

GetEnumerator()

-
-Gets an enumerator that enumerates the subviews in this view. -
-
-
Declaration
-
- 
public IEnumerator GetEnumerator()
-
-
Returns
- - - - - - - - - - - - - -
TypeDescription
System.Collections.IEnumeratorThe enumerator.
- -

LayoutSubviews()

@@ -2474,6 +2118,35 @@ Method invoked when a view loses focus. + +

OnMouseClick(View.MouseEventArgs)

+
+Invokes the MouseClick event. +
+
+
Declaration
+
+ 
protected void OnMouseClick(View.MouseEventArgs args)
+
+
Parameters
+ + + + + + + + + + + + + + + +
TypeNameDescription
View.MouseEventArgsargs
+ +

OnMouseEnter(MouseEvent)

@@ -3177,6 +2850,93 @@ Pretty prints the View +

Added

+
+Event fired when a subview is being added to this view. +
+
+
Declaration
+
+ 
public event Action<View> Added
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action<View>
+ + +

DrawContent

+
+Event invoked when the content area of the View is to be drawn. +
+
+
Declaration
+
+ 
public event Action<Rect> DrawContent
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action<Rect>
+
Remarks
+
+

+Will be invoked before any subviews added with Add(View) have been drawn. +

+

+Rect provides the view-relative rectangle describing the currently visible viewport into the View. +

+
+ + +

Enter

+
+Event fired when the view gets focus. +
+
+
Declaration
+
+ 
public event Action<View.FocusEventArgs> Enter
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action<View.FocusEventArgs>
+ +

Initialized

Event called only once when the View is being initialized for the first time. @@ -3203,13 +2963,278 @@ This derived from System.ComponentModel.ISupportInitializeNot + + +

KeyDown

+
+Invoked when a key is pressed +
+
+
Declaration
+
+ 
public event Action<View.KeyEventEventArgs> KeyDown
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action<View.KeyEventEventArgs>
+ + +

KeyPress

+
+Invoked when a character key is pressed and occurs after the key up event. +
+
+
Declaration
+
+ 
public event Action<View.KeyEventEventArgs> KeyPress
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action<View.KeyEventEventArgs>
+ + +

KeyUp

+
+Invoked when a key is released +
+
+
Declaration
+
+ 
public event Action<View.KeyEventEventArgs> KeyUp
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action<View.KeyEventEventArgs>
+ + +

LayoutComplete

+
+Fired after the Views's LayoutSubviews() method has completed. +
+
+
Declaration
+
+ 
public event Action<View.LayoutEventArgs> LayoutComplete
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action<View.LayoutEventArgs>
+
Remarks
+
+Subscribe to this event to perform tasks when the View has been resized or the layout has otherwise changed. +
+ + +

LayoutStarted

+
+Fired after the Views's LayoutSubviews() method has completed. +
+
+
Declaration
+
+ 
public event Action<View.LayoutEventArgs> LayoutStarted
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action<View.LayoutEventArgs>
+
Remarks
+
+Subscribe to this event to perform tasks when the View has been resized or the layout has otherwise changed. +
+ + +

Leave

+
+Event fired when the view looses focus. +
+
+
Declaration
+
+ 
public event Action<View.FocusEventArgs> Leave
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action<View.FocusEventArgs>
+ + +

MouseClick

+
+Event fired when a mouse event is generated. +
+
+
Declaration
+
+ 
public event Action<View.MouseEventArgs> MouseClick
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action<View.MouseEventArgs>
+ + +

MouseEnter

+
+Event fired when the view receives the mouse event for the first time. +
+
+
Declaration
+
+ 
public event Action<View.MouseEventArgs> MouseEnter
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action<View.MouseEventArgs>
+ + +

MouseLeave

+
+Event fired when the view receives a mouse event for the last time. +
+
+
Declaration
+
+ 
public event Action<View.MouseEventArgs> MouseLeave
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action<View.MouseEventArgs>
+ + +

Removed

+
+Event fired when a subview is being removed from this view. +
+
+
Declaration
+
+ 
public event Action<View> Removed
+
+
Event Type
+ + + + + + + + + + + + + +
TypeDescription
System.Action<View>

Implements

System.IDisposable
-
- System.Collections.IEnumerable -
System.ComponentModel.ISupportInitializeNotification
diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Window.html b/docs/api/Terminal.Gui/Terminal.Gui.Window.html index 55197eb9d..3c8b3cedf 100644 --- a/docs/api/Terminal.Gui/Terminal.Gui.Window.html +++ b/docs/api/Terminal.Gui/Terminal.Gui.Window.html @@ -101,7 +101,6 @@ A Toplevel System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
-
System.Collections.IEnumerable
Inherited Members
@@ -165,6 +164,9 @@ A Toplevel View.HotKeySpecifier
+
+ View.Data +
@@ -366,6 +368,9 @@ A Toplevel View.OnMouseEvent(MouseEvent)
+ @@ -404,7 +409,7 @@ A Toplevel Assembly: Terminal.Gui.dll
Syntax
- 
public class Window : Toplevel, IDisposable, ISupportInitializeNotification, ISupportInitialize, IEnumerable
+ 
public class Window : Toplevel, IDisposable, ISupportInitializeNotification, ISupportInitialize
Remarks
@@ -709,33 +714,6 @@ The Views that have been added to this view can be retrieved via the -

GetEnumerator()

-
-Enumerates the various Views in the embedded Terminal.Gui.Window.ContentView. -
-
-
Declaration
-
- 
public IEnumerator GetEnumerator()
-
-
Returns
- - - - - - - - - - - - - -
TypeDescription
System.Collections.IEnumeratorThe enumerator.
- -

MouseEvent(MouseEvent)

@@ -883,9 +861,6 @@ Removes all subviews (children) added via System.ComponentModel.ISupportInitialize
-
- System.Collections.IEnumerable -
diff --git a/docs/api/Terminal.Gui/Unix.Terminal.Curses.Event.html b/docs/api/Terminal.Gui/Unix.Terminal.Curses.Event.html index f487f9d73..127f7b0b1 100644 --- a/docs/api/Terminal.Gui/Unix.Terminal.Curses.Event.html +++ b/docs/api/Terminal.Gui/Unix.Terminal.Curses.Event.html @@ -89,7 +89,8 @@
Assembly: Terminal.Gui.dll
Syntax
- 
public enum Event : long
+ 
[Flags]
+public enum Event : long

Fields

@@ -197,6 +198,14 @@ ButtonShift + + ButtonWheeledDown + + + + ButtonWheeledUp + + ReportMousePosition diff --git a/docs/api/Terminal.Gui/Unix.Terminal.Curses.html b/docs/api/Terminal.Gui/Unix.Terminal.Curses.html index 7b0019c1a..08fde9f38 100644 --- a/docs/api/Terminal.Gui/Unix.Terminal.Curses.html +++ b/docs/api/Terminal.Gui/Unix.Terminal.Curses.html @@ -945,7 +945,7 @@
Declaration
- 
public const int AltKeyDown = 529
+ 
public const int AltKeyDown = 523
Field Value
@@ -969,7 +969,7 @@
Declaration
- 
public const int AltKeyEnd = 534
+ 
public const int AltKeyEnd = 528
Field Value
@@ -993,7 +993,7 @@
Declaration
- 
public const int AltKeyHome = 540
+ 
public const int AltKeyHome = 533
Field Value
@@ -1017,7 +1017,7 @@
Declaration
- 
public const int AltKeyLeft = 551
+ 
public const int AltKeyLeft = 543
Field Value
@@ -1041,7 +1041,7 @@
Declaration
- 
public const int AltKeyNPage = 556
+ 
public const int AltKeyNPage = 548
Field Value
@@ -1065,7 +1065,7 @@
Declaration
- 
public const int AltKeyPPage = 561
+ 
public const int AltKeyPPage = 553
Field Value
@@ -1089,7 +1089,7 @@
Declaration
- 
public const int AltKeyRight = 566
+ 
public const int AltKeyRight = 558
Field Value
@@ -1113,7 +1113,7 @@
Declaration
- 
public const int AltKeyUp = 572
+ 
public const int AltKeyUp = 564
Field Value
@@ -1329,7 +1329,7 @@
Declaration
- 
public const int CtrlKeyDown = 531
+ 
public const int CtrlKeyDown = 525
Field Value
@@ -1353,7 +1353,7 @@
Declaration
- 
public const int CtrlKeyEnd = 536
+ 
public const int CtrlKeyEnd = 530
Field Value
@@ -1377,7 +1377,7 @@
Declaration
- 
public const int CtrlKeyHome = 542
+ 
public const int CtrlKeyHome = 535
Field Value
@@ -1401,7 +1401,7 @@
Declaration
- 
public const int CtrlKeyLeft = 553
+ 
public const int CtrlKeyLeft = 545
Field Value
@@ -1425,7 +1425,7 @@
Declaration
- 
public const int CtrlKeyNPage = 558
+ 
public const int CtrlKeyNPage = 550
Field Value
@@ -1449,7 +1449,7 @@
Declaration
- 
public const int CtrlKeyPPage = 563
+ 
public const int CtrlKeyPPage = 555
Field Value
@@ -1473,7 +1473,7 @@
Declaration
- 
public const int CtrlKeyRight = 568
+ 
public const int CtrlKeyRight = 560
Field Value
@@ -1497,7 +1497,7 @@
Declaration
- 
public const int CtrlKeyUp = 574
+ 
public const int CtrlKeyUp = 566
Field Value
@@ -1521,7 +1521,7 @@
Declaration
- 
public const int DownEnd = 6
+ 
public const int DownEnd = 0
Field Value
@@ -1569,7 +1569,7 @@
Declaration
- 
public const int Home = 7
+ 
public const int Home = 0
Field Value
@@ -2313,7 +2313,7 @@
Declaration
- 
public const int LeftRightUpNPagePPage = 8
+ 
public const int LeftRightUpNPagePPage = 0
Field Value
@@ -2337,7 +2337,7 @@
Declaration
- 
public const int ShiftCtrlKeyDown = 532
+ 
public const int ShiftCtrlKeyDown = 526
Field Value
@@ -2361,7 +2361,7 @@
Declaration
- 
public const int ShiftCtrlKeyEnd = 537
+ 
public const int ShiftCtrlKeyEnd = 531
Field Value
@@ -2385,7 +2385,7 @@
Declaration
- 
public const int ShiftCtrlKeyHome = 543
+ 
public const int ShiftCtrlKeyHome = 536
Field Value
@@ -2409,7 +2409,7 @@
Declaration
- 
public const int ShiftCtrlKeyLeft = 554
+ 
public const int ShiftCtrlKeyLeft = 546
Field Value
@@ -2433,7 +2433,7 @@
Declaration
- 
public const int ShiftCtrlKeyNPage = 559
+ 
public const int ShiftCtrlKeyNPage = 551
Field Value
@@ -2457,7 +2457,7 @@
Declaration
- 
public const int ShiftCtrlKeyPPage = 564
+ 
public const int ShiftCtrlKeyPPage = 556
Field Value
@@ -2481,7 +2481,7 @@
Declaration
- 
public const int ShiftCtrlKeyRight = 569
+ 
public const int ShiftCtrlKeyRight = 561
Field Value
@@ -2505,7 +2505,7 @@
Declaration
- 
public const int ShiftCtrlKeyUp = 575
+ 
public const int ShiftCtrlKeyUp = 567
Field Value
diff --git a/docs/api/UICatalog/UICatalog.Binding.html b/docs/api/UICatalog/UICatalog.Binding.html index 8126ebdc0..219f7891f 100644 --- a/docs/api/UICatalog/UICatalog.Binding.html +++ b/docs/api/UICatalog/UICatalog.Binding.html @@ -90,11 +90,35 @@
System.Object
Binding
+
+
Inherited Members
+
+ System.Object.Equals(System.Object) +
+
+ System.Object.Equals(System.Object, System.Object) +
+
+ System.Object.GetHashCode() +
+
+ System.Object.GetType() +
+
+ System.Object.MemberwiseClone() +
+
+ System.Object.ReferenceEquals(System.Object, System.Object) +
+
+ System.Object.ToString() +
+
Namespace: UICatalog
Assembly: UICatalog.dll
Syntax
- 
public class Binding : object
+ 
public class Binding

Constructors

diff --git a/docs/api/UICatalog/UICatalog.ListWrapperConverter.html b/docs/api/UICatalog/UICatalog.ListWrapperConverter.html index f5b556a89..3f5c2ef2b 100644 --- a/docs/api/UICatalog/UICatalog.ListWrapperConverter.html +++ b/docs/api/UICatalog/UICatalog.ListWrapperConverter.html @@ -94,11 +94,35 @@
Implements
+
+
Inherited Members
+
+ System.Object.Equals(System.Object) +
+
+ System.Object.Equals(System.Object, System.Object) +
+
+ System.Object.GetHashCode() +
+
+ System.Object.GetType() +
+
+ System.Object.MemberwiseClone() +
+
+ System.Object.ReferenceEquals(System.Object, System.Object) +
+
+ System.Object.ToString() +
+
Namespace: UICatalog
Assembly: UICatalog.dll
Syntax
- 
public class ListWrapperConverter : object, IValueConverter
+ 
public class ListWrapperConverter : IValueConverter

Methods

diff --git a/docs/api/UICatalog/UICatalog.Scenario.ScenarioCategory.html b/docs/api/UICatalog/UICatalog.Scenario.ScenarioCategory.html index aaf99381e..87a11597e 100644 --- a/docs/api/UICatalog/UICatalog.Scenario.ScenarioCategory.html +++ b/docs/api/UICatalog/UICatalog.Scenario.ScenarioCategory.html @@ -89,13 +89,144 @@
Inheritance
System.Object
-
Scenario.ScenarioCategory
+
System.Attribute
+
Scenario.ScenarioCategory
+
+
+
Inherited Members
+
+ System.Attribute.Equals(System.Object) +
+
+ System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type) +
+
+ System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, System.Boolean) +
+
+ System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type) +
+
+ System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, System.Boolean) +
+
+ System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type) +
+
+ System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, System.Boolean) +
+
+ System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type) +
+
+ System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, System.Boolean) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.Assembly) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Boolean) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, System.Boolean) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Boolean) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, System.Boolean) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.Module) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Boolean) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, System.Boolean) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Boolean) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, System.Boolean) +
+
+ System.Attribute.GetHashCode() +
+
+ System.Attribute.IsDefaultAttribute() +
+
+ System.Attribute.IsDefined(System.Reflection.Assembly, System.Type) +
+
+ System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, System.Boolean) +
+
+ System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type) +
+
+ System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, System.Boolean) +
+
+ System.Attribute.IsDefined(System.Reflection.Module, System.Type) +
+
+ System.Attribute.IsDefined(System.Reflection.Module, System.Type, System.Boolean) +
+
+ System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type) +
+
+ System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, System.Boolean) +
+
+ System.Attribute.Match(System.Object) +
+
+ System.Attribute.TypeId +
+
+ System.Object.Equals(System.Object, System.Object) +
+
+ System.Object.GetType() +
+
+ System.Object.MemberwiseClone() +
+
+ System.Object.ReferenceEquals(System.Object, System.Object) +
+
+ System.Object.ToString() +
Namespace: UICatalog
Assembly: UICatalog.dll
Syntax
- 
public class ScenarioCategory : System.Attribute
+ 
[AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]
+public class ScenarioCategory : Attribute

Constructors

@@ -159,7 +290,7 @@ -

GetCategories(Type)

+

GetCategories(Type)

Static helper function to get the Scenario Categories given a Type

@@ -178,7 +309,7 @@ - + @@ -194,7 +325,7 @@ - + @@ -203,7 +334,7 @@ -

GetName(Type)

+

GetName(Type)

Static helper function to get the Scenario Name given a Type

@@ -222,7 +353,7 @@ - + diff --git a/docs/api/UICatalog/UICatalog.Scenario.ScenarioMetadata.html b/docs/api/UICatalog/UICatalog.Scenario.ScenarioMetadata.html index 95baa2943..1171a33c6 100644 --- a/docs/api/UICatalog/UICatalog.Scenario.ScenarioMetadata.html +++ b/docs/api/UICatalog/UICatalog.Scenario.ScenarioMetadata.html @@ -89,13 +89,144 @@
Inheritance
System.Object
-
Scenario.ScenarioMetadata
+
System.Attribute
+
Scenario.ScenarioMetadata
+
+
+
Inherited Members
+
+ System.Attribute.Equals(System.Object) +
+
+ System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type) +
+
+ System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, System.Boolean) +
+
+ System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type) +
+
+ System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, System.Boolean) +
+
+ System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type) +
+
+ System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, System.Boolean) +
+
+ System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type) +
+
+ System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, System.Boolean) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.Assembly) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Boolean) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, System.Boolean) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Boolean) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, System.Boolean) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.Module) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Boolean) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, System.Boolean) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Boolean) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type) +
+
+ System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, System.Boolean) +
+
+ System.Attribute.GetHashCode() +
+
+ System.Attribute.IsDefaultAttribute() +
+
+ System.Attribute.IsDefined(System.Reflection.Assembly, System.Type) +
+
+ System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, System.Boolean) +
+
+ System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type) +
+
+ System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, System.Boolean) +
+
+ System.Attribute.IsDefined(System.Reflection.Module, System.Type) +
+
+ System.Attribute.IsDefined(System.Reflection.Module, System.Type, System.Boolean) +
+
+ System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type) +
+
+ System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, System.Boolean) +
+
+ System.Attribute.Match(System.Object) +
+
+ System.Attribute.TypeId +
+
+ System.Object.Equals(System.Object, System.Object) +
+
+ System.Object.GetType() +
+
+ System.Object.MemberwiseClone() +
+
+ System.Object.ReferenceEquals(System.Object, System.Object) +
+
+ System.Object.ToString() +
Namespace: UICatalog
Assembly: UICatalog.dll
Syntax
- 
public class ScenarioMetadata : System.Attribute
+ 
[AttributeUsage(AttributeTargets.Class)]
+public class ScenarioMetadata : Attribute

Constructors

@@ -190,7 +321,7 @@ -

GetDescription(Type)

+

GetDescription(Type)

Static helper function to get the Scenario Description given a Type

@@ -209,7 +340,7 @@ - + @@ -233,7 +364,7 @@ -

GetName(Type)

+

GetName(Type)

Static helper function to get the Scenario Name given a Type

@@ -252,7 +383,7 @@ - + diff --git a/docs/api/UICatalog/UICatalog.Scenario.html b/docs/api/UICatalog/UICatalog.Scenario.html index 6ac5b583f..68745da7b 100644 --- a/docs/api/UICatalog/UICatalog.Scenario.html +++ b/docs/api/UICatalog/UICatalog.Scenario.html @@ -99,6 +99,31 @@ ListViews. Press ENTER to run the selected scenario. Press CTRL-Q to exit it.
System.Object
Scenario
+
+
Implements
+
System.IDisposable
+
+
+
Inherited Members
+
+ System.Object.Equals(System.Object) +
+
+ System.Object.Equals(System.Object, System.Object) +
+
+ System.Object.GetHashCode() +
+
+ System.Object.GetType() +
+
+ System.Object.MemberwiseClone() +
+
+ System.Object.ReferenceEquals(System.Object, System.Object) +
+
Namespace: UICatalog
Assembly: UICatalog.dll
Syntax
@@ -239,7 +264,7 @@ namespace UICatalog { - + @@ -267,7 +292,7 @@ namespace UICatalog { - + @@ -449,6 +474,12 @@ Overrides that do not call the base.Overrides +
System.Object.ToString()
+

Implements

+
+ System.IDisposable +
diff --git a/docs/api/UICatalog/UICatalog.UICatalogApp.html b/docs/api/UICatalog/UICatalog.UICatalogApp.html index d7d8c008c..1bf6f42ce 100644 --- a/docs/api/UICatalog/UICatalog.UICatalogApp.html +++ b/docs/api/UICatalog/UICatalog.UICatalogApp.html @@ -91,11 +91,35 @@
System.Object
UICatalogApp
+
+
Inherited Members
+
+ System.Object.Equals(System.Object) +
+
+ System.Object.Equals(System.Object, System.Object) +
+
+ System.Object.GetHashCode() +
+
+ System.Object.GetType() +
+
+ System.Object.MemberwiseClone() +
+
+ System.Object.ReferenceEquals(System.Object, System.Object) +
+
+ System.Object.ToString() +
+
Namespace: UICatalog
Assembly: UICatalog.dll
Syntax
- 
public class UICatalogApp : object
+ 
public class UICatalogApp
diff --git a/docs/api/UICatalog/UICatalog.UStringValueConverter.html b/docs/api/UICatalog/UICatalog.UStringValueConverter.html index d75217ca9..c576a8efb 100644 --- a/docs/api/UICatalog/UICatalog.UStringValueConverter.html +++ b/docs/api/UICatalog/UICatalog.UStringValueConverter.html @@ -94,11 +94,35 @@
Implements
+
+
Inherited Members
+
+ System.Object.Equals(System.Object) +
+
+ System.Object.Equals(System.Object, System.Object) +
+
+ System.Object.GetHashCode() +
+
+ System.Object.GetType() +
+
+ System.Object.MemberwiseClone() +
+
+ System.Object.ReferenceEquals(System.Object, System.Object) +
+
+ System.Object.ToString() +
+
Namespace: UICatalog
Assembly: UICatalog.dll
Syntax
- 
public class UStringValueConverter : object, IValueConverter
+ 
public class UStringValueConverter : IValueConverter

Methods

diff --git a/docs/index.html b/docs/index.html index 628671186..a167c55f2 100644 --- a/docs/index.html +++ b/docs/index.html @@ -73,7 +73,7 @@

Terminal.Gui - Terminal UI toolkit for .NET

A simple UI toolkit for .NET, .NET Core, and Mono that works on Windows, the Mac, and Linux/Unix.

-

We are actively converging on a major update to Terminal.Gui. The most recent released Nuget package is version 0.81 which is way behind master. This README and the API Documentation refers to the latest build from master. If you want the latest and greatest functionality, clone and build locally. Otherwise 0.81 is quite stable, but the documentation may not match.

+

The most recent released Nuget package is version 0.90 which is the "Stable Feature Complete" pre-release of 1.0.

diff --git a/docs/index.json b/docs/index.json index 204047131..46c96642a 100644 --- a/docs/index.json +++ b/docs/index.json @@ -22,12 +22,12 @@ "api/Terminal.Gui/Terminal.Gui.Button.html": { "href": "api/Terminal.Gui/Terminal.Gui.Button.html", "title": "Class Button", - "keywords": "Class Button Button is a View that provides an item that invokes an System.Action when activated by the user. Inheritance System.Object Responder View Button Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.GetEnumerator() View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.Redraw(Rect) View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class Button : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize Remarks Provides a button showing text invokes an System.Action when clicked on with a mouse or when the user presses SPACE, ENTER, or hotkey. The hotkey is the first letter or digit following the first underscore ('_') in the button text. Use HotKeySpecifier to change the hotkey specifier from the default of ('_'). If no hotkey specifier is found, the first uppercase letter encountered will be used as the hotkey. When the button is configured as the default ( IsDefault ) and the user presses the ENTER key, if no other View processes the KeyEvent , the Button 's System.Action will be invoked. Constructors Button() Initializes a new instance of Button using Computed layout. Declaration public Button() Remarks The width of the Button is computed based on the text length. The height will always be 1. Button(ustring, Boolean) Initializes a new instance of Button using Computed layout. Declaration public Button(ustring text, bool is_default = false) Parameters Type Name Description NStack.ustring text The button's text System.Boolean is_default If true , a special decoration is used, and the user pressing the enter key in a Dialog will implicitly activate this button. Remarks The width of the Button is computed based on the text length. The height will always be 1. Button(Int32, Int32, ustring) Initializes a new instance of Button using Absolute layout, based on the given text Declaration public Button(int x, int y, ustring text) Parameters Type Name Description System.Int32 x X position where the button will be shown. System.Int32 y Y position where the button will be shown. NStack.ustring text The button's text Remarks The width of the Button is computed based on the text length. The height will always be 1. Button(Int32, Int32, ustring, Boolean) Initializes a new instance of Button using Absolute layout, based on the given text. Declaration public Button(int x, int y, ustring text, bool is_default) Parameters Type Name Description System.Int32 x X position where the button will be shown. System.Int32 y Y position where the button will be shown. NStack.ustring text The button's text System.Boolean is_default If true , a special decoration is used, and the user pressing the enter key in a Dialog will implicitly activate this button. Remarks The width of the Button is computed based on the text length. The height will always be 1. Fields Clicked Clicked System.Action , raised when the user clicks the primary mouse button within the Bounds of this View or if the user presses the action key while this view is focused. (TODO: IsDefault) Declaration public Action Clicked Field Value Type Description System.Action Remarks Client code can hook up to this event, it is raised when the button is activated either with the mouse or the keyboard. Properties IsDefault Gets or sets whether the Button is the default action to activate in a dialog. Declaration public bool IsDefault { get; set; } Property Value Type Description System.Boolean true if is default; otherwise, false . Text The text displayed by this Button . Declaration public ustring Text { get; set; } Property Value Type Description NStack.ustring Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessColdKey(KeyEvent) This method can be overwritten by views that want to provide accelerator functionality (Alt-key for example), but without interefering with normal ProcessKey behavior. Declaration public override bool ProcessColdKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessColdKey(KeyEvent) Remarks After keys are sent to the subviews on the current view, all the view are processed and the key is passed to the views to allow some of them to process the keystroke as a cold-key. This functionality is used, for example, by default buttons to act on the enter key. Processing this as a hot-key would prevent non-default buttons from consuming the enter keypress when they have the focus. ProcessHotKey(KeyEvent) This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example). Declaration public override bool ProcessHotKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessHotKey(KeyEvent) Remarks Before keys are sent to the subview on the current view, all the views are processed and the key is passed to the widgets to allow some of them to process the keystroke as a hot-key. For example, if you implement a button that has a hotkey ok \"o\", you would catch the combination Alt-o here. If the event is caught, you must return true to stop the keystroke from being dispatched to other views. ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" + "keywords": "Class Button Button is a View that provides an item that invokes an System.Action when activated by the user. Inheritance System.Object Responder View Button Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.Redraw(Rect) View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class Button : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks Provides a button showing text invokes an System.Action when clicked on with a mouse or when the user presses SPACE, ENTER, or hotkey. The hotkey is the first letter or digit following the first underscore ('_') in the button text. Use HotKeySpecifier to change the hotkey specifier from the default of ('_'). If no hotkey specifier is found, the first uppercase letter encountered will be used as the hotkey. When the button is configured as the default ( IsDefault ) and the user presses the ENTER key, if no other View processes the KeyEvent , the Button 's System.Action will be invoked. Constructors Button() Initializes a new instance of Button using Computed layout. Declaration public Button() Remarks The width of the Button is computed based on the text length. The height will always be 1. Button(ustring, Boolean) Initializes a new instance of Button using Computed layout. Declaration public Button(ustring text, bool is_default = false) Parameters Type Name Description NStack.ustring text The button's text System.Boolean is_default If true , a special decoration is used, and the user pressing the enter key in a Dialog will implicitly activate this button. Remarks The width of the Button is computed based on the text length. The height will always be 1. Button(Int32, Int32, ustring) Initializes a new instance of Button using Absolute layout, based on the given text Declaration public Button(int x, int y, ustring text) Parameters Type Name Description System.Int32 x X position where the button will be shown. System.Int32 y Y position where the button will be shown. NStack.ustring text The button's text Remarks The width of the Button is computed based on the text length. The height will always be 1. Button(Int32, Int32, ustring, Boolean) Initializes a new instance of Button using Absolute layout, based on the given text. Declaration public Button(int x, int y, ustring text, bool is_default) Parameters Type Name Description System.Int32 x X position where the button will be shown. System.Int32 y Y position where the button will be shown. NStack.ustring text The button's text System.Boolean is_default If true , a special decoration is used, and the user pressing the enter key in a Dialog will implicitly activate this button. Remarks The width of the Button is computed based on the text length. The height will always be 1. Properties IsDefault Gets or sets whether the Button is the default action to activate in a dialog. Declaration public bool IsDefault { get; set; } Property Value Type Description System.Boolean true if is default; otherwise, false . Text The text displayed by this Button . Declaration public ustring Text { get; set; } Property Value Type Description NStack.ustring Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessColdKey(KeyEvent) This method can be overwritten by views that want to provide accelerator functionality (Alt-key for example), but without interefering with normal ProcessKey behavior. Declaration public override bool ProcessColdKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessColdKey(KeyEvent) Remarks After keys are sent to the subviews on the current view, all the view are processed and the key is passed to the views to allow some of them to process the keystroke as a cold-key. This functionality is used, for example, by default buttons to act on the enter key. Processing this as a hot-key would prevent non-default buttons from consuming the enter keypress when they have the focus. ProcessHotKey(KeyEvent) This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example). Declaration public override bool ProcessHotKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessHotKey(KeyEvent) Remarks Before keys are sent to the subview on the current view, all the views are processed and the key is passed to the widgets to allow some of them to process the keystroke as a hot-key. For example, if you implement a button that has a hotkey ok \"o\", you would catch the combination Alt-o here. If the event is caught, you must return true to stop the keystroke from being dispatched to other views. ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Events Clicked Clicked System.Action , raised when the user clicks the primary mouse button within the Bounds of this View or if the user presses the action key while this view is focused. (TODO: IsDefault) Declaration public event Action Clicked Event Type Type Description System.Action Remarks Client code can hook up to this event, it is raised when the button is activated either with the mouse or the keyboard. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" }, "api/Terminal.Gui/Terminal.Gui.CheckBox.html": { "href": "api/Terminal.Gui/Terminal.Gui.CheckBox.html", "title": "Class CheckBox", - "keywords": "Class CheckBox The CheckBox View shows an on/off toggle that the user can set Inheritance System.Object Responder View CheckBox Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.GetEnumerator() View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class CheckBox : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize Constructors CheckBox() Initializes a new instance of CheckBox based on the given text, using Computed layout. Declaration public CheckBox() CheckBox(ustring, Boolean) Initializes a new instance of CheckBox based on the given text, using Computed layout. Declaration public CheckBox(ustring s, bool is_checked = false) Parameters Type Name Description NStack.ustring s S. System.Boolean is_checked If set to true is checked. CheckBox(Int32, Int32, ustring) Initializes a new instance of CheckBox using Absolute layout. Declaration public CheckBox(int x, int y, ustring s) Parameters Type Name Description System.Int32 x System.Int32 y NStack.ustring s Remarks The size of CheckBox is computed based on the text length. This CheckBox is not toggled. CheckBox(Int32, Int32, ustring, Boolean) Initializes a new instance of CheckBox using Absolute layout. Declaration public CheckBox(int x, int y, ustring s, bool is_checked) Parameters Type Name Description System.Int32 x System.Int32 y NStack.ustring s System.Boolean is_checked Remarks The size of CheckBox is computed based on the text length. Fields Toggled Toggled event, raised when the CheckBox is toggled. Declaration public Action Toggled Field Value Type Description System.Action < System.Boolean > Remarks Client code can hook up to this event, it is raised when the CheckBox is activated either with the mouse or the keyboard. The passed bool contains the previous state. Properties Checked The state of the CheckBox Declaration public bool Checked { get; set; } Property Value Type Description System.Boolean Text The text displayed by this CheckBox Declaration public ustring Text { get; set; } Property Value Type Description NStack.ustring Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) OnToggled(Boolean) Called when the Checked property changes. Invokes the Toggled event. Declaration public virtual void OnToggled(bool previousChecked) Parameters Type Name Description System.Boolean previousChecked PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" + "keywords": "Class CheckBox The CheckBox View shows an on/off toggle that the user can set Inheritance System.Object Responder View CheckBox Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class CheckBox : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors CheckBox() Initializes a new instance of CheckBox based on the given text, using Computed layout. Declaration public CheckBox() CheckBox(ustring, Boolean) Initializes a new instance of CheckBox based on the given text, using Computed layout. Declaration public CheckBox(ustring s, bool is_checked = false) Parameters Type Name Description NStack.ustring s S. System.Boolean is_checked If set to true is checked. CheckBox(Int32, Int32, ustring) Initializes a new instance of CheckBox using Absolute layout. Declaration public CheckBox(int x, int y, ustring s) Parameters Type Name Description System.Int32 x System.Int32 y NStack.ustring s Remarks The size of CheckBox is computed based on the text length. This CheckBox is not toggled. CheckBox(Int32, Int32, ustring, Boolean) Initializes a new instance of CheckBox using Absolute layout. Declaration public CheckBox(int x, int y, ustring s, bool is_checked) Parameters Type Name Description System.Int32 x System.Int32 y NStack.ustring s System.Boolean is_checked Remarks The size of CheckBox is computed based on the text length. Properties Checked The state of the CheckBox Declaration public bool Checked { get; set; } Property Value Type Description System.Boolean Text The text displayed by this CheckBox Declaration public ustring Text { get; set; } Property Value Type Description NStack.ustring Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) OnToggled(Boolean) Called when the Checked property changes. Invokes the Toggled event. Declaration public virtual void OnToggled(bool previousChecked) Parameters Type Name Description System.Boolean previousChecked PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. Events Toggled Toggled event, raised when the CheckBox is toggled. Declaration public event Action Toggled Event Type Type Description System.Action < System.Boolean > Remarks Client code can hook up to this event, it is raised when the CheckBox is activated either with the mouse or the keyboard. The passed bool contains the previous state. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" }, "api/Terminal.Gui/Terminal.Gui.Clipboard.html": { "href": "api/Terminal.Gui/Terminal.Gui.Clipboard.html", @@ -52,7 +52,7 @@ "api/Terminal.Gui/Terminal.Gui.ComboBox.html": { "href": "api/Terminal.Gui/Terminal.Gui.ComboBox.html", "title": "Class ComboBox", - "keywords": "Class ComboBox ComboBox control Inheritance System.Object Responder View ComboBox Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.GetEnumerator() View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class ComboBox : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize Constructors ComboBox() Public constructor Declaration public ComboBox() ComboBox(ustring) Public constructor Declaration public ComboBox(ustring text) Parameters Type Name Description NStack.ustring text ComboBox(Rect, IList) Public constructor Declaration public ComboBox(Rect rect, IList source) Parameters Type Name Description Rect rect System.Collections.IList source Fields OpenSelectedItem This event is raised when the user Double Clicks on an item or presses ENTER to open the selected item. Declaration public Action OpenSelectedItem Field Value Type Description System.Action < ListViewItemEventArgs > SelectedItemChanged This event is raised when the selected item in the ComboBox has changed. Declaration public Action SelectedItemChanged Field Value Type Description System.Action < ListViewItemEventArgs > Properties ColorScheme Declaration public ColorScheme ColorScheme { get; set; } Property Value Type Description ColorScheme SelectedItem Gets the index of the currently selected item in the Source Declaration public int SelectedItem { get; } Property Value Type Description System.Int32 The selected item or -1 none selected. Source Gets or sets the IListDataSource backing this ComboBox , enabling custom rendering. Declaration public IListDataSource Source { get; set; } Property Value Type Description IListDataSource The source. Remarks Use SetSource(IList) to set a new System.Collections.IList source. Text The currently selected list item Declaration public ustring Text { get; set; } Property Value Type Description NStack.ustring Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnEnter(View) OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnLeave(View) OnOpenSelectedItem() Invokes the OnOpenSelectedItem event if it is defined. Declaration public virtual bool OnOpenSelectedItem() Returns Type Description System.Boolean OnSelectedChanged() Invokes the SelectedChanged event if it is defined. Declaration public virtual bool OnSelectedChanged() Returns Type Description System.Boolean ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent e) Parameters Type Name Description KeyEvent e Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. SetSource(IList) Sets the source of the ComboBox to an System.Collections.IList . Declaration public void SetSource(IList source) Parameters Type Name Description System.Collections.IList source Remarks Use the Source property to set a new IListDataSource source and use custome rendering. Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" + "keywords": "Class ComboBox ComboBox control Inheritance System.Object Responder View ComboBox Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class ComboBox : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors ComboBox() Public constructor Declaration public ComboBox() ComboBox(ustring) Public constructor Declaration public ComboBox(ustring text) Parameters Type Name Description NStack.ustring text ComboBox(Rect, IList) Public constructor Declaration public ComboBox(Rect rect, IList source) Parameters Type Name Description Rect rect System.Collections.IList source Properties ColorScheme Declaration public ColorScheme ColorScheme { get; set; } Property Value Type Description ColorScheme SelectedItem Gets the index of the currently selected item in the Source Declaration public int SelectedItem { get; } Property Value Type Description System.Int32 The selected item or -1 none selected. Source Gets or sets the IListDataSource backing this ComboBox , enabling custom rendering. Declaration public IListDataSource Source { get; set; } Property Value Type Description IListDataSource The source. Remarks Use SetSource(IList) to set a new System.Collections.IList source. Text The currently selected list item Declaration public ustring Text { get; set; } Property Value Type Description NStack.ustring Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnEnter(View) OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnLeave(View) OnOpenSelectedItem() Invokes the OnOpenSelectedItem event if it is defined. Declaration public virtual bool OnOpenSelectedItem() Returns Type Description System.Boolean OnSelectedChanged() Invokes the SelectedChanged event if it is defined. Declaration public virtual bool OnSelectedChanged() Returns Type Description System.Boolean ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent e) Parameters Type Name Description KeyEvent e Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. SetSource(IList) Sets the source of the ComboBox to an System.Collections.IList . Declaration public void SetSource(IList source) Parameters Type Name Description System.Collections.IList source Remarks Use the Source property to set a new IListDataSource source and use custome rendering. Events OpenSelectedItem This event is raised when the user Double Clicks on an item or presses ENTER to open the selected item. Declaration public event Action OpenSelectedItem Event Type Type Description System.Action < ListViewItemEventArgs > SelectedItemChanged This event is raised when the selected item in the ComboBox has changed. Declaration public event Action SelectedItemChanged Event Type Type Description System.Action < ListViewItemEventArgs > Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" }, "api/Terminal.Gui/Terminal.Gui.ConsoleDriver.DiagnosticFlags.html": { "href": "api/Terminal.Gui/Terminal.Gui.ConsoleDriver.DiagnosticFlags.html", @@ -67,7 +67,7 @@ "api/Terminal.Gui/Terminal.Gui.DateField.html": { "href": "api/Terminal.Gui/Terminal.Gui.DateField.html", "title": "Class DateField", - "keywords": "Class DateField Simple Date editing View Inheritance System.Object Responder View TextField DateField Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members TextField.Used TextField.ReadOnly TextField.TextChanged TextField.OnLeave(View) TextField.Frame TextField.Text TextField.Secret TextField.CursorPosition TextField.PositionCursor() TextField.Redraw(Rect) TextField.CanFocus TextField.SelectedStart TextField.SelectedLength TextField.SelectedText TextField.ClearAllSelection() TextField.Copy() TextField.Cut() TextField.Paste() View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.GetEnumerator() View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class DateField : TextField, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize Remarks The DateField View provides date editing functionality with mouse support. Constructors DateField() Initializes a new instance of DateField using Computed layout. Declaration public DateField() DateField(DateTime) Initializes a new instance of DateField using Computed layout. Declaration public DateField(DateTime date) Parameters Type Name Description System.DateTime date DateField(Int32, Int32, DateTime, Boolean) Initializes a new instance of DateField using Absolute layout. Declaration public DateField(int x, int y, DateTime date, bool isShort = false) Parameters Type Name Description System.Int32 x The x coordinate. System.Int32 y The y coordinate. System.DateTime date Initial date contents. System.Boolean isShort If true, shows only two digits for the year. Fields DateChanged DateChanged event, raised when the Date property has changed. Declaration public Action> DateChanged Field Value Type Description System.Action < DateTimeEventArgs < System.DateTime >> Remarks This event is raised when the Date property changes. Properties Date Gets or sets the date of the DateField . Declaration public DateTime Date { get; set; } Property Value Type Description System.DateTime Remarks IsShortFormat Get or set the date format for the widget. Declaration public bool IsShortFormat { get; set; } Property Value Type Description System.Boolean Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent ev) Parameters Type Name Description MouseEvent ev Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides TextField.MouseEvent(MouseEvent) OnDateChanged(DateTimeEventArgs) Event firing method for the DateChanged event. Declaration public virtual void OnDateChanged(DateTimeEventArgs args) Parameters Type Name Description DateTimeEventArgs < System.DateTime > args Event arguments ProcessKey(KeyEvent) Processes key presses for the TextField . Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides TextField.ProcessKey(KeyEvent) Remarks The TextField control responds to the following keys: Keys Function Delete , Backspace Deletes the character before cursor. Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" + "keywords": "Class DateField Simple Date editing View Inheritance System.Object Responder View TextField DateField Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members TextField.Used TextField.ReadOnly TextField.TextChanged TextField.OnLeave(View) TextField.Frame TextField.Text TextField.Secret TextField.CursorPosition TextField.PositionCursor() TextField.Redraw(Rect) TextField.CanFocus TextField.SelectedStart TextField.SelectedLength TextField.SelectedText TextField.ClearAllSelection() TextField.Copy() TextField.Cut() TextField.Paste() View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class DateField : TextField, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The DateField View provides date editing functionality with mouse support. Constructors DateField() Initializes a new instance of DateField using Computed layout. Declaration public DateField() DateField(DateTime) Initializes a new instance of DateField using Computed layout. Declaration public DateField(DateTime date) Parameters Type Name Description System.DateTime date DateField(Int32, Int32, DateTime, Boolean) Initializes a new instance of DateField using Absolute layout. Declaration public DateField(int x, int y, DateTime date, bool isShort = false) Parameters Type Name Description System.Int32 x The x coordinate. System.Int32 y The y coordinate. System.DateTime date Initial date contents. System.Boolean isShort If true, shows only two digits for the year. Properties Date Gets or sets the date of the DateField . Declaration public DateTime Date { get; set; } Property Value Type Description System.DateTime Remarks IsShortFormat Get or set the date format for the widget. Declaration public bool IsShortFormat { get; set; } Property Value Type Description System.Boolean Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent ev) Parameters Type Name Description MouseEvent ev Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides TextField.MouseEvent(MouseEvent) OnDateChanged(DateTimeEventArgs) Event firing method for the DateChanged event. Declaration public virtual void OnDateChanged(DateTimeEventArgs args) Parameters Type Name Description DateTimeEventArgs < System.DateTime > args Event arguments ProcessKey(KeyEvent) Processes key presses for the TextField . Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides TextField.ProcessKey(KeyEvent) Remarks The TextField control responds to the following keys: Keys Function Delete , Backspace Deletes the character before cursor. Events DateChanged DateChanged event, raised when the Date property has changed. Declaration public event Action> DateChanged Event Type Type Description System.Action < DateTimeEventArgs < System.DateTime >> Remarks This event is raised when the Date property changes. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" }, "api/Terminal.Gui/Terminal.Gui.DateTimeEventArgs-1.html": { "href": "api/Terminal.Gui/Terminal.Gui.DateTimeEventArgs-1.html", @@ -77,7 +77,7 @@ "api/Terminal.Gui/Terminal.Gui.Dialog.html": { "href": "api/Terminal.Gui/Terminal.Gui.Dialog.html", "title": "Class Dialog", - "keywords": "Class Dialog The Dialog View is a Window that by default is centered and contains one or more Button s. It defaults to the Dialog color scheme and has a 1 cell padding around the edges. Inheritance System.Object Responder View Toplevel Window Dialog FileDialog Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize System.Collections.IEnumerable Inherited Members Window.Title Window.GetEnumerator() Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.MouseEvent(MouseEvent) Window.Text Window.TextAlignment Toplevel.Running Toplevel.Ready Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.WillPresent() View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class Dialog : Window, IDisposable, ISupportInitializeNotification, ISupportInitialize, IEnumerable Remarks To run the Dialog modally, create the Dialog , and pass it to Run() . This will execute the dialog until it terminates via the [ESC] or [CTRL-Q] key, or when one of the views or buttons added to the dialog calls RequestStop() . Constructors Dialog() Initializes a new instance of the Dialog class using Computed . Declaration public Dialog() Remarks Te Dialog will be vertically and horizontally centered in the container and the size will be 85% of the container. After initialzation use X , Y , Width , and Height to override this with a location or size. Use AddButton(Button) to add buttons to the dialog. Dialog(ustring, Int32, Int32, Button[]) Initializes a new instance of the Dialog class using Computed positioning and an optional set of Button s to display Declaration public Dialog(ustring title, int width, int height, params Button[] buttons) Parameters Type Name Description NStack.ustring title Title for the dialog. System.Int32 width Width for the dialog. System.Int32 height Height for the dialog. Button [] buttons Optional buttons to lay out at the bottom of the dialog. Remarks if width and height are both 0, the Dialog will be vertically and horizontally centered in the container and the size will be 85% of the container. After initialzation use X , Y , Width , and Height to override this with a location or size. Dialog(ustring, Button[]) Initializes a new instance of the Dialog class using Computed positioning and with an optional set of Button s to display Declaration public Dialog(ustring title, params Button[] buttons) Parameters Type Name Description NStack.ustring title Title for the dialog. Button [] buttons Optional buttons to lay out at the bottom of the dialog. Remarks Te Dialog will be vertically and horizontally centered in the container and the size will be 85% of the container. After initialzation use X , Y , Width , and Height to override this with a location or size. Methods AddButton(Button) Adds a Button to the Dialog , its layout will be controlled by the Dialog Declaration public void AddButton(Button button) Parameters Type Name Description Button button Button to add. ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides Toplevel.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize System.Collections.IEnumerable" + "keywords": "Class Dialog The Dialog View is a Window that by default is centered and contains one or more Button s. It defaults to the Dialog color scheme and has a 1 cell padding around the edges. Inheritance System.Object Responder View Toplevel Window Dialog FileDialog Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members Window.Title Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.MouseEvent(MouseEvent) Window.Text Window.TextAlignment Toplevel.Running Toplevel.Ready Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.WillPresent() View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class Dialog : Window, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks To run the Dialog modally, create the Dialog , and pass it to Run() . This will execute the dialog until it terminates via the [ESC] or [CTRL-Q] key, or when one of the views or buttons added to the dialog calls RequestStop() . Constructors Dialog() Initializes a new instance of the Dialog class using Computed . Declaration public Dialog() Remarks Te Dialog will be vertically and horizontally centered in the container and the size will be 85% of the container. After initialzation use X , Y , Width , and Height to override this with a location or size. Use AddButton(Button) to add buttons to the dialog. Dialog(ustring, Int32, Int32, Button[]) Initializes a new instance of the Dialog class using Computed positioning and an optional set of Button s to display Declaration public Dialog(ustring title, int width, int height, params Button[] buttons) Parameters Type Name Description NStack.ustring title Title for the dialog. System.Int32 width Width for the dialog. System.Int32 height Height for the dialog. Button [] buttons Optional buttons to lay out at the bottom of the dialog. Remarks if width and height are both 0, the Dialog will be vertically and horizontally centered in the container and the size will be 85% of the container. After initialzation use X , Y , Width , and Height to override this with a location or size. Dialog(ustring, Button[]) Initializes a new instance of the Dialog class using Computed positioning and with an optional set of Button s to display Declaration public Dialog(ustring title, params Button[] buttons) Parameters Type Name Description NStack.ustring title Title for the dialog. Button [] buttons Optional buttons to lay out at the bottom of the dialog. Remarks Te Dialog will be vertically and horizontally centered in the container and the size will be 85% of the container. After initialzation use X , Y , Width , and Height to override this with a location or size. Methods AddButton(Button) Adds a Button to the Dialog , its layout will be controlled by the Dialog Declaration public void AddButton(Button button) Parameters Type Name Description Button button Button to add. ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides Toplevel.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" }, "api/Terminal.Gui/Terminal.Gui.Dim.html": { "href": "api/Terminal.Gui/Terminal.Gui.Dim.html", @@ -102,17 +102,17 @@ "api/Terminal.Gui/Terminal.Gui.FileDialog.html": { "href": "api/Terminal.Gui/Terminal.Gui.FileDialog.html", "title": "Class FileDialog", - "keywords": "Class FileDialog Base class for the OpenDialog and the SaveDialog Inheritance System.Object Responder View Toplevel Window Dialog FileDialog OpenDialog SaveDialog Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize System.Collections.IEnumerable Inherited Members Dialog.AddButton(Button) Dialog.ProcessKey(KeyEvent) Window.Title Window.GetEnumerator() Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.MouseEvent(MouseEvent) Window.Text Window.TextAlignment Toplevel.Running Toplevel.Ready Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class FileDialog : Dialog, IDisposable, ISupportInitializeNotification, ISupportInitialize, IEnumerable Constructors FileDialog() Initializes a new FileDialog . Declaration public FileDialog() FileDialog(ustring, ustring, ustring, ustring) Initializes a new instance of FileDialog Declaration public FileDialog(ustring title, ustring prompt, ustring nameFieldLabel, ustring message) Parameters Type Name Description NStack.ustring title The title. NStack.ustring prompt The prompt. NStack.ustring nameFieldLabel The name field label. NStack.ustring message The message. Properties AllowedFileTypes The array of filename extensions allowed, or null if all file extensions are allowed. Declaration public string[] AllowedFileTypes { get; set; } Property Value Type Description System.String [] The allowed file types. AllowsOtherFileTypes Gets or sets a value indicating whether this FileDialog allows the file to be saved with a different extension Declaration public bool AllowsOtherFileTypes { get; set; } Property Value Type Description System.Boolean true if allows other file types; otherwise, false . Canceled Check if the dialog was or not canceled. Declaration public bool Canceled { get; } Property Value Type Description System.Boolean CanCreateDirectories Gets or sets a value indicating whether this FileDialog can create directories. Declaration public bool CanCreateDirectories { get; set; } Property Value Type Description System.Boolean true if can create directories; otherwise, false . DirectoryPath Gets or sets the directory path for this panel Declaration public ustring DirectoryPath { get; set; } Property Value Type Description NStack.ustring The directory path. FilePath The File path that is currently shown on the panel Declaration public ustring FilePath { get; set; } Property Value Type Description NStack.ustring The absolute file path for the file path entered. IsExtensionHidden Gets or sets a value indicating whether this FileDialog is extension hidden. Declaration public bool IsExtensionHidden { get; set; } Property Value Type Description System.Boolean true if is extension hidden; otherwise, false . Message Gets or sets the message displayed to the user, defaults to nothing Declaration public ustring Message { get; set; } Property Value Type Description NStack.ustring The message. NameFieldLabel Gets or sets the name field label. Declaration public ustring NameFieldLabel { get; set; } Property Value Type Description NStack.ustring The name field label. Prompt Gets or sets the prompt label for the Button displayed to the user Declaration public ustring Prompt { get; set; } Property Value Type Description NStack.ustring The prompt. Methods WillPresent() Invoked by Begin(Toplevel) as part of the Run(Toplevel) after the views have been laid out, and before the views are drawn for the first time. Declaration public override void WillPresent() Overrides Toplevel.WillPresent() Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize System.Collections.IEnumerable" + "keywords": "Class FileDialog Base class for the OpenDialog and the SaveDialog Inheritance System.Object Responder View Toplevel Window Dialog FileDialog OpenDialog SaveDialog Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members Dialog.AddButton(Button) Dialog.ProcessKey(KeyEvent) Window.Title Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.MouseEvent(MouseEvent) Window.Text Window.TextAlignment Toplevel.Running Toplevel.Ready Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class FileDialog : Dialog, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors FileDialog() Initializes a new FileDialog . Declaration public FileDialog() FileDialog(ustring, ustring, ustring, ustring) Initializes a new instance of FileDialog Declaration public FileDialog(ustring title, ustring prompt, ustring nameFieldLabel, ustring message) Parameters Type Name Description NStack.ustring title The title. NStack.ustring prompt The prompt. NStack.ustring nameFieldLabel The name field label. NStack.ustring message The message. Properties AllowedFileTypes The array of filename extensions allowed, or null if all file extensions are allowed. Declaration public string[] AllowedFileTypes { get; set; } Property Value Type Description System.String [] The allowed file types. AllowsOtherFileTypes Gets or sets a value indicating whether this FileDialog allows the file to be saved with a different extension Declaration public bool AllowsOtherFileTypes { get; set; } Property Value Type Description System.Boolean true if allows other file types; otherwise, false . Canceled Check if the dialog was or not canceled. Declaration public bool Canceled { get; } Property Value Type Description System.Boolean CanCreateDirectories Gets or sets a value indicating whether this FileDialog can create directories. Declaration public bool CanCreateDirectories { get; set; } Property Value Type Description System.Boolean true if can create directories; otherwise, false . DirectoryPath Gets or sets the directory path for this panel Declaration public ustring DirectoryPath { get; set; } Property Value Type Description NStack.ustring The directory path. FilePath The File path that is currently shown on the panel Declaration public ustring FilePath { get; set; } Property Value Type Description NStack.ustring The absolute file path for the file path entered. IsExtensionHidden Gets or sets a value indicating whether this FileDialog is extension hidden. Declaration public bool IsExtensionHidden { get; set; } Property Value Type Description System.Boolean true if is extension hidden; otherwise, false . Message Gets or sets the message displayed to the user, defaults to nothing Declaration public ustring Message { get; set; } Property Value Type Description NStack.ustring The message. NameFieldLabel Gets or sets the name field label. Declaration public ustring NameFieldLabel { get; set; } Property Value Type Description NStack.ustring The name field label. Prompt Gets or sets the prompt label for the Button displayed to the user Declaration public ustring Prompt { get; set; } Property Value Type Description NStack.ustring The prompt. Methods WillPresent() Invoked by Begin(Toplevel) as part of the Run(Toplevel) after the views have been laid out, and before the views are drawn for the first time. Declaration public override void WillPresent() Overrides Toplevel.WillPresent() Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" }, "api/Terminal.Gui/Terminal.Gui.FrameView.html": { "href": "api/Terminal.Gui/Terminal.Gui.FrameView.html", "title": "Class FrameView", - "keywords": "Class FrameView The FrameView is a container frame that draws a frame around the contents. It is similar to a GroupBox in Windows. Inheritance System.Object Responder View FrameView Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.GetEnumerator() View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.MouseEvent(MouseEvent) Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class FrameView : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize Constructors FrameView() Initializes a new instance of the FrameView class using Computed layout. Declaration public FrameView() FrameView(ustring) Initializes a new instance of the FrameView class using Computed layout. Declaration public FrameView(ustring title) Parameters Type Name Description NStack.ustring title Title. FrameView(Rect, ustring) Initializes a new instance of the FrameView class using Absolute layout. Declaration public FrameView(Rect frame, ustring title = null) Parameters Type Name Description Rect frame Frame. NStack.ustring title Title. FrameView(Rect, ustring, View[]) Initializes a new instance of the FrameView class using Computed layout. Declaration public FrameView(Rect frame, ustring title, View[] views) Parameters Type Name Description Rect frame Frame. NStack.ustring title Title. View [] views Views. Properties Text The text displayed by the Label . Declaration public override ustring Text { get; set; } Property Value Type Description NStack.ustring Overrides View.Text TextAlignment Controls the text-alignment property of the label, changing it will redisplay the Label . Declaration public override TextAlignment TextAlignment { get; set; } Property Value Type Description TextAlignment The text alignment. Overrides View.TextAlignment Title The title to be displayed for this FrameView . Declaration public ustring Title { get; set; } Property Value Type Description NStack.ustring The title. Methods Add(View) Add the specified View to this container. Declaration public override void Add(View view) Parameters Type Name Description View view View to add to this container Overrides View.Add(View) Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. Remove(View) Removes a View from this container. Declaration public override void Remove(View view) Parameters Type Name Description View view Overrides View.Remove(View) Remarks RemoveAll() Removes all View s from this container. Declaration public override void RemoveAll() Overrides View.RemoveAll() Remarks Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" + "keywords": "Class FrameView The FrameView is a container frame that draws a frame around the contents. It is similar to a GroupBox in Windows. Inheritance System.Object Responder View FrameView Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.MouseEvent(MouseEvent) Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class FrameView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors FrameView() Initializes a new instance of the FrameView class using Computed layout. Declaration public FrameView() FrameView(ustring) Initializes a new instance of the FrameView class using Computed layout. Declaration public FrameView(ustring title) Parameters Type Name Description NStack.ustring title Title. FrameView(Rect, ustring) Initializes a new instance of the FrameView class using Absolute layout. Declaration public FrameView(Rect frame, ustring title = null) Parameters Type Name Description Rect frame Frame. NStack.ustring title Title. FrameView(Rect, ustring, View[]) Initializes a new instance of the FrameView class using Computed layout. Declaration public FrameView(Rect frame, ustring title, View[] views) Parameters Type Name Description Rect frame Frame. NStack.ustring title Title. View [] views Views. Properties Text The text displayed by the Label . Declaration public override ustring Text { get; set; } Property Value Type Description NStack.ustring Overrides View.Text TextAlignment Controls the text-alignment property of the label, changing it will redisplay the Label . Declaration public override TextAlignment TextAlignment { get; set; } Property Value Type Description TextAlignment The text alignment. Overrides View.TextAlignment Title The title to be displayed for this FrameView . Declaration public ustring Title { get; set; } Property Value Type Description NStack.ustring The title. Methods Add(View) Add the specified View to this container. Declaration public override void Add(View view) Parameters Type Name Description View view View to add to this container Overrides View.Add(View) Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. Remove(View) Removes a View from this container. Declaration public override void Remove(View view) Parameters Type Name Description View view Overrides View.Remove(View) Remarks RemoveAll() Removes all View s from this container. Declaration public override void RemoveAll() Overrides View.RemoveAll() Remarks Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" }, "api/Terminal.Gui/Terminal.Gui.HexView.html": { "href": "api/Terminal.Gui/Terminal.Gui.HexView.html", "title": "Class HexView", - "keywords": "Class HexView An hex viewer and editor View over a System.IO.Stream Inheritance System.Object Responder View HexView Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.GetEnumerator() View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.MouseEvent(MouseEvent) Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class HexView : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize Remarks HexView provides a hex editor on top of a seekable System.IO.Stream with the left side showing an hex dump of the values in the System.IO.Stream and the right side showing the contents (filtered to non-control sequence ASCII characters). Users can switch from one side to the other by using the tab key. To enable editing, set AllowEdits to true. When AllowEdits is true the user can make changes to the hexadecimal values of the System.IO.Stream . Any changes are tracked in the Edits property (a System.Collections.Generic.SortedDictionary`2 ) indicating the position where the changes were made and the new values. A convenience method, ApplyEdits() will apply the edits to the System.IO.Stream . Control the first byte shown by setting the DisplayStart property to an offset in the stream. Constructors HexView() Initialzies a HexView class using Computed layout. Declaration public HexView() HexView(Stream) Initialzies a HexView class using Computed layout. Declaration public HexView(Stream source) Parameters Type Name Description System.IO.Stream source The System.IO.Stream to view and edit as hex, this System.IO.Stream must support seeking, or an exception will be thrown. Properties AllowEdits Gets or sets whether this HexView allow editing of the System.IO.Stream of the underlying System.IO.Stream . Declaration public bool AllowEdits { get; set; } Property Value Type Description System.Boolean true if allow edits; otherwise, false . DisplayStart Sets or gets the offset into the System.IO.Stream that will displayed at the top of the HexView Declaration public long DisplayStart { get; set; } Property Value Type Description System.Int64 The display start. Edits Gets a System.Collections.Generic.SortedDictionary`2 describing the edits done to the HexView . Each Key indicates an offset where an edit was made and the Value is the changed byte. Declaration public IReadOnlyDictionary Edits { get; } Property Value Type Description System.Collections.Generic.IReadOnlyDictionary < System.Int64 , System.Byte > The edits. Frame Gets or sets the frame for the view. The frame is relative to the view's container ( SuperView ). Declaration public override Rect Frame { get; set; } Property Value Type Description Rect The frame. Overrides View.Frame Remarks Change the Frame when using the Absolute layout style to move or resize views. Altering the Frame of a view will trigger the redrawing of the view as well as the redrawing of the affected regions of the SuperView . Source Sets or gets the System.IO.Stream the HexView is operating on; the stream must support seeking ( System.IO.Stream.CanSeek == true). Declaration public Stream Source { get; set; } Property Value Type Description System.IO.Stream The source. Methods ApplyEdits() This method applies andy edits made to the System.IO.Stream and resets the contents of the Edits property Declaration public void ApplyEdits() PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" + "keywords": "Class HexView An hex viewer and editor View over a System.IO.Stream Inheritance System.Object Responder View HexView Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.MouseEvent(MouseEvent) Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class HexView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks HexView provides a hex editor on top of a seekable System.IO.Stream with the left side showing an hex dump of the values in the System.IO.Stream and the right side showing the contents (filtered to non-control sequence ASCII characters). Users can switch from one side to the other by using the tab key. To enable editing, set AllowEdits to true. When AllowEdits is true the user can make changes to the hexadecimal values of the System.IO.Stream . Any changes are tracked in the Edits property (a System.Collections.Generic.SortedDictionary`2 ) indicating the position where the changes were made and the new values. A convenience method, ApplyEdits() will apply the edits to the System.IO.Stream . Control the first byte shown by setting the DisplayStart property to an offset in the stream. Constructors HexView() Initialzies a HexView class using Computed layout. Declaration public HexView() HexView(Stream) Initialzies a HexView class using Computed layout. Declaration public HexView(Stream source) Parameters Type Name Description System.IO.Stream source The System.IO.Stream to view and edit as hex, this System.IO.Stream must support seeking, or an exception will be thrown. Properties AllowEdits Gets or sets whether this HexView allow editing of the System.IO.Stream of the underlying System.IO.Stream . Declaration public bool AllowEdits { get; set; } Property Value Type Description System.Boolean true if allow edits; otherwise, false . DisplayStart Sets or gets the offset into the System.IO.Stream that will displayed at the top of the HexView Declaration public long DisplayStart { get; set; } Property Value Type Description System.Int64 The display start. Edits Gets a System.Collections.Generic.SortedDictionary`2 describing the edits done to the HexView . Each Key indicates an offset where an edit was made and the Value is the changed byte. Declaration public IReadOnlyDictionary Edits { get; } Property Value Type Description System.Collections.Generic.IReadOnlyDictionary < System.Int64 , System.Byte > The edits. Frame Gets or sets the frame for the view. The frame is relative to the view's container ( SuperView ). Declaration public override Rect Frame { get; set; } Property Value Type Description Rect The frame. Overrides View.Frame Remarks Change the Frame when using the Absolute layout style to move or resize views. Altering the Frame of a view will trigger the redrawing of the view as well as the redrawing of the affected regions of the SuperView . Source Sets or gets the System.IO.Stream the HexView is operating on; the stream must support seeking ( System.IO.Stream.CanSeek == true). Declaration public Stream Source { get; set; } Property Value Type Description System.IO.Stream The source. Methods ApplyEdits() This method applies andy edits made to the System.IO.Stream and resets the contents of the Edits property Declaration public void ApplyEdits() PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" }, "api/Terminal.Gui/Terminal.Gui.html": { "href": "api/Terminal.Gui/Terminal.Gui.html", @@ -147,7 +147,7 @@ "api/Terminal.Gui/Terminal.Gui.Label.html": { "href": "api/Terminal.Gui/Terminal.Gui.Label.html", "title": "Class Label", - "keywords": "Class Label The Label View displays a string at a given position and supports multiple lines separted by newline characters. Multi-line Labels support word wrap. Inheritance System.Object Responder View Label Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.GetEnumerator() View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.Redraw(Rect) View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.MouseEvent(MouseEvent) Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class Label : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize Remarks The Label view is functionality identical to View and is included for API backwards compatibility. Constructors Label() Declaration public Label() Label(ustring) Initializes a new instance of View using Computed layout. Declaration public Label(ustring text) Parameters Type Name Description NStack.ustring text text to initialize the Text property with. Remarks The View will be created using Computed coordinates with the given string. The initial size ( Frame will be adjusted to fit the contents of Text , including newlines ('\\n') for multiple lines. If Height is greater than one, word wrapping is provided. Label(Int32, Int32, ustring) Initializes a new instance of View using Absolute layout. Declaration public Label(int x, int y, ustring text) Parameters Type Name Description System.Int32 x column to locate the Label. System.Int32 y row to locate the Label. NStack.ustring text text to initialize the Text property with. Remarks The View will be created at the given coordinates with the given string. The size ( Frame will be adjusted to fit the contents of Text , including newlines ('\\n') for multiple lines. No line wrapping is provided. Label(Rect) Initializes a new instance of a Absolute View class with the absolute dimensions specified in the frame parameter. Declaration public Label(Rect frame) Parameters Type Name Description Rect frame The region covered by this view. Remarks This constructor intitalize a View with a LayoutStyle of Absolute . Use View() to initialize a View with LayoutStyle of Computed Label(Rect, ustring) Initializes a new instance of View using Absolute layout. Declaration public Label(Rect rect, ustring text) Parameters Type Name Description Rect rect Location. NStack.ustring text text to initialize the Text property with. Remarks The View will be created at the given coordinates with the given string. The initial size ( Frame will be adjusted to fit the contents of Text , including newlines ('\\n') for multiple lines. If rect.Height is greater than one, word wrapping is provided. Fields Clicked Clicked System.Action , raised when the user clicks the primary mouse button within the Bounds of this View or if the user presses the action key while this view is focused. (TODO: IsDefault) Declaration public Action Clicked Field Value Type Description System.Action Remarks Client code can hook up to this event, it is raised when the button is activated either with the mouse or the keyboard. Methods OnMouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool OnMouseEvent(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnMouseEvent(MouseEvent) Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" + "keywords": "Class Label The Label View displays a string at a given position and supports multiple lines separted by newline characters. Multi-line Labels support word wrap. Inheritance System.Object Responder View Label Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.Redraw(Rect) View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.MouseEvent(MouseEvent) Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class Label : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The Label view is functionality identical to View and is included for API backwards compatibility. Constructors Label() Declaration public Label() Label(ustring) Initializes a new instance of View using Computed layout. Declaration public Label(ustring text) Parameters Type Name Description NStack.ustring text text to initialize the Text property with. Remarks The View will be created using Computed coordinates with the given string. The initial size ( Frame will be adjusted to fit the contents of Text , including newlines ('\\n') for multiple lines. If Height is greater than one, word wrapping is provided. Label(Int32, Int32, ustring) Initializes a new instance of View using Absolute layout. Declaration public Label(int x, int y, ustring text) Parameters Type Name Description System.Int32 x column to locate the Label. System.Int32 y row to locate the Label. NStack.ustring text text to initialize the Text property with. Remarks The View will be created at the given coordinates with the given string. The size ( Frame will be adjusted to fit the contents of Text , including newlines ('\\n') for multiple lines. No line wrapping is provided. Label(Rect) Initializes a new instance of a Absolute View class with the absolute dimensions specified in the frame parameter. Declaration public Label(Rect frame) Parameters Type Name Description Rect frame The region covered by this view. Remarks This constructor intitalize a View with a LayoutStyle of Absolute . Use View() to initialize a View with LayoutStyle of Computed Label(Rect, ustring) Initializes a new instance of View using Absolute layout. Declaration public Label(Rect rect, ustring text) Parameters Type Name Description Rect rect Location. NStack.ustring text text to initialize the Text property with. Remarks The View will be created at the given coordinates with the given string. The initial size ( Frame will be adjusted to fit the contents of Text , including newlines ('\\n') for multiple lines. If rect.Height is greater than one, word wrapping is provided. Methods OnMouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool OnMouseEvent(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnMouseEvent(MouseEvent) Events Clicked Clicked System.Action , raised when the user clicks the primary mouse button within the Bounds of this View or if the user presses the action key while this view is focused. (TODO: IsDefault) Declaration public event Action Clicked Event Type Type Description System.Action Remarks Client code can hook up to this event, it is raised when the button is activated either with the mouse or the keyboard. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" }, "api/Terminal.Gui/Terminal.Gui.LayoutStyle.html": { "href": "api/Terminal.Gui/Terminal.Gui.LayoutStyle.html", @@ -157,7 +157,7 @@ "api/Terminal.Gui/Terminal.Gui.ListView.html": { "href": "api/Terminal.Gui/Terminal.Gui.ListView.html", "title": "Class ListView", - "keywords": "Class ListView ListView View renders a scrollable list of data where each item can be activated to perform an action. Inheritance System.Object Responder View ListView Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.GetEnumerator() View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class ListView : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize Remarks The ListView displays lists of data and allows the user to scroll through the data. Items in the can be activated firing an event (with the ENTER key or a mouse double-click). If the AllowsMarking property is true, elements of the list can be marked by the user. By default ListView uses System.Object.ToString() to render the items of any System.Collections.IList object (e.g. arrays, System.Collections.Generic.List , and other collections). Alternatively, an object that implements the IListDataSource interface can be provided giving full control of what is rendered. ListView can display any object that implements the System.Collections.IList interface. System.String values are converted into NStack.ustring values before rendering, and other values are converted into System.String by calling System.Object.ToString() and then converting to NStack.ustring . To change the contents of the ListView, set the Source property (when providing custom rendering via IListDataSource ) or call SetSource(IList) an System.Collections.IList is being used. When AllowsMarking is set to true the rendering will prefix the rendered items with [x] or [ ] and bind the SPACE key to toggle the selection. To implement a different marking style set AllowsMarking to false and implement custom rendering. Constructors ListView() Initializes a new instance of ListView . Set the Source property to display something. Declaration public ListView() ListView(IList) Initializes a new instance of ListView that will display the contents of the object implementing the System.Collections.IList interface, with relative positioning. Declaration public ListView(IList source) Parameters Type Name Description System.Collections.IList source An System.Collections.IList data source, if the elements are strings or ustrings, the string is rendered, otherwise the ToString() method is invoked on the result. ListView(IListDataSource) Initializes a new instance of ListView that will display the provided data source, using relative positioning. Declaration public ListView(IListDataSource source) Parameters Type Name Description IListDataSource source IListDataSource object that provides a mechanism to render the data. The number of elements on the collection should not change, if you must change, set the \"Source\" property to reset the internal settings of the ListView. ListView(Rect, IList) Initializes a new instance of ListView that will display the contents of the object implementing the System.Collections.IList interface with an absolute position. Declaration public ListView(Rect rect, IList source) Parameters Type Name Description Rect rect Frame for the listview. System.Collections.IList source An IList data source, if the elements of the IList are strings or ustrings, the string is rendered, otherwise the ToString() method is invoked on the result. ListView(Rect, IListDataSource) Initializes a new instance of ListView with the provided data source and an absolute position Declaration public ListView(Rect rect, IListDataSource source) Parameters Type Name Description Rect rect Frame for the listview. IListDataSource source IListDataSource object that provides a mechanism to render the data. The number of elements on the collection should not change, if you must change, set the \"Source\" property to reset the internal settings of the ListView. Fields OpenSelectedItem This event is raised when the user Double Clicks on an item or presses ENTER to open the selected item. Declaration public Action OpenSelectedItem Field Value Type Description System.Action < ListViewItemEventArgs > SelectedItemChanged This event is raised when the selected item in the ListView has changed. Declaration public Action SelectedItemChanged Field Value Type Description System.Action < ListViewItemEventArgs > Properties AllowsMarking Gets or sets whether this ListView allows items to be marked. Declaration public bool AllowsMarking { get; set; } Property Value Type Description System.Boolean true if allows marking elements of the list; otherwise, false . Remarks If set to true, ListView will render items marked items with \"[x]\", and unmarked items with \"[ ]\" spaces. SPACE key will toggle marking. AllowsMultipleSelection If set to true allows more than one item to be selected. If false only allow one item selected. Declaration public bool AllowsMultipleSelection { get; set; } Property Value Type Description System.Boolean SelectedItem Gets or sets the index of the currently selected item. Declaration public int SelectedItem { get; set; } Property Value Type Description System.Int32 The selected item. Source Gets or sets the IListDataSource backing this ListView , enabling custom rendering. Declaration public IListDataSource Source { get; set; } Property Value Type Description IListDataSource The source. Remarks Use SetSource(IList) to set a new System.Collections.IList source. TopItem Gets or sets the item that is displayed at the top of the ListView . Declaration public int TopItem { get; set; } Property Value Type Description System.Int32 The top item. Methods AllowsAll() Prevents marking if it's not allowed mark and if it's not allows multiple selection. Declaration public virtual bool AllowsAll() Returns Type Description System.Boolean MarkUnmarkRow() Marks an unmarked row. Declaration public virtual bool MarkUnmarkRow() Returns Type Description System.Boolean MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) MoveDown() Moves the selected item index to the next row. Declaration public virtual bool MoveDown() Returns Type Description System.Boolean MoveEnd() Moves the selected item index to the last row. Declaration public virtual bool MoveEnd() Returns Type Description System.Boolean MoveHome() Moves the selected item index to the first row. Declaration public virtual bool MoveHome() Returns Type Description System.Boolean MovePageDown() Moves the selected item index to the previous page. Declaration public virtual bool MovePageDown() Returns Type Description System.Boolean MovePageUp() Moves the selected item index to the next page. Declaration public virtual bool MovePageUp() Returns Type Description System.Boolean MoveUp() Moves the selected item index to the previous row. Declaration public virtual bool MoveUp() Returns Type Description System.Boolean OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnEnter(View) OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnLeave(View) OnOpenSelectedItem() Invokes the OnOpenSelectedItem event if it is defined. Declaration public virtual bool OnOpenSelectedItem() Returns Type Description System.Boolean OnSelectedChanged() Invokes the SelectedChanged event if it is defined. Declaration public virtual bool OnSelectedChanged() Returns Type Description System.Boolean PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. SetSource(IList) Sets the source of the ListView to an System.Collections.IList . Declaration public void SetSource(IList source) Parameters Type Name Description System.Collections.IList source Remarks Use the Source property to set a new IListDataSource source and use custome rendering. SetSourceAsync(IList) Sets the source to an System.Collections.IList value asynchronously. Declaration public Task SetSourceAsync(IList source) Parameters Type Name Description System.Collections.IList source Returns Type Description System.Threading.Tasks.Task An item implementing the IList interface. Remarks Use the Source property to set a new IListDataSource source and use custome rendering. Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" + "keywords": "Class ListView ListView View renders a scrollable list of data where each item can be activated to perform an action. Inheritance System.Object Responder View ListView Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class ListView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The ListView displays lists of data and allows the user to scroll through the data. Items in the can be activated firing an event (with the ENTER key or a mouse double-click). If the AllowsMarking property is true, elements of the list can be marked by the user. By default ListView uses System.Object.ToString() to render the items of any System.Collections.IList object (e.g. arrays, System.Collections.Generic.List , and other collections). Alternatively, an object that implements the IListDataSource interface can be provided giving full control of what is rendered. ListView can display any object that implements the System.Collections.IList interface. System.String values are converted into NStack.ustring values before rendering, and other values are converted into System.String by calling System.Object.ToString() and then converting to NStack.ustring . To change the contents of the ListView, set the Source property (when providing custom rendering via IListDataSource ) or call SetSource(IList) an System.Collections.IList is being used. When AllowsMarking is set to true the rendering will prefix the rendered items with [x] or [ ] and bind the SPACE key to toggle the selection. To implement a different marking style set AllowsMarking to false and implement custom rendering. Constructors ListView() Initializes a new instance of ListView . Set the Source property to display something. Declaration public ListView() ListView(IList) Initializes a new instance of ListView that will display the contents of the object implementing the System.Collections.IList interface, with relative positioning. Declaration public ListView(IList source) Parameters Type Name Description System.Collections.IList source An System.Collections.IList data source, if the elements are strings or ustrings, the string is rendered, otherwise the ToString() method is invoked on the result. ListView(IListDataSource) Initializes a new instance of ListView that will display the provided data source, using relative positioning. Declaration public ListView(IListDataSource source) Parameters Type Name Description IListDataSource source IListDataSource object that provides a mechanism to render the data. The number of elements on the collection should not change, if you must change, set the \"Source\" property to reset the internal settings of the ListView. ListView(Rect, IList) Initializes a new instance of ListView that will display the contents of the object implementing the System.Collections.IList interface with an absolute position. Declaration public ListView(Rect rect, IList source) Parameters Type Name Description Rect rect Frame for the listview. System.Collections.IList source An IList data source, if the elements of the IList are strings or ustrings, the string is rendered, otherwise the ToString() method is invoked on the result. ListView(Rect, IListDataSource) Initializes a new instance of ListView with the provided data source and an absolute position Declaration public ListView(Rect rect, IListDataSource source) Parameters Type Name Description Rect rect Frame for the listview. IListDataSource source IListDataSource object that provides a mechanism to render the data. The number of elements on the collection should not change, if you must change, set the \"Source\" property to reset the internal settings of the ListView. Properties AllowsMarking Gets or sets whether this ListView allows items to be marked. Declaration public bool AllowsMarking { get; set; } Property Value Type Description System.Boolean true if allows marking elements of the list; otherwise, false . Remarks If set to true, ListView will render items marked items with \"[x]\", and unmarked items with \"[ ]\" spaces. SPACE key will toggle marking. AllowsMultipleSelection If set to true allows more than one item to be selected. If false only allow one item selected. Declaration public bool AllowsMultipleSelection { get; set; } Property Value Type Description System.Boolean SelectedItem Gets or sets the index of the currently selected item. Declaration public int SelectedItem { get; set; } Property Value Type Description System.Int32 The selected item. Source Gets or sets the IListDataSource backing this ListView , enabling custom rendering. Declaration public IListDataSource Source { get; set; } Property Value Type Description IListDataSource The source. Remarks Use SetSource(IList) to set a new System.Collections.IList source. TopItem Gets or sets the item that is displayed at the top of the ListView . Declaration public int TopItem { get; set; } Property Value Type Description System.Int32 The top item. Methods AllowsAll() Prevents marking if it's not allowed mark and if it's not allows multiple selection. Declaration public virtual bool AllowsAll() Returns Type Description System.Boolean MarkUnmarkRow() Marks an unmarked row. Declaration public virtual bool MarkUnmarkRow() Returns Type Description System.Boolean MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) MoveDown() Moves the selected item index to the next row. Declaration public virtual bool MoveDown() Returns Type Description System.Boolean MoveEnd() Moves the selected item index to the last row. Declaration public virtual bool MoveEnd() Returns Type Description System.Boolean MoveHome() Moves the selected item index to the first row. Declaration public virtual bool MoveHome() Returns Type Description System.Boolean MovePageDown() Moves the selected item index to the previous page. Declaration public virtual bool MovePageDown() Returns Type Description System.Boolean MovePageUp() Moves the selected item index to the next page. Declaration public virtual bool MovePageUp() Returns Type Description System.Boolean MoveUp() Moves the selected item index to the previous row. Declaration public virtual bool MoveUp() Returns Type Description System.Boolean OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnEnter(View) OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnLeave(View) OnOpenSelectedItem() Invokes the OnOpenSelectedItem event if it is defined. Declaration public virtual bool OnOpenSelectedItem() Returns Type Description System.Boolean OnSelectedChanged() Invokes the SelectedChanged event if it is defined. Declaration public virtual bool OnSelectedChanged() Returns Type Description System.Boolean PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. SetSource(IList) Sets the source of the ListView to an System.Collections.IList . Declaration public void SetSource(IList source) Parameters Type Name Description System.Collections.IList source Remarks Use the Source property to set a new IListDataSource source and use custome rendering. SetSourceAsync(IList) Sets the source to an System.Collections.IList value asynchronously. Declaration public Task SetSourceAsync(IList source) Parameters Type Name Description System.Collections.IList source Returns Type Description System.Threading.Tasks.Task An item implementing the IList interface. Remarks Use the Source property to set a new IListDataSource source and use custome rendering. Events OpenSelectedItem This event is raised when the user Double Clicks on an item or presses ENTER to open the selected item. Declaration public event Action OpenSelectedItem Event Type Type Description System.Action < ListViewItemEventArgs > SelectedItemChanged This event is raised when the selected item in the ListView has changed. Declaration public event Action SelectedItemChanged Event Type Type Description System.Action < ListViewItemEventArgs > Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" }, "api/Terminal.Gui/Terminal.Gui.ListViewItemEventArgs.html": { "href": "api/Terminal.Gui/Terminal.Gui.ListViewItemEventArgs.html", @@ -177,17 +177,17 @@ "api/Terminal.Gui/Terminal.Gui.MenuBar.html": { "href": "api/Terminal.Gui/Terminal.Gui.MenuBar.html", "title": "Class MenuBar", - "keywords": "Class MenuBar The MenuBar provides a menu for Terminal.Gui applications. Inheritance System.Object Responder View MenuBar Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.GetEnumerator() View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessColdKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class MenuBar : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize Remarks The MenuBar appears on the first row of the terminal. The MenuBar provides global hotkeys for the application. Constructors MenuBar() Initializes a new instance of the MenuBar . Declaration public MenuBar() MenuBar(MenuBarItem[]) Initializes a new instance of the MenuBar class with the specified set of toplevel menu items. Declaration public MenuBar(MenuBarItem[] menus) Parameters Type Name Description MenuBarItem [] menus Individual menu items; a null item will result in a separator being drawn. Fields MenuClosing Raised when a menu is closing. Declaration public Action MenuClosing Field Value Type Description System.Action MenuOpening Raised as a menu is opening. Declaration public Action MenuOpening Field Value Type Description System.Action Properties IsMenuOpen True if the menu is open; otherwise false. Declaration public bool IsMenuOpen { get; protected set; } Property Value Type Description System.Boolean LastFocused Get the lasted focused view before open the menu. Declaration public View LastFocused { get; } Property Value Type Description View Menus Gets or sets the array of MenuBarItem s for the menu. Only set this when the MenuBar is vislble. Declaration public MenuBarItem[] Menus { get; set; } Property Value Type Description MenuBarItem [] The menu array. UseKeysUpDownAsKeysLeftRight Used for change the navigation key style. Declaration public bool UseKeysUpDownAsKeysLeftRight { get; set; } Property Value Type Description System.Boolean Methods CloseMenu() Closes the current Menu programatically, if open. Declaration public void CloseMenu() MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) OnKeyDown(KeyEvent) Declaration public override bool OnKeyDown(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides View.OnKeyDown(KeyEvent) OnKeyUp(KeyEvent) Declaration public override bool OnKeyUp(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides View.OnKeyUp(KeyEvent) OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnLeave(View) OnMenuClosing() Virtual method that will invoke the MenuClosing Declaration public virtual void OnMenuClosing() OnMenuOpening() Virtual method that will invoke the MenuOpening Declaration public virtual void OnMenuOpening() OpenMenu() Opens the current Menu programatically. Declaration public void OpenMenu() PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessHotKey(KeyEvent) This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example). Declaration public override bool ProcessHotKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessHotKey(KeyEvent) Remarks Before keys are sent to the subview on the current view, all the views are processed and the key is passed to the widgets to allow some of them to process the keystroke as a hot-key. For example, if you implement a button that has a hotkey ok \"o\", you would catch the combination Alt-o here. If the event is caught, you must return true to stop the keystroke from being dispatched to other views. ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" + "keywords": "Class MenuBar The MenuBar provides a menu for Terminal.Gui applications. Inheritance System.Object Responder View MenuBar Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessColdKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class MenuBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The MenuBar appears on the first row of the terminal. The MenuBar provides global hotkeys for the application. Constructors MenuBar() Initializes a new instance of the MenuBar . Declaration public MenuBar() MenuBar(MenuBarItem[]) Initializes a new instance of the MenuBar class with the specified set of toplevel menu items. Declaration public MenuBar(MenuBarItem[] menus) Parameters Type Name Description MenuBarItem [] menus Individual menu items; a null item will result in a separator being drawn. Properties IsMenuOpen True if the menu is open; otherwise false. Declaration public bool IsMenuOpen { get; protected set; } Property Value Type Description System.Boolean LastFocused Get the lasted focused view before open the menu. Declaration public View LastFocused { get; } Property Value Type Description View Menus Gets or sets the array of MenuBarItem s for the menu. Only set this when the MenuBar is vislble. Declaration public MenuBarItem[] Menus { get; set; } Property Value Type Description MenuBarItem [] The menu array. UseKeysUpDownAsKeysLeftRight Used for change the navigation key style. Declaration public bool UseKeysUpDownAsKeysLeftRight { get; set; } Property Value Type Description System.Boolean Methods CloseMenu() Closes the current Menu programatically, if open. Declaration public void CloseMenu() MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) OnKeyDown(KeyEvent) Declaration public override bool OnKeyDown(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides View.OnKeyDown(KeyEvent) OnKeyUp(KeyEvent) Declaration public override bool OnKeyUp(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides View.OnKeyUp(KeyEvent) OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnLeave(View) OnMenuClosing() Virtual method that will invoke the MenuClosing Declaration public virtual void OnMenuClosing() OnMenuOpening() Virtual method that will invoke the MenuOpening Declaration public virtual void OnMenuOpening() OpenMenu() Opens the current Menu programatically. Declaration public void OpenMenu() PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessHotKey(KeyEvent) This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example). Declaration public override bool ProcessHotKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessHotKey(KeyEvent) Remarks Before keys are sent to the subview on the current view, all the views are processed and the key is passed to the widgets to allow some of them to process the keystroke as a hot-key. For example, if you implement a button that has a hotkey ok \"o\", you would catch the combination Alt-o here. If the event is caught, you must return true to stop the keystroke from being dispatched to other views. ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. Events MenuClosing Raised when a menu is closing. Declaration public event Action MenuClosing Event Type Type Description System.Action MenuOpening Raised as a menu is opening. Declaration public event Action MenuOpening Event Type Type Description System.Action Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" }, "api/Terminal.Gui/Terminal.Gui.MenuBarItem.html": { "href": "api/Terminal.Gui/Terminal.Gui.MenuBarItem.html", "title": "Class MenuBarItem", - "keywords": "Class MenuBarItem A MenuBarItem contains MenuBarItem s or MenuItem s. Inheritance System.Object MenuItem MenuBarItem Inherited Members MenuItem.HotKey MenuItem.ShortCut MenuItem.Title MenuItem.Help MenuItem.Action MenuItem.CanExecute MenuItem.IsEnabled() MenuItem.Checked MenuItem.CheckType MenuItem.Parent MenuItem.GetMenuItem() MenuItem.GetMenuBarItem() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class MenuBarItem : MenuItem Constructors MenuBarItem() Initializes a new MenuBarItem . Declaration public MenuBarItem() MenuBarItem(ustring, ustring, Action, Func, MenuItem) Initializes a new MenuBarItem as a MenuItem . Declaration public MenuBarItem(ustring title, ustring help, Action action, Func canExecute = null, MenuItem parent = null) Parameters Type Name Description NStack.ustring title Title for the menu item. NStack.ustring help Help text to display. System.Action action Action to invoke when the menu item is activated. System.Func < System.Boolean > canExecute Function to determine if the action can currently be executed. MenuItem parent The parent MenuItem of this if exist, otherwise is null. MenuBarItem(ustring, MenuItem[], MenuItem) Initializes a new MenuBarItem . Declaration public MenuBarItem(ustring title, MenuItem[] children, MenuItem parent = null) Parameters Type Name Description NStack.ustring title Title for the menu item. MenuItem [] children The items in the current menu. MenuItem parent The parent MenuItem of this if exist, otherwise is null. MenuBarItem(MenuItem[]) Initializes a new MenuBarItem . Declaration public MenuBarItem(MenuItem[] children) Parameters Type Name Description MenuItem [] children The items in the current menu. Properties Children Gets or sets an array of MenuItem objects that are the children of this MenuBarItem Declaration public MenuItem[] Children { get; set; } Property Value Type Description MenuItem [] The children. Methods GetChildrenIndex(MenuItem) Get the index of the MenuItem parameter. Declaration public int GetChildrenIndex(MenuItem children) Parameters Type Name Description MenuItem children Returns Type Description System.Int32 Returns a value bigger than -1 if the MenuItem is a child of this. IsSubMenuOf(MenuItem) Check if the MenuItem parameter is a child of this. Declaration public bool IsSubMenuOf(MenuItem menuItem) Parameters Type Name Description MenuItem menuItem Returns Type Description System.Boolean Returns true if it is a child of this. false otherwise. SubMenu(MenuItem) Check if the children parameter is a MenuBarItem . Declaration public MenuBarItem SubMenu(MenuItem children) Parameters Type Name Description MenuItem children Returns Type Description MenuBarItem Returns a MenuBarItem or null otherwise." + "keywords": "Class MenuBarItem A MenuBarItem contains MenuBarItem s or MenuItem s. Inheritance System.Object MenuItem MenuBarItem Inherited Members MenuItem.HotKey MenuItem.Title MenuItem.Help MenuItem.Action MenuItem.CanExecute MenuItem.IsEnabled() MenuItem.Checked MenuItem.CheckType MenuItem.Parent MenuItem.GetMenuItem() MenuItem.GetMenuBarItem() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class MenuBarItem : MenuItem Constructors MenuBarItem() Initializes a new MenuBarItem . Declaration public MenuBarItem() MenuBarItem(ustring, ustring, Action, Func, MenuItem) Initializes a new MenuBarItem as a MenuItem . Declaration public MenuBarItem(ustring title, ustring help, Action action, Func canExecute = null, MenuItem parent = null) Parameters Type Name Description NStack.ustring title Title for the menu item. NStack.ustring help Help text to display. System.Action action Action to invoke when the menu item is activated. System.Func < System.Boolean > canExecute Function to determine if the action can currently be executed. MenuItem parent The parent MenuItem of this if exist, otherwise is null. MenuBarItem(ustring, MenuItem[], MenuItem) Initializes a new MenuBarItem . Declaration public MenuBarItem(ustring title, MenuItem[] children, MenuItem parent = null) Parameters Type Name Description NStack.ustring title Title for the menu item. MenuItem [] children The items in the current menu. MenuItem parent The parent MenuItem of this if exist, otherwise is null. MenuBarItem(MenuItem[]) Initializes a new MenuBarItem . Declaration public MenuBarItem(MenuItem[] children) Parameters Type Name Description MenuItem [] children The items in the current menu. Properties Children Gets or sets an array of MenuItem objects that are the children of this MenuBarItem Declaration public MenuItem[] Children { get; set; } Property Value Type Description MenuItem [] The children. Methods GetChildrenIndex(MenuItem) Get the index of the MenuItem parameter. Declaration public int GetChildrenIndex(MenuItem children) Parameters Type Name Description MenuItem children Returns Type Description System.Int32 Returns a value bigger than -1 if the MenuItem is a child of this. IsSubMenuOf(MenuItem) Check if the MenuItem parameter is a child of this. Declaration public bool IsSubMenuOf(MenuItem menuItem) Parameters Type Name Description MenuItem menuItem Returns Type Description System.Boolean Returns true if it is a child of this. false otherwise. SubMenu(MenuItem) Check if the children parameter is a MenuBarItem . Declaration public MenuBarItem SubMenu(MenuItem children) Parameters Type Name Description MenuItem children Returns Type Description MenuBarItem Returns a MenuBarItem or null otherwise." }, "api/Terminal.Gui/Terminal.Gui.MenuItem.html": { "href": "api/Terminal.Gui/Terminal.Gui.MenuItem.html", "title": "Class MenuItem", - "keywords": "Class MenuItem A MenuItem has a title, an associated help text, and an action to execute on activation. Inheritance System.Object MenuItem MenuBarItem Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class MenuItem Constructors MenuItem() Initializes a new instance of MenuItem Declaration public MenuItem() MenuItem(ustring, ustring, Action, Func, MenuItem) Initializes a new instance of MenuItem . Declaration public MenuItem(ustring title, ustring help, Action action, Func canExecute = null, MenuItem parent = null) Parameters Type Name Description NStack.ustring title Title for the menu item. NStack.ustring help Help text to display. System.Action action Action to invoke when the menu item is activated. System.Func < System.Boolean > canExecute Function to determine if the action can currently be executed. MenuItem parent The parent of this menu item. Fields HotKey The HotKey is used when the menu is active, the shortcut can be triggered when the menu is not active. For example HotKey would be \"N\" when the File Menu is open (assuming there is a \"_New\" entry if the ShortCut is set to \"Control-N\", this would be a global hotkey that would trigger as well Declaration public Rune HotKey Field Value Type Description System.Rune ShortCut This is the global setting that can be used as a global shortcut to invoke the action on the menu. Declaration public Key ShortCut Field Value Type Description Key Properties Action Gets or sets the action to be invoked when the menu is triggered Declaration public Action Action { get; set; } Property Value Type Description System.Action Method to invoke. CanExecute Gets or sets the action to be invoked if the menu can be triggered Declaration public Func CanExecute { get; set; } Property Value Type Description System.Func < System.Boolean > Function to determine if action is ready to be executed. Checked Sets or gets whether the MenuItem shows a check indicator or not. See MenuItemCheckStyle . Declaration public bool Checked { get; set; } Property Value Type Description System.Boolean CheckType Sets or gets the type selection indicator the menu item will be displayed with. Declaration public MenuItemCheckStyle CheckType { get; set; } Property Value Type Description MenuItemCheckStyle Help Gets or sets the help text for the menu item. Declaration public ustring Help { get; set; } Property Value Type Description NStack.ustring The help text. Parent Gets or sets the parent for this MenuItem . Declaration public MenuItem Parent { get; } Property Value Type Description MenuItem The parent. Title Gets or sets the title. Declaration public ustring Title { get; set; } Property Value Type Description NStack.ustring The title. Methods GetMenuBarItem() Merely a debugging aid to see the interaction with main Declaration public bool GetMenuBarItem() Returns Type Description System.Boolean GetMenuItem() Merely a debugging aid to see the interaction with main Declaration public MenuItem GetMenuItem() Returns Type Description MenuItem IsEnabled() Shortcut to check if the menu item is enabled Declaration public bool IsEnabled() Returns Type Description System.Boolean" + "keywords": "Class MenuItem A MenuItem has a title, an associated help text, and an action to execute on activation. Inheritance System.Object MenuItem MenuBarItem Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class MenuItem Constructors MenuItem() Initializes a new instance of MenuItem Declaration public MenuItem() MenuItem(ustring, ustring, Action, Func, MenuItem) Initializes a new instance of MenuItem . Declaration public MenuItem(ustring title, ustring help, Action action, Func canExecute = null, MenuItem parent = null) Parameters Type Name Description NStack.ustring title Title for the menu item. NStack.ustring help Help text to display. System.Action action Action to invoke when the menu item is activated. System.Func < System.Boolean > canExecute Function to determine if the action can currently be executed. MenuItem parent The parent of this menu item. Fields HotKey The HotKey is used when the menu is active, the shortcut can be triggered when the menu is not active. For example HotKey would be \"N\" when the File Menu is open (assuming there is a \"_New\" entry if the ShortCut is set to \"Control-N\", this would be a global hotkey that would trigger as well Declaration public Rune HotKey Field Value Type Description System.Rune Properties Action Gets or sets the action to be invoked when the menu is triggered Declaration public Action Action { get; set; } Property Value Type Description System.Action Method to invoke. CanExecute Gets or sets the action to be invoked if the menu can be triggered Declaration public Func CanExecute { get; set; } Property Value Type Description System.Func < System.Boolean > Function to determine if action is ready to be executed. Checked Sets or gets whether the MenuItem shows a check indicator or not. See MenuItemCheckStyle . Declaration public bool Checked { get; set; } Property Value Type Description System.Boolean CheckType Sets or gets the type selection indicator the menu item will be displayed with. Declaration public MenuItemCheckStyle CheckType { get; set; } Property Value Type Description MenuItemCheckStyle Help Gets or sets the help text for the menu item. Declaration public ustring Help { get; set; } Property Value Type Description NStack.ustring The help text. Parent Gets or sets the parent for this MenuItem . Declaration public MenuItem Parent { get; } Property Value Type Description MenuItem The parent. Title Gets or sets the title. Declaration public ustring Title { get; set; } Property Value Type Description NStack.ustring The title. Methods GetMenuBarItem() Merely a debugging aid to see the interaction with main Declaration public bool GetMenuBarItem() Returns Type Description System.Boolean GetMenuItem() Merely a debugging aid to see the interaction with main Declaration public MenuItem GetMenuItem() Returns Type Description MenuItem IsEnabled() Shortcut to check if the menu item is enabled Declaration public bool IsEnabled() Returns Type Description System.Boolean" }, "api/Terminal.Gui/Terminal.Gui.MenuItemCheckStyle.html": { "href": "api/Terminal.Gui/Terminal.Gui.MenuItemCheckStyle.html", @@ -207,7 +207,7 @@ "api/Terminal.Gui/Terminal.Gui.MouseFlags.html": { "href": "api/Terminal.Gui/Terminal.Gui.MouseFlags.html", "title": "Enum MouseFlags", - "keywords": "Enum MouseFlags Mouse flags reported in MouseEvent . Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax [Flags] public enum MouseFlags Remarks They just happen to map to the ncurses ones. Fields Name Description AllEvents Mask that captures all the events. Button1Clicked The first mouse button was clicked (press+release). Button1DoubleClicked The first mouse button was double-clicked. Button1Pressed The first mouse button was pressed. Button1Released The first mouse button was released. Button1TripleClicked The first mouse button was triple-clicked. Button2Clicked The second mouse button was clicked (press+release). Button2DoubleClicked The second mouse button was double-clicked. Button2Pressed The second mouse button was pressed. Button2Released The second mouse button was released. Button2TripleClicked The second mouse button was triple-clicked. Button3Clicked The third mouse button was clicked (press+release). Button3DoubleClicked The third mouse button was double-clicked. Button3Pressed The third mouse button was pressed. Button3Released The third mouse button was released. Button3TripleClicked The third mouse button was triple-clicked. Button4Clicked The fourth button was clicked (press+release). Button4DoubleClicked The fourth button was double-clicked. Button4Pressed The fourth mouse button was pressed. Button4Released The fourth mouse button was released. Button4TripleClicked The fourth button was triple-clicked. ButtonAlt Flag: the alt key was pressed when the mouse button took place. ButtonCtrl Flag: the ctrl key was pressed when the mouse button took place. ButtonShift Flag: the shift key was pressed when the mouse button took place. ReportMousePosition The mouse position is being reported in this event. WheeledDown Vertical button wheeled up. WheeledUp Vertical button wheeled up." + "keywords": "Enum MouseFlags Mouse flags reported in MouseEvent . Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax [Flags] public enum MouseFlags Remarks They just happen to map to the ncurses ones. Fields Name Description AllEvents Mask that captures all the events. Button1Clicked The first mouse button was clicked (press+release). Button1DoubleClicked The first mouse button was double-clicked. Button1Pressed The first mouse button was pressed. Button1Released The first mouse button was released. Button1TripleClicked The first mouse button was triple-clicked. Button2Clicked The second mouse button was clicked (press+release). Button2DoubleClicked The second mouse button was double-clicked. Button2Pressed The second mouse button was pressed. Button2Released The second mouse button was released. Button2TripleClicked The second mouse button was triple-clicked. Button3Clicked The third mouse button was clicked (press+release). Button3DoubleClicked The third mouse button was double-clicked. Button3Pressed The third mouse button was pressed. Button3Released The third mouse button was released. Button3TripleClicked The third mouse button was triple-clicked. Button4Clicked The fourth button was clicked (press+release). Button4DoubleClicked The fourth button was double-clicked. Button4Pressed The fourth mouse button was pressed. Button4Released The fourth mouse button was released. Button4TripleClicked The fourth button was triple-clicked. ButtonAlt Flag: the alt key was pressed when the mouse button took place. ButtonCtrl Flag: the ctrl key was pressed when the mouse button took place. ButtonShift Flag: the shift key was pressed when the mouse button took place. ReportMousePosition The mouse position is being reported in this event. WheeledDown Vertical button wheeled up. WheeledLeft Vertical button wheeled up while pressing ButtonShift. WheeledRight Vertical button wheeled down while pressing ButtonShift. WheeledUp Vertical button wheeled up." }, "api/Terminal.Gui/Terminal.Gui.NetMainLoop.html": { "href": "api/Terminal.Gui/Terminal.Gui.NetMainLoop.html", @@ -217,7 +217,7 @@ "api/Terminal.Gui/Terminal.Gui.OpenDialog.html": { "href": "api/Terminal.Gui/Terminal.Gui.OpenDialog.html", "title": "Class OpenDialog", - "keywords": "Class OpenDialog The OpenDialog provides an interactive dialog box for users to select files or directories. Inheritance System.Object Responder View Toplevel Window Dialog FileDialog OpenDialog Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize System.Collections.IEnumerable Inherited Members FileDialog.WillPresent() FileDialog.Prompt FileDialog.NameFieldLabel FileDialog.Message FileDialog.CanCreateDirectories FileDialog.IsExtensionHidden FileDialog.DirectoryPath FileDialog.AllowedFileTypes FileDialog.AllowsOtherFileTypes FileDialog.FilePath FileDialog.Canceled Dialog.AddButton(Button) Dialog.ProcessKey(KeyEvent) Window.Title Window.GetEnumerator() Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.MouseEvent(MouseEvent) Window.Text Window.TextAlignment Toplevel.Running Toplevel.Ready Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class OpenDialog : FileDialog, IDisposable, ISupportInitializeNotification, ISupportInitialize, IEnumerable Remarks The open dialog can be used to select files for opening, it can be configured to allow multiple items to be selected (based on the AllowsMultipleSelection) variable and you can control whether this should allow files or directories to be selected. To use, create an instance of OpenDialog , and pass it to Run() . This will run the dialog modally, and when this returns, the list of filds will be available on the FilePaths property. To select more than one file, users can use the spacebar, or control-t. Constructors OpenDialog() Initializes a new OpenDialog . Declaration public OpenDialog() OpenDialog(ustring, ustring) Initializes a new OpenDialog . Declaration public OpenDialog(ustring title, ustring message) Parameters Type Name Description NStack.ustring title NStack.ustring message Properties AllowsMultipleSelection Gets or sets a value indicating whether this OpenDialog allows multiple selection. Declaration public bool AllowsMultipleSelection { get; set; } Property Value Type Description System.Boolean true if allows multiple selection; otherwise, false , defaults to false. CanChooseDirectories Gets or sets a value indicating whether this OpenDialog can choose directories. Declaration public bool CanChooseDirectories { get; set; } Property Value Type Description System.Boolean true if can choose directories; otherwise, false defaults to false . CanChooseFiles Gets or sets a value indicating whether this OpenDialog can choose files. Declaration public bool CanChooseFiles { get; set; } Property Value Type Description System.Boolean true if can choose files; otherwise, false . Defaults to true FilePaths Returns the selected files, or an empty list if nothing has been selected Declaration public IReadOnlyList FilePaths { get; } Property Value Type Description System.Collections.Generic.IReadOnlyList < System.String > The file paths. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize System.Collections.IEnumerable" + "keywords": "Class OpenDialog The OpenDialog provides an interactive dialog box for users to select files or directories. Inheritance System.Object Responder View Toplevel Window Dialog FileDialog OpenDialog Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members FileDialog.WillPresent() FileDialog.Prompt FileDialog.NameFieldLabel FileDialog.Message FileDialog.CanCreateDirectories FileDialog.IsExtensionHidden FileDialog.DirectoryPath FileDialog.AllowedFileTypes FileDialog.AllowsOtherFileTypes FileDialog.FilePath FileDialog.Canceled Dialog.AddButton(Button) Dialog.ProcessKey(KeyEvent) Window.Title Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.MouseEvent(MouseEvent) Window.Text Window.TextAlignment Toplevel.Running Toplevel.Ready Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class OpenDialog : FileDialog, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The open dialog can be used to select files for opening, it can be configured to allow multiple items to be selected (based on the AllowsMultipleSelection) variable and you can control whether this should allow files or directories to be selected. To use, create an instance of OpenDialog , and pass it to Run() . This will run the dialog modally, and when this returns, the list of filds will be available on the FilePaths property. To select more than one file, users can use the spacebar, or control-t. Constructors OpenDialog() Initializes a new OpenDialog . Declaration public OpenDialog() OpenDialog(ustring, ustring) Initializes a new OpenDialog . Declaration public OpenDialog(ustring title, ustring message) Parameters Type Name Description NStack.ustring title NStack.ustring message Properties AllowsMultipleSelection Gets or sets a value indicating whether this OpenDialog allows multiple selection. Declaration public bool AllowsMultipleSelection { get; set; } Property Value Type Description System.Boolean true if allows multiple selection; otherwise, false , defaults to false. CanChooseDirectories Gets or sets a value indicating whether this OpenDialog can choose directories. Declaration public bool CanChooseDirectories { get; set; } Property Value Type Description System.Boolean true if can choose directories; otherwise, false defaults to false . CanChooseFiles Gets or sets a value indicating whether this OpenDialog can choose files. Declaration public bool CanChooseFiles { get; set; } Property Value Type Description System.Boolean true if can choose files; otherwise, false . Defaults to true FilePaths Returns the selected files, or an empty list if nothing has been selected Declaration public IReadOnlyList FilePaths { get; } Property Value Type Description System.Collections.Generic.IReadOnlyList < System.String > The file paths. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" }, "api/Terminal.Gui/Terminal.Gui.Point.html": { "href": "api/Terminal.Gui/Terminal.Gui.Point.html", @@ -232,12 +232,12 @@ "api/Terminal.Gui/Terminal.Gui.ProgressBar.html": { "href": "api/Terminal.Gui/Terminal.Gui.ProgressBar.html", "title": "Class ProgressBar", - "keywords": "Class ProgressBar A Progress Bar view that can indicate progress of an activity visually. Inheritance System.Object Responder View ProgressBar Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.GetEnumerator() View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.MouseEvent(MouseEvent) Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class ProgressBar : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize Remarks ProgressBar can operate in two modes, percentage mode, or activity mode. The progress bar starts in percentage mode and setting the Fraction property will reflect on the UI the progress made so far. Activity mode is used when the application has no way of knowing how much time is left, and is started when the Pulse() method is called. Call Pulse() repeatedly as progress is made. Constructors ProgressBar() Initializes a new instance of the ProgressBar class, starts in percentage mode and uses relative layout. Declaration public ProgressBar() ProgressBar(Rect) Initializes a new instance of the ProgressBar class, starts in percentage mode with an absolute position and size. Declaration public ProgressBar(Rect rect) Parameters Type Name Description Rect rect Rect. Properties Fraction Gets or sets the ProgressBar fraction to display, must be a value between 0 and 1. Declaration public float Fraction { get; set; } Property Value Type Description System.Single The fraction representing the progress. Methods Pulse() Notifies the ProgressBar that some progress has taken place. Declaration public void Pulse() Remarks If the ProgressBar is is percentage mode, it switches to activity mode. If is in activity mode, the marker is moved. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect region) Parameters Type Name Description Rect region Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" + "keywords": "Class ProgressBar A Progress Bar view that can indicate progress of an activity visually. Inheritance System.Object Responder View ProgressBar Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.MouseEvent(MouseEvent) Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class ProgressBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks ProgressBar can operate in two modes, percentage mode, or activity mode. The progress bar starts in percentage mode and setting the Fraction property will reflect on the UI the progress made so far. Activity mode is used when the application has no way of knowing how much time is left, and is started when the Pulse() method is called. Call Pulse() repeatedly as progress is made. Constructors ProgressBar() Initializes a new instance of the ProgressBar class, starts in percentage mode and uses relative layout. Declaration public ProgressBar() ProgressBar(Rect) Initializes a new instance of the ProgressBar class, starts in percentage mode with an absolute position and size. Declaration public ProgressBar(Rect rect) Parameters Type Name Description Rect rect Rect. Properties Fraction Gets or sets the ProgressBar fraction to display, must be a value between 0 and 1. Declaration public float Fraction { get; set; } Property Value Type Description System.Single The fraction representing the progress. Methods Pulse() Notifies the ProgressBar that some progress has taken place. Declaration public void Pulse() Remarks If the ProgressBar is is percentage mode, it switches to activity mode. If is in activity mode, the marker is moved. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect region) Parameters Type Name Description Rect region Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" }, "api/Terminal.Gui/Terminal.Gui.RadioGroup.html": { "href": "api/Terminal.Gui/Terminal.Gui.RadioGroup.html", "title": "Class RadioGroup", - "keywords": "Class RadioGroup RadioGroup shows a group of radio labels, only one of those can be selected at a given time Inheritance System.Object Responder View RadioGroup Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.GetEnumerator() View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class RadioGroup : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize Constructors RadioGroup() Initializes a new instance of the RadioGroup class using Computed layout. Declaration public RadioGroup() RadioGroup(ustring[], Int32) Initializes a new instance of the RadioGroup class using Computed layout. Declaration public RadioGroup(ustring[] radioLabels, int selected = 0) Parameters Type Name Description NStack.ustring [] radioLabels The radio labels; an array of strings that can contain hotkeys using an underscore before the letter. System.Int32 selected The index of the item to be selected, the value is clamped to the number of items. RadioGroup(Int32, Int32, ustring[], Int32) Initializes a new instance of the RadioGroup class using Absolute layout. The View frame is computed from the provided radio labels. Declaration public RadioGroup(int x, int y, ustring[] radioLabels, int selected = 0) Parameters Type Name Description System.Int32 x The x coordinate. System.Int32 y The y coordinate. NStack.ustring [] radioLabels The radio labels; an array of strings that can contain hotkeys using an underscore before the letter. System.Int32 selected The item to be selected, the value is clamped to the number of items. RadioGroup(Rect, ustring[], Int32) Initializes a new instance of the RadioGroup class using Absolute layout. Declaration public RadioGroup(Rect rect, ustring[] radioLabels, int selected = 0) Parameters Type Name Description Rect rect Boundaries for the radio group. NStack.ustring [] radioLabels The radio labels; an array of strings that can contain hotkeys using an underscore before the letter. System.Int32 selected The index of item to be selected, the value is clamped to the number of items. Fields SelectedItemChanged Invoked when the selected radio label has changed. Declaration public Action SelectedItemChanged Field Value Type Description System.Action < RadioGroup.SelectedItemChangedArgs > Properties DisplayMode Gets or sets the DisplayModeLayout for this RadioGroup . Declaration public DisplayModeLayout DisplayMode { get; set; } Property Value Type Description DisplayModeLayout HorizontalSpace Gets or sets the horizontal space for this RadioGroup if the DisplayMode is Horizontal Declaration public int HorizontalSpace { get; set; } Property Value Type Description System.Int32 RadioLabels The radio labels to display Declaration public ustring[] RadioLabels { get; set; } Property Value Type Description NStack.ustring [] The radio labels. SelectedItem The currently selected item from the list of radio labels Declaration public int SelectedItem { get; set; } Property Value Type Description System.Int32 The selected. Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) OnSelectedItemChanged(Int32, Int32) Called whenever the current selected item changes. Invokes the SelectedItemChanged event. Declaration public virtual void OnSelectedItemChanged(int selectedItem, int previousSelectedItem) Parameters Type Name Description System.Int32 selectedItem System.Int32 previousSelectedItem PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessColdKey(KeyEvent) This method can be overwritten by views that want to provide accelerator functionality (Alt-key for example), but without interefering with normal ProcessKey behavior. Declaration public override bool ProcessColdKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessColdKey(KeyEvent) Remarks After keys are sent to the subviews on the current view, all the view are processed and the key is passed to the views to allow some of them to process the keystroke as a cold-key. This functionality is used, for example, by default buttons to act on the enter key. Processing this as a hot-key would prevent non-default buttons from consuming the enter keypress when they have the focus. ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" + "keywords": "Class RadioGroup RadioGroup shows a group of radio labels, only one of those can be selected at a given time Inheritance System.Object Responder View RadioGroup Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class RadioGroup : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors RadioGroup() Initializes a new instance of the RadioGroup class using Computed layout. Declaration public RadioGroup() RadioGroup(ustring[], Int32) Initializes a new instance of the RadioGroup class using Computed layout. Declaration public RadioGroup(ustring[] radioLabels, int selected = 0) Parameters Type Name Description NStack.ustring [] radioLabels The radio labels; an array of strings that can contain hotkeys using an underscore before the letter. System.Int32 selected The index of the item to be selected, the value is clamped to the number of items. RadioGroup(Int32, Int32, ustring[], Int32) Initializes a new instance of the RadioGroup class using Absolute layout. The View frame is computed from the provided radio labels. Declaration public RadioGroup(int x, int y, ustring[] radioLabels, int selected = 0) Parameters Type Name Description System.Int32 x The x coordinate. System.Int32 y The y coordinate. NStack.ustring [] radioLabels The radio labels; an array of strings that can contain hotkeys using an underscore before the letter. System.Int32 selected The item to be selected, the value is clamped to the number of items. RadioGroup(Rect, ustring[], Int32) Initializes a new instance of the RadioGroup class using Absolute layout. Declaration public RadioGroup(Rect rect, ustring[] radioLabels, int selected = 0) Parameters Type Name Description Rect rect Boundaries for the radio group. NStack.ustring [] radioLabels The radio labels; an array of strings that can contain hotkeys using an underscore before the letter. System.Int32 selected The index of item to be selected, the value is clamped to the number of items. Properties DisplayMode Gets or sets the DisplayModeLayout for this RadioGroup . Declaration public DisplayModeLayout DisplayMode { get; set; } Property Value Type Description DisplayModeLayout HorizontalSpace Gets or sets the horizontal space for this RadioGroup if the DisplayMode is Horizontal Declaration public int HorizontalSpace { get; set; } Property Value Type Description System.Int32 RadioLabels The radio labels to display Declaration public ustring[] RadioLabels { get; set; } Property Value Type Description NStack.ustring [] The radio labels. SelectedItem The currently selected item from the list of radio labels Declaration public int SelectedItem { get; set; } Property Value Type Description System.Int32 The selected. Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) OnSelectedItemChanged(Int32, Int32) Called whenever the current selected item changes. Invokes the SelectedItemChanged event. Declaration public virtual void OnSelectedItemChanged(int selectedItem, int previousSelectedItem) Parameters Type Name Description System.Int32 selectedItem System.Int32 previousSelectedItem PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessColdKey(KeyEvent) This method can be overwritten by views that want to provide accelerator functionality (Alt-key for example), but without interefering with normal ProcessKey behavior. Declaration public override bool ProcessColdKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessColdKey(KeyEvent) Remarks After keys are sent to the subviews on the current view, all the view are processed and the key is passed to the views to allow some of them to process the keystroke as a cold-key. This functionality is used, for example, by default buttons to act on the enter key. Processing this as a hot-key would prevent non-default buttons from consuming the enter keypress when they have the focus. ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. Refresh() Allow to invoke the SelectedItemChanged after their creation. Declaration public void Refresh() Events SelectedItemChanged Invoked when the selected radio label has changed. Declaration public event Action SelectedItemChanged Event Type Type Description System.Action < RadioGroup.SelectedItemChangedArgs > Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" }, "api/Terminal.Gui/Terminal.Gui.RadioGroup.SelectedItemChangedArgs.html": { "href": "api/Terminal.Gui/Terminal.Gui.RadioGroup.SelectedItemChangedArgs.html", @@ -257,17 +257,17 @@ "api/Terminal.Gui/Terminal.Gui.SaveDialog.html": { "href": "api/Terminal.Gui/Terminal.Gui.SaveDialog.html", "title": "Class SaveDialog", - "keywords": "Class SaveDialog The SaveDialog provides an interactive dialog box for users to pick a file to save. Inheritance System.Object Responder View Toplevel Window Dialog FileDialog SaveDialog Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize System.Collections.IEnumerable Inherited Members FileDialog.WillPresent() FileDialog.Prompt FileDialog.NameFieldLabel FileDialog.Message FileDialog.CanCreateDirectories FileDialog.IsExtensionHidden FileDialog.DirectoryPath FileDialog.AllowedFileTypes FileDialog.AllowsOtherFileTypes FileDialog.FilePath FileDialog.Canceled Dialog.AddButton(Button) Dialog.ProcessKey(KeyEvent) Window.Title Window.GetEnumerator() Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.MouseEvent(MouseEvent) Window.Text Window.TextAlignment Toplevel.Running Toplevel.Ready Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class SaveDialog : FileDialog, IDisposable, ISupportInitializeNotification, ISupportInitialize, IEnumerable Remarks To use, create an instance of SaveDialog , and pass it to Run() . This will run the dialog modally, and when this returns, the FileName property will contain the selected file name or null if the user canceled. Constructors SaveDialog() Initializes a new SaveDialog . Declaration public SaveDialog() SaveDialog(ustring, ustring) Initializes a new SaveDialog . Declaration public SaveDialog(ustring title, ustring message) Parameters Type Name Description NStack.ustring title The title. NStack.ustring message The message. Properties FileName Gets the name of the file the user selected for saving, or null if the user canceled the SaveDialog . Declaration public ustring FileName { get; } Property Value Type Description NStack.ustring The name of the file. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize System.Collections.IEnumerable" + "keywords": "Class SaveDialog The SaveDialog provides an interactive dialog box for users to pick a file to save. Inheritance System.Object Responder View Toplevel Window Dialog FileDialog SaveDialog Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members FileDialog.WillPresent() FileDialog.Prompt FileDialog.NameFieldLabel FileDialog.Message FileDialog.CanCreateDirectories FileDialog.IsExtensionHidden FileDialog.DirectoryPath FileDialog.AllowedFileTypes FileDialog.AllowsOtherFileTypes FileDialog.FilePath FileDialog.Canceled Dialog.AddButton(Button) Dialog.ProcessKey(KeyEvent) Window.Title Window.Add(View) Window.Remove(View) Window.RemoveAll() Window.Redraw(Rect) Window.MouseEvent(MouseEvent) Window.Text Window.TextAlignment Toplevel.Running Toplevel.Ready Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class SaveDialog : FileDialog, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks To use, create an instance of SaveDialog , and pass it to Run() . This will run the dialog modally, and when this returns, the FileName property will contain the selected file name or null if the user canceled. Constructors SaveDialog() Initializes a new SaveDialog . Declaration public SaveDialog() SaveDialog(ustring, ustring) Initializes a new SaveDialog . Declaration public SaveDialog(ustring title, ustring message) Parameters Type Name Description NStack.ustring title The title. NStack.ustring message The message. Properties FileName Gets the name of the file the user selected for saving, or null if the user canceled the SaveDialog . Declaration public ustring FileName { get; } Property Value Type Description NStack.ustring The name of the file. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" }, "api/Terminal.Gui/Terminal.Gui.ScrollBarView.html": { "href": "api/Terminal.Gui/Terminal.Gui.ScrollBarView.html", "title": "Class ScrollBarView", - "keywords": "Class ScrollBarView ScrollBarViews are views that display a 1-character scrollbar, either horizontal or vertical Inheritance System.Object Responder View ScrollBarView Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.GetEnumerator() View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class ScrollBarView : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize Remarks The scrollbar is drawn to be a representation of the Size, assuming that the scroll position is set at Position. If the region to display the scrollbar is larger than three characters, arrow indicators are drawn. Constructors ScrollBarView() Initializes a new instance of the ScrollBarView class using Computed layout. Declaration public ScrollBarView() ScrollBarView(Int32, Int32, Boolean) Initializes a new instance of the ScrollBarView class using Computed layout. Declaration public ScrollBarView(int size, int position, bool isVertical) Parameters Type Name Description System.Int32 size The size that this scrollbar represents. System.Int32 position The position within this scrollbar. System.Boolean isVertical If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal. ScrollBarView(Rect) Initializes a new instance of the ScrollBarView class using Absolute layout. Declaration public ScrollBarView(Rect rect) Parameters Type Name Description Rect rect Frame for the scrollbar. ScrollBarView(Rect, Int32, Int32, Boolean) Initializes a new instance of the ScrollBarView class using Absolute layout. Declaration public ScrollBarView(Rect rect, int size, int position, bool isVertical) Parameters Type Name Description Rect rect Frame for the scrollbar. System.Int32 size The size that this scrollbar represents. Sets the Size property. System.Int32 position The position within this scrollbar. Sets the Position property. System.Boolean isVertical If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal. Sets the IsVertical property. Fields ChangedPosition This event is raised when the position on the scrollbar has changed. Declaration public Action ChangedPosition Field Value Type Description System.Action Properties IsVertical If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal. Declaration public bool IsVertical { get; set; } Property Value Type Description System.Boolean Position The position, relative to Size , to set the scrollbar at. Declaration public int Position { get; set; } Property Value Type Description System.Int32 The position. Size The size of content the scrollbar represents. Declaration public int Size { get; set; } Property Value Type Description System.Int32 The size. Remarks The Size is typically the size of the virtual content. E.g. when a Scrollbar is part of a ScrollView the Size is set to the appropriate dimension of ContentSize . Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect region) Parameters Type Name Description Rect region Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" + "keywords": "Class ScrollBarView ScrollBarViews are views that display a 1-character scrollbar, either horizontal or vertical Inheritance System.Object Responder View ScrollBarView Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class ScrollBarView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The scrollbar is drawn to be a representation of the Size, assuming that the scroll position is set at Position. If the region to display the scrollbar is larger than three characters, arrow indicators are drawn. Constructors ScrollBarView() Initializes a new instance of the ScrollBarView class using Computed layout. Declaration public ScrollBarView() ScrollBarView(Int32, Int32, Boolean) Initializes a new instance of the ScrollBarView class using Computed layout. Declaration public ScrollBarView(int size, int position, bool isVertical) Parameters Type Name Description System.Int32 size The size that this scrollbar represents. System.Int32 position The position within this scrollbar. System.Boolean isVertical If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal. ScrollBarView(Rect) Initializes a new instance of the ScrollBarView class using Absolute layout. Declaration public ScrollBarView(Rect rect) Parameters Type Name Description Rect rect Frame for the scrollbar. ScrollBarView(Rect, Int32, Int32, Boolean) Initializes a new instance of the ScrollBarView class using Absolute layout. Declaration public ScrollBarView(Rect rect, int size, int position, bool isVertical) Parameters Type Name Description Rect rect Frame for the scrollbar. System.Int32 size The size that this scrollbar represents. Sets the Size property. System.Int32 position The position within this scrollbar. Sets the Position property. System.Boolean isVertical If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal. Sets the IsVertical property. Properties Host Get or sets the view that host this ScrollView Declaration public ScrollView Host { get; } Property Value Type Description ScrollView IsVertical If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal. Declaration public bool IsVertical { get; set; } Property Value Type Description System.Boolean Position The position, relative to Size , to set the scrollbar at. Declaration public int Position { get; set; } Property Value Type Description System.Int32 The position. Size The size of content the scrollbar represents. Declaration public int Size { get; set; } Property Value Type Description System.Int32 The size. Remarks The Size is typically the size of the virtual content. E.g. when a Scrollbar is part of a ScrollView the Size is set to the appropriate dimension of ContentSize . Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect region) Parameters Type Name Description Rect region Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. Events ChangedPosition This event is raised when the position on the scrollbar has changed. Declaration public event Action ChangedPosition Event Type Type Description System.Action Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" }, "api/Terminal.Gui/Terminal.Gui.ScrollView.html": { "href": "api/Terminal.Gui/Terminal.Gui.ScrollView.html", "title": "Class ScrollView", - "keywords": "Class ScrollView Scrollviews are views that present a window into a virtual space where subviews are added. Similar to the iOS UIScrollView. Inheritance System.Object Responder View ScrollView Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.GetEnumerator() View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class ScrollView : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize Remarks The subviews that are added to this ScrollView are offset by the ContentOffset property. The view itself is a window into the space represented by the ContentSize . Use the Constructors ScrollView() Initializes a new instance of the ScrollView class using Computed positioning. Declaration public ScrollView() ScrollView(Rect) Initializes a new instance of the ScrollView class using Absolute positioning. Declaration public ScrollView(Rect frame) Parameters Type Name Description Rect frame Properties AutoHideScrollBars If true the vertical/horizontal scroll bars won't be showed if it's not needed. Declaration public bool AutoHideScrollBars { get; set; } Property Value Type Description System.Boolean ContentOffset Represents the top left corner coordinate that is displayed by the scrollview Declaration public Point ContentOffset { get; set; } Property Value Type Description Point The content offset. ContentSize Represents the contents of the data shown inside the scrolview Declaration public Size ContentSize { get; set; } Property Value Type Description Size The size of the content. ShowHorizontalScrollIndicator Gets or sets the visibility for the horizontal scroll indicator. Declaration public bool ShowHorizontalScrollIndicator { get; set; } Property Value Type Description System.Boolean true if show horizontal scroll indicator; otherwise, false . ShowVerticalScrollIndicator /// Gets or sets the visibility for the vertical scroll indicator. Declaration public bool ShowVerticalScrollIndicator { get; set; } Property Value Type Description System.Boolean true if show vertical scroll indicator; otherwise, false . Methods Add(View) Adds the view to the scrollview. Declaration public override void Add(View view) Parameters Type Name Description View view The view to add to the scrollview. Overrides View.Add(View) Dispose(Boolean) Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Declaration protected override void Dispose(bool disposing) Parameters Type Name Description System.Boolean disposing Overrides View.Dispose(Boolean) Remarks If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. If disposing equals false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed. MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect region) Parameters Type Name Description Rect region Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. RemoveAll() Removes all widgets from this container. Declaration public override void RemoveAll() Overrides View.RemoveAll() Remarks ScrollDown(Int32) Scrolls the view down. Declaration public bool ScrollDown(int lines) Parameters Type Name Description System.Int32 lines Number of lines to scroll. Returns Type Description System.Boolean true , if left was scrolled, false otherwise. ScrollLeft(Int32) Scrolls the view to the left Declaration public bool ScrollLeft(int cols) Parameters Type Name Description System.Int32 cols Number of columns to scroll by. Returns Type Description System.Boolean true , if left was scrolled, false otherwise. ScrollRight(Int32) Scrolls the view to the right. Declaration public bool ScrollRight(int cols) Parameters Type Name Description System.Int32 cols Number of columns to scroll by. Returns Type Description System.Boolean true , if right was scrolled, false otherwise. ScrollUp(Int32) Scrolls the view up. Declaration public bool ScrollUp(int lines) Parameters Type Name Description System.Int32 lines Number of lines to scroll. Returns Type Description System.Boolean true , if left was scrolled, false otherwise. Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" + "keywords": "Class ScrollView Scrollviews are views that present a window into a virtual space where subviews are added. Similar to the iOS UIScrollView. Inheritance System.Object Responder View ScrollView Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class ScrollView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The subviews that are added to this ScrollView are offset by the ContentOffset property. The view itself is a window into the space represented by the ContentSize . Use the Constructors ScrollView() Initializes a new instance of the ScrollView class using Computed positioning. Declaration public ScrollView() ScrollView(Rect) Initializes a new instance of the ScrollView class using Absolute positioning. Declaration public ScrollView(Rect frame) Parameters Type Name Description Rect frame Properties AutoHideScrollBars If true the vertical/horizontal scroll bars won't be showed if it's not needed. Declaration public bool AutoHideScrollBars { get; set; } Property Value Type Description System.Boolean ContentOffset Represents the top left corner coordinate that is displayed by the scrollview Declaration public Point ContentOffset { get; set; } Property Value Type Description Point The content offset. ContentSize Represents the contents of the data shown inside the scrolview Declaration public Size ContentSize { get; set; } Property Value Type Description Size The size of the content. KeepContentAlwaysInViewport Get or sets if the view-port is kept always visible in the area of this ScrollView Declaration public bool KeepContentAlwaysInViewport { get; set; } Property Value Type Description System.Boolean ShowHorizontalScrollIndicator Gets or sets the visibility for the horizontal scroll indicator. Declaration public bool ShowHorizontalScrollIndicator { get; set; } Property Value Type Description System.Boolean true if show horizontal scroll indicator; otherwise, false . ShowVerticalScrollIndicator /// Gets or sets the visibility for the vertical scroll indicator. Declaration public bool ShowVerticalScrollIndicator { get; set; } Property Value Type Description System.Boolean true if show vertical scroll indicator; otherwise, false . Methods Add(View) Adds the view to the scrollview. Declaration public override void Add(View view) Parameters Type Name Description View view The view to add to the scrollview. Overrides View.Add(View) Dispose(Boolean) Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Declaration protected override void Dispose(bool disposing) Parameters Type Name Description System.Boolean disposing Overrides View.Dispose(Boolean) Remarks If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. If disposing equals false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed. MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect region) Parameters Type Name Description Rect region Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. RemoveAll() Removes all widgets from this container. Declaration public override void RemoveAll() Overrides View.RemoveAll() Remarks ScrollDown(Int32) Scrolls the view down. Declaration public bool ScrollDown(int lines) Parameters Type Name Description System.Int32 lines Number of lines to scroll. Returns Type Description System.Boolean true , if left was scrolled, false otherwise. ScrollLeft(Int32) Scrolls the view to the left Declaration public bool ScrollLeft(int cols) Parameters Type Name Description System.Int32 cols Number of columns to scroll by. Returns Type Description System.Boolean true , if left was scrolled, false otherwise. ScrollRight(Int32) Scrolls the view to the right. Declaration public bool ScrollRight(int cols) Parameters Type Name Description System.Int32 cols Number of columns to scroll by. Returns Type Description System.Boolean true , if right was scrolled, false otherwise. ScrollUp(Int32) Scrolls the view up. Declaration public bool ScrollUp(int lines) Parameters Type Name Description System.Int32 lines Number of lines to scroll. Returns Type Description System.Boolean true , if left was scrolled, false otherwise. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" }, "api/Terminal.Gui/Terminal.Gui.Size.html": { "href": "api/Terminal.Gui/Terminal.Gui.Size.html", @@ -277,7 +277,7 @@ "api/Terminal.Gui/Terminal.Gui.StatusBar.html": { "href": "api/Terminal.Gui/Terminal.Gui.StatusBar.html", "title": "Class StatusBar", - "keywords": "Class StatusBar A status bar is a View that snaps to the bottom of a Toplevel displaying set of StatusItem s. The StatusBar 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. Inheritance System.Object Responder View StatusBar Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.GetEnumerator() View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class StatusBar : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize Constructors StatusBar() Initializes a new instance of the StatusBar class. Declaration public StatusBar() StatusBar(StatusItem[]) Initializes a new instance of the StatusBar class with the specified set of StatusItem s. The StatusBar will be drawn on the lowest line of the terminal or SuperView (if not null). Declaration public StatusBar(StatusItem[] items) Parameters Type Name Description StatusItem [] items A list of statusbar items. Properties Items The items that compose the StatusBar Declaration public StatusItem[] Items { get; set; } Property Value Type Description StatusItem [] Methods Dispose(Boolean) Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Declaration protected override void Dispose(bool disposing) Parameters Type Name Description System.Boolean disposing Overrides View.Dispose(Boolean) Remarks If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. If disposing equals false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed. MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) ProcessHotKey(KeyEvent) This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example). Declaration public override bool ProcessHotKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessHotKey(KeyEvent) Remarks Before keys are sent to the subview on the current view, all the views are processed and the key is passed to the widgets to allow some of them to process the keystroke as a hot-key. For example, if you implement a button that has a hotkey ok \"o\", you would catch the combination Alt-o here. If the event is caught, you must return true to stop the keystroke from being dispatched to other views. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" + "keywords": "Class StatusBar A status bar is a View that snaps to the bottom of a Toplevel displaying set of StatusItem s. The StatusBar 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. Inheritance System.Object Responder View StatusBar Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.CanFocus View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class StatusBar : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Constructors StatusBar() Initializes a new instance of the StatusBar class. Declaration public StatusBar() StatusBar(StatusItem[]) Initializes a new instance of the StatusBar class with the specified set of StatusItem s. The StatusBar will be drawn on the lowest line of the terminal or SuperView (if not null). Declaration public StatusBar(StatusItem[] items) Parameters Type Name Description StatusItem [] items A list of statusbar items. Properties Items The items that compose the StatusBar Declaration public StatusItem[] Items { get; set; } Property Value Type Description StatusItem [] Methods Dispose(Boolean) Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Declaration protected override void Dispose(bool disposing) Parameters Type Name Description System.Boolean disposing Overrides View.Dispose(Boolean) Remarks If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. If disposing equals false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed. MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent me) Parameters Type Name Description MouseEvent me Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) ProcessHotKey(KeyEvent) This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example). Declaration public override bool ProcessHotKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessHotKey(KeyEvent) Remarks Before keys are sent to the subview on the current view, all the views are processed and the key is passed to the widgets to allow some of them to process the keystroke as a hot-key. For example, if you implement a button that has a hotkey ok \"o\", you would catch the combination Alt-o here. If the event is caught, you must return true to stop the keystroke from being dispatched to other views. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" }, "api/Terminal.Gui/Terminal.Gui.StatusItem.html": { "href": "api/Terminal.Gui/Terminal.Gui.StatusItem.html", @@ -292,27 +292,27 @@ "api/Terminal.Gui/Terminal.Gui.TextField.html": { "href": "api/Terminal.Gui/Terminal.Gui.TextField.html", "title": "Class TextField", - "keywords": "Class TextField Single-line text entry View Inheritance System.Object Responder View TextField DateField TimeField Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.GetEnumerator() View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class TextField : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize Remarks The TextField View provides editing functionality and mouse support. Constructors TextField() Initializes a new instance of the TextField class using Computed positioning. Declaration public TextField() TextField(ustring) Initializes a new instance of the TextField class using Computed positioning. Declaration public TextField(ustring text) Parameters Type Name Description NStack.ustring text Initial text contents. TextField(Int32, Int32, Int32, ustring) Initializes a new instance of the TextField class using Absolute positioning. Declaration public TextField(int x, int y, int w, ustring text) Parameters Type Name Description System.Int32 x The x coordinate. System.Int32 y The y coordinate. System.Int32 w The width. NStack.ustring text Initial text contents. TextField(String) Initializes a new instance of the TextField class using Computed positioning. Declaration public TextField(string text) Parameters Type Name Description System.String text Initial text contents. Fields TextChanged Changed event, raised when the text has changed. Declaration public Action TextChanged Field Value Type Description System.Action < NStack.ustring > Remarks This event is raised when the Text changes. Properties CanFocus Gets or sets a value indicating whether this Responder can focus. Declaration public override bool CanFocus { get; set; } Property Value Type Description System.Boolean true if can focus; otherwise, false . Overrides View.CanFocus CursorPosition Sets or gets the current cursor position. Declaration public int CursorPosition { get; set; } Property Value Type Description System.Int32 Frame Gets or sets the frame for the view. The frame is relative to the view's container ( SuperView ). Declaration public override Rect Frame { get; set; } Property Value Type Description Rect The frame. Overrides View.Frame Remarks Change the Frame when using the Absolute layout style to move or resize views. Altering the Frame of a view will trigger the redrawing of the view as well as the redrawing of the affected regions of the SuperView . ReadOnly If set to true its not allow any changes in the text. Declaration public bool ReadOnly { get; set; } Property Value Type Description System.Boolean Secret Sets the secret property. Declaration public bool Secret { get; set; } Property Value Type Description System.Boolean Remarks This makes the text entry suitable for entering passwords. SelectedLength Length of the selected text. Declaration public int SelectedLength { get; set; } Property Value Type Description System.Int32 SelectedStart Start position of the selected text. Declaration public int SelectedStart { get; set; } Property Value Type Description System.Int32 SelectedText The selected text. Declaration public ustring SelectedText { get; set; } Property Value Type Description NStack.ustring Text Sets or gets the text held by the view. Declaration public ustring Text { get; set; } Property Value Type Description NStack.ustring Remarks Used Tracks whether the text field should be considered \"used\", that is, that the user has moved in the entry, so new input should be appended at the cursor position, rather than clearing the entry Declaration public bool Used { get; set; } Property Value Type Description System.Boolean Methods ClearAllSelection() Clear the selected text. Declaration public void ClearAllSelection() Copy() Copy the selected text to the clipboard. Declaration public virtual void Copy() Cut() Cut the selected text to the clipboard. Declaration public virtual void Cut() MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent ev) Parameters Type Name Description MouseEvent ev Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnLeave(View) Paste() Paste the selected text from the clipboard. Declaration public virtual void Paste() PositionCursor() Sets the cursor position. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) Processes key presses for the TextField . Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks The TextField control responds to the following keys: Keys Function Delete , Backspace Deletes the character before cursor. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" + "keywords": "Class TextField Single-line text entry View Inheritance System.Object Responder View TextField DateField TimeField Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class TextField : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The TextField View provides editing functionality and mouse support. Constructors TextField() Initializes a new instance of the TextField class using Computed positioning. Declaration public TextField() TextField(ustring) Initializes a new instance of the TextField class using Computed positioning. Declaration public TextField(ustring text) Parameters Type Name Description NStack.ustring text Initial text contents. TextField(Int32, Int32, Int32, ustring) Initializes a new instance of the TextField class using Absolute positioning. Declaration public TextField(int x, int y, int w, ustring text) Parameters Type Name Description System.Int32 x The x coordinate. System.Int32 y The y coordinate. System.Int32 w The width. NStack.ustring text Initial text contents. TextField(String) Initializes a new instance of the TextField class using Computed positioning. Declaration public TextField(string text) Parameters Type Name Description System.String text Initial text contents. Properties CanFocus Gets or sets a value indicating whether this Responder can focus. Declaration public override bool CanFocus { get; set; } Property Value Type Description System.Boolean true if can focus; otherwise, false . Overrides View.CanFocus CursorPosition Sets or gets the current cursor position. Declaration public int CursorPosition { get; set; } Property Value Type Description System.Int32 Frame Gets or sets the frame for the view. The frame is relative to the view's container ( SuperView ). Declaration public override Rect Frame { get; set; } Property Value Type Description Rect The frame. Overrides View.Frame Remarks Change the Frame when using the Absolute layout style to move or resize views. Altering the Frame of a view will trigger the redrawing of the view as well as the redrawing of the affected regions of the SuperView . ReadOnly If set to true its not allow any changes in the text. Declaration public bool ReadOnly { get; set; } Property Value Type Description System.Boolean Secret Sets the secret property. Declaration public bool Secret { get; set; } Property Value Type Description System.Boolean Remarks This makes the text entry suitable for entering passwords. SelectedLength Length of the selected text. Declaration public int SelectedLength { get; set; } Property Value Type Description System.Int32 SelectedStart Start position of the selected text. Declaration public int SelectedStart { get; set; } Property Value Type Description System.Int32 SelectedText The selected text. Declaration public ustring SelectedText { get; set; } Property Value Type Description NStack.ustring Text Sets or gets the text held by the view. Declaration public ustring Text { get; set; } Property Value Type Description NStack.ustring Remarks Used Tracks whether the text field should be considered \"used\", that is, that the user has moved in the entry, so new input should be appended at the cursor position, rather than clearing the entry Declaration public bool Used { get; set; } Property Value Type Description System.Boolean Methods ClearAllSelection() Clear the selected text. Declaration public void ClearAllSelection() Copy() Copy the selected text to the clipboard. Declaration public virtual void Copy() Cut() Cut the selected text to the clipboard. Declaration public virtual void Cut() MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent ev) Parameters Type Name Description MouseEvent ev Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides View.OnLeave(View) Paste() Paste the selected text from the clipboard. Declaration public virtual void Paste() PositionCursor() Sets the cursor position. Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) Processes key presses for the TextField . Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks The TextField control responds to the following keys: Keys Function Delete , Backspace Deletes the character before cursor. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. Events TextChanged Changed event, raised when the text has changed. Declaration public event Action TextChanged Event Type Type Description System.Action < NStack.ustring > Remarks This event is raised when the Text changes. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" }, "api/Terminal.Gui/Terminal.Gui.TextFormatter.html": { "href": "api/Terminal.Gui/Terminal.Gui.TextFormatter.html", "title": "Class TextFormatter", - "keywords": "Class TextFormatter Provides text formatting capabilities for console apps. Supports, hotkeys, horizontal alignment, multille lines, and word-based line wrap. Inheritance System.Object TextFormatter Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class TextFormatter Properties Alignment Controls the horizontal text-alignment property. Declaration public TextAlignment Alignment { get; set; } Property Value Type Description TextAlignment The text alignment. HotKey Gets the hotkey. Will be an upper case letter or digit. Declaration public Key HotKey { get; } Property Value Type Description Key HotKeyPos The position in the text of the hotkey. The hotkey will be rendered using the hot color. Declaration public int HotKeyPos { get; set; } Property Value Type Description System.Int32 HotKeySpecifier The specifier character for the hotkey (e.g. '_'). Set to '\\xffff' to disable hotkey support for this View instance. The default is '\\xffff'. Declaration public Rune HotKeySpecifier { get; set; } Property Value Type Description System.Rune HotKeyTagMask Specifies the mask to apply to the hotkey to tag it as the hotkey. The default value of 0x100000 causes the underlying Rune to be identified as a \"private use\" Unicode character. Declaration public uint HotKeyTagMask { get; set; } Property Value Type Description System.UInt32 Lines Gets the formatted lines. Declaration public List Lines { get; } Property Value Type Description System.Collections.Generic.List < NStack.ustring > Remarks Upon a 'get' of this property, if the text needs to be formatted (if NeedsFormat is true ) Format(ustring, Int32, TextAlignment, Boolean) will be called internally. NeedsFormat Gets or sets whether the TextFormatter needs to format the text when Draw(Rect, Attribute, Attribute) is called. If it is false when Draw is called, the Draw call will be faster. Declaration public bool NeedsFormat { get; set; } Property Value Type Description System.Boolean Remarks This is set to true when the properties of TextFormatter are set. Size Gets or sets the size of the area the text will be constrainted to when formatted. Declaration public Size Size { get; set; } Property Value Type Description Size Text The text to be displayed. This text is never modified. Declaration public virtual ustring Text { get; set; } Property Value Type Description NStack.ustring Methods CalcRect(Int32, Int32, ustring) Calculates the rectangle required to hold text, assuming no word wrapping. Declaration public static Rect CalcRect(int x, int y, ustring text) Parameters Type Name Description System.Int32 x The x location of the rectangle System.Int32 y The y location of the rectangle NStack.ustring text The text to measure Returns Type Description Rect ClipAndJustify(ustring, Int32, TextAlignment) Justifies text within a specified width. Declaration public static ustring ClipAndJustify(ustring text, int width, TextAlignment talign) Parameters Type Name Description NStack.ustring text The text to justify. System.Int32 width If the text length is greater that width it will be clipped. TextAlignment talign Alignment. Returns Type Description NStack.ustring Justified and clipped text. Draw(Rect, Attribute, Attribute) Draws the text held by TextFormatter to Driver using the colors specified. Declaration public void Draw(Rect bounds, Attribute normalColor, Attribute hotColor) Parameters Type Name Description Rect bounds Specifies the screen-relative location and maximum size for drawing the text. Attribute normalColor The color to use for all text except the hotkey Attribute hotColor The color to use to draw the hotkey FindHotKey(ustring, Rune, Boolean, out Int32, out Key) Finds the hotkey and its location in text. Declaration public static bool FindHotKey(ustring text, Rune hotKeySpecifier, bool firstUpperCase, out int hotPos, out Key hotKey) Parameters Type Name Description NStack.ustring text The text to look in. System.Rune hotKeySpecifier The hotkey specifier (e.g. '_') to look for. System.Boolean firstUpperCase If true the legacy behavior of identifying the first upper case character as the hotkey will be eanbled. Regardless of the value of this parameter, hotKeySpecifier takes precidence. System.Int32 hotPos Outputs the Rune index into text . Key hotKey Outputs the hotKey. Returns Type Description System.Boolean true if a hotkey was found; false otherwise. Format(ustring, Int32, TextAlignment, Boolean) Reformats text into lines, applying text alignment and optionally wrapping text to new lines on word boundaries. Declaration public static List Format(ustring text, int width, TextAlignment talign, bool wordWrap) Parameters Type Name Description NStack.ustring text System.Int32 width The width to bound the text to for word wrapping and clipping. TextAlignment talign Specifies how the text will be aligned horizontally. System.Boolean wordWrap If true , the text will be wrapped to new lines as need. If false , forces text to fit a single line. Line breaks are converted to spaces. The text will be clipped to width Returns Type Description System.Collections.Generic.List < NStack.ustring > A list of word wrapped lines. Remarks An empty text string will result in one empty line. If width is 0, a single, empty line will be returned. If width is int.MaxValue, the text will be formatted to the maximum width possible. Justify(ustring, Int32, Char) Justifies the text to fill the width provided. Space will be added between words (demarked by spaces and tabs) to make the text just fit width . Spaces will not be added to the ends. Declaration public static ustring Justify(ustring text, int width, char spaceChar = ' ') Parameters Type Name Description NStack.ustring text System.Int32 width System.Char spaceChar Character to replace whitespace and pad with. For debugging purposes. Returns Type Description NStack.ustring The justifed text. MaxLines(ustring, Int32) Computes the number of lines needed to render the specified text given the width. Declaration public static int MaxLines(ustring text, int width) Parameters Type Name Description NStack.ustring text Text, may contain newlines. System.Int32 width The minimum width for the text. Returns Type Description System.Int32 Number of lines. MaxWidth(ustring, Int32) Computes the maximum width needed to render the text (single line or multple lines) given a minimum width. Declaration public static int MaxWidth(ustring text, int width) Parameters Type Name Description NStack.ustring text Text, may contain newlines. System.Int32 width The minimum width for the text. Returns Type Description System.Int32 Max width of lines. RemoveHotKeySpecifier(ustring, Int32, Rune) Removes the hotkey specifier from text. Declaration public static ustring RemoveHotKeySpecifier(ustring text, int hotPos, Rune hotKeySpecifier) Parameters Type Name Description NStack.ustring text The text to manipulate. System.Int32 hotPos Returns the position of the hot-key in the text. -1 if not found. System.Rune hotKeySpecifier The hot-key specifier (e.g. '_') to look for. Returns Type Description NStack.ustring The input text with the hotkey specifier ('_') removed. ReplaceHotKeyWithTag(ustring, Int32) Replaces the Rune at the index specfiied by the hotPos parameter with a tag identifying it as the hotkey. Declaration public ustring ReplaceHotKeyWithTag(ustring text, int hotPos) Parameters Type Name Description NStack.ustring text The text to tag the hotkey in. System.Int32 hotPos The Rune index of the hotkey in text . Returns Type Description NStack.ustring The text with the hotkey tagged. Remarks The returned string will not render correctly without first un-doing the tag. To undo the tag, search for Runes with a bitmask of otKeyTagMask and remove that bitmask. WordWrap(ustring, Int32) Formats the provided text to fit within the width provided using word wrapping. Declaration public static List WordWrap(ustring text, int width) Parameters Type Name Description NStack.ustring text The text to word wrap System.Int32 width The width to contrain the text to Returns Type Description System.Collections.Generic.List < NStack.ustring > Returns a list of word wrapped lines. Remarks This method does not do any justification. This method strips Newline ('\\n' and '\\r\\n') sequences before processing." + "keywords": "Class TextFormatter Provides text formatting capabilities for console apps. Supports, hotkeys, horizontal alignment, multille lines, and word-based line wrap. Inheritance System.Object TextFormatter Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class TextFormatter Properties Alignment Controls the horizontal text-alignment property. Declaration public TextAlignment Alignment { get; set; } Property Value Type Description TextAlignment The text alignment. CursorPosition Gets the cursor position from HotKey . If the HotKey is defined, the cursor will be positioned over it. Declaration public int CursorPosition { get; set; } Property Value Type Description System.Int32 HotKey Gets the hotkey. Will be an upper case letter or digit. Declaration public Key HotKey { get; } Property Value Type Description Key HotKeyPos The position in the text of the hotkey. The hotkey will be rendered using the hot color. Declaration public int HotKeyPos { get; set; } Property Value Type Description System.Int32 HotKeySpecifier The specifier character for the hotkey (e.g. '_'). Set to '\\xffff' to disable hotkey support for this View instance. The default is '\\xffff'. Declaration public Rune HotKeySpecifier { get; set; } Property Value Type Description System.Rune HotKeyTagMask Specifies the mask to apply to the hotkey to tag it as the hotkey. The default value of 0x100000 causes the underlying Rune to be identified as a \"private use\" Unicode character. Declaration public uint HotKeyTagMask { get; set; } Property Value Type Description System.UInt32 Lines Gets the formatted lines. Declaration public List Lines { get; } Property Value Type Description System.Collections.Generic.List < NStack.ustring > Remarks Upon a 'get' of this property, if the text needs to be formatted (if NeedsFormat is true ) Format(ustring, Int32, TextAlignment, Boolean) will be called internally. NeedsFormat Gets or sets whether the TextFormatter needs to format the text when Draw(Rect, Attribute, Attribute) is called. If it is false when Draw is called, the Draw call will be faster. Declaration public bool NeedsFormat { get; set; } Property Value Type Description System.Boolean Remarks This is set to true when the properties of TextFormatter are set. Size Gets or sets the size of the area the text will be constrainted to when formatted. Declaration public Size Size { get; set; } Property Value Type Description Size Text The text to be displayed. This text is never modified. Declaration public virtual ustring Text { get; set; } Property Value Type Description NStack.ustring Methods CalcRect(Int32, Int32, ustring) Calculates the rectangle required to hold text, assuming no word wrapping. Declaration public static Rect CalcRect(int x, int y, ustring text) Parameters Type Name Description System.Int32 x The x location of the rectangle System.Int32 y The y location of the rectangle NStack.ustring text The text to measure Returns Type Description Rect ClipAndJustify(ustring, Int32, TextAlignment) Justifies text within a specified width. Declaration public static ustring ClipAndJustify(ustring text, int width, TextAlignment talign) Parameters Type Name Description NStack.ustring text The text to justify. System.Int32 width If the text length is greater that width it will be clipped. TextAlignment talign Alignment. Returns Type Description NStack.ustring Justified and clipped text. Draw(Rect, Attribute, Attribute) Draws the text held by TextFormatter to Driver using the colors specified. Declaration public void Draw(Rect bounds, Attribute normalColor, Attribute hotColor) Parameters Type Name Description Rect bounds Specifies the screen-relative location and maximum size for drawing the text. Attribute normalColor The color to use for all text except the hotkey Attribute hotColor The color to use to draw the hotkey FindHotKey(ustring, Rune, Boolean, out Int32, out Key) Finds the hotkey and its location in text. Declaration public static bool FindHotKey(ustring text, Rune hotKeySpecifier, bool firstUpperCase, out int hotPos, out Key hotKey) Parameters Type Name Description NStack.ustring text The text to look in. System.Rune hotKeySpecifier The hotkey specifier (e.g. '_') to look for. System.Boolean firstUpperCase If true the legacy behavior of identifying the first upper case character as the hotkey will be eanbled. Regardless of the value of this parameter, hotKeySpecifier takes precidence. System.Int32 hotPos Outputs the Rune index into text . Key hotKey Outputs the hotKey. Returns Type Description System.Boolean true if a hotkey was found; false otherwise. Format(ustring, Int32, TextAlignment, Boolean) Reformats text into lines, applying text alignment and optionally wrapping text to new lines on word boundaries. Declaration public static List Format(ustring text, int width, TextAlignment talign, bool wordWrap) Parameters Type Name Description NStack.ustring text System.Int32 width The width to bound the text to for word wrapping and clipping. TextAlignment talign Specifies how the text will be aligned horizontally. System.Boolean wordWrap If true , the text will be wrapped to new lines as need. If false , forces text to fit a single line. Line breaks are converted to spaces. The text will be clipped to width Returns Type Description System.Collections.Generic.List < NStack.ustring > A list of word wrapped lines. Remarks An empty text string will result in one empty line. If width is 0, a single, empty line will be returned. If width is int.MaxValue, the text will be formatted to the maximum width possible. Justify(ustring, Int32, Char) Justifies the text to fill the width provided. Space will be added between words (demarked by spaces and tabs) to make the text just fit width . Spaces will not be added to the ends. Declaration public static ustring Justify(ustring text, int width, char spaceChar = ' ') Parameters Type Name Description NStack.ustring text System.Int32 width System.Char spaceChar Character to replace whitespace and pad with. For debugging purposes. Returns Type Description NStack.ustring The justifed text. MaxLines(ustring, Int32) Computes the number of lines needed to render the specified text given the width. Declaration public static int MaxLines(ustring text, int width) Parameters Type Name Description NStack.ustring text Text, may contain newlines. System.Int32 width The minimum width for the text. Returns Type Description System.Int32 Number of lines. MaxWidth(ustring, Int32) Computes the maximum width needed to render the text (single line or multple lines) given a minimum width. Declaration public static int MaxWidth(ustring text, int width) Parameters Type Name Description NStack.ustring text Text, may contain newlines. System.Int32 width The minimum width for the text. Returns Type Description System.Int32 Max width of lines. RemoveHotKeySpecifier(ustring, Int32, Rune) Removes the hotkey specifier from text. Declaration public static ustring RemoveHotKeySpecifier(ustring text, int hotPos, Rune hotKeySpecifier) Parameters Type Name Description NStack.ustring text The text to manipulate. System.Int32 hotPos Returns the position of the hot-key in the text. -1 if not found. System.Rune hotKeySpecifier The hot-key specifier (e.g. '_') to look for. Returns Type Description NStack.ustring The input text with the hotkey specifier ('_') removed. ReplaceHotKeyWithTag(ustring, Int32) Replaces the Rune at the index specfiied by the hotPos parameter with a tag identifying it as the hotkey. Declaration public ustring ReplaceHotKeyWithTag(ustring text, int hotPos) Parameters Type Name Description NStack.ustring text The text to tag the hotkey in. System.Int32 hotPos The Rune index of the hotkey in text . Returns Type Description NStack.ustring The text with the hotkey tagged. Remarks The returned string will not render correctly without first un-doing the tag. To undo the tag, search for Runes with a bitmask of otKeyTagMask and remove that bitmask. WordWrap(ustring, Int32) Formats the provided text to fit within the width provided using word wrapping. Declaration public static List WordWrap(ustring text, int width) Parameters Type Name Description NStack.ustring text The text to word wrap System.Int32 width The width to contrain the text to Returns Type Description System.Collections.Generic.List < NStack.ustring > Returns a list of word wrapped lines. Remarks This method does not do any justification. This method strips Newline ('\\n' and '\\r\\n') sequences before processing." }, "api/Terminal.Gui/Terminal.Gui.TextView.html": { "href": "api/Terminal.Gui/Terminal.Gui.TextView.html", "title": "Class TextView", - "keywords": "Class TextView Multi-line text editing View Inheritance System.Object Responder View TextView Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.GetEnumerator() View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class TextView : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize Remarks TextView provides a multi-line text editor. Users interact with it with the standard Emacs commands for movement or the arrow keys. Shortcut Action performed Left cursor, Control-b Moves the editing point left. Right cursor, Control-f Moves the editing point right. Alt-b Moves one word back. Alt-f Moves one word forward. Up cursor, Control-p Moves the editing point one line up. Down cursor, Control-n Moves the editing point one line down Home key, Control-a Moves the cursor to the beginning of the line. End key, Control-e Moves the cursor to the end of the line. Delete, Control-d Deletes the character in front of the cursor. Backspace Deletes the character behind the cursor. Control-k Deletes the text until the end of the line and replaces the kill buffer with the deleted text. You can paste this text in a different place by using Control-y. Control-y Pastes the content of the kill ring into the current position. Alt-d Deletes the word above the cursor and adds it to the kill ring. You can paste the contents of the kill ring with Control-y. Control-q Quotes the next input character, to prevent the normal processing of key handling to take place. Constructors TextView() Initializes a TextView on the specified area, with dimensions controlled with the X, Y, Width and Height properties. Declaration public TextView() TextView(Rect) Initializes a TextView on the specified area, with absolute position and size. Declaration public TextView(Rect frame) Parameters Type Name Description Rect frame Remarks Fields TextChanged Raised when the Text of the TextView changes. Declaration public Action TextChanged Field Value Type Description System.Action Properties CanFocus Gets or sets a value indicating whether this Responder can focus. Declaration public override bool CanFocus { get; set; } Property Value Type Description System.Boolean true if can focus; otherwise, false . Overrides View.CanFocus CurrentColumn Gets the cursor column. Declaration public int CurrentColumn { get; } Property Value Type Description System.Int32 The cursor column. CurrentRow Gets the current cursor row. Declaration public int CurrentRow { get; } Property Value Type Description System.Int32 ReadOnly Gets or sets whether the TextView is in read-only mode or not Declaration public bool ReadOnly { get; set; } Property Value Type Description System.Boolean Boolean value(Default false) Text Sets or gets the text in the TextView . Declaration public override ustring Text { get; set; } Property Value Type Description NStack.ustring Overrides View.Text Remarks Methods CloseFile() Closes the contents of the stream into the TextView . Declaration public bool CloseFile() Returns Type Description System.Boolean true , if stream was closed, false otherwise. LoadFile(String) Loads the contents of the file into the TextView . Declaration public bool LoadFile(string path) Parameters Type Name Description System.String path Path to the file to load. Returns Type Description System.Boolean true , if file was loaded, false otherwise. LoadStream(Stream) Loads the contents of the stream into the TextView . Declaration public void LoadStream(Stream stream) Parameters Type Name Description System.IO.Stream stream Stream to load the contents from. MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent ev) Parameters Type Name Description MouseEvent ev Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) PositionCursor() Positions the cursor on the current row and column Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. ScrollTo(Int32) Will scroll the TextView to display the specified row at the top Declaration public void ScrollTo(int row) Parameters Type Name Description System.Int32 row Row that should be displayed at the top, if the value is negative it will be reset to zero Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" + "keywords": "Class TextView Multi-line text editing View Inheritance System.Object Responder View TextView Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class TextView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks TextView provides a multi-line text editor. Users interact with it with the standard Emacs commands for movement or the arrow keys. Shortcut Action performed Left cursor, Control-b Moves the editing point left. Right cursor, Control-f Moves the editing point right. Alt-b Moves one word back. Alt-f Moves one word forward. Up cursor, Control-p Moves the editing point one line up. Down cursor, Control-n Moves the editing point one line down Home key, Control-a Moves the cursor to the beginning of the line. End key, Control-e Moves the cursor to the end of the line. Control-Home Scrolls to the first line and moves the cursor there. Control-End Scrolls to the last line and moves the cursor there. Delete, Control-d Deletes the character in front of the cursor. Backspace Deletes the character behind the cursor. Control-k Deletes the text until the end of the line and replaces the kill buffer with the deleted text. You can paste this text in a different place by using Control-y. Control-y Pastes the content of the kill ring into the current position. Alt-d Deletes the word above the cursor and adds it to the kill ring. You can paste the contents of the kill ring with Control-y. Control-q Quotes the next input character, to prevent the normal processing of key handling to take place. Constructors TextView() Initializes a TextView on the specified area, with dimensions controlled with the X, Y, Width and Height properties. Declaration public TextView() TextView(Rect) Initializes a TextView on the specified area, with absolute position and size. Declaration public TextView(Rect frame) Parameters Type Name Description Rect frame Remarks Properties CanFocus Gets or sets a value indicating whether this Responder can focus. Declaration public override bool CanFocus { get; set; } Property Value Type Description System.Boolean true if can focus; otherwise, false . Overrides View.CanFocus CurrentColumn Gets the cursor column. Declaration public int CurrentColumn { get; } Property Value Type Description System.Int32 The cursor column. CurrentRow Gets the current cursor row. Declaration public int CurrentRow { get; } Property Value Type Description System.Int32 ReadOnly Gets or sets whether the TextView is in read-only mode or not Declaration public bool ReadOnly { get; set; } Property Value Type Description System.Boolean Boolean value(Default false) Text Sets or gets the text in the TextView . Declaration public override ustring Text { get; set; } Property Value Type Description NStack.ustring Overrides View.Text Remarks Methods CloseFile() Closes the contents of the stream into the TextView . Declaration public bool CloseFile() Returns Type Description System.Boolean true , if stream was closed, false otherwise. LoadFile(String) Loads the contents of the file into the TextView . Declaration public bool LoadFile(string path) Parameters Type Name Description System.String path Path to the file to load. Returns Type Description System.Boolean true , if file was loaded, false otherwise. LoadStream(Stream) Loads the contents of the stream into the TextView . Declaration public void LoadStream(Stream stream) Parameters Type Name Description System.IO.Stream stream Stream to load the contents from. MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent ev) Parameters Type Name Description MouseEvent ev Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) MoveEnd() Will scroll the TextView to the last line and position the cursor there. Declaration public void MoveEnd() MoveHome() Will scroll the TextView to the first line and position the cursor there. Declaration public void MoveHome() PositionCursor() Positions the cursor on the current row and column Declaration public override void PositionCursor() Overrides View.PositionCursor() ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. ScrollTo(Int32) Will scroll the TextView to display the specified row at the top Declaration public void ScrollTo(int row) Parameters Type Name Description System.Int32 row Row that should be displayed at the top, if the value is negative it will be reset to zero Events TextChanged Raised when the Text of the TextView changes. Declaration public event Action TextChanged Event Type Type Description System.Action Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" }, "api/Terminal.Gui/Terminal.Gui.TimeField.html": { "href": "api/Terminal.Gui/Terminal.Gui.TimeField.html", "title": "Class TimeField", - "keywords": "Class TimeField Time editing View Inheritance System.Object Responder View TextField TimeField Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members TextField.Used TextField.ReadOnly TextField.TextChanged TextField.OnLeave(View) TextField.Frame TextField.Text TextField.Secret TextField.CursorPosition TextField.PositionCursor() TextField.Redraw(Rect) TextField.CanFocus TextField.SelectedStart TextField.SelectedLength TextField.SelectedText TextField.ClearAllSelection() TextField.Copy() TextField.Cut() TextField.Paste() View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.GetEnumerator() View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class TimeField : TextField, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize Remarks The TimeField View provides time editing functionality with mouse support. Constructors TimeField() Initializes a new instance of TimeField using Computed positioning. Declaration public TimeField() TimeField(Int32, Int32, TimeSpan, Boolean) Initializes a new instance of TimeField using Absolute positioning. Declaration public TimeField(int x, int y, TimeSpan time, bool isShort = false) Parameters Type Name Description System.Int32 x The x coordinate. System.Int32 y The y coordinate. System.TimeSpan time Initial time. System.Boolean isShort If true, the seconds are hidden. Sets the IsShortFormat property. TimeField(TimeSpan) Initializes a new instance of TimeField using Computed positioning. Declaration public TimeField(TimeSpan time) Parameters Type Name Description System.TimeSpan time Initial time Fields TimeChanged TimeChanged event, raised when the Date has changed. Declaration public Action> TimeChanged Field Value Type Description System.Action < DateTimeEventArgs < System.TimeSpan >> Remarks This event is raised when the Time changes. Properties IsShortFormat Get or sets whether TimeField uses the short or long time format. Declaration public bool IsShortFormat { get; set; } Property Value Type Description System.Boolean Time Gets or sets the time of the TimeField . Declaration public TimeSpan Time { get; set; } Property Value Type Description System.TimeSpan Remarks Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent ev) Parameters Type Name Description MouseEvent ev Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides TextField.MouseEvent(MouseEvent) OnTimeChanged(DateTimeEventArgs) Event firing method that invokes the TimeChanged event. Declaration public virtual void OnTimeChanged(DateTimeEventArgs args) Parameters Type Name Description DateTimeEventArgs < System.TimeSpan > args The event arguments ProcessKey(KeyEvent) Processes key presses for the TextField . Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides TextField.ProcessKey(KeyEvent) Remarks The TextField control responds to the following keys: Keys Function Delete , Backspace Deletes the character before cursor. Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" + "keywords": "Class TimeField Time editing View Inheritance System.Object Responder View TextField TimeField Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members TextField.Used TextField.ReadOnly TextField.TextChanged TextField.OnLeave(View) TextField.Frame TextField.Text TextField.Secret TextField.CursorPosition TextField.PositionCursor() TextField.Redraw(Rect) TextField.CanFocus TextField.SelectedStart TextField.SelectedLength TextField.SelectedText TextField.ClearAllSelection() TextField.Copy() TextField.Cut() TextField.Paste() View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View) View.Add(View[]) View.RemoveAll() View.Remove(View) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.OnKeyDown(KeyEvent) View.KeyUp View.OnKeyUp(KeyEvent) View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class TimeField : TextField, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The TimeField View provides time editing functionality with mouse support. Constructors TimeField() Initializes a new instance of TimeField using Computed positioning. Declaration public TimeField() TimeField(Int32, Int32, TimeSpan, Boolean) Initializes a new instance of TimeField using Absolute positioning. Declaration public TimeField(int x, int y, TimeSpan time, bool isShort = false) Parameters Type Name Description System.Int32 x The x coordinate. System.Int32 y The y coordinate. System.TimeSpan time Initial time. System.Boolean isShort If true, the seconds are hidden. Sets the IsShortFormat property. TimeField(TimeSpan) Initializes a new instance of TimeField using Computed positioning. Declaration public TimeField(TimeSpan time) Parameters Type Name Description System.TimeSpan time Initial time Properties IsShortFormat Get or sets whether TimeField uses the short or long time format. Declaration public bool IsShortFormat { get; set; } Property Value Type Description System.Boolean Time Gets or sets the time of the TimeField . Declaration public TimeSpan Time { get; set; } Property Value Type Description System.TimeSpan Remarks Methods MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent ev) Parameters Type Name Description MouseEvent ev Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides TextField.MouseEvent(MouseEvent) OnTimeChanged(DateTimeEventArgs) Event firing method that invokes the TimeChanged event. Declaration public virtual void OnTimeChanged(DateTimeEventArgs args) Parameters Type Name Description DateTimeEventArgs < System.TimeSpan > args The event arguments ProcessKey(KeyEvent) Processes key presses for the TextField . Declaration public override bool ProcessKey(KeyEvent kb) Parameters Type Name Description KeyEvent kb Returns Type Description System.Boolean Overrides TextField.ProcessKey(KeyEvent) Remarks The TextField control responds to the following keys: Keys Function Delete , Backspace Deletes the character before cursor. Events TimeChanged TimeChanged event, raised when the Date has changed. Declaration public event Action> TimeChanged Event Type Type Description System.Action < DateTimeEventArgs < System.TimeSpan >> Remarks This event is raised when the Time changes. Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" }, "api/Terminal.Gui/Terminal.Gui.Toplevel.html": { "href": "api/Terminal.Gui/Terminal.Gui.Toplevel.html", "title": "Class Toplevel", - "keywords": "Class Toplevel Toplevel views can be modally executed. Inheritance System.Object Responder View Toplevel Window Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.GetEnumerator() View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.MouseEvent(MouseEvent) Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class Toplevel : View, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize Remarks Toplevels can be modally executing views, started by calling Run(Toplevel) . They return control to the caller when RequestStop() has been called (which sets the Running property to false). A Toplevel is created when an application initialzies Terminal.Gui by callling Init(ConsoleDriver, IMainLoopDriver) . The application Toplevel can be accessed via Top . Additional Toplevels can be created and run (e.g. Dialog s. To run a Toplevel, create the Toplevel and call Run(Toplevel) . Toplevels can also opt-in to more sophisticated initialization by implementing System.ComponentModel.ISupportInitialize . When they do so, the System.ComponentModel.ISupportInitialize.BeginInit() and System.ComponentModel.ISupportInitialize.EndInit() methods will be called before running the view. If first-run-only initialization is preferred, the System.ComponentModel.ISupportInitializeNotification can be implemented too, in which case the System.ComponentModel.ISupportInitialize methods will only be called if System.ComponentModel.ISupportInitializeNotification.IsInitialized is false . This allows proper View inheritance hierarchies to override base class layout code optimally by doing so only on first run, instead of on every run. Constructors Toplevel() Initializes a new instance of the Toplevel class with Computed layout, defaulting to full screen. Declaration public Toplevel() Toplevel(Rect) Initializes a new instance of the Toplevel class with the specified absolute layout. Declaration public Toplevel(Rect frame) Parameters Type Name Description Rect frame A superview-relative rectangle specifying the location and size for the new Toplevel Fields Ready Fired once the Toplevel's MainLoop has started it's first iteration. Subscribe to this event to perform tasks when the Toplevel has been laid out and focus has been set. changes. A Ready event handler is a good place to finalize initialization after calling ` Run() (topLevel)`. Declaration public Action Ready Field Value Type Description System.Action Properties CanFocus Gets or sets a value indicating whether this Toplevel can focus. Declaration public override bool CanFocus { get; } Property Value Type Description System.Boolean true if can focus; otherwise, false . Overrides View.CanFocus MenuBar Gets or sets the menu for this Toplevel Declaration public MenuBar MenuBar { get; set; } Property Value Type Description MenuBar Modal Determines whether the Toplevel is modal or not. Causes ProcessKey(KeyEvent) to propagate keys upwards by default unless set to true . Declaration public bool Modal { get; set; } Property Value Type Description System.Boolean Running Gets or sets whether the MainLoop for this Toplevel is running or not. Declaration public bool Running { get; set; } Property Value Type Description System.Boolean Remarks Setting this property directly is discouraged. Use RequestStop() instead. StatusBar Gets or sets the status bar for this Toplevel Declaration public StatusBar StatusBar { get; set; } Property Value Type Description StatusBar Methods Add(View) Adds a subview (child) to this view. Declaration public override void Add(View view) Parameters Type Name Description View view Overrides View.Add(View) Remarks The Views that have been added to this view can be retrieved via the Subviews property. See also Remove(View) RemoveAll() Create() Convenience factory method that creates a new Toplevel with the current terminal dimensions. Declaration public static Toplevel Create() Returns Type Description Toplevel The create. OnKeyDown(KeyEvent) Declaration public override bool OnKeyDown(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides View.OnKeyDown(KeyEvent) OnKeyUp(KeyEvent) Declaration public override bool OnKeyUp(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides View.OnKeyUp(KeyEvent) ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. Remove(View) Removes a subview added via Add(View) or Add(View[]) from this View. Declaration public override void Remove(View view) Parameters Type Name Description View view Overrides View.Remove(View) Remarks RemoveAll() Removes all subviews (children) added via Add(View) or Add(View[]) from this View. Declaration public override void RemoveAll() Overrides View.RemoveAll() WillPresent() Invoked by Begin(Toplevel) as part of the Run(Toplevel) after the views have been laid out, and before the views are drawn for the first time. Declaration public virtual void WillPresent() Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" + "keywords": "Class Toplevel Toplevel views can be modally executed. Inheritance System.Object Responder View Toplevel Window Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.Text View.TextAlignment View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.MouseEvent(MouseEvent) Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class Toplevel : View, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks Toplevels can be modally executing views, started by calling Run(Toplevel) . They return control to the caller when RequestStop() has been called (which sets the Running property to false). A Toplevel is created when an application initialzies Terminal.Gui by callling Init(ConsoleDriver, IMainLoopDriver) . The application Toplevel can be accessed via Top . Additional Toplevels can be created and run (e.g. Dialog s. To run a Toplevel, create the Toplevel and call Run(Toplevel) . Toplevels can also opt-in to more sophisticated initialization by implementing System.ComponentModel.ISupportInitialize . When they do so, the System.ComponentModel.ISupportInitialize.BeginInit() and System.ComponentModel.ISupportInitialize.EndInit() methods will be called before running the view. If first-run-only initialization is preferred, the System.ComponentModel.ISupportInitializeNotification can be implemented too, in which case the System.ComponentModel.ISupportInitialize methods will only be called if System.ComponentModel.ISupportInitializeNotification.IsInitialized is false . This allows proper View inheritance hierarchies to override base class layout code optimally by doing so only on first run, instead of on every run. Constructors Toplevel() Initializes a new instance of the Toplevel class with Computed layout, defaulting to full screen. Declaration public Toplevel() Toplevel(Rect) Initializes a new instance of the Toplevel class with the specified absolute layout. Declaration public Toplevel(Rect frame) Parameters Type Name Description Rect frame A superview-relative rectangle specifying the location and size for the new Toplevel Properties CanFocus Gets or sets a value indicating whether this Toplevel can focus. Declaration public override bool CanFocus { get; } Property Value Type Description System.Boolean true if can focus; otherwise, false . Overrides View.CanFocus MenuBar Gets or sets the menu for this Toplevel Declaration public MenuBar MenuBar { get; set; } Property Value Type Description MenuBar Modal Determines whether the Toplevel is modal or not. Causes ProcessKey(KeyEvent) to propagate keys upwards by default unless set to true . Declaration public bool Modal { get; set; } Property Value Type Description System.Boolean Running Gets or sets whether the MainLoop for this Toplevel is running or not. Declaration public bool Running { get; set; } Property Value Type Description System.Boolean Remarks Setting this property directly is discouraged. Use RequestStop() instead. StatusBar Gets or sets the status bar for this Toplevel Declaration public StatusBar StatusBar { get; set; } Property Value Type Description StatusBar Methods Add(View) Adds a subview (child) to this view. Declaration public override void Add(View view) Parameters Type Name Description View view Overrides View.Add(View) Remarks The Views that have been added to this view can be retrieved via the Subviews property. See also Remove(View) RemoveAll() Create() Convenience factory method that creates a new Toplevel with the current terminal dimensions. Declaration public static Toplevel Create() Returns Type Description Toplevel The create. OnKeyDown(KeyEvent) Declaration public override bool OnKeyDown(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides View.OnKeyDown(KeyEvent) OnKeyUp(KeyEvent) Declaration public override bool OnKeyUp(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides View.OnKeyUp(KeyEvent) ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides View.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides View.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. Remove(View) Removes a subview added via Add(View) or Add(View[]) from this View. Declaration public override void Remove(View view) Parameters Type Name Description View view Overrides View.Remove(View) Remarks RemoveAll() Removes all subviews (children) added via Add(View) or Add(View[]) from this View. Declaration public override void RemoveAll() Overrides View.RemoveAll() WillPresent() Invoked by Begin(Toplevel) as part of the Run(Toplevel) after the views have been laid out, and before the views are drawn for the first time. Declaration public virtual void WillPresent() Events Ready Fired once the Toplevel's MainLoop has started it's first iteration. Subscribe to this event to perform tasks when the Toplevel has been laid out and focus has been set. changes. A Ready event handler is a good place to finalize initialization after calling ` Run() (topLevel)`. Declaration public event Action Ready Event Type Type Description System.Action Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" }, "api/Terminal.Gui/Terminal.Gui.View.FocusEventArgs.html": { "href": "api/Terminal.Gui/Terminal.Gui.View.FocusEventArgs.html", @@ -322,7 +322,7 @@ "api/Terminal.Gui/Terminal.Gui.View.html": { "href": "api/Terminal.Gui/Terminal.Gui.View.html", "title": "Class View", - "keywords": "Class View 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. Inheritance System.Object Responder View Button CheckBox ComboBox FrameView HexView Label ListView MenuBar ProgressBar RadioGroup ScrollBarView ScrollView StatusBar TextField TextView Toplevel Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members Responder.MouseEvent(MouseEvent) Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class View : Responder, IDisposable, IEnumerable, ISupportInitializeNotification, ISupportInitialize Remarks The View defines the base functionality for user interface elements in Terminal.Gui. Views can contain one or more subviews, can respond to user input and render themselves on the screen. Views supports two layout styles: Absolute or Computed. The choice as to which layout style is used by the View is determined when the View is initizlied. To create a View using Absolute layout, call a constructor that takes a Rect parameter to specify the absolute position and size (the View. Frame )/. To create a View using Computed layout use a constructor that does not take a Rect parametr and set the X, Y, Width and Height properties on the view. Both approaches use coordinates that are relative to the container they are being added to. To switch between Absolute and Computed layout, use the LayoutStyle property. Computed layout is more flexible and supports dynamic console apps where controls adjust layout as the terminal resizes or other Views change size or position. The X, Y, Width and Height properties are Dim and Pos objects that dynamically update the position of a view. The X and Y properties are of type Pos and you can use either absolute positions, percentages or anchor points. The Width and Height properties are of type Dim and can use absolute position, percentages and anchors. These are useful as they will take care of repositioning views when view's frames are resized or if the terminal size changes. Absolute layout requires specifying coordinates and sizes of Views explicitly, and the View will typcialy stay in a fixed position and size. To change the position and size use the Frame property. Subviews (child views) can be added to a View by calling the Add(View) method. The container of a View can be accessed with the SuperView property. To flag a region of the View's Bounds to be redrawn call SetNeedsDisplay(Rect) . To flag the entire view for redraw call SetNeedsDisplay() . Views have a ColorScheme property that defines the default colors that subviews should use for rendering. This ensures that the views fit in the context where they are being used, and allows for themes to be plugged in. For example, the default colors for windows and toplevels uses a blue background, while it uses a white background for dialog boxes and a red background for errors. Subclasses should not rely on ColorScheme being set at construction time. If a ColorScheme is not set on a view, the view will inherit the value from its SuperView and the value might only be valid once a view has been added to a SuperView. By using ColorScheme applications will work both in color as well as black and white displays. Views that are focusable should implement the PositionCursor() to make sure that the cursor is placed in a location that makes sense. Unix terminals do not have a way of hiding the cursor, so it can be distracting to have the cursor left at the last focused view. So views should make sure that they place the cursor in a visually sensible place. The LayoutSubviews() method is invoked when the size or layout of a view has changed. The default processing system will keep the size and dimensions for views that use the Absolute , and will recompute the frames for the vies that use Computed . Constructors View() Initializes a new instance of View using Computed layout. Declaration public View() Remarks Use X , Y , Width , and Height properties to dynamically control the size and location of the view. The Label will be created using Computed coordinates. The initial size ( Frame will be adjusted to fit the contents of Text , including newlines ('\\n') for multiple lines. If Height is greater than one, word wrapping is provided. This constructor intitalize a View with a LayoutStyle of Computed . Use X , Y , Width , and Height properties to dynamically control the size and location of the view. View(ustring) Initializes a new instance of View using Computed layout. Declaration public View(ustring text) Parameters Type Name Description NStack.ustring text text to initialize the Text property with. Remarks The View will be created using Computed coordinates with the given string. The initial size ( Frame will be adjusted to fit the contents of Text , including newlines ('\\n') for multiple lines. If Height is greater than one, word wrapping is provided. View(Int32, Int32, ustring) Initializes a new instance of View using Absolute layout. Declaration public View(int x, int y, ustring text) Parameters Type Name Description System.Int32 x column to locate the Label. System.Int32 y row to locate the Label. NStack.ustring text text to initialize the Text property with. Remarks The View will be created at the given coordinates with the given string. The size ( Frame will be adjusted to fit the contents of Text , including newlines ('\\n') for multiple lines. No line wrapping is provided. View(Rect) Initializes a new instance of a Absolute View class with the absolute dimensions specified in the frame parameter. Declaration public View(Rect frame) Parameters Type Name Description Rect frame The region covered by this view. Remarks This constructor intitalize a View with a LayoutStyle of Absolute . Use View() to initialize a View with LayoutStyle of Computed View(Rect, ustring) Initializes a new instance of View using Absolute layout. Declaration public View(Rect rect, ustring text) Parameters Type Name Description Rect rect Location. NStack.ustring text text to initialize the Text property with. Remarks The View will be created at the given coordinates with the given string. The initial size ( Frame will be adjusted to fit the contents of Text , including newlines ('\\n') for multiple lines. If rect.Height is greater than one, word wrapping is provided. Fields Added Event fired when a subview is being added to this view. Declaration public Action Added Field Value Type Description System.Action < View > DrawContent Event invoked when the content area of the View is to be drawn. Declaration public Action DrawContent Field Value Type Description System.Action < Rect > Remarks Will be invoked before any subviews added with Add(View) have been drawn. Rect provides the view-relative rectangle describing the currently visible viewport into the View . Enter Event fired when the view gets focus. Declaration public Action Enter Field Value Type Description System.Action < View.FocusEventArgs > KeyDown Invoked when a key is pressed Declaration public Action KeyDown Field Value Type Description System.Action < View.KeyEventEventArgs > KeyPress Invoked when a character key is pressed and occurs after the key up event. Declaration public Action KeyPress Field Value Type Description System.Action < View.KeyEventEventArgs > KeyUp Invoked when a key is released Declaration public Action KeyUp Field Value Type Description System.Action < View.KeyEventEventArgs > LayoutComplete Fired after the Views's LayoutSubviews() method has completed. Declaration public Action LayoutComplete Field Value Type Description System.Action < View.LayoutEventArgs > Remarks Subscribe to this event to perform tasks when the View has been resized or the layout has otherwise changed. LayoutStarted Fired after the Views's LayoutSubviews() method has completed. Declaration public Action LayoutStarted Field Value Type Description System.Action < View.LayoutEventArgs > Remarks Subscribe to this event to perform tasks when the View has been resized or the layout has otherwise changed. Leave Event fired when the view looses focus. Declaration public Action Leave Field Value Type Description System.Action < View.FocusEventArgs > MouseClick Event fired when a mouse event is generated. Declaration public Action MouseClick Field Value Type Description System.Action < View.MouseEventArgs > MouseEnter Event fired when the view receives the mouse event for the first time. Declaration public Action MouseEnter Field Value Type Description System.Action < View.MouseEventArgs > MouseLeave Event fired when the view receives a mouse event for the last time. Declaration public Action MouseLeave Field Value Type Description System.Action < View.MouseEventArgs > Removed Event fired when a subview is being removed from this view. Declaration public Action Removed Field Value Type Description System.Action < View > Properties Bounds The bounds represent the View-relative rectangle used for this view; the area inside of the view. Declaration public Rect Bounds { get; set; } Property Value Type Description Rect The bounds. Remarks Updates to the Bounds update the Frame , and has the same side effects as updating the Frame . Because Bounds coordinates are relative to the upper-left corner of the View , the coordinates of the upper-left corner of the rectangle returned by this property are (0,0). Use this property to obtain the size and coordinates of the client area of the control for tasks such as drawing on the surface of the control. CanFocus Gets or sets a value indicating whether this Responder can focus. Declaration public override bool CanFocus { get; set; } Property Value Type Description System.Boolean true if can focus; otherwise, false . Overrides Responder.CanFocus ColorScheme The color scheme for this view, if it is not defined, it returns the SuperView 's color scheme. Declaration public ColorScheme ColorScheme { get; set; } Property Value Type Description ColorScheme Driver Points to the current driver in use by the view, it is a convenience property for simplifying the development of new views. Declaration public static ConsoleDriver Driver { get; } Property Value Type Description ConsoleDriver Focused Returns the currently focused view inside this view, or null if nothing is focused. Declaration public View Focused { get; } Property Value Type Description View The focused. Frame Gets or sets the frame for the view. The frame is relative to the view's container ( SuperView ). Declaration public virtual Rect Frame { get; set; } Property Value Type Description Rect The frame. Remarks Change the Frame when using the Absolute layout style to move or resize views. Altering the Frame of a view will trigger the redrawing of the view as well as the redrawing of the affected regions of the SuperView . HasFocus Gets or sets a value indicating whether this Responder has focus. Declaration public override bool HasFocus { get; } Property Value Type Description System.Boolean true if has focus; otherwise, false . Overrides Responder.HasFocus Height Gets or sets the height of the view. Only used whe LayoutStyle is Computed . Declaration public Dim Height { get; set; } Property Value Type Description Dim The height. HotKey Gets or sets the HotKey defined for this view. A user pressing HotKey on the keyboard while this view has focus will cause the Clicked event to fire. Declaration public Key HotKey { get; set; } Property Value Type Description Key HotKeySpecifier Gets or sets the specifier character for the hotkey (e.g. '_'). Set to '\\xffff' to disable hotkey support for this View instance. The default is '\\xffff'. Declaration public Rune HotKeySpecifier { get; set; } Property Value Type Description System.Rune Id Gets or sets an identifier for the view; Declaration public ustring Id { get; set; } Property Value Type Description NStack.ustring The identifier. Remarks The id should be unique across all Views that share a SuperView. IsCurrentTop Returns a value indicating if this View is currently on Top (Active) Declaration public bool IsCurrentTop { get; } Property Value Type Description System.Boolean IsInitialized Get or sets if the View was already initialized. This derived from System.ComponentModel.ISupportInitializeNotification to allow notify all the views that are being initialized. Declaration public bool IsInitialized { get; set; } Property Value Type Description System.Boolean LayoutStyle Controls how the View's Frame is computed during the LayoutSubviews method, if the style is set to Absolute , LayoutSubviews does not change the Frame . If the style is Computed the Frame is updated using the X , Y , Width , and Height properties. Declaration public LayoutStyle LayoutStyle { get; set; } Property Value Type Description LayoutStyle The layout style. MostFocused Returns the most focused view in the chain of subviews (the leaf view that has the focus). Declaration public View MostFocused { get; } Property Value Type Description View The most focused. Subviews This returns a list of the subviews contained by this view. Declaration public IList Subviews { get; } Property Value Type Description System.Collections.Generic.IList < View > The subviews. SuperView Returns the container for this view, or null if this view has not been added to a container. Declaration public View SuperView { get; } Property Value Type Description View The super view. TabIndex Indicates the index of the current View from the TabIndexes list. Declaration public int TabIndex { get; set; } Property Value Type Description System.Int32 TabIndexes This returns a tab index list of the subviews contained by this view. Declaration public IList TabIndexes { get; } Property Value Type Description System.Collections.Generic.IList < View > The tabIndexes. TabStop This only be true if the CanFocus is also true and the focus can be avoided by setting this to false Declaration public bool TabStop { get; set; } Property Value Type Description System.Boolean Text The text displayed by the View . Declaration public virtual ustring Text { get; set; } Property Value Type Description NStack.ustring Remarks If provided, the text will be drawn before any subviews are drawn. The text will be drawn starting at the view origin (0, 0) and will be formatted according to the TextAlignment property. If the view's height is greater than 1, the text will word-wrap to additional lines if it does not fit horizontally. If the view's height is 1, the text will be clipped. Set the HotKeySpecifier to enable hotkey support. To disable hotkey support set HotKeySpecifier to (Rune)0xffff . TextAlignment Gets or sets how the View's Text is aligned horizontally when drawn. Changing this property will redisplay the View . Declaration public virtual TextAlignment TextAlignment { get; set; } Property Value Type Description TextAlignment The text alignment. Visible Gets or sets the view visibility. Declaration public bool Visible { get; set; } Property Value Type Description System.Boolean WantContinuousButtonPressed Gets or sets a value indicating whether this View want continuous button pressed event. Declaration public virtual bool WantContinuousButtonPressed { get; set; } Property Value Type Description System.Boolean WantMousePositionReports Gets or sets a value indicating whether this View wants mouse position reports. Declaration public virtual bool WantMousePositionReports { get; set; } Property Value Type Description System.Boolean true if want mouse position reports; otherwise, false . Width Gets or sets the width of the view. Only used whe LayoutStyle is Computed . Declaration public Dim Width { get; set; } Property Value Type Description Dim The width. Remarks If LayoutStyle is Absolute changing this property has no effect and its value is indeterminate. X Gets or sets the X position for the view (the column). Only used whe LayoutStyle is Computed . Declaration public Pos X { get; set; } Property Value Type Description Pos The X Position. Remarks If LayoutStyle is Absolute changing this property has no effect and its value is indeterminate. Y Gets or sets the Y position for the view (the row). Only used whe LayoutStyle is Computed . Declaration public Pos Y { get; set; } Property Value Type Description Pos The y position (line). Remarks If LayoutStyle is Absolute changing this property has no effect and its value is indeterminate. Methods Add(View) Adds a subview (child) to this view. Declaration public virtual void Add(View view) Parameters Type Name Description View view Remarks The Views that have been added to this view can be retrieved via the Subviews property. See also Remove(View) RemoveAll() Add(View[]) Adds the specified views (children) to the view. Declaration public void Add(params View[] views) Parameters Type Name Description View [] views Array of one or more views (can be optional parameter). Remarks The Views that have been added to this view can be retrieved via the Subviews property. See also Remove(View) RemoveAll() AddRune(Int32, Int32, Rune) Displays the specified character in the specified column and row of the View. Declaration public void AddRune(int col, int row, Rune ch) Parameters Type Name Description System.Int32 col Column (view-relative). System.Int32 row Row (view-relative). System.Rune ch Ch. BeginInit() This derived from System.ComponentModel.ISupportInitializeNotification to allow notify all the views that are beginning initialized. Declaration public void BeginInit() BringSubviewForward(View) Moves the subview backwards in the hierarchy, only one step Declaration public void BringSubviewForward(View subview) Parameters Type Name Description View subview The subview to send backwards Remarks If you want to send the view all the way to the back use SendSubviewToBack. BringSubviewToFront(View) Brings the specified subview to the front so it is drawn on top of any other views. Declaration public void BringSubviewToFront(View subview) Parameters Type Name Description View subview The subview to send to the front Remarks SendSubviewToBack(View) . ChildNeedsDisplay() Indicates that any child views (in the Subviews list) need to be repainted. Declaration public void ChildNeedsDisplay() Clear() Clears the view region with the current color. Declaration public void Clear() Remarks This clears the entire region used by this view. Clear(Rect) Clears the specified region with the current color. Declaration public void Clear(Rect regionScreen) Parameters Type Name Description Rect regionScreen The screen-relative region to clear. Remarks ClearNeedsDisplay() Removes the SetNeedsDisplay() and the ChildNeedsDisplay() setting on this view. Declaration protected void ClearNeedsDisplay() ClipToBounds() Sets the ConsoleDriver 's clip region to the current View's Bounds . Declaration public Rect ClipToBounds() Returns Type Description Rect The existing driver's clip region, which can be then re-eapplied by setting Driver .Clip ( Clip ). Remarks Bounds is View-relative. Dispose(Boolean) Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Declaration protected override void Dispose(bool disposing) Parameters Type Name Description System.Boolean disposing Overrides Responder.Dispose(Boolean) Remarks If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. If disposing equals false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed. DrawFrame(Rect, Int32, Boolean) Draws a frame in the current view, clipped by the boundary of this view Declaration public void DrawFrame(Rect region, int padding = 0, bool fill = false) Parameters Type Name Description Rect region View-relative region for the frame to be drawn. System.Int32 padding The padding to add around the outside of the drawn frame. System.Boolean fill If set to true it fill will the contents. DrawHotString(ustring, Boolean, ColorScheme) Utility function to draw strings that contains a hotkey using a ColorScheme and the \"focused\" state. Declaration public void DrawHotString(ustring text, bool focused, ColorScheme scheme) Parameters Type Name Description NStack.ustring text String to display, the underscoore before a letter flags the next letter as the hotkey. System.Boolean focused If set to true this uses the focused colors from the color scheme, otherwise the regular ones. ColorScheme scheme The color scheme to use. DrawHotString(ustring, Attribute, Attribute) Utility function to draw strings that contain a hotkey. Declaration public void DrawHotString(ustring text, Attribute hotColor, Attribute normalColor) Parameters Type Name Description NStack.ustring text String to display, the hotkey specifier before a letter flags the next letter as the hotkey. Attribute hotColor Hot color. Attribute normalColor Normal color. Remarks The hotkey is any character following the hotkey specifier, which is the underscore ('_') character by default. The hotkey specifier can be changed via HotKeySpecifier EndInit() This derived from System.ComponentModel.ISupportInitializeNotification to allow notify all the views that are ending initialized. Declaration public void EndInit() EnsureFocus() Finds the first view in the hierarchy that wants to get the focus if nothing is currently focused, otherwise, it does nothing. Declaration public void EnsureFocus() FocusFirst() Focuses the first focusable subview if one exists. Declaration public void FocusFirst() FocusLast() Focuses the last focusable subview if one exists. Declaration public void FocusLast() FocusNext() Focuses the next view. Declaration public bool FocusNext() Returns Type Description System.Boolean true , if next was focused, false otherwise. FocusPrev() Focuses the previous view. Declaration public bool FocusPrev() Returns Type Description System.Boolean true , if previous was focused, false otherwise. GetEnumerator() Gets an enumerator that enumerates the subviews in this view. Declaration public IEnumerator GetEnumerator() Returns Type Description System.Collections.IEnumerator The enumerator. LayoutSubviews() Invoked when a view starts executing or when the dimensions of the view have changed, for example in response to the container view or terminal resizing. Declaration public virtual void LayoutSubviews() Remarks Calls Terminal.Gui.View.OnLayoutComplete(Terminal.Gui.View.LayoutEventArgs) (which raises the LayoutComplete event) before it returns. Move(Int32, Int32) This moves the cursor to the specified column and row in the view. Declaration public void Move(int col, int row) Parameters Type Name Description System.Int32 col Col. System.Int32 row Row. OnAdded(View) Method invoked when a subview is being added to this view. Declaration public virtual void OnAdded(View view) Parameters Type Name Description View view The subview being added. OnDrawContent(Rect) Enables overrides to draw infinitely scrolled content and/or a background behind added controls. Declaration public virtual void OnDrawContent(Rect viewport) Parameters Type Name Description Rect viewport The view-relative rectangle describing the currently visible viewport into the View Remarks This method will be called before any subviews added with Add(View) have been drawn. OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.OnEnter(View) OnKeyDown(KeyEvent) Declaration public override bool OnKeyDown(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides Responder.OnKeyDown(KeyEvent) OnKeyUp(KeyEvent) Declaration public override bool OnKeyUp(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides Responder.OnKeyUp(KeyEvent) OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.OnLeave(View) OnMouseEnter(MouseEvent) Method invoked when a mouse event is generated for the first time. Declaration public override bool OnMouseEnter(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.OnMouseEnter(MouseEvent) OnMouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public virtual bool OnMouseEvent(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Returns Type Description System.Boolean true , if the event was handled, false otherwise. OnMouseLeave(MouseEvent) Method invoked when a mouse event is generated for the last time. Declaration public override bool OnMouseLeave(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.OnMouseLeave(MouseEvent) OnRemoved(View) Method invoked when a subview is being removed from this view. Declaration public virtual void OnRemoved(View view) Parameters Type Name Description View view The subview being removed. PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public virtual void PositionCursor() ProcessColdKey(KeyEvent) This method can be overwritten by views that want to provide accelerator functionality (Alt-key for example), but without interefering with normal ProcessKey behavior. Declaration public override bool ProcessColdKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides Responder.ProcessColdKey(KeyEvent) Remarks After keys are sent to the subviews on the current view, all the view are processed and the key is passed to the views to allow some of them to process the keystroke as a cold-key. This functionality is used, for example, by default buttons to act on the enter key. Processing this as a hot-key would prevent non-default buttons from consuming the enter keypress when they have the focus. ProcessHotKey(KeyEvent) This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example). Declaration public override bool ProcessHotKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Returns Type Description System.Boolean Overrides Responder.ProcessHotKey(KeyEvent) Remarks Before keys are sent to the subview on the current view, all the views are processed and the key is passed to the widgets to allow some of them to process the keystroke as a hot-key. For example, if you implement a button that has a hotkey ok \"o\", you would catch the combination Alt-o here. If the event is caught, you must return true to stop the keystroke from being dispatched to other views. ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides Responder.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public virtual void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. Remove(View) Removes a subview added via Add(View) or Add(View[]) from this View. Declaration public virtual void Remove(View view) Parameters Type Name Description View view Remarks RemoveAll() Removes all subviews (children) added via Add(View) or Add(View[]) from this View. Declaration public virtual void RemoveAll() ScreenToView(Int32, Int32) Converts a point from screen-relative coordinates to view-relative coordinates. Declaration public Point ScreenToView(int x, int y) Parameters Type Name Description System.Int32 x X screen-coordinate point. System.Int32 y Y screen-coordinate point. Returns Type Description Point The mapped point. SendSubviewBackwards(View) Moves the subview backwards in the hierarchy, only one step Declaration public void SendSubviewBackwards(View subview) Parameters Type Name Description View subview The subview to send backwards Remarks If you want to send the view all the way to the back use SendSubviewToBack. SendSubviewToBack(View) Sends the specified subview to the front so it is the first view drawn Declaration public void SendSubviewToBack(View subview) Parameters Type Name Description View subview The subview to send to the front Remarks BringSubviewToFront(View) . SetClip(Rect) Sets the clip region to the specified view-relative region. Declaration public Rect SetClip(Rect region) Parameters Type Name Description Rect region View-relative clip region. Returns Type Description Rect The previous screen-relative clip region. SetFocus() Causes the specified view and the entire parent hierarchy to have the focused order updated. Declaration public void SetFocus() SetNeedsDisplay() Sets a flag indicating this view needs to be redisplayed because its state has changed. Declaration public void SetNeedsDisplay() SetNeedsDisplay(Rect) Flags the view-relative region on this View as needing to be repainted. Declaration public void SetNeedsDisplay(Rect region) Parameters Type Name Description Rect region The view-relative region that must be flagged for repaint. ToString() Pretty prints the View Declaration public override string ToString() Returns Type Description System.String Overrides System.Object.ToString() Events Initialized Event called only once when the View is being initialized for the first time. Allows configurations and assignments to be performed before the View being shown. This derived from System.ComponentModel.ISupportInitializeNotification to allow notify all the views that are being initialized. Declaration public event EventHandler Initialized Event Type Type Description System.EventHandler Implements System.IDisposable System.Collections.IEnumerable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" + "keywords": "Class View 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. Inheritance System.Object Responder View Button CheckBox ComboBox FrameView HexView Label ListView MenuBar ProgressBar RadioGroup ScrollBarView ScrollView StatusBar TextField TextView Toplevel Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members Responder.MouseEvent(MouseEvent) Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class View : Responder, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The View defines the base functionality for user interface elements in Terminal.Gui. Views can contain one or more subviews, can respond to user input and render themselves on the screen. Views supports two layout styles: Absolute or Computed. The choice as to which layout style is used by the View is determined when the View is initizlied. To create a View using Absolute layout, call a constructor that takes a Rect parameter to specify the absolute position and size (the View. Frame )/. To create a View using Computed layout use a constructor that does not take a Rect parametr and set the X, Y, Width and Height properties on the view. Both approaches use coordinates that are relative to the container they are being added to. To switch between Absolute and Computed layout, use the LayoutStyle property. Computed layout is more flexible and supports dynamic console apps where controls adjust layout as the terminal resizes or other Views change size or position. The X, Y, Width and Height properties are Dim and Pos objects that dynamically update the position of a view. The X and Y properties are of type Pos and you can use either absolute positions, percentages or anchor points. The Width and Height properties are of type Dim and can use absolute position, percentages and anchors. These are useful as they will take care of repositioning views when view's frames are resized or if the terminal size changes. Absolute layout requires specifying coordinates and sizes of Views explicitly, and the View will typcialy stay in a fixed position and size. To change the position and size use the Frame property. Subviews (child views) can be added to a View by calling the Add(View) method. The container of a View can be accessed with the SuperView property. To flag a region of the View's Bounds to be redrawn call SetNeedsDisplay(Rect) . To flag the entire view for redraw call SetNeedsDisplay() . Views have a ColorScheme property that defines the default colors that subviews should use for rendering. This ensures that the views fit in the context where they are being used, and allows for themes to be plugged in. For example, the default colors for windows and toplevels uses a blue background, while it uses a white background for dialog boxes and a red background for errors. Subclasses should not rely on ColorScheme being set at construction time. If a ColorScheme is not set on a view, the view will inherit the value from its SuperView and the value might only be valid once a view has been added to a SuperView. By using ColorScheme applications will work both in color as well as black and white displays. Views that are focusable should implement the PositionCursor() to make sure that the cursor is placed in a location that makes sense. Unix terminals do not have a way of hiding the cursor, so it can be distracting to have the cursor left at the last focused view. So views should make sure that they place the cursor in a visually sensible place. The LayoutSubviews() method is invoked when the size or layout of a view has changed. The default processing system will keep the size and dimensions for views that use the Absolute , and will recompute the frames for the vies that use Computed . Constructors View() Initializes a new instance of View using Computed layout. Declaration public View() Remarks Use X , Y , Width , and Height properties to dynamically control the size and location of the view. The Label will be created using Computed coordinates. The initial size ( Frame will be adjusted to fit the contents of Text , including newlines ('\\n') for multiple lines. If Height is greater than one, word wrapping is provided. This constructor intitalize a View with a LayoutStyle of Computed . Use X , Y , Width , and Height properties to dynamically control the size and location of the view. View(ustring) Initializes a new instance of View using Computed layout. Declaration public View(ustring text) Parameters Type Name Description NStack.ustring text text to initialize the Text property with. Remarks The View will be created using Computed coordinates with the given string. The initial size ( Frame will be adjusted to fit the contents of Text , including newlines ('\\n') for multiple lines. If Height is greater than one, word wrapping is provided. View(Int32, Int32, ustring) Initializes a new instance of View using Absolute layout. Declaration public View(int x, int y, ustring text) Parameters Type Name Description System.Int32 x column to locate the Label. System.Int32 y row to locate the Label. NStack.ustring text text to initialize the Text property with. Remarks The View will be created at the given coordinates with the given string. The size ( Frame will be adjusted to fit the contents of Text , including newlines ('\\n') for multiple lines. No line wrapping is provided. View(Rect) Initializes a new instance of a Absolute View class with the absolute dimensions specified in the frame parameter. Declaration public View(Rect frame) Parameters Type Name Description Rect frame The region covered by this view. Remarks This constructor intitalize a View with a LayoutStyle of Absolute . Use View() to initialize a View with LayoutStyle of Computed View(Rect, ustring) Initializes a new instance of View using Absolute layout. Declaration public View(Rect rect, ustring text) Parameters Type Name Description Rect rect Location. NStack.ustring text text to initialize the Text property with. Remarks The View will be created at the given coordinates with the given string. The initial size ( Frame will be adjusted to fit the contents of Text , including newlines ('\\n') for multiple lines. If rect.Height is greater than one, word wrapping is provided. Properties Bounds The bounds represent the View-relative rectangle used for this view; the area inside of the view. Declaration public Rect Bounds { get; set; } Property Value Type Description Rect The bounds. Remarks Updates to the Bounds update the Frame , and has the same side effects as updating the Frame . Because Bounds coordinates are relative to the upper-left corner of the View , the coordinates of the upper-left corner of the rectangle returned by this property are (0,0). Use this property to obtain the size and coordinates of the client area of the control for tasks such as drawing on the surface of the control. CanFocus Gets or sets a value indicating whether this Responder can focus. Declaration public override bool CanFocus { get; set; } Property Value Type Description System.Boolean true if can focus; otherwise, false . Overrides Responder.CanFocus ColorScheme The color scheme for this view, if it is not defined, it returns the SuperView 's color scheme. Declaration public ColorScheme ColorScheme { get; set; } Property Value Type Description ColorScheme Data Gets or sets arbitrary data for the view. Declaration public object Data { get; set; } Property Value Type Description System.Object Remarks This property is not used internally. Driver Points to the current driver in use by the view, it is a convenience property for simplifying the development of new views. Declaration public static ConsoleDriver Driver { get; } Property Value Type Description ConsoleDriver Focused Returns the currently focused view inside this view, or null if nothing is focused. Declaration public View Focused { get; } Property Value Type Description View The focused. Frame Gets or sets the frame for the view. The frame is relative to the view's container ( SuperView ). Declaration public virtual Rect Frame { get; set; } Property Value Type Description Rect The frame. Remarks Change the Frame when using the Absolute layout style to move or resize views. Altering the Frame of a view will trigger the redrawing of the view as well as the redrawing of the affected regions of the SuperView . HasFocus Gets or sets a value indicating whether this Responder has focus. Declaration public override bool HasFocus { get; } Property Value Type Description System.Boolean true if has focus; otherwise, false . Overrides Responder.HasFocus Height Gets or sets the height of the view. Only used whe LayoutStyle is Computed . Declaration public Dim Height { get; set; } Property Value Type Description Dim The height. HotKey Gets or sets the HotKey defined for this view. A user pressing HotKey on the keyboard while this view has focus will cause the Clicked event to fire. Declaration public Key HotKey { get; set; } Property Value Type Description Key HotKeySpecifier Gets or sets the specifier character for the hotkey (e.g. '_'). Set to '\\xffff' to disable hotkey support for this View instance. The default is '\\xffff'. Declaration public Rune HotKeySpecifier { get; set; } Property Value Type Description System.Rune Id Gets or sets an identifier for the view; Declaration public ustring Id { get; set; } Property Value Type Description NStack.ustring The identifier. Remarks The id should be unique across all Views that share a SuperView. IsCurrentTop Returns a value indicating if this View is currently on Top (Active) Declaration public bool IsCurrentTop { get; } Property Value Type Description System.Boolean IsInitialized Get or sets if the View was already initialized. This derived from System.ComponentModel.ISupportInitializeNotification to allow notify all the views that are being initialized. Declaration public bool IsInitialized { get; set; } Property Value Type Description System.Boolean LayoutStyle Controls how the View's Frame is computed during the LayoutSubviews method, if the style is set to Absolute , LayoutSubviews does not change the Frame . If the style is Computed the Frame is updated using the X , Y , Width , and Height properties. Declaration public LayoutStyle LayoutStyle { get; set; } Property Value Type Description LayoutStyle The layout style. MostFocused Returns the most focused view in the chain of subviews (the leaf view that has the focus). Declaration public View MostFocused { get; } Property Value Type Description View The most focused. Subviews This returns a list of the subviews contained by this view. Declaration public IList Subviews { get; } Property Value Type Description System.Collections.Generic.IList < View > The subviews. SuperView Returns the container for this view, or null if this view has not been added to a container. Declaration public View SuperView { get; } Property Value Type Description View The super view. TabIndex Indicates the index of the current View from the TabIndexes list. Declaration public int TabIndex { get; set; } Property Value Type Description System.Int32 TabIndexes This returns a tab index list of the subviews contained by this view. Declaration public IList TabIndexes { get; } Property Value Type Description System.Collections.Generic.IList < View > The tabIndexes. TabStop This only be true if the CanFocus is also true and the focus can be avoided by setting this to false Declaration public bool TabStop { get; set; } Property Value Type Description System.Boolean Text The text displayed by the View . Declaration public virtual ustring Text { get; set; } Property Value Type Description NStack.ustring Remarks If provided, the text will be drawn before any subviews are drawn. The text will be drawn starting at the view origin (0, 0) and will be formatted according to the TextAlignment property. If the view's height is greater than 1, the text will word-wrap to additional lines if it does not fit horizontally. If the view's height is 1, the text will be clipped. Set the HotKeySpecifier to enable hotkey support. To disable hotkey support set HotKeySpecifier to (Rune)0xffff . TextAlignment Gets or sets how the View's Text is aligned horizontally when drawn. Changing this property will redisplay the View . Declaration public virtual TextAlignment TextAlignment { get; set; } Property Value Type Description TextAlignment The text alignment. Visible Gets or sets the view visibility. Declaration public bool Visible { get; set; } Property Value Type Description System.Boolean WantContinuousButtonPressed Gets or sets a value indicating whether this View want continuous button pressed event. Declaration public virtual bool WantContinuousButtonPressed { get; set; } Property Value Type Description System.Boolean WantMousePositionReports Gets or sets a value indicating whether this View wants mouse position reports. Declaration public virtual bool WantMousePositionReports { get; set; } Property Value Type Description System.Boolean true if want mouse position reports; otherwise, false . Width Gets or sets the width of the view. Only used whe LayoutStyle is Computed . Declaration public Dim Width { get; set; } Property Value Type Description Dim The width. Remarks If LayoutStyle is Absolute changing this property has no effect and its value is indeterminate. X Gets or sets the X position for the view (the column). Only used whe LayoutStyle is Computed . Declaration public Pos X { get; set; } Property Value Type Description Pos The X Position. Remarks If LayoutStyle is Absolute changing this property has no effect and its value is indeterminate. Y Gets or sets the Y position for the view (the row). Only used whe LayoutStyle is Computed . Declaration public Pos Y { get; set; } Property Value Type Description Pos The y position (line). Remarks If LayoutStyle is Absolute changing this property has no effect and its value is indeterminate. Methods Add(View) Adds a subview (child) to this view. Declaration public virtual void Add(View view) Parameters Type Name Description View view Remarks The Views that have been added to this view can be retrieved via the Subviews property. See also Remove(View) RemoveAll() Add(View[]) Adds the specified views (children) to the view. Declaration public void Add(params View[] views) Parameters Type Name Description View [] views Array of one or more views (can be optional parameter). Remarks The Views that have been added to this view can be retrieved via the Subviews property. See also Remove(View) RemoveAll() AddRune(Int32, Int32, Rune) Displays the specified character in the specified column and row of the View. Declaration public void AddRune(int col, int row, Rune ch) Parameters Type Name Description System.Int32 col Column (view-relative). System.Int32 row Row (view-relative). System.Rune ch Ch. BeginInit() This derived from System.ComponentModel.ISupportInitializeNotification to allow notify all the views that are beginning initialized. Declaration public void BeginInit() BringSubviewForward(View) Moves the subview backwards in the hierarchy, only one step Declaration public void BringSubviewForward(View subview) Parameters Type Name Description View subview The subview to send backwards Remarks If you want to send the view all the way to the back use SendSubviewToBack. BringSubviewToFront(View) Brings the specified subview to the front so it is drawn on top of any other views. Declaration public void BringSubviewToFront(View subview) Parameters Type Name Description View subview The subview to send to the front Remarks SendSubviewToBack(View) . ChildNeedsDisplay() Indicates that any child views (in the Subviews list) need to be repainted. Declaration public void ChildNeedsDisplay() Clear() Clears the view region with the current color. Declaration public void Clear() Remarks This clears the entire region used by this view. Clear(Rect) Clears the specified region with the current color. Declaration public void Clear(Rect regionScreen) Parameters Type Name Description Rect regionScreen The screen-relative region to clear. Remarks ClearNeedsDisplay() Removes the SetNeedsDisplay() and the ChildNeedsDisplay() setting on this view. Declaration protected void ClearNeedsDisplay() ClipToBounds() Sets the ConsoleDriver 's clip region to the current View's Bounds . Declaration public Rect ClipToBounds() Returns Type Description Rect The existing driver's clip region, which can be then re-eapplied by setting Driver .Clip ( Clip ). Remarks Bounds is View-relative. Dispose(Boolean) Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. Declaration protected override void Dispose(bool disposing) Parameters Type Name Description System.Boolean disposing Overrides Responder.Dispose(Boolean) Remarks If disposing equals true, the method has been called directly or indirectly by a user's code. Managed and unmanaged resources can be disposed. If disposing equals false, the method has been called by the runtime from inside the finalizer and you should not reference other objects. Only unmanaged resources can be disposed. DrawFrame(Rect, Int32, Boolean) Draws a frame in the current view, clipped by the boundary of this view Declaration public void DrawFrame(Rect region, int padding = 0, bool fill = false) Parameters Type Name Description Rect region View-relative region for the frame to be drawn. System.Int32 padding The padding to add around the outside of the drawn frame. System.Boolean fill If set to true it fill will the contents. DrawHotString(ustring, Boolean, ColorScheme) Utility function to draw strings that contains a hotkey using a ColorScheme and the \"focused\" state. Declaration public void DrawHotString(ustring text, bool focused, ColorScheme scheme) Parameters Type Name Description NStack.ustring text String to display, the underscoore before a letter flags the next letter as the hotkey. System.Boolean focused If set to true this uses the focused colors from the color scheme, otherwise the regular ones. ColorScheme scheme The color scheme to use. DrawHotString(ustring, Attribute, Attribute) Utility function to draw strings that contain a hotkey. Declaration public void DrawHotString(ustring text, Attribute hotColor, Attribute normalColor) Parameters Type Name Description NStack.ustring text String to display, the hotkey specifier before a letter flags the next letter as the hotkey. Attribute hotColor Hot color. Attribute normalColor Normal color. Remarks The hotkey is any character following the hotkey specifier, which is the underscore ('_') character by default. The hotkey specifier can be changed via HotKeySpecifier EndInit() This derived from System.ComponentModel.ISupportInitializeNotification to allow notify all the views that are ending initialized. Declaration public void EndInit() EnsureFocus() Finds the first view in the hierarchy that wants to get the focus if nothing is currently focused, otherwise, it does nothing. Declaration public void EnsureFocus() FocusFirst() Focuses the first focusable subview if one exists. Declaration public void FocusFirst() FocusLast() Focuses the last focusable subview if one exists. Declaration public void FocusLast() FocusNext() Focuses the next view. Declaration public bool FocusNext() Returns Type Description System.Boolean true , if next was focused, false otherwise. FocusPrev() Focuses the previous view. Declaration public bool FocusPrev() Returns Type Description System.Boolean true , if previous was focused, false otherwise. LayoutSubviews() Invoked when a view starts executing or when the dimensions of the view have changed, for example in response to the container view or terminal resizing. Declaration public virtual void LayoutSubviews() Remarks Calls Terminal.Gui.View.OnLayoutComplete(Terminal.Gui.View.LayoutEventArgs) (which raises the LayoutComplete event) before it returns. Move(Int32, Int32) This moves the cursor to the specified column and row in the view. Declaration public void Move(int col, int row) Parameters Type Name Description System.Int32 col Col. System.Int32 row Row. OnAdded(View) Method invoked when a subview is being added to this view. Declaration public virtual void OnAdded(View view) Parameters Type Name Description View view The subview being added. OnDrawContent(Rect) Enables overrides to draw infinitely scrolled content and/or a background behind added controls. Declaration public virtual void OnDrawContent(Rect viewport) Parameters Type Name Description Rect viewport The view-relative rectangle describing the currently visible viewport into the View Remarks This method will be called before any subviews added with Add(View) have been drawn. OnEnter(View) Method invoked when a view gets focus. Declaration public override bool OnEnter(View view) Parameters Type Name Description View view The view that is losing focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.OnEnter(View) OnKeyDown(KeyEvent) Declaration public override bool OnKeyDown(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides Responder.OnKeyDown(KeyEvent) OnKeyUp(KeyEvent) Declaration public override bool OnKeyUp(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides Responder.OnKeyUp(KeyEvent) OnLeave(View) Method invoked when a view loses focus. Declaration public override bool OnLeave(View view) Parameters Type Name Description View view The view that is getting focus. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.OnLeave(View) OnMouseClick(View.MouseEventArgs) Invokes the MouseClick event. Declaration protected void OnMouseClick(View.MouseEventArgs args) Parameters Type Name Description View.MouseEventArgs args OnMouseEnter(MouseEvent) Method invoked when a mouse event is generated for the first time. Declaration public override bool OnMouseEnter(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.OnMouseEnter(MouseEvent) OnMouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public virtual bool OnMouseEvent(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Returns Type Description System.Boolean true , if the event was handled, false otherwise. OnMouseLeave(MouseEvent) Method invoked when a mouse event is generated for the last time. Declaration public override bool OnMouseLeave(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.OnMouseLeave(MouseEvent) OnRemoved(View) Method invoked when a subview is being removed from this view. Declaration public virtual void OnRemoved(View view) Parameters Type Name Description View view The subview being removed. PositionCursor() Positions the cursor in the right position based on the currently focused view in the chain. Declaration public virtual void PositionCursor() ProcessColdKey(KeyEvent) This method can be overwritten by views that want to provide accelerator functionality (Alt-key for example), but without interefering with normal ProcessKey behavior. Declaration public override bool ProcessColdKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides Responder.ProcessColdKey(KeyEvent) Remarks After keys are sent to the subviews on the current view, all the view are processed and the key is passed to the views to allow some of them to process the keystroke as a cold-key. This functionality is used, for example, by default buttons to act on the enter key. Processing this as a hot-key would prevent non-default buttons from consuming the enter keypress when they have the focus. ProcessHotKey(KeyEvent) This method can be overwritten by view that want to provide accelerator functionality (Alt-key for example). Declaration public override bool ProcessHotKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Returns Type Description System.Boolean Overrides Responder.ProcessHotKey(KeyEvent) Remarks Before keys are sent to the subview on the current view, all the views are processed and the key is passed to the widgets to allow some of them to process the keystroke as a hot-key. For example, if you implement a button that has a hotkey ok \"o\", you would catch the combination Alt-o here. If the event is caught, you must return true to stop the keystroke from being dispatched to other views. ProcessKey(KeyEvent) If the view is focused, gives the view a chance to process the keystroke. Declaration public override bool ProcessKey(KeyEvent keyEvent) Parameters Type Name Description KeyEvent keyEvent Contains the details about the key that produced the event. Returns Type Description System.Boolean Overrides Responder.ProcessKey(KeyEvent) Remarks Views can override this method if they are interested in processing the given keystroke. If they consume the keystroke, they must return true to stop the keystroke from being processed by other widgets or consumed by the widget engine. If they return false, the keystroke will be passed using the ProcessColdKey method to other views to process. The View implementation does nothing but return false, so it is not necessary to call base.ProcessKey if you derive directly from View, but you should if you derive other View subclasses. Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public virtual void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. Remove(View) Removes a subview added via Add(View) or Add(View[]) from this View. Declaration public virtual void Remove(View view) Parameters Type Name Description View view Remarks RemoveAll() Removes all subviews (children) added via Add(View) or Add(View[]) from this View. Declaration public virtual void RemoveAll() ScreenToView(Int32, Int32) Converts a point from screen-relative coordinates to view-relative coordinates. Declaration public Point ScreenToView(int x, int y) Parameters Type Name Description System.Int32 x X screen-coordinate point. System.Int32 y Y screen-coordinate point. Returns Type Description Point The mapped point. SendSubviewBackwards(View) Moves the subview backwards in the hierarchy, only one step Declaration public void SendSubviewBackwards(View subview) Parameters Type Name Description View subview The subview to send backwards Remarks If you want to send the view all the way to the back use SendSubviewToBack. SendSubviewToBack(View) Sends the specified subview to the front so it is the first view drawn Declaration public void SendSubviewToBack(View subview) Parameters Type Name Description View subview The subview to send to the front Remarks BringSubviewToFront(View) . SetClip(Rect) Sets the clip region to the specified view-relative region. Declaration public Rect SetClip(Rect region) Parameters Type Name Description Rect region View-relative clip region. Returns Type Description Rect The previous screen-relative clip region. SetFocus() Causes the specified view and the entire parent hierarchy to have the focused order updated. Declaration public void SetFocus() SetNeedsDisplay() Sets a flag indicating this view needs to be redisplayed because its state has changed. Declaration public void SetNeedsDisplay() SetNeedsDisplay(Rect) Flags the view-relative region on this View as needing to be repainted. Declaration public void SetNeedsDisplay(Rect region) Parameters Type Name Description Rect region The view-relative region that must be flagged for repaint. ToString() Pretty prints the View Declaration public override string ToString() Returns Type Description System.String Overrides System.Object.ToString() Events Added Event fired when a subview is being added to this view. Declaration public event Action Added Event Type Type Description System.Action < View > DrawContent Event invoked when the content area of the View is to be drawn. Declaration public event Action DrawContent Event Type Type Description System.Action < Rect > Remarks Will be invoked before any subviews added with Add(View) have been drawn. Rect provides the view-relative rectangle describing the currently visible viewport into the View . Enter Event fired when the view gets focus. Declaration public event Action Enter Event Type Type Description System.Action < View.FocusEventArgs > Initialized Event called only once when the View is being initialized for the first time. Allows configurations and assignments to be performed before the View being shown. This derived from System.ComponentModel.ISupportInitializeNotification to allow notify all the views that are being initialized. Declaration public event EventHandler Initialized Event Type Type Description System.EventHandler KeyDown Invoked when a key is pressed Declaration public event Action KeyDown Event Type Type Description System.Action < View.KeyEventEventArgs > KeyPress Invoked when a character key is pressed and occurs after the key up event. Declaration public event Action KeyPress Event Type Type Description System.Action < View.KeyEventEventArgs > KeyUp Invoked when a key is released Declaration public event Action KeyUp Event Type Type Description System.Action < View.KeyEventEventArgs > LayoutComplete Fired after the Views's LayoutSubviews() method has completed. Declaration public event Action LayoutComplete Event Type Type Description System.Action < View.LayoutEventArgs > Remarks Subscribe to this event to perform tasks when the View has been resized or the layout has otherwise changed. LayoutStarted Fired after the Views's LayoutSubviews() method has completed. Declaration public event Action LayoutStarted Event Type Type Description System.Action < View.LayoutEventArgs > Remarks Subscribe to this event to perform tasks when the View has been resized or the layout has otherwise changed. Leave Event fired when the view looses focus. Declaration public event Action Leave Event Type Type Description System.Action < View.FocusEventArgs > MouseClick Event fired when a mouse event is generated. Declaration public event Action MouseClick Event Type Type Description System.Action < View.MouseEventArgs > MouseEnter Event fired when the view receives the mouse event for the first time. Declaration public event Action MouseEnter Event Type Type Description System.Action < View.MouseEventArgs > MouseLeave Event fired when the view receives a mouse event for the last time. Declaration public event Action MouseLeave Event Type Type Description System.Action < View.MouseEventArgs > Removed Event fired when a subview is being removed from this view. Declaration public event Action Removed Event Type Type Description System.Action < View > Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" }, "api/Terminal.Gui/Terminal.Gui.View.KeyEventEventArgs.html": { "href": "api/Terminal.Gui/Terminal.Gui.View.KeyEventEventArgs.html", @@ -342,17 +342,17 @@ "api/Terminal.Gui/Terminal.Gui.Window.html": { "href": "api/Terminal.Gui/Terminal.Gui.Window.html", "title": "Class Window", - "keywords": "Class Window A Toplevel View that draws a border around its Frame with a Title at the top. Inheritance System.Object Responder View Toplevel Window Dialog Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize System.Collections.IEnumerable Inherited Members Toplevel.Running Toplevel.Ready Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessKey(KeyEvent) Toplevel.WillPresent() View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class Window : Toplevel, IDisposable, ISupportInitializeNotification, ISupportInitialize, IEnumerable Remarks The 'client area' of a Window is a rectangle deflated by one or more rows/columns from Bounds . A this time there is no API to determine this rectangle. Constructors Window() Initializes a new instance of the Window class using Computed positioning. Declaration public Window() Window(ustring) Initializes a new instance of the Window class with an optional title using Computed positioning. Declaration public Window(ustring title = null) Parameters Type Name Description NStack.ustring title Title. Remarks This constructor intitalize a View with a LayoutStyle of Computed . Use X , Y , Width , and Height properties to dynamically control the size and location of the view. Window(ustring, Int32) Initializes a new instance of the Window using Absolute positioning with the specified frame for its location, with the specified frame padding, and an optional title. Declaration public Window(ustring title = null, int padding = 0) Parameters Type Name Description NStack.ustring title Title. System.Int32 padding Number of characters to use for padding of the drawn frame. Remarks This constructor intitalize a View with a LayoutStyle of Computed . Use X , Y , Width , and Height properties to dynamically control the size and location of the view. Window(Rect, ustring) Initializes a new instance of the Window class with an optional title using Absolute positioning. Declaration public Window(Rect frame, ustring title = null) Parameters Type Name Description Rect frame Superview-relative rectangle specifying the location and size NStack.ustring title Title Remarks This constructor intitalizes a Window with a LayoutStyle of Absolute . Use constructors that do not take Rect parameters to initialize a Window with Computed . Window(Rect, ustring, Int32) Initializes a new instance of the Window using Absolute positioning with the specified frame for its location, with the specified frame padding, and an optional title. Declaration public Window(Rect frame, ustring title = null, int padding = 0) Parameters Type Name Description Rect frame Superview-relative rectangle specifying the location and size NStack.ustring title Title System.Int32 padding Number of characters to use for padding of the drawn frame. Remarks This constructor intitalizes a Window with a LayoutStyle of Absolute . Use constructors that do not take Rect parameters to initialize a Window with LayoutStyle of Computed Properties Text The text displayed by the Label . Declaration public override ustring Text { get; set; } Property Value Type Description NStack.ustring Overrides View.Text TextAlignment Controls the text-alignment property of the label, changing it will redisplay the Label . Declaration public override TextAlignment TextAlignment { get; set; } Property Value Type Description TextAlignment The text alignment. Overrides View.TextAlignment Title The title to be displayed for this window. Declaration public ustring Title { get; set; } Property Value Type Description NStack.ustring The title Methods Add(View) Adds a subview (child) to this view. Declaration public override void Add(View view) Parameters Type Name Description View view Overrides Toplevel.Add(View) Remarks The Views that have been added to this view can be retrieved via the Subviews property. See also Remove(View) RemoveAll() GetEnumerator() Enumerates the various View s in the embedded Terminal.Gui.Window.ContentView . Declaration public IEnumerator GetEnumerator() Returns Type Description System.Collections.IEnumerator The enumerator. MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Contains the details about the mouse event. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides Toplevel.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. Remove(View) Removes a subview added via Add(View) or Add(View[]) from this View. Declaration public override void Remove(View view) Parameters Type Name Description View view Overrides Toplevel.Remove(View) Remarks RemoveAll() Removes all subviews (children) added via Add(View) or Add(View[]) from this View. Declaration public override void RemoveAll() Overrides Toplevel.RemoveAll() Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize System.Collections.IEnumerable" + "keywords": "Class Window A Toplevel View that draws a border around its Frame with a Title at the top. Inheritance System.Object Responder View Toplevel Window Dialog Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize Inherited Members Toplevel.Running Toplevel.Ready Toplevel.Create() Toplevel.CanFocus Toplevel.Modal Toplevel.MenuBar Toplevel.StatusBar Toplevel.OnKeyDown(KeyEvent) Toplevel.OnKeyUp(KeyEvent) Toplevel.ProcessKey(KeyEvent) Toplevel.WillPresent() View.Added View.Removed View.Enter View.Leave View.MouseEnter View.MouseLeave View.MouseClick View.HotKey View.HotKeySpecifier View.Data View.Driver View.Subviews View.TabIndexes View.TabIndex View.TabStop View.Id View.IsCurrentTop View.WantMousePositionReports View.WantContinuousButtonPressed View.Frame View.LayoutStyle View.Bounds View.X View.Y View.Width View.Height View.SuperView View.SetNeedsDisplay() View.SetNeedsDisplay(Rect) View.ChildNeedsDisplay() View.Add(View[]) View.BringSubviewToFront(View) View.SendSubviewToBack(View) View.SendSubviewBackwards(View) View.BringSubviewForward(View) View.Clear() View.Clear(Rect) View.ScreenToView(Int32, Int32) View.ClipToBounds() View.SetClip(Rect) View.DrawFrame(Rect, Int32, Boolean) View.DrawHotString(ustring, Attribute, Attribute) View.DrawHotString(ustring, Boolean, ColorScheme) View.Move(Int32, Int32) View.PositionCursor() View.HasFocus View.OnAdded(View) View.OnRemoved(View) View.OnEnter(View) View.OnLeave(View) View.Focused View.MostFocused View.ColorScheme View.AddRune(Int32, Int32, Rune) View.ClearNeedsDisplay() View.DrawContent View.OnDrawContent(Rect) View.SetFocus() View.KeyPress View.ProcessHotKey(KeyEvent) View.ProcessColdKey(KeyEvent) View.KeyDown View.KeyUp View.EnsureFocus() View.FocusFirst() View.FocusLast() View.FocusPrev() View.FocusNext() View.LayoutStarted View.LayoutComplete View.Initialized View.LayoutSubviews() View.IsInitialized View.ToString() View.OnMouseEnter(MouseEvent) View.OnMouseLeave(MouseEvent) View.OnMouseEvent(MouseEvent) View.OnMouseClick(View.MouseEventArgs) View.Dispose(Boolean) View.BeginInit() View.EndInit() View.Visible Responder.Dispose() System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : Terminal.Gui Assembly : Terminal.Gui.dll Syntax public class Window : Toplevel, IDisposable, ISupportInitializeNotification, ISupportInitialize Remarks The 'client area' of a Window is a rectangle deflated by one or more rows/columns from Bounds . A this time there is no API to determine this rectangle. Constructors Window() Initializes a new instance of the Window class using Computed positioning. Declaration public Window() Window(ustring) Initializes a new instance of the Window class with an optional title using Computed positioning. Declaration public Window(ustring title = null) Parameters Type Name Description NStack.ustring title Title. Remarks This constructor intitalize a View with a LayoutStyle of Computed . Use X , Y , Width , and Height properties to dynamically control the size and location of the view. Window(ustring, Int32) Initializes a new instance of the Window using Absolute positioning with the specified frame for its location, with the specified frame padding, and an optional title. Declaration public Window(ustring title = null, int padding = 0) Parameters Type Name Description NStack.ustring title Title. System.Int32 padding Number of characters to use for padding of the drawn frame. Remarks This constructor intitalize a View with a LayoutStyle of Computed . Use X , Y , Width , and Height properties to dynamically control the size and location of the view. Window(Rect, ustring) Initializes a new instance of the Window class with an optional title using Absolute positioning. Declaration public Window(Rect frame, ustring title = null) Parameters Type Name Description Rect frame Superview-relative rectangle specifying the location and size NStack.ustring title Title Remarks This constructor intitalizes a Window with a LayoutStyle of Absolute . Use constructors that do not take Rect parameters to initialize a Window with Computed . Window(Rect, ustring, Int32) Initializes a new instance of the Window using Absolute positioning with the specified frame for its location, with the specified frame padding, and an optional title. Declaration public Window(Rect frame, ustring title = null, int padding = 0) Parameters Type Name Description Rect frame Superview-relative rectangle specifying the location and size NStack.ustring title Title System.Int32 padding Number of characters to use for padding of the drawn frame. Remarks This constructor intitalizes a Window with a LayoutStyle of Absolute . Use constructors that do not take Rect parameters to initialize a Window with LayoutStyle of Computed Properties Text The text displayed by the Label . Declaration public override ustring Text { get; set; } Property Value Type Description NStack.ustring Overrides View.Text TextAlignment Controls the text-alignment property of the label, changing it will redisplay the Label . Declaration public override TextAlignment TextAlignment { get; set; } Property Value Type Description TextAlignment The text alignment. Overrides View.TextAlignment Title The title to be displayed for this window. Declaration public ustring Title { get; set; } Property Value Type Description NStack.ustring The title Methods Add(View) Adds a subview (child) to this view. Declaration public override void Add(View view) Parameters Type Name Description View view Overrides Toplevel.Add(View) Remarks The Views that have been added to this view can be retrieved via the Subviews property. See also Remove(View) RemoveAll() MouseEvent(MouseEvent) Method invoked when a mouse event is generated Declaration public override bool MouseEvent(MouseEvent mouseEvent) Parameters Type Name Description MouseEvent mouseEvent Contains the details about the mouse event. Returns Type Description System.Boolean true , if the event was handled, false otherwise. Overrides Responder.MouseEvent(MouseEvent) Redraw(Rect) Redraws this view and its subviews; only redraws the views that have been flagged for a re-display. Declaration public override void Redraw(Rect bounds) Parameters Type Name Description Rect bounds The bounds (view-relative region) to redraw. Overrides Toplevel.Redraw(Rect) Remarks Always use Bounds (view-relative) when calling Redraw(Rect) , NOT Frame (superview-relative). Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver. Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter. Remove(View) Removes a subview added via Add(View) or Add(View[]) from this View. Declaration public override void Remove(View view) Parameters Type Name Description View view Overrides Toplevel.Remove(View) Remarks RemoveAll() Removes all subviews (children) added via Add(View) or Add(View[]) from this View. Declaration public override void RemoveAll() Overrides Toplevel.RemoveAll() Implements System.IDisposable System.ComponentModel.ISupportInitializeNotification System.ComponentModel.ISupportInitialize" }, "api/Terminal.Gui/Unix.Terminal.Curses.Event.html": { "href": "api/Terminal.Gui/Unix.Terminal.Curses.Event.html", "title": "Enum Curses.Event", - "keywords": "Enum Curses.Event Namespace : Unix.Terminal Assembly : Terminal.Gui.dll Syntax public enum Event : long Fields Name Description AllEvents Button1Clicked Button1DoubleClicked Button1Pressed Button1Released Button1TripleClicked Button2Clicked Button2DoubleClicked Button2Pressed Button2Released Button2TrippleClicked Button3Clicked Button3DoubleClicked Button3Pressed Button3Released Button3TripleClicked Button4Clicked Button4DoubleClicked Button4Pressed Button4Released Button4TripleClicked ButtonAlt ButtonCtrl ButtonShift ReportMousePosition" + "keywords": "Enum Curses.Event Namespace : Unix.Terminal Assembly : Terminal.Gui.dll Syntax [Flags] public enum Event : long Fields Name Description AllEvents Button1Clicked Button1DoubleClicked Button1Pressed Button1Released Button1TripleClicked Button2Clicked Button2DoubleClicked Button2Pressed Button2Released Button2TrippleClicked Button3Clicked Button3DoubleClicked Button3Pressed Button3Released Button3TripleClicked Button4Clicked Button4DoubleClicked Button4Pressed Button4Released Button4TripleClicked ButtonAlt ButtonCtrl ButtonShift ButtonWheeledDown ButtonWheeledUp ReportMousePosition" }, "api/Terminal.Gui/Unix.Terminal.Curses.html": { "href": "api/Terminal.Gui/Unix.Terminal.Curses.html", "title": "Class Curses", - "keywords": "Class Curses Inheritance System.Object Curses Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Unix.Terminal Assembly : Terminal.Gui.dll Syntax public class Curses Fields A_BLINK Declaration public const int A_BLINK = 524288 Field Value Type Description System.Int32 A_BOLD Declaration public const int A_BOLD = 2097152 Field Value Type Description System.Int32 A_DIM Declaration public const int A_DIM = 1048576 Field Value Type Description System.Int32 A_INVIS Declaration public const int A_INVIS = 8388608 Field Value Type Description System.Int32 A_NORMAL Declaration public const int A_NORMAL = 0 Field Value Type Description System.Int32 A_PROTECT Declaration public const int A_PROTECT = 16777216 Field Value Type Description System.Int32 A_REVERSE Declaration public const int A_REVERSE = 262144 Field Value Type Description System.Int32 A_STANDOUT Declaration public const int A_STANDOUT = 65536 Field Value Type Description System.Int32 A_UNDERLINE Declaration public const int A_UNDERLINE = 131072 Field Value Type Description System.Int32 ACS_BLOCK Declaration public const int ACS_BLOCK = 4194352 Field Value Type Description System.Int32 ACS_BOARD Declaration public const int ACS_BOARD = 4194408 Field Value Type Description System.Int32 ACS_BTEE Declaration public const int ACS_BTEE = 4194422 Field Value Type Description System.Int32 ACS_BULLET Declaration public const int ACS_BULLET = 4194430 Field Value Type Description System.Int32 ACS_CKBOARD Declaration public const int ACS_CKBOARD = 4194401 Field Value Type Description System.Int32 ACS_DARROW Declaration public const int ACS_DARROW = 4194350 Field Value Type Description System.Int32 ACS_DEGREE Declaration public const int ACS_DEGREE = 4194406 Field Value Type Description System.Int32 ACS_DIAMOND Declaration public const int ACS_DIAMOND = 4194400 Field Value Type Description System.Int32 ACS_HLINE Declaration public const int ACS_HLINE = 4194417 Field Value Type Description System.Int32 ACS_LANTERN Declaration public const int ACS_LANTERN = 4194409 Field Value Type Description System.Int32 ACS_LARROW Declaration public const int ACS_LARROW = 4194348 Field Value Type Description System.Int32 ACS_LLCORNER Declaration public const int ACS_LLCORNER = 4194413 Field Value Type Description System.Int32 ACS_LRCORNER Declaration public const int ACS_LRCORNER = 4194410 Field Value Type Description System.Int32 ACS_LTEE Declaration public const int ACS_LTEE = 4194420 Field Value Type Description System.Int32 ACS_PLMINUS Declaration public const int ACS_PLMINUS = 4194407 Field Value Type Description System.Int32 ACS_PLUS Declaration public const int ACS_PLUS = 4194414 Field Value Type Description System.Int32 ACS_RARROW Declaration public const int ACS_RARROW = 4194347 Field Value Type Description System.Int32 ACS_RTEE Declaration public const int ACS_RTEE = 4194421 Field Value Type Description System.Int32 ACS_S1 Declaration public const int ACS_S1 = 4194415 Field Value Type Description System.Int32 ACS_S9 Declaration public const int ACS_S9 = 4194419 Field Value Type Description System.Int32 ACS_TTEE Declaration public const int ACS_TTEE = 4194423 Field Value Type Description System.Int32 ACS_UARROW Declaration public const int ACS_UARROW = 4194349 Field Value Type Description System.Int32 ACS_ULCORNER Declaration public const int ACS_ULCORNER = 4194412 Field Value Type Description System.Int32 ACS_URCORNER Declaration public const int ACS_URCORNER = 4194411 Field Value Type Description System.Int32 ACS_VLINE Declaration public const int ACS_VLINE = 4194424 Field Value Type Description System.Int32 AltKeyDown Declaration public const int AltKeyDown = 529 Field Value Type Description System.Int32 AltKeyEnd Declaration public const int AltKeyEnd = 534 Field Value Type Description System.Int32 AltKeyHome Declaration public const int AltKeyHome = 540 Field Value Type Description System.Int32 AltKeyLeft Declaration public const int AltKeyLeft = 551 Field Value Type Description System.Int32 AltKeyNPage Declaration public const int AltKeyNPage = 556 Field Value Type Description System.Int32 AltKeyPPage Declaration public const int AltKeyPPage = 561 Field Value Type Description System.Int32 AltKeyRight Declaration public const int AltKeyRight = 566 Field Value Type Description System.Int32 AltKeyUp Declaration public const int AltKeyUp = 572 Field Value Type Description System.Int32 COLOR_BLACK Declaration public const int COLOR_BLACK = 0 Field Value Type Description System.Int32 COLOR_BLUE Declaration public const int COLOR_BLUE = 4 Field Value Type Description System.Int32 COLOR_CYAN Declaration public const int COLOR_CYAN = 6 Field Value Type Description System.Int32 COLOR_GREEN Declaration public const int COLOR_GREEN = 2 Field Value Type Description System.Int32 COLOR_MAGENTA Declaration public const int COLOR_MAGENTA = 5 Field Value Type Description System.Int32 COLOR_RED Declaration public const int COLOR_RED = 1 Field Value Type Description System.Int32 COLOR_WHITE Declaration public const int COLOR_WHITE = 7 Field Value Type Description System.Int32 COLOR_YELLOW Declaration public const int COLOR_YELLOW = 3 Field Value Type Description System.Int32 CtrlKeyDown Declaration public const int CtrlKeyDown = 531 Field Value Type Description System.Int32 CtrlKeyEnd Declaration public const int CtrlKeyEnd = 536 Field Value Type Description System.Int32 CtrlKeyHome Declaration public const int CtrlKeyHome = 542 Field Value Type Description System.Int32 CtrlKeyLeft Declaration public const int CtrlKeyLeft = 553 Field Value Type Description System.Int32 CtrlKeyNPage Declaration public const int CtrlKeyNPage = 558 Field Value Type Description System.Int32 CtrlKeyPPage Declaration public const int CtrlKeyPPage = 563 Field Value Type Description System.Int32 CtrlKeyRight Declaration public const int CtrlKeyRight = 568 Field Value Type Description System.Int32 CtrlKeyUp Declaration public const int CtrlKeyUp = 574 Field Value Type Description System.Int32 DownEnd Declaration public const int DownEnd = 6 Field Value Type Description System.Int32 ERR Declaration public const int ERR = -1 Field Value Type Description System.Int32 Home Declaration public const int Home = 7 Field Value Type Description System.Int32 KEY_CODE_YES Declaration public const int KEY_CODE_YES = 256 Field Value Type Description System.Int32 KeyAlt Declaration public const int KeyAlt = 8192 Field Value Type Description System.Int32 KeyBackspace Declaration public const int KeyBackspace = 263 Field Value Type Description System.Int32 KeyBackTab Declaration public const int KeyBackTab = 353 Field Value Type Description System.Int32 KeyDeleteChar Declaration public const int KeyDeleteChar = 330 Field Value Type Description System.Int32 KeyDown Declaration public const int KeyDown = 258 Field Value Type Description System.Int32 KeyEnd Declaration public const int KeyEnd = 360 Field Value Type Description System.Int32 KeyF1 Declaration public const int KeyF1 = 265 Field Value Type Description System.Int32 KeyF10 Declaration public const int KeyF10 = 274 Field Value Type Description System.Int32 KeyF11 Declaration public const int KeyF11 = 275 Field Value Type Description System.Int32 KeyF12 Declaration public const int KeyF12 = 276 Field Value Type Description System.Int32 KeyF2 Declaration public const int KeyF2 = 266 Field Value Type Description System.Int32 KeyF3 Declaration public const int KeyF3 = 267 Field Value Type Description System.Int32 KeyF4 Declaration public const int KeyF4 = 268 Field Value Type Description System.Int32 KeyF5 Declaration public const int KeyF5 = 269 Field Value Type Description System.Int32 KeyF6 Declaration public const int KeyF6 = 270 Field Value Type Description System.Int32 KeyF7 Declaration public const int KeyF7 = 271 Field Value Type Description System.Int32 KeyF8 Declaration public const int KeyF8 = 272 Field Value Type Description System.Int32 KeyF9 Declaration public const int KeyF9 = 273 Field Value Type Description System.Int32 KeyHome Declaration public const int KeyHome = 262 Field Value Type Description System.Int32 KeyInsertChar Declaration public const int KeyInsertChar = 331 Field Value Type Description System.Int32 KeyLeft Declaration public const int KeyLeft = 260 Field Value Type Description System.Int32 KeyMouse Declaration public const int KeyMouse = 409 Field Value Type Description System.Int32 KeyNPage Declaration public const int KeyNPage = 338 Field Value Type Description System.Int32 KeyPPage Declaration public const int KeyPPage = 339 Field Value Type Description System.Int32 KeyResize Declaration public const int KeyResize = 410 Field Value Type Description System.Int32 KeyRight Declaration public const int KeyRight = 261 Field Value Type Description System.Int32 KeyTab Declaration public const int KeyTab = 9 Field Value Type Description System.Int32 KeyUp Declaration public const int KeyUp = 259 Field Value Type Description System.Int32 LC_ALL Declaration public const int LC_ALL = 6 Field Value Type Description System.Int32 LeftRightUpNPagePPage Declaration public const int LeftRightUpNPagePPage = 8 Field Value Type Description System.Int32 ShiftCtrlKeyDown Declaration public const int ShiftCtrlKeyDown = 532 Field Value Type Description System.Int32 ShiftCtrlKeyEnd Declaration public const int ShiftCtrlKeyEnd = 537 Field Value Type Description System.Int32 ShiftCtrlKeyHome Declaration public const int ShiftCtrlKeyHome = 543 Field Value Type Description System.Int32 ShiftCtrlKeyLeft Declaration public const int ShiftCtrlKeyLeft = 554 Field Value Type Description System.Int32 ShiftCtrlKeyNPage Declaration public const int ShiftCtrlKeyNPage = 559 Field Value Type Description System.Int32 ShiftCtrlKeyPPage Declaration public const int ShiftCtrlKeyPPage = 564 Field Value Type Description System.Int32 ShiftCtrlKeyRight Declaration public const int ShiftCtrlKeyRight = 569 Field Value Type Description System.Int32 ShiftCtrlKeyUp Declaration public const int ShiftCtrlKeyUp = 575 Field Value Type Description System.Int32 ShiftKeyDown Declaration public const int ShiftKeyDown = 336 Field Value Type Description System.Int32 ShiftKeyEnd Declaration public const int ShiftKeyEnd = 386 Field Value Type Description System.Int32 ShiftKeyHome Declaration public const int ShiftKeyHome = 391 Field Value Type Description System.Int32 ShiftKeyLeft Declaration public const int ShiftKeyLeft = 393 Field Value Type Description System.Int32 ShiftKeyNPage Declaration public const int ShiftKeyNPage = 396 Field Value Type Description System.Int32 ShiftKeyPPage Declaration public const int ShiftKeyPPage = 398 Field Value Type Description System.Int32 ShiftKeyRight Declaration public const int ShiftKeyRight = 402 Field Value Type Description System.Int32 ShiftKeyUp Declaration public const int ShiftKeyUp = 337 Field Value Type Description System.Int32 Properties ColorPairs Declaration public static int ColorPairs { get; } Property Value Type Description System.Int32 Cols Declaration public static int Cols { get; } Property Value Type Description System.Int32 HasColors Declaration public static bool HasColors { get; } Property Value Type Description System.Boolean Lines Declaration public static int Lines { get; } Property Value Type Description System.Int32 Methods addch(Int32) Declaration public static int addch(int ch) Parameters Type Name Description System.Int32 ch Returns Type Description System.Int32 addstr(String, Object[]) Declaration public static int addstr(string format, params object[] args) Parameters Type Name Description System.String format System.Object [] args Returns Type Description System.Int32 addwstr(String) Declaration public static int addwstr(string s) Parameters Type Name Description System.String s Returns Type Description System.Int32 attroff(Int32) Declaration public static int attroff(int attrs) Parameters Type Name Description System.Int32 attrs Returns Type Description System.Int32 attron(Int32) Declaration public static int attron(int attrs) Parameters Type Name Description System.Int32 attrs Returns Type Description System.Int32 attrset(Int32) Declaration public static int attrset(int attrs) Parameters Type Name Description System.Int32 attrs Returns Type Description System.Int32 cbreak() Declaration public static int cbreak() Returns Type Description System.Int32 CheckWinChange() Declaration public static bool CheckWinChange() Returns Type Description System.Boolean clearok(IntPtr, Boolean) Declaration public static int clearok(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 COLOR_PAIRS() Declaration public static int COLOR_PAIRS() Returns Type Description System.Int32 ColorPair(Int32) Declaration public static int ColorPair(int n) Parameters Type Name Description System.Int32 n Returns Type Description System.Int32 doupdate() Declaration public static int doupdate() Returns Type Description System.Int32 echo() Declaration public static int echo() Returns Type Description System.Int32 endwin() Declaration public static int endwin() Returns Type Description System.Int32 get_wch(out Int32) Declaration public static int get_wch(out int sequence) Parameters Type Name Description System.Int32 sequence Returns Type Description System.Int32 getch() Declaration public static int getch() Returns Type Description System.Int32 getmouse(out Curses.MouseEvent) Declaration public static uint getmouse(out Curses.MouseEvent ev) Parameters Type Name Description Curses.MouseEvent ev Returns Type Description System.UInt32 halfdelay(Int32) Declaration public static int halfdelay(int t) Parameters Type Name Description System.Int32 t Returns Type Description System.Int32 has_colors() Declaration public static bool has_colors() Returns Type Description System.Boolean idcok(IntPtr, Boolean) Declaration public static void idcok(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf idlok(IntPtr, Boolean) Declaration public static int idlok(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 immedok(IntPtr, Boolean) Declaration public static void immedok(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf init_pair(Int16, Int16, Int16) Declaration public static int init_pair(short pair, short f, short b) Parameters Type Name Description System.Int16 pair System.Int16 f System.Int16 b Returns Type Description System.Int32 InitColorPair(Int16, Int16, Int16) Declaration public static int InitColorPair(short pair, short foreground, short background) Parameters Type Name Description System.Int16 pair System.Int16 foreground System.Int16 background Returns Type Description System.Int32 initscr() Declaration public static Curses.Window initscr() Returns Type Description Curses.Window intrflush(IntPtr, Boolean) Declaration public static int intrflush(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 IsAlt(Int32) Declaration public static int IsAlt(int key) Parameters Type Name Description System.Int32 key Returns Type Description System.Int32 isendwin() Declaration public static bool isendwin() Returns Type Description System.Boolean keypad(IntPtr, Boolean) Declaration public static int keypad(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 leaveok(IntPtr, Boolean) Declaration public static int leaveok(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 meta(IntPtr, Boolean) Declaration public static int meta(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 mouseinterval(Int32) Declaration public static int mouseinterval(int interval) Parameters Type Name Description System.Int32 interval Returns Type Description System.Int32 mousemask(Curses.Event, out Curses.Event) Declaration public static Curses.Event mousemask(Curses.Event newmask, out Curses.Event oldmask) Parameters Type Name Description Curses.Event newmask Curses.Event oldmask Returns Type Description Curses.Event move(Int32, Int32) Declaration public static int move(int line, int col) Parameters Type Name Description System.Int32 line System.Int32 col Returns Type Description System.Int32 mvgetch(Int32, Int32) Declaration public static int mvgetch(int y, int x) Parameters Type Name Description System.Int32 y System.Int32 x Returns Type Description System.Int32 nl() Declaration public static int nl() Returns Type Description System.Int32 nocbreak() Declaration public static int nocbreak() Returns Type Description System.Int32 noecho() Declaration public static int noecho() Returns Type Description System.Int32 nonl() Declaration public static int nonl() Returns Type Description System.Int32 noqiflush() Declaration public static void noqiflush() noraw() Declaration public static int noraw() Returns Type Description System.Int32 notimeout(IntPtr, Boolean) Declaration public static int notimeout(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 qiflush() Declaration public static void qiflush() raw() Declaration public static int raw() Returns Type Description System.Int32 redrawwin(IntPtr) Declaration public static int redrawwin(IntPtr win) Parameters Type Name Description System.IntPtr win Returns Type Description System.Int32 refresh() Declaration public static int refresh() Returns Type Description System.Int32 scrollok(IntPtr, Boolean) Declaration public static int scrollok(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 setlocale(Int32, String) Declaration public static int setlocale(int cate, string locale) Parameters Type Name Description System.Int32 cate System.String locale Returns Type Description System.Int32 setscrreg(Int32, Int32) Declaration public static int setscrreg(int top, int bot) Parameters Type Name Description System.Int32 top System.Int32 bot Returns Type Description System.Int32 start_color() Declaration public static int start_color() Returns Type Description System.Int32 StartColor() Declaration public static int StartColor() Returns Type Description System.Int32 timeout(Int32) Declaration public static int timeout(int delay) Parameters Type Name Description System.Int32 delay Returns Type Description System.Int32 typeahead(IntPtr) Declaration public static int typeahead(IntPtr fd) Parameters Type Name Description System.IntPtr fd Returns Type Description System.Int32 ungetch(Int32) Declaration public static int ungetch(int ch) Parameters Type Name Description System.Int32 ch Returns Type Description System.Int32 ungetmouse(ref Curses.MouseEvent) Declaration public static uint ungetmouse(ref Curses.MouseEvent ev) Parameters Type Name Description Curses.MouseEvent ev Returns Type Description System.UInt32 use_default_colors() Declaration public static int use_default_colors() Returns Type Description System.Int32 UseDefaultColors() Declaration public static int UseDefaultColors() Returns Type Description System.Int32 waddch(IntPtr, Int32) Declaration public static int waddch(IntPtr win, int ch) Parameters Type Name Description System.IntPtr win System.Int32 ch Returns Type Description System.Int32 wmove(IntPtr, Int32, Int32) Declaration public static int wmove(IntPtr win, int line, int col) Parameters Type Name Description System.IntPtr win System.Int32 line System.Int32 col Returns Type Description System.Int32 wnoutrefresh(IntPtr) Declaration public static int wnoutrefresh(IntPtr win) Parameters Type Name Description System.IntPtr win Returns Type Description System.Int32 wrefresh(IntPtr) Declaration public static int wrefresh(IntPtr win) Parameters Type Name Description System.IntPtr win Returns Type Description System.Int32 wsetscrreg(IntPtr, Int32, Int32) Declaration public static int wsetscrreg(IntPtr win, int top, int bot) Parameters Type Name Description System.IntPtr win System.Int32 top System.Int32 bot Returns Type Description System.Int32 wtimeout(IntPtr, Int32) Declaration public static int wtimeout(IntPtr win, int delay) Parameters Type Name Description System.IntPtr win System.Int32 delay Returns Type Description System.Int32" + "keywords": "Class Curses Inheritance System.Object Curses Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : Unix.Terminal Assembly : Terminal.Gui.dll Syntax public class Curses Fields A_BLINK Declaration public const int A_BLINK = 524288 Field Value Type Description System.Int32 A_BOLD Declaration public const int A_BOLD = 2097152 Field Value Type Description System.Int32 A_DIM Declaration public const int A_DIM = 1048576 Field Value Type Description System.Int32 A_INVIS Declaration public const int A_INVIS = 8388608 Field Value Type Description System.Int32 A_NORMAL Declaration public const int A_NORMAL = 0 Field Value Type Description System.Int32 A_PROTECT Declaration public const int A_PROTECT = 16777216 Field Value Type Description System.Int32 A_REVERSE Declaration public const int A_REVERSE = 262144 Field Value Type Description System.Int32 A_STANDOUT Declaration public const int A_STANDOUT = 65536 Field Value Type Description System.Int32 A_UNDERLINE Declaration public const int A_UNDERLINE = 131072 Field Value Type Description System.Int32 ACS_BLOCK Declaration public const int ACS_BLOCK = 4194352 Field Value Type Description System.Int32 ACS_BOARD Declaration public const int ACS_BOARD = 4194408 Field Value Type Description System.Int32 ACS_BTEE Declaration public const int ACS_BTEE = 4194422 Field Value Type Description System.Int32 ACS_BULLET Declaration public const int ACS_BULLET = 4194430 Field Value Type Description System.Int32 ACS_CKBOARD Declaration public const int ACS_CKBOARD = 4194401 Field Value Type Description System.Int32 ACS_DARROW Declaration public const int ACS_DARROW = 4194350 Field Value Type Description System.Int32 ACS_DEGREE Declaration public const int ACS_DEGREE = 4194406 Field Value Type Description System.Int32 ACS_DIAMOND Declaration public const int ACS_DIAMOND = 4194400 Field Value Type Description System.Int32 ACS_HLINE Declaration public const int ACS_HLINE = 4194417 Field Value Type Description System.Int32 ACS_LANTERN Declaration public const int ACS_LANTERN = 4194409 Field Value Type Description System.Int32 ACS_LARROW Declaration public const int ACS_LARROW = 4194348 Field Value Type Description System.Int32 ACS_LLCORNER Declaration public const int ACS_LLCORNER = 4194413 Field Value Type Description System.Int32 ACS_LRCORNER Declaration public const int ACS_LRCORNER = 4194410 Field Value Type Description System.Int32 ACS_LTEE Declaration public const int ACS_LTEE = 4194420 Field Value Type Description System.Int32 ACS_PLMINUS Declaration public const int ACS_PLMINUS = 4194407 Field Value Type Description System.Int32 ACS_PLUS Declaration public const int ACS_PLUS = 4194414 Field Value Type Description System.Int32 ACS_RARROW Declaration public const int ACS_RARROW = 4194347 Field Value Type Description System.Int32 ACS_RTEE Declaration public const int ACS_RTEE = 4194421 Field Value Type Description System.Int32 ACS_S1 Declaration public const int ACS_S1 = 4194415 Field Value Type Description System.Int32 ACS_S9 Declaration public const int ACS_S9 = 4194419 Field Value Type Description System.Int32 ACS_TTEE Declaration public const int ACS_TTEE = 4194423 Field Value Type Description System.Int32 ACS_UARROW Declaration public const int ACS_UARROW = 4194349 Field Value Type Description System.Int32 ACS_ULCORNER Declaration public const int ACS_ULCORNER = 4194412 Field Value Type Description System.Int32 ACS_URCORNER Declaration public const int ACS_URCORNER = 4194411 Field Value Type Description System.Int32 ACS_VLINE Declaration public const int ACS_VLINE = 4194424 Field Value Type Description System.Int32 AltKeyDown Declaration public const int AltKeyDown = 523 Field Value Type Description System.Int32 AltKeyEnd Declaration public const int AltKeyEnd = 528 Field Value Type Description System.Int32 AltKeyHome Declaration public const int AltKeyHome = 533 Field Value Type Description System.Int32 AltKeyLeft Declaration public const int AltKeyLeft = 543 Field Value Type Description System.Int32 AltKeyNPage Declaration public const int AltKeyNPage = 548 Field Value Type Description System.Int32 AltKeyPPage Declaration public const int AltKeyPPage = 553 Field Value Type Description System.Int32 AltKeyRight Declaration public const int AltKeyRight = 558 Field Value Type Description System.Int32 AltKeyUp Declaration public const int AltKeyUp = 564 Field Value Type Description System.Int32 COLOR_BLACK Declaration public const int COLOR_BLACK = 0 Field Value Type Description System.Int32 COLOR_BLUE Declaration public const int COLOR_BLUE = 4 Field Value Type Description System.Int32 COLOR_CYAN Declaration public const int COLOR_CYAN = 6 Field Value Type Description System.Int32 COLOR_GREEN Declaration public const int COLOR_GREEN = 2 Field Value Type Description System.Int32 COLOR_MAGENTA Declaration public const int COLOR_MAGENTA = 5 Field Value Type Description System.Int32 COLOR_RED Declaration public const int COLOR_RED = 1 Field Value Type Description System.Int32 COLOR_WHITE Declaration public const int COLOR_WHITE = 7 Field Value Type Description System.Int32 COLOR_YELLOW Declaration public const int COLOR_YELLOW = 3 Field Value Type Description System.Int32 CtrlKeyDown Declaration public const int CtrlKeyDown = 525 Field Value Type Description System.Int32 CtrlKeyEnd Declaration public const int CtrlKeyEnd = 530 Field Value Type Description System.Int32 CtrlKeyHome Declaration public const int CtrlKeyHome = 535 Field Value Type Description System.Int32 CtrlKeyLeft Declaration public const int CtrlKeyLeft = 545 Field Value Type Description System.Int32 CtrlKeyNPage Declaration public const int CtrlKeyNPage = 550 Field Value Type Description System.Int32 CtrlKeyPPage Declaration public const int CtrlKeyPPage = 555 Field Value Type Description System.Int32 CtrlKeyRight Declaration public const int CtrlKeyRight = 560 Field Value Type Description System.Int32 CtrlKeyUp Declaration public const int CtrlKeyUp = 566 Field Value Type Description System.Int32 DownEnd Declaration public const int DownEnd = 0 Field Value Type Description System.Int32 ERR Declaration public const int ERR = -1 Field Value Type Description System.Int32 Home Declaration public const int Home = 0 Field Value Type Description System.Int32 KEY_CODE_YES Declaration public const int KEY_CODE_YES = 256 Field Value Type Description System.Int32 KeyAlt Declaration public const int KeyAlt = 8192 Field Value Type Description System.Int32 KeyBackspace Declaration public const int KeyBackspace = 263 Field Value Type Description System.Int32 KeyBackTab Declaration public const int KeyBackTab = 353 Field Value Type Description System.Int32 KeyDeleteChar Declaration public const int KeyDeleteChar = 330 Field Value Type Description System.Int32 KeyDown Declaration public const int KeyDown = 258 Field Value Type Description System.Int32 KeyEnd Declaration public const int KeyEnd = 360 Field Value Type Description System.Int32 KeyF1 Declaration public const int KeyF1 = 265 Field Value Type Description System.Int32 KeyF10 Declaration public const int KeyF10 = 274 Field Value Type Description System.Int32 KeyF11 Declaration public const int KeyF11 = 275 Field Value Type Description System.Int32 KeyF12 Declaration public const int KeyF12 = 276 Field Value Type Description System.Int32 KeyF2 Declaration public const int KeyF2 = 266 Field Value Type Description System.Int32 KeyF3 Declaration public const int KeyF3 = 267 Field Value Type Description System.Int32 KeyF4 Declaration public const int KeyF4 = 268 Field Value Type Description System.Int32 KeyF5 Declaration public const int KeyF5 = 269 Field Value Type Description System.Int32 KeyF6 Declaration public const int KeyF6 = 270 Field Value Type Description System.Int32 KeyF7 Declaration public const int KeyF7 = 271 Field Value Type Description System.Int32 KeyF8 Declaration public const int KeyF8 = 272 Field Value Type Description System.Int32 KeyF9 Declaration public const int KeyF9 = 273 Field Value Type Description System.Int32 KeyHome Declaration public const int KeyHome = 262 Field Value Type Description System.Int32 KeyInsertChar Declaration public const int KeyInsertChar = 331 Field Value Type Description System.Int32 KeyLeft Declaration public const int KeyLeft = 260 Field Value Type Description System.Int32 KeyMouse Declaration public const int KeyMouse = 409 Field Value Type Description System.Int32 KeyNPage Declaration public const int KeyNPage = 338 Field Value Type Description System.Int32 KeyPPage Declaration public const int KeyPPage = 339 Field Value Type Description System.Int32 KeyResize Declaration public const int KeyResize = 410 Field Value Type Description System.Int32 KeyRight Declaration public const int KeyRight = 261 Field Value Type Description System.Int32 KeyTab Declaration public const int KeyTab = 9 Field Value Type Description System.Int32 KeyUp Declaration public const int KeyUp = 259 Field Value Type Description System.Int32 LC_ALL Declaration public const int LC_ALL = 6 Field Value Type Description System.Int32 LeftRightUpNPagePPage Declaration public const int LeftRightUpNPagePPage = 0 Field Value Type Description System.Int32 ShiftCtrlKeyDown Declaration public const int ShiftCtrlKeyDown = 526 Field Value Type Description System.Int32 ShiftCtrlKeyEnd Declaration public const int ShiftCtrlKeyEnd = 531 Field Value Type Description System.Int32 ShiftCtrlKeyHome Declaration public const int ShiftCtrlKeyHome = 536 Field Value Type Description System.Int32 ShiftCtrlKeyLeft Declaration public const int ShiftCtrlKeyLeft = 546 Field Value Type Description System.Int32 ShiftCtrlKeyNPage Declaration public const int ShiftCtrlKeyNPage = 551 Field Value Type Description System.Int32 ShiftCtrlKeyPPage Declaration public const int ShiftCtrlKeyPPage = 556 Field Value Type Description System.Int32 ShiftCtrlKeyRight Declaration public const int ShiftCtrlKeyRight = 561 Field Value Type Description System.Int32 ShiftCtrlKeyUp Declaration public const int ShiftCtrlKeyUp = 567 Field Value Type Description System.Int32 ShiftKeyDown Declaration public const int ShiftKeyDown = 336 Field Value Type Description System.Int32 ShiftKeyEnd Declaration public const int ShiftKeyEnd = 386 Field Value Type Description System.Int32 ShiftKeyHome Declaration public const int ShiftKeyHome = 391 Field Value Type Description System.Int32 ShiftKeyLeft Declaration public const int ShiftKeyLeft = 393 Field Value Type Description System.Int32 ShiftKeyNPage Declaration public const int ShiftKeyNPage = 396 Field Value Type Description System.Int32 ShiftKeyPPage Declaration public const int ShiftKeyPPage = 398 Field Value Type Description System.Int32 ShiftKeyRight Declaration public const int ShiftKeyRight = 402 Field Value Type Description System.Int32 ShiftKeyUp Declaration public const int ShiftKeyUp = 337 Field Value Type Description System.Int32 Properties ColorPairs Declaration public static int ColorPairs { get; } Property Value Type Description System.Int32 Cols Declaration public static int Cols { get; } Property Value Type Description System.Int32 HasColors Declaration public static bool HasColors { get; } Property Value Type Description System.Boolean Lines Declaration public static int Lines { get; } Property Value Type Description System.Int32 Methods addch(Int32) Declaration public static int addch(int ch) Parameters Type Name Description System.Int32 ch Returns Type Description System.Int32 addstr(String, Object[]) Declaration public static int addstr(string format, params object[] args) Parameters Type Name Description System.String format System.Object [] args Returns Type Description System.Int32 addwstr(String) Declaration public static int addwstr(string s) Parameters Type Name Description System.String s Returns Type Description System.Int32 attroff(Int32) Declaration public static int attroff(int attrs) Parameters Type Name Description System.Int32 attrs Returns Type Description System.Int32 attron(Int32) Declaration public static int attron(int attrs) Parameters Type Name Description System.Int32 attrs Returns Type Description System.Int32 attrset(Int32) Declaration public static int attrset(int attrs) Parameters Type Name Description System.Int32 attrs Returns Type Description System.Int32 cbreak() Declaration public static int cbreak() Returns Type Description System.Int32 CheckWinChange() Declaration public static bool CheckWinChange() Returns Type Description System.Boolean clearok(IntPtr, Boolean) Declaration public static int clearok(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 COLOR_PAIRS() Declaration public static int COLOR_PAIRS() Returns Type Description System.Int32 ColorPair(Int32) Declaration public static int ColorPair(int n) Parameters Type Name Description System.Int32 n Returns Type Description System.Int32 doupdate() Declaration public static int doupdate() Returns Type Description System.Int32 echo() Declaration public static int echo() Returns Type Description System.Int32 endwin() Declaration public static int endwin() Returns Type Description System.Int32 get_wch(out Int32) Declaration public static int get_wch(out int sequence) Parameters Type Name Description System.Int32 sequence Returns Type Description System.Int32 getch() Declaration public static int getch() Returns Type Description System.Int32 getmouse(out Curses.MouseEvent) Declaration public static uint getmouse(out Curses.MouseEvent ev) Parameters Type Name Description Curses.MouseEvent ev Returns Type Description System.UInt32 halfdelay(Int32) Declaration public static int halfdelay(int t) Parameters Type Name Description System.Int32 t Returns Type Description System.Int32 has_colors() Declaration public static bool has_colors() Returns Type Description System.Boolean idcok(IntPtr, Boolean) Declaration public static void idcok(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf idlok(IntPtr, Boolean) Declaration public static int idlok(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 immedok(IntPtr, Boolean) Declaration public static void immedok(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf init_pair(Int16, Int16, Int16) Declaration public static int init_pair(short pair, short f, short b) Parameters Type Name Description System.Int16 pair System.Int16 f System.Int16 b Returns Type Description System.Int32 InitColorPair(Int16, Int16, Int16) Declaration public static int InitColorPair(short pair, short foreground, short background) Parameters Type Name Description System.Int16 pair System.Int16 foreground System.Int16 background Returns Type Description System.Int32 initscr() Declaration public static Curses.Window initscr() Returns Type Description Curses.Window intrflush(IntPtr, Boolean) Declaration public static int intrflush(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 IsAlt(Int32) Declaration public static int IsAlt(int key) Parameters Type Name Description System.Int32 key Returns Type Description System.Int32 isendwin() Declaration public static bool isendwin() Returns Type Description System.Boolean keypad(IntPtr, Boolean) Declaration public static int keypad(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 leaveok(IntPtr, Boolean) Declaration public static int leaveok(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 meta(IntPtr, Boolean) Declaration public static int meta(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 mouseinterval(Int32) Declaration public static int mouseinterval(int interval) Parameters Type Name Description System.Int32 interval Returns Type Description System.Int32 mousemask(Curses.Event, out Curses.Event) Declaration public static Curses.Event mousemask(Curses.Event newmask, out Curses.Event oldmask) Parameters Type Name Description Curses.Event newmask Curses.Event oldmask Returns Type Description Curses.Event move(Int32, Int32) Declaration public static int move(int line, int col) Parameters Type Name Description System.Int32 line System.Int32 col Returns Type Description System.Int32 mvgetch(Int32, Int32) Declaration public static int mvgetch(int y, int x) Parameters Type Name Description System.Int32 y System.Int32 x Returns Type Description System.Int32 nl() Declaration public static int nl() Returns Type Description System.Int32 nocbreak() Declaration public static int nocbreak() Returns Type Description System.Int32 noecho() Declaration public static int noecho() Returns Type Description System.Int32 nonl() Declaration public static int nonl() Returns Type Description System.Int32 noqiflush() Declaration public static void noqiflush() noraw() Declaration public static int noraw() Returns Type Description System.Int32 notimeout(IntPtr, Boolean) Declaration public static int notimeout(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 qiflush() Declaration public static void qiflush() raw() Declaration public static int raw() Returns Type Description System.Int32 redrawwin(IntPtr) Declaration public static int redrawwin(IntPtr win) Parameters Type Name Description System.IntPtr win Returns Type Description System.Int32 refresh() Declaration public static int refresh() Returns Type Description System.Int32 scrollok(IntPtr, Boolean) Declaration public static int scrollok(IntPtr win, bool bf) Parameters Type Name Description System.IntPtr win System.Boolean bf Returns Type Description System.Int32 setlocale(Int32, String) Declaration public static int setlocale(int cate, string locale) Parameters Type Name Description System.Int32 cate System.String locale Returns Type Description System.Int32 setscrreg(Int32, Int32) Declaration public static int setscrreg(int top, int bot) Parameters Type Name Description System.Int32 top System.Int32 bot Returns Type Description System.Int32 start_color() Declaration public static int start_color() Returns Type Description System.Int32 StartColor() Declaration public static int StartColor() Returns Type Description System.Int32 timeout(Int32) Declaration public static int timeout(int delay) Parameters Type Name Description System.Int32 delay Returns Type Description System.Int32 typeahead(IntPtr) Declaration public static int typeahead(IntPtr fd) Parameters Type Name Description System.IntPtr fd Returns Type Description System.Int32 ungetch(Int32) Declaration public static int ungetch(int ch) Parameters Type Name Description System.Int32 ch Returns Type Description System.Int32 ungetmouse(ref Curses.MouseEvent) Declaration public static uint ungetmouse(ref Curses.MouseEvent ev) Parameters Type Name Description Curses.MouseEvent ev Returns Type Description System.UInt32 use_default_colors() Declaration public static int use_default_colors() Returns Type Description System.Int32 UseDefaultColors() Declaration public static int UseDefaultColors() Returns Type Description System.Int32 waddch(IntPtr, Int32) Declaration public static int waddch(IntPtr win, int ch) Parameters Type Name Description System.IntPtr win System.Int32 ch Returns Type Description System.Int32 wmove(IntPtr, Int32, Int32) Declaration public static int wmove(IntPtr win, int line, int col) Parameters Type Name Description System.IntPtr win System.Int32 line System.Int32 col Returns Type Description System.Int32 wnoutrefresh(IntPtr) Declaration public static int wnoutrefresh(IntPtr win) Parameters Type Name Description System.IntPtr win Returns Type Description System.Int32 wrefresh(IntPtr) Declaration public static int wrefresh(IntPtr win) Parameters Type Name Description System.IntPtr win Returns Type Description System.Int32 wsetscrreg(IntPtr, Int32, Int32) Declaration public static int wsetscrreg(IntPtr win, int top, int bot) Parameters Type Name Description System.IntPtr win System.Int32 top System.Int32 bot Returns Type Description System.Int32 wtimeout(IntPtr, Int32) Declaration public static int wtimeout(IntPtr win, int delay) Parameters Type Name Description System.IntPtr win System.Int32 delay Returns Type Description System.Int32" }, "api/Terminal.Gui/Unix.Terminal.Curses.MouseEvent.html": { "href": "api/Terminal.Gui/Unix.Terminal.Curses.MouseEvent.html", @@ -372,7 +372,7 @@ "api/UICatalog/UICatalog.Binding.html": { "href": "api/UICatalog/UICatalog.Binding.html", "title": "Class Binding", - "keywords": "Class Binding Inheritance System.Object Binding Namespace : UICatalog Assembly : UICatalog.dll Syntax public class Binding : object Constructors Binding(View, String, View, String, IValueConverter) Declaration public Binding(View source, string sourcePropertyName, View target, string targetPropertyName, IValueConverter valueConverter = null) Parameters Type Name Description View source System.String sourcePropertyName View target System.String targetPropertyName IValueConverter valueConverter Properties Source Declaration public View Source { get; } Property Value Type Description View SourcePropertyName Declaration public string SourcePropertyName { get; } Property Value Type Description System.String Target Declaration public View Target { get; } Property Value Type Description View TargetPropertyName Declaration public string TargetPropertyName { get; } Property Value Type Description System.String" + "keywords": "Class Binding Inheritance System.Object Binding Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : UICatalog Assembly : UICatalog.dll Syntax public class Binding Constructors Binding(View, String, View, String, IValueConverter) Declaration public Binding(View source, string sourcePropertyName, View target, string targetPropertyName, IValueConverter valueConverter = null) Parameters Type Name Description View source System.String sourcePropertyName View target System.String targetPropertyName IValueConverter valueConverter Properties Source Declaration public View Source { get; } Property Value Type Description View SourcePropertyName Declaration public string SourcePropertyName { get; } Property Value Type Description System.String Target Declaration public View Target { get; } Property Value Type Description View TargetPropertyName Declaration public string TargetPropertyName { get; } Property Value Type Description System.String" }, "api/UICatalog/UICatalog.html": { "href": "api/UICatalog/UICatalog.html", @@ -387,32 +387,32 @@ "api/UICatalog/UICatalog.ListWrapperConverter.html": { "href": "api/UICatalog/UICatalog.ListWrapperConverter.html", "title": "Class ListWrapperConverter", - "keywords": "Class ListWrapperConverter Inheritance System.Object ListWrapperConverter Implements IValueConverter Namespace : UICatalog Assembly : UICatalog.dll Syntax public class ListWrapperConverter : object, IValueConverter Methods Convert(Object, Object) Declaration public object Convert(object value, object parameter = null) Parameters Type Name Description System.Object value System.Object parameter Returns Type Description System.Object Implements IValueConverter" + "keywords": "Class ListWrapperConverter Inheritance System.Object ListWrapperConverter Implements IValueConverter Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : UICatalog Assembly : UICatalog.dll Syntax public class ListWrapperConverter : IValueConverter Methods Convert(Object, Object) Declaration public object Convert(object value, object parameter = null) Parameters Type Name Description System.Object value System.Object parameter Returns Type Description System.Object Implements IValueConverter" }, "api/UICatalog/UICatalog.Scenario.html": { "href": "api/UICatalog/UICatalog.Scenario.html", "title": "Class Scenario", - "keywords": "Class Scenario Base class for each demo/scenario. To define a new scenario: Create a new .cs file in the Scenarios directory that derives from Scenario . Annotate the Scenario derived class with a attribute specifying the scenario's name and description. Add one or more Scenario.ScenarioCategory attributes to the class specifying which categories the sceanrio belongs to. If you don't specify a category the sceanrio will show up in \"All\". Implement the Setup() override which will be called when a user selects the scenario to run. Optionally, implement the and/or Run() overrides to provide a custom implementation. The UI Catalog program uses reflection to find all scenarios and adds them to the ListViews. Press ENTER to run the selected scenario. Press CTRL-Q to exit it. / Inheritance System.Object Scenario Namespace : UICatalog Assembly : UICatalog.dll Syntax public class Scenario : IDisposable Examples The example below is provided in the Scenarios directory as a generic sample that can be copied and re-named: using Terminal.Gui; namespace UICatalog { [ScenarioMetadata (Name: \"Generic\", Description: \"Generic sample - A template for creating new Scenarios\")] [ScenarioCategory (\"Controls\")] class MyScenario : Scenario { public override void Setup () { // Put your scenario code here, e.g. Win.Add (new Button (\"Press me!\") { X = Pos.Center (), Y = Pos.Center (), Clicked = () => MessageBox.Query (20, 7, \"Hi\", \"Neat?\", \"Yes\", \"No\") }); } } } Properties Top The Top level for the Scenario . This should be set to Top in most cases. Declaration public Toplevel Top { get; set; } Property Value Type Description Toplevel Win The Window for the Scenario . This should be set within the Top in most cases. Declaration public Window Win { get; set; } Property Value Type Description Window Methods Dispose() Declaration public void Dispose() Dispose(Boolean) Declaration protected virtual void Dispose(bool disposing) Parameters Type Name Description System.Boolean disposing GetCategories() Helper function to get the list of categories a Scenario belongs to (defined in Scenario.ScenarioCategory ) Declaration public List GetCategories() Returns Type Description List < System.String > list of category names GetDerivedClasses() Returns an instance of each Scenario defined in the project. https://stackoverflow.com/questions/5411694/get-all-inherited-classes-of-an-abstract-class Declaration public static List GetDerivedClasses() Returns Type Description List < Type > Type Parameters Name Description T GetDescription() Helper to get the Scenario Description (defined in Scenario.ScenarioMetadata ) Declaration public string GetDescription() Returns Type Description System.String GetName() Helper to get the Scenario Name (defined in Scenario.ScenarioMetadata ) Declaration public string GetName() Returns Type Description System.String Init(Toplevel, ColorScheme) Helper that provides the default Window implementation with a frame and label showing the name of the Scenario and logic to exit back to the Scenario picker UI. Override to provide any Toplevel behavior needed. Declaration public virtual void Init(Toplevel top, ColorScheme colorScheme) Parameters Type Name Description Toplevel top The Toplevel created by the UI Catalog host. ColorScheme colorScheme The colorscheme to use. Remarks Thg base implementation calls Init(ConsoleDriver, IMainLoopDriver) , sets Top to the passed in Toplevel , creates a Window for Win and adds it to Top . Overrides that do not call the base. Run() , must call Init(ConsoleDriver, IMainLoopDriver) before creating any views or calling other Terminal.Gui APIs. RequestStop() Stops the scenario. Override to change shutdown behavior for the Scenario . Declaration public virtual void RequestStop() Run() Runs the Scenario . Override to start the Scenario using a Toplevel different than Top . Declaration public virtual void Run() Remarks Overrides that do not call the base. Run() , must call Shutdown() before returning. Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public virtual void Setup() Remarks This is typically the best place to put scenario logic code. ToString() Declaration public override string ToString() Returns Type Description System.String" + "keywords": "Class Scenario Base class for each demo/scenario. To define a new scenario: Create a new .cs file in the Scenarios directory that derives from Scenario . Annotate the Scenario derived class with a attribute specifying the scenario's name and description. Add one or more Scenario.ScenarioCategory attributes to the class specifying which categories the sceanrio belongs to. If you don't specify a category the sceanrio will show up in \"All\". Implement the Setup() override which will be called when a user selects the scenario to run. Optionally, implement the and/or Run() overrides to provide a custom implementation. The UI Catalog program uses reflection to find all scenarios and adds them to the ListViews. Press ENTER to run the selected scenario. Press CTRL-Q to exit it. / Inheritance System.Object Scenario Implements System.IDisposable Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) Namespace : UICatalog Assembly : UICatalog.dll Syntax public class Scenario : IDisposable Examples The example below is provided in the Scenarios directory as a generic sample that can be copied and re-named: using Terminal.Gui; namespace UICatalog { [ScenarioMetadata (Name: \"Generic\", Description: \"Generic sample - A template for creating new Scenarios\")] [ScenarioCategory (\"Controls\")] class MyScenario : Scenario { public override void Setup () { // Put your scenario code here, e.g. Win.Add (new Button (\"Press me!\") { X = Pos.Center (), Y = Pos.Center (), Clicked = () => MessageBox.Query (20, 7, \"Hi\", \"Neat?\", \"Yes\", \"No\") }); } } } Properties Top The Top level for the Scenario . This should be set to Top in most cases. Declaration public Toplevel Top { get; set; } Property Value Type Description Toplevel Win The Window for the Scenario . This should be set within the Top in most cases. Declaration public Window Win { get; set; } Property Value Type Description Window Methods Dispose() Declaration public void Dispose() Dispose(Boolean) Declaration protected virtual void Dispose(bool disposing) Parameters Type Name Description System.Boolean disposing GetCategories() Helper function to get the list of categories a Scenario belongs to (defined in Scenario.ScenarioCategory ) Declaration public List GetCategories() Returns Type Description System.Collections.Generic.List < System.String > list of category names GetDerivedClasses() Returns an instance of each Scenario defined in the project. https://stackoverflow.com/questions/5411694/get-all-inherited-classes-of-an-abstract-class Declaration public static List GetDerivedClasses() Returns Type Description System.Collections.Generic.List < System.Type > Type Parameters Name Description T GetDescription() Helper to get the Scenario Description (defined in Scenario.ScenarioMetadata ) Declaration public string GetDescription() Returns Type Description System.String GetName() Helper to get the Scenario Name (defined in Scenario.ScenarioMetadata ) Declaration public string GetName() Returns Type Description System.String Init(Toplevel, ColorScheme) Helper that provides the default Window implementation with a frame and label showing the name of the Scenario and logic to exit back to the Scenario picker UI. Override to provide any Toplevel behavior needed. Declaration public virtual void Init(Toplevel top, ColorScheme colorScheme) Parameters Type Name Description Toplevel top The Toplevel created by the UI Catalog host. ColorScheme colorScheme The colorscheme to use. Remarks Thg base implementation calls Init(ConsoleDriver, IMainLoopDriver) , sets Top to the passed in Toplevel , creates a Window for Win and adds it to Top . Overrides that do not call the base. Run() , must call Init(ConsoleDriver, IMainLoopDriver) before creating any views or calling other Terminal.Gui APIs. RequestStop() Stops the scenario. Override to change shutdown behavior for the Scenario . Declaration public virtual void RequestStop() Run() Runs the Scenario . Override to start the Scenario using a Toplevel different than Top . Declaration public virtual void Run() Remarks Overrides that do not call the base. Run() , must call Shutdown() before returning. Setup() Override this to implement the Scenario setup logic (create controls, etc...). Declaration public virtual void Setup() Remarks This is typically the best place to put scenario logic code. ToString() Declaration public override string ToString() Returns Type Description System.String Overrides System.Object.ToString() Implements System.IDisposable" }, "api/UICatalog/UICatalog.Scenario.ScenarioCategory.html": { "href": "api/UICatalog/UICatalog.Scenario.ScenarioCategory.html", "title": "Class Scenario.ScenarioCategory", - "keywords": "Class Scenario.ScenarioCategory Defines the category names used to catagorize a Scenario Inheritance System.Object Scenario.ScenarioCategory Namespace : UICatalog Assembly : UICatalog.dll Syntax public class ScenarioCategory : System.Attribute Constructors ScenarioCategory(String) Declaration public ScenarioCategory(string Name) Parameters Type Name Description System.String Name Properties Name Category Name Declaration public string Name { get; set; } Property Value Type Description System.String Methods GetCategories(Type) Static helper function to get the Scenario Categories given a Type Declaration public static List GetCategories(Type t) Parameters Type Name Description Type t Returns Type Description List < System.String > list of category names GetName(Type) Static helper function to get the Scenario Name given a Type Declaration public static string GetName(Type t) Parameters Type Name Description Type t Returns Type Description System.String Name of the category" + "keywords": "Class Scenario.ScenarioCategory Defines the category names used to catagorize a Scenario Inheritance System.Object System.Attribute Scenario.ScenarioCategory Inherited Members System.Attribute.Equals(System.Object) System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type) System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, System.Boolean) System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type) System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, System.Boolean) System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type) System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, System.Boolean) System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type) System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, System.Boolean) System.Attribute.GetCustomAttributes(System.Reflection.Assembly) System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Boolean) System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type) System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, System.Boolean) System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo) System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Boolean) System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type) System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, System.Boolean) System.Attribute.GetCustomAttributes(System.Reflection.Module) System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Boolean) System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type) System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, System.Boolean) System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo) System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Boolean) System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type) System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, System.Boolean) System.Attribute.GetHashCode() System.Attribute.IsDefaultAttribute() System.Attribute.IsDefined(System.Reflection.Assembly, System.Type) System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, System.Boolean) System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type) System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, System.Boolean) System.Attribute.IsDefined(System.Reflection.Module, System.Type) System.Attribute.IsDefined(System.Reflection.Module, System.Type, System.Boolean) System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type) System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, System.Boolean) System.Attribute.Match(System.Object) System.Attribute.TypeId System.Object.Equals(System.Object, System.Object) System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : UICatalog Assembly : UICatalog.dll Syntax [AttributeUsage(AttributeTargets.Class, AllowMultiple = true)] public class ScenarioCategory : Attribute Constructors ScenarioCategory(String) Declaration public ScenarioCategory(string Name) Parameters Type Name Description System.String Name Properties Name Category Name Declaration public string Name { get; set; } Property Value Type Description System.String Methods GetCategories(Type) Static helper function to get the Scenario Categories given a Type Declaration public static List GetCategories(Type t) Parameters Type Name Description System.Type t Returns Type Description System.Collections.Generic.List < System.String > list of category names GetName(Type) Static helper function to get the Scenario Name given a Type Declaration public static string GetName(Type t) Parameters Type Name Description System.Type t Returns Type Description System.String Name of the category" }, "api/UICatalog/UICatalog.Scenario.ScenarioMetadata.html": { "href": "api/UICatalog/UICatalog.Scenario.ScenarioMetadata.html", "title": "Class Scenario.ScenarioMetadata", - "keywords": "Class Scenario.ScenarioMetadata Defines the metadata (Name and Description) for a Scenario Inheritance System.Object Scenario.ScenarioMetadata Namespace : UICatalog Assembly : UICatalog.dll Syntax public class ScenarioMetadata : System.Attribute Constructors ScenarioMetadata(String, String) Declaration public ScenarioMetadata(string Name, string Description) Parameters Type Name Description System.String Name System.String Description Properties Description Scenario Description Declaration public string Description { get; set; } Property Value Type Description System.String Name Scenario Name Declaration public string Name { get; set; } Property Value Type Description System.String Methods GetDescription(Type) Static helper function to get the Scenario Description given a Type Declaration public static string GetDescription(Type t) Parameters Type Name Description Type t Returns Type Description System.String GetName(Type) Static helper function to get the Scenario Name given a Type Declaration public static string GetName(Type t) Parameters Type Name Description Type t Returns Type Description System.String" + "keywords": "Class Scenario.ScenarioMetadata Defines the metadata (Name and Description) for a Scenario Inheritance System.Object System.Attribute Scenario.ScenarioMetadata Inherited Members System.Attribute.Equals(System.Object) System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type) System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, System.Boolean) System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type) System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, System.Boolean) System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type) System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, System.Boolean) System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type) System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, System.Boolean) System.Attribute.GetCustomAttributes(System.Reflection.Assembly) System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Boolean) System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type) System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, System.Boolean) System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo) System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Boolean) System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type) System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, System.Boolean) System.Attribute.GetCustomAttributes(System.Reflection.Module) System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Boolean) System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type) System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, System.Boolean) System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo) System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Boolean) System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type) System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, System.Boolean) System.Attribute.GetHashCode() System.Attribute.IsDefaultAttribute() System.Attribute.IsDefined(System.Reflection.Assembly, System.Type) System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, System.Boolean) System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type) System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, System.Boolean) System.Attribute.IsDefined(System.Reflection.Module, System.Type) System.Attribute.IsDefined(System.Reflection.Module, System.Type, System.Boolean) System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type) System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, System.Boolean) System.Attribute.Match(System.Object) System.Attribute.TypeId System.Object.Equals(System.Object, System.Object) System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : UICatalog Assembly : UICatalog.dll Syntax [AttributeUsage(AttributeTargets.Class)] public class ScenarioMetadata : Attribute Constructors ScenarioMetadata(String, String) Declaration public ScenarioMetadata(string Name, string Description) Parameters Type Name Description System.String Name System.String Description Properties Description Scenario Description Declaration public string Description { get; set; } Property Value Type Description System.String Name Scenario Name Declaration public string Name { get; set; } Property Value Type Description System.String Methods GetDescription(Type) Static helper function to get the Scenario Description given a Type Declaration public static string GetDescription(Type t) Parameters Type Name Description System.Type t Returns Type Description System.String GetName(Type) Static helper function to get the Scenario Name given a Type Declaration public static string GetName(Type t) Parameters Type Name Description System.Type t Returns Type Description System.String" }, "api/UICatalog/UICatalog.UICatalogApp.html": { "href": "api/UICatalog/UICatalog.UICatalogApp.html", "title": "Class UICatalogApp", - "keywords": "Class UICatalogApp UI Catalog is a comprehensive sample app and scenario library for Terminal.Gui Inheritance System.Object UICatalogApp Namespace : UICatalog Assembly : UICatalog.dll Syntax public class UICatalogApp : object" + "keywords": "Class UICatalogApp UI Catalog is a comprehensive sample app and scenario library for Terminal.Gui Inheritance System.Object UICatalogApp Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : UICatalog Assembly : UICatalog.dll Syntax public class UICatalogApp" }, "api/UICatalog/UICatalog.UStringValueConverter.html": { "href": "api/UICatalog/UICatalog.UStringValueConverter.html", "title": "Class UStringValueConverter", - "keywords": "Class UStringValueConverter Inheritance System.Object UStringValueConverter Implements IValueConverter Namespace : UICatalog Assembly : UICatalog.dll Syntax public class UStringValueConverter : object, IValueConverter Methods Convert(Object, Object) Declaration public object Convert(object value, object parameter = null) Parameters Type Name Description System.Object value System.Object parameter Returns Type Description System.Object Implements IValueConverter" + "keywords": "Class UStringValueConverter Inheritance System.Object UStringValueConverter Implements IValueConverter Inherited Members System.Object.Equals(System.Object) System.Object.Equals(System.Object, System.Object) System.Object.GetHashCode() System.Object.GetType() System.Object.MemberwiseClone() System.Object.ReferenceEquals(System.Object, System.Object) System.Object.ToString() Namespace : UICatalog Assembly : UICatalog.dll Syntax public class UStringValueConverter : IValueConverter Methods Convert(Object, Object) Declaration public object Convert(object value, object parameter = null) Parameters Type Name Description System.Object value System.Object parameter Returns Type Description System.Object Implements IValueConverter" }, "articles/index.html": { "href": "articles/index.html", @@ -442,11 +442,11 @@ "index.html": { "href": "index.html", "title": "Terminal.Gui - Terminal UI toolkit for .NET", - "keywords": "Terminal.Gui - Terminal UI toolkit for .NET A simple UI toolkit for .NET, .NET Core, and Mono that works on Windows, the Mac, and Linux/Unix. We are actively converging on a major update to Terminal.Gui. The most recent released Nuget package is version 0.81 which is way behind master . This README and the API Documentation refers to the latest build from master . If you want the latest and greatest functionality, clone and build locally. Otherwise 0.81 is quite stable, but the documentation may not match. Terminal.Gui Project on GitHub Terminal.Gui API Documentation API Reference Terminal.Gui API Overview Keyboard Event Processing Event Processing and the Application Main Loop UI Catalog UI Catalog is a comprehensive sample library for Terminal.Gui. It provides a simple UI for adding to the catalog of scenarios. UI Catalog API Reference UI Catalog Source" + "keywords": "Terminal.Gui - Terminal UI toolkit for .NET A simple UI toolkit for .NET, .NET Core, and Mono that works on Windows, the Mac, and Linux/Unix. The most recent released Nuget package is version 0.90 which is the \"Stable Feature Complete\" pre-release of 1.0. Terminal.Gui Project on GitHub Terminal.Gui API Documentation API Reference Terminal.Gui API Overview Keyboard Event Processing Event Processing and the Application Main Loop UI Catalog UI Catalog is a comprehensive sample library for Terminal.Gui. It provides a simple UI for adding to the catalog of scenarios. UI Catalog API Reference UI Catalog Source" }, "README.html": { "href": "README.html", "title": "To Generate the Docs", - "keywords": "This folder generates the API docs for Terminal.Gui To Generate the Docs Do a Release build on master . This will cause all /// references to be updated. Change in to the docfx/ directory. Type docfx --metadata to generate metadata Type docfx --serve to generate the docs and start a local webserver for testing. If docfx fails with a Stackoverflow error. Just run it again. And again. Sometimes it takes a few times. If that doesn't work, create a fresh clone or delete the docfx/api , docfx/obj , and docs/ folders and run the steps above again." + "keywords": "This folder generates the API docs for Terminal.Gui. The API documentation is generated using the DocFX tool . The output of docfx gets put into the ./docs folder which is then checked in. The ./docs folder is then picked up by Github Pages and published to Miguel's Github Pages ( https://migueldeicaza.github.io/gui.cs/ ). To Generate the Docs Install DotFX https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html From the solution root type ../docfx/build.ps1 Browse to http://localhost:8080 and verify everything looks good. Hit ctrl-c to stop the script. Commit to git. If docfx fails with a Stackoverflow error. Just run it again. And again. Sometimes it takes a few times. If that doesn't work, create a fresh clone or delete the docfx/api , docfx/obj , and docs/ folders and run the steps above again." } } \ No newline at end of file diff --git a/docs/manifest.json b/docs/manifest.json index b68ed9262..bff5500f2 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -1,6 +1,6 @@ { "homepages": [], - "source_base_path": "C:/Users/charlie/s/gui.cs/docfx", + "source_base_path": "C:/Users/ckindel/s/gui.cs/docfx", "xrefmap": "xrefmap.yml", "files": [ { @@ -18,7 +18,7 @@ "output": { ".html": { "relative_path": "README.html", - "hash": "j2UvA6L0XLJ6h5ZOpwvjlQ==" + "hash": "ev8XMddJHQpjAxQfEx3K+g==" } }, "is_incremental": false, @@ -78,7 +78,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.Button.html", - "hash": "4Ncfw9VzzJB+fDqpjnnz6w==" + "hash": "MGDPnRO4DDQCAW5qssWgEg==" } }, "is_incremental": false, @@ -90,7 +90,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.CheckBox.html", - "hash": "E6KTwmNOF1OaIRKpH/Tktw==" + "hash": "2wOcWTizruL1IjY3a4y9Cg==" } }, "is_incremental": false, @@ -150,7 +150,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.ComboBox.html", - "hash": "hvkQbeAqZGRQkG1+FFHPJA==" + "hash": "Xgf4xAW3MKUDvQLcH38xNg==" } }, "is_incremental": false, @@ -186,7 +186,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.DateField.html", - "hash": "qmDYWej83q+DDBccwJIjmw==" + "hash": "qjQFqRZU/FlE8iTQ7gSTyg==" } }, "is_incremental": false, @@ -210,7 +210,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.Dialog.html", - "hash": "cdXS40u6ucrWGC9VUfqJHQ==" + "hash": "ai6thSd8ww48dy4ntcnezA==" } }, "is_incremental": false, @@ -270,7 +270,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.FileDialog.html", - "hash": "uhS2y6IJOpUbMcc7DREudA==" + "hash": "dmr8gIkWUApGKf7zk9HaGA==" } }, "is_incremental": false, @@ -282,7 +282,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.FrameView.html", - "hash": "oohQ5a3RnnBtxyeNv8zTYg==" + "hash": "S9ZHUnRU90aJ7ZQfYfS5Fg==" } }, "is_incremental": false, @@ -294,7 +294,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.HexView.html", - "hash": "Cb90u3cifWCBhMEK1fS0iQ==" + "hash": "4BTtNnROMXltXzUDMrLScg==" } }, "is_incremental": false, @@ -366,7 +366,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.Label.html", - "hash": "YKXlPLPSo0erQmDwwC/uww==" + "hash": "uSyh92D3WOYpbSHMGaHm9A==" } }, "is_incremental": false, @@ -390,7 +390,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.ListView.html", - "hash": "dnot9dduyoNvwUO2c2r6Jg==" + "hash": "tiujqjo270jmYwYrkOIp3w==" } }, "is_incremental": false, @@ -438,7 +438,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.MenuBar.html", - "hash": "shpyEveZgQ57Wla5EAnBWA==" + "hash": "Jiu/7p2PWC3s5Hv6M3Yb4Q==" } }, "is_incremental": false, @@ -450,7 +450,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.MenuBarItem.html", - "hash": "SmMNdE/kMwAI7VakptezvQ==" + "hash": "AEwNmo1AFJgd8UT2ICeBdw==" } }, "is_incremental": false, @@ -462,7 +462,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.MenuItem.html", - "hash": "p2zTuywZuQj5VvHu2OkbNw==" + "hash": "pUJF1Ucdd+dAjd54tXhq/Q==" } }, "is_incremental": false, @@ -510,7 +510,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.MouseFlags.html", - "hash": "QasFv753z1lsjT7sjhR9Pw==" + "hash": "3974x3u7m616HhWDOaIGvw==" } }, "is_incremental": false, @@ -534,7 +534,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.OpenDialog.html", - "hash": "lAitEFswEcj0anix+Sj8Mw==" + "hash": "wPb+pub4Fbg+8qXIlIjW5g==" } }, "is_incremental": false, @@ -570,7 +570,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.ProgressBar.html", - "hash": "TCoarwIWfL26L95zoXj/oQ==" + "hash": "cIgNlDHScc2ZbfbDSjViHw==" } }, "is_incremental": false, @@ -594,7 +594,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.RadioGroup.html", - "hash": "+/M4SWa0E8UmnNBMG6VhvA==" + "hash": "ACH8iMv6ctRvgf7eYzL7Tw==" } }, "is_incremental": false, @@ -630,7 +630,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.SaveDialog.html", - "hash": "0vkXU3vUUY8X+aZ1MpyiSg==" + "hash": "dRJK6tq1HjrhsML7NZhZuA==" } }, "is_incremental": false, @@ -642,7 +642,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.ScrollBarView.html", - "hash": "v6uY+p98WPN80KvLPWJO1w==" + "hash": "GHCkZfgoqRdqlK8tPXGb8A==" } }, "is_incremental": false, @@ -654,7 +654,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.ScrollView.html", - "hash": "yHhx66yBciEMWltAxHvE8w==" + "hash": "z+Q/6YffWSIt1jZ0dA7rTg==" } }, "is_incremental": false, @@ -678,7 +678,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.StatusBar.html", - "hash": "GdSUMVXX3iVE3WcX6yT7+g==" + "hash": "2gjTR2GuA1aRdbSeI7qdzQ==" } }, "is_incremental": false, @@ -714,7 +714,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.TextField.html", - "hash": "zxUhf/H/fQENa26l13eqqA==" + "hash": "eFNfdQmbf+a4IK3y8D7sTQ==" } }, "is_incremental": false, @@ -726,7 +726,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.TextFormatter.html", - "hash": "RN/mf/xvJefyuhKTJZExag==" + "hash": "oC59pqrEg2JpycU4CLutJA==" } }, "is_incremental": false, @@ -738,7 +738,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.TextView.html", - "hash": "B69NtMoqAoZEyJuVIjr1tw==" + "hash": "/i4H4LUXJ5BJBgbpU4r7Cw==" } }, "is_incremental": false, @@ -750,7 +750,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.TimeField.html", - "hash": "Jn/4ArAcmhhwViwRw57oDg==" + "hash": "pBhFs/Z1W7O5ykxZeBiWKg==" } }, "is_incremental": false, @@ -762,7 +762,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.Toplevel.html", - "hash": "dv+oXk+eNypc7AVR6IBiOw==" + "hash": "BfiH5bxJ+FGiUAI6uvwN2Q==" } }, "is_incremental": false, @@ -822,7 +822,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.View.html", - "hash": "amNNCa2+fN5n+87ph6yPlA==" + "hash": "mLYmfCPwtUlME2Cd8xyjwQ==" } }, "is_incremental": false, @@ -834,7 +834,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Terminal.Gui.Window.html", - "hash": "fLvtZIqL2Ic7U1YMU1TSaQ==" + "hash": "K3mbrO+N7wyuNIgf34XYWg==" } }, "is_incremental": false, @@ -858,7 +858,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Unix.Terminal.Curses.Event.html", - "hash": "Kn7DhdxDQmND4MY3YlvVxA==" + "hash": "M/hQtS13QnIKLZRbiJywYA==" } }, "is_incremental": false, @@ -894,7 +894,7 @@ "output": { ".html": { "relative_path": "api/Terminal.Gui/Unix.Terminal.Curses.html", - "hash": "aDGNpV97QbkUh+wiN0L13Q==" + "hash": "UWkh+wjXTijxDw5c7pR4QA==" } }, "is_incremental": false, @@ -930,7 +930,7 @@ "output": { ".html": { "relative_path": "api/UICatalog/UICatalog.Binding.html", - "hash": "lSyWedk13AZFQhQvG45RmA==" + "hash": "hRZnEdkrZaSyuSBpZofU2g==" } }, "is_incremental": false, @@ -954,7 +954,7 @@ "output": { ".html": { "relative_path": "api/UICatalog/UICatalog.ListWrapperConverter.html", - "hash": "5vQooCiXKBC4/a61ozSxBw==" + "hash": "9RywfEKpSeKUcVQxF+Z3fQ==" } }, "is_incremental": false, @@ -966,7 +966,7 @@ "output": { ".html": { "relative_path": "api/UICatalog/UICatalog.Scenario.ScenarioCategory.html", - "hash": "DdR0YanBQteoEXo5UIB4OQ==" + "hash": "zKkWSPZIhBeS7559bNJMoQ==" } }, "is_incremental": false, @@ -978,7 +978,7 @@ "output": { ".html": { "relative_path": "api/UICatalog/UICatalog.Scenario.ScenarioMetadata.html", - "hash": "fkWznfApYftZgPeJebHlTQ==" + "hash": "Va/z9O9Xnw/zx9R8YubMDA==" } }, "is_incremental": false, @@ -990,7 +990,7 @@ "output": { ".html": { "relative_path": "api/UICatalog/UICatalog.Scenario.html", - "hash": "EW4CDdmIOp5t8BlqkW0tyg==" + "hash": "A612hD8hkmTarO/j1qn7Tw==" } }, "is_incremental": false, @@ -1002,7 +1002,7 @@ "output": { ".html": { "relative_path": "api/UICatalog/UICatalog.UICatalogApp.html", - "hash": "g0IPUEiGUJK/s069keRXOg==" + "hash": "NP9irLG7E5q8E+9+ITZdcQ==" } }, "is_incremental": false, @@ -1014,7 +1014,7 @@ "output": { ".html": { "relative_path": "api/UICatalog/UICatalog.UStringValueConverter.html", - "hash": "dDeISS7N/HY9hUFDaI5NCQ==" + "hash": "kPIeYlH2E3G7kAAIeaWvhQ==" } }, "is_incremental": false, @@ -1147,7 +1147,7 @@ "output": { ".html": { "relative_path": "index.html", - "hash": "RGfz5C9zHOtZsyNzbkUcqw==" + "hash": "41E/fuGu2/bhbW30vTXrCQ==" } }, "is_incremental": false, diff --git a/docs/xrefmap.yml b/docs/xrefmap.yml index 890130b89..9145e768f 100644 --- a/docs/xrefmap.yml +++ b/docs/xrefmap.yml @@ -435,7 +435,7 @@ references: - uid: Terminal.Gui.Button.Clicked name: Clicked href: api/Terminal.Gui/Terminal.Gui.Button.html#Terminal_Gui_Button_Clicked - commentId: F:Terminal.Gui.Button.Clicked + commentId: E:Terminal.Gui.Button.Clicked fullName: Terminal.Gui.Button.Clicked nameWithType: Button.Clicked - uid: Terminal.Gui.Button.IsDefault @@ -660,7 +660,7 @@ references: - uid: Terminal.Gui.CheckBox.Toggled name: Toggled href: api/Terminal.Gui/Terminal.Gui.CheckBox.html#Terminal_Gui_CheckBox_Toggled - commentId: F:Terminal.Gui.CheckBox.Toggled + commentId: E:Terminal.Gui.CheckBox.Toggled fullName: Terminal.Gui.CheckBox.Toggled nameWithType: CheckBox.Toggled - uid: Terminal.Gui.Clipboard @@ -1109,7 +1109,7 @@ references: - uid: Terminal.Gui.ComboBox.OpenSelectedItem name: OpenSelectedItem href: api/Terminal.Gui/Terminal.Gui.ComboBox.html#Terminal_Gui_ComboBox_OpenSelectedItem - commentId: F:Terminal.Gui.ComboBox.OpenSelectedItem + commentId: E:Terminal.Gui.ComboBox.OpenSelectedItem fullName: Terminal.Gui.ComboBox.OpenSelectedItem nameWithType: ComboBox.OpenSelectedItem - uid: Terminal.Gui.ComboBox.ProcessKey(Terminal.Gui.KeyEvent) @@ -1154,7 +1154,7 @@ references: - uid: Terminal.Gui.ComboBox.SelectedItemChanged name: SelectedItemChanged href: api/Terminal.Gui/Terminal.Gui.ComboBox.html#Terminal_Gui_ComboBox_SelectedItemChanged - commentId: F:Terminal.Gui.ComboBox.SelectedItemChanged + commentId: E:Terminal.Gui.ComboBox.SelectedItemChanged fullName: Terminal.Gui.ComboBox.SelectedItemChanged nameWithType: ComboBox.SelectedItemChanged - uid: Terminal.Gui.ComboBox.SetSource(System.Collections.IList) @@ -1782,7 +1782,7 @@ references: - uid: Terminal.Gui.DateField.DateChanged name: DateChanged href: api/Terminal.Gui/Terminal.Gui.DateField.html#Terminal_Gui_DateField_DateChanged - commentId: F:Terminal.Gui.DateField.DateChanged + commentId: E:Terminal.Gui.DateField.DateChanged fullName: Terminal.Gui.DateField.DateChanged nameWithType: DateField.DateChanged - uid: Terminal.Gui.DateField.IsShortFormat @@ -4460,7 +4460,7 @@ references: - uid: Terminal.Gui.Label.Clicked name: Clicked href: api/Terminal.Gui/Terminal.Gui.Label.html#Terminal_Gui_Label_Clicked - commentId: F:Terminal.Gui.Label.Clicked + commentId: E:Terminal.Gui.Label.Clicked fullName: Terminal.Gui.Label.Clicked nameWithType: Label.Clicked - uid: Terminal.Gui.Label.OnMouseEvent(Terminal.Gui.MouseEvent) @@ -4735,7 +4735,7 @@ references: - uid: Terminal.Gui.ListView.OpenSelectedItem name: OpenSelectedItem href: api/Terminal.Gui/Terminal.Gui.ListView.html#Terminal_Gui_ListView_OpenSelectedItem - commentId: F:Terminal.Gui.ListView.OpenSelectedItem + commentId: E:Terminal.Gui.ListView.OpenSelectedItem fullName: Terminal.Gui.ListView.OpenSelectedItem nameWithType: ListView.OpenSelectedItem - uid: Terminal.Gui.ListView.PositionCursor @@ -4793,7 +4793,7 @@ references: - uid: Terminal.Gui.ListView.SelectedItemChanged name: SelectedItemChanged href: api/Terminal.Gui/Terminal.Gui.ListView.html#Terminal_Gui_ListView_SelectedItemChanged - commentId: F:Terminal.Gui.ListView.SelectedItemChanged + commentId: E:Terminal.Gui.ListView.SelectedItemChanged fullName: Terminal.Gui.ListView.SelectedItemChanged nameWithType: ListView.SelectedItemChanged - uid: Terminal.Gui.ListView.SetSource(System.Collections.IList) @@ -5205,13 +5205,13 @@ references: - uid: Terminal.Gui.MenuBar.MenuClosing name: MenuClosing href: api/Terminal.Gui/Terminal.Gui.MenuBar.html#Terminal_Gui_MenuBar_MenuClosing - commentId: F:Terminal.Gui.MenuBar.MenuClosing + commentId: E:Terminal.Gui.MenuBar.MenuClosing fullName: Terminal.Gui.MenuBar.MenuClosing nameWithType: MenuBar.MenuClosing - uid: Terminal.Gui.MenuBar.MenuOpening name: MenuOpening href: api/Terminal.Gui/Terminal.Gui.MenuBar.html#Terminal_Gui_MenuBar_MenuOpening - commentId: F:Terminal.Gui.MenuBar.MenuOpening + commentId: E:Terminal.Gui.MenuBar.MenuOpening fullName: Terminal.Gui.MenuBar.MenuOpening nameWithType: MenuBar.MenuOpening - uid: Terminal.Gui.MenuBar.Menus @@ -5632,12 +5632,6 @@ references: isSpec: "True" fullName: Terminal.Gui.MenuItem.Parent nameWithType: MenuItem.Parent -- uid: Terminal.Gui.MenuItem.ShortCut - name: ShortCut - href: api/Terminal.Gui/Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_ShortCut - commentId: F:Terminal.Gui.MenuItem.ShortCut - fullName: Terminal.Gui.MenuItem.ShortCut - nameWithType: MenuItem.ShortCut - uid: Terminal.Gui.MenuItem.Title name: Title href: api/Terminal.Gui/Terminal.Gui.MenuItem.html#Terminal_Gui_MenuItem_Title @@ -5948,6 +5942,18 @@ references: commentId: F:Terminal.Gui.MouseFlags.WheeledDown fullName: Terminal.Gui.MouseFlags.WheeledDown nameWithType: MouseFlags.WheeledDown +- uid: Terminal.Gui.MouseFlags.WheeledLeft + name: WheeledLeft + href: api/Terminal.Gui/Terminal.Gui.MouseFlags.html#Terminal_Gui_MouseFlags_WheeledLeft + commentId: F:Terminal.Gui.MouseFlags.WheeledLeft + fullName: Terminal.Gui.MouseFlags.WheeledLeft + nameWithType: MouseFlags.WheeledLeft +- uid: Terminal.Gui.MouseFlags.WheeledRight + name: WheeledRight + href: api/Terminal.Gui/Terminal.Gui.MouseFlags.html#Terminal_Gui_MouseFlags_WheeledRight + commentId: F:Terminal.Gui.MouseFlags.WheeledRight + fullName: Terminal.Gui.MouseFlags.WheeledRight + nameWithType: MouseFlags.WheeledRight - uid: Terminal.Gui.MouseFlags.WheeledUp name: WheeledUp href: api/Terminal.Gui/Terminal.Gui.MouseFlags.html#Terminal_Gui_MouseFlags_WheeledUp @@ -6746,6 +6752,19 @@ references: isSpec: "True" fullName: Terminal.Gui.RadioGroup.Redraw nameWithType: RadioGroup.Redraw +- uid: Terminal.Gui.RadioGroup.Refresh + name: Refresh() + href: api/Terminal.Gui/Terminal.Gui.RadioGroup.html#Terminal_Gui_RadioGroup_Refresh + commentId: M:Terminal.Gui.RadioGroup.Refresh + fullName: Terminal.Gui.RadioGroup.Refresh() + nameWithType: RadioGroup.Refresh() +- uid: Terminal.Gui.RadioGroup.Refresh* + name: Refresh + href: api/Terminal.Gui/Terminal.Gui.RadioGroup.html#Terminal_Gui_RadioGroup_Refresh_ + commentId: Overload:Terminal.Gui.RadioGroup.Refresh + isSpec: "True" + fullName: Terminal.Gui.RadioGroup.Refresh + nameWithType: RadioGroup.Refresh - uid: Terminal.Gui.RadioGroup.SelectedItem name: SelectedItem href: api/Terminal.Gui/Terminal.Gui.RadioGroup.html#Terminal_Gui_RadioGroup_SelectedItem @@ -6762,7 +6781,7 @@ references: - uid: Terminal.Gui.RadioGroup.SelectedItemChanged name: SelectedItemChanged href: api/Terminal.Gui/Terminal.Gui.RadioGroup.html#Terminal_Gui_RadioGroup_SelectedItemChanged - commentId: F:Terminal.Gui.RadioGroup.SelectedItemChanged + commentId: E:Terminal.Gui.RadioGroup.SelectedItemChanged fullName: Terminal.Gui.RadioGroup.SelectedItemChanged nameWithType: RadioGroup.SelectedItemChanged - uid: Terminal.Gui.RadioGroup.SelectedItemChangedArgs @@ -7421,9 +7440,22 @@ references: - uid: Terminal.Gui.ScrollBarView.ChangedPosition name: ChangedPosition href: api/Terminal.Gui/Terminal.Gui.ScrollBarView.html#Terminal_Gui_ScrollBarView_ChangedPosition - commentId: F:Terminal.Gui.ScrollBarView.ChangedPosition + commentId: E:Terminal.Gui.ScrollBarView.ChangedPosition fullName: Terminal.Gui.ScrollBarView.ChangedPosition nameWithType: ScrollBarView.ChangedPosition +- uid: Terminal.Gui.ScrollBarView.Host + name: Host + href: api/Terminal.Gui/Terminal.Gui.ScrollBarView.html#Terminal_Gui_ScrollBarView_Host + commentId: P:Terminal.Gui.ScrollBarView.Host + fullName: Terminal.Gui.ScrollBarView.Host + nameWithType: ScrollBarView.Host +- uid: Terminal.Gui.ScrollBarView.Host* + name: Host + href: api/Terminal.Gui/Terminal.Gui.ScrollBarView.html#Terminal_Gui_ScrollBarView_Host_ + commentId: Overload:Terminal.Gui.ScrollBarView.Host + isSpec: "True" + fullName: Terminal.Gui.ScrollBarView.Host + nameWithType: ScrollBarView.Host - uid: Terminal.Gui.ScrollBarView.IsVertical name: IsVertical href: api/Terminal.Gui/Terminal.Gui.ScrollBarView.html#Terminal_Gui_ScrollBarView_IsVertical @@ -7579,6 +7611,19 @@ references: isSpec: "True" fullName: Terminal.Gui.ScrollView.Dispose nameWithType: ScrollView.Dispose +- uid: Terminal.Gui.ScrollView.KeepContentAlwaysInViewport + name: KeepContentAlwaysInViewport + href: api/Terminal.Gui/Terminal.Gui.ScrollView.html#Terminal_Gui_ScrollView_KeepContentAlwaysInViewport + commentId: P:Terminal.Gui.ScrollView.KeepContentAlwaysInViewport + fullName: Terminal.Gui.ScrollView.KeepContentAlwaysInViewport + nameWithType: ScrollView.KeepContentAlwaysInViewport +- uid: Terminal.Gui.ScrollView.KeepContentAlwaysInViewport* + name: KeepContentAlwaysInViewport + href: api/Terminal.Gui/Terminal.Gui.ScrollView.html#Terminal_Gui_ScrollView_KeepContentAlwaysInViewport_ + commentId: Overload:Terminal.Gui.ScrollView.KeepContentAlwaysInViewport + isSpec: "True" + fullName: Terminal.Gui.ScrollView.KeepContentAlwaysInViewport + nameWithType: ScrollView.KeepContentAlwaysInViewport - uid: Terminal.Gui.ScrollView.MouseEvent(Terminal.Gui.MouseEvent) name: MouseEvent(MouseEvent) href: api/Terminal.Gui/Terminal.Gui.ScrollView.html#Terminal_Gui_ScrollView_MouseEvent_Terminal_Gui_MouseEvent_ @@ -8383,7 +8428,7 @@ references: - uid: Terminal.Gui.TextField.TextChanged name: TextChanged href: api/Terminal.Gui/Terminal.Gui.TextField.html#Terminal_Gui_TextField_TextChanged - commentId: F:Terminal.Gui.TextField.TextChanged + commentId: E:Terminal.Gui.TextField.TextChanged fullName: Terminal.Gui.TextField.TextChanged nameWithType: TextField.TextChanged - uid: Terminal.Gui.TextField.Used @@ -8444,6 +8489,19 @@ references: isSpec: "True" fullName: Terminal.Gui.TextFormatter.ClipAndJustify nameWithType: TextFormatter.ClipAndJustify +- uid: Terminal.Gui.TextFormatter.CursorPosition + name: CursorPosition + href: api/Terminal.Gui/Terminal.Gui.TextFormatter.html#Terminal_Gui_TextFormatter_CursorPosition + commentId: P:Terminal.Gui.TextFormatter.CursorPosition + fullName: Terminal.Gui.TextFormatter.CursorPosition + nameWithType: TextFormatter.CursorPosition +- uid: Terminal.Gui.TextFormatter.CursorPosition* + name: CursorPosition + href: api/Terminal.Gui/Terminal.Gui.TextFormatter.html#Terminal_Gui_TextFormatter_CursorPosition_ + commentId: Overload:Terminal.Gui.TextFormatter.CursorPosition + isSpec: "True" + fullName: Terminal.Gui.TextFormatter.CursorPosition + nameWithType: TextFormatter.CursorPosition - uid: Terminal.Gui.TextFormatter.Draw(Terminal.Gui.Rect,Terminal.Gui.Attribute,Terminal.Gui.Attribute) name: Draw(Rect, Attribute, Attribute) href: api/Terminal.Gui/Terminal.Gui.TextFormatter.html#Terminal_Gui_TextFormatter_Draw_Terminal_Gui_Rect_Terminal_Gui_Attribute_Terminal_Gui_Attribute_ @@ -8784,6 +8842,32 @@ references: isSpec: "True" fullName: Terminal.Gui.TextView.MouseEvent nameWithType: TextView.MouseEvent +- uid: Terminal.Gui.TextView.MoveEnd + name: MoveEnd() + href: api/Terminal.Gui/Terminal.Gui.TextView.html#Terminal_Gui_TextView_MoveEnd + commentId: M:Terminal.Gui.TextView.MoveEnd + fullName: Terminal.Gui.TextView.MoveEnd() + nameWithType: TextView.MoveEnd() +- uid: Terminal.Gui.TextView.MoveEnd* + name: MoveEnd + href: api/Terminal.Gui/Terminal.Gui.TextView.html#Terminal_Gui_TextView_MoveEnd_ + commentId: Overload:Terminal.Gui.TextView.MoveEnd + isSpec: "True" + fullName: Terminal.Gui.TextView.MoveEnd + nameWithType: TextView.MoveEnd +- uid: Terminal.Gui.TextView.MoveHome + name: MoveHome() + href: api/Terminal.Gui/Terminal.Gui.TextView.html#Terminal_Gui_TextView_MoveHome + commentId: M:Terminal.Gui.TextView.MoveHome + fullName: Terminal.Gui.TextView.MoveHome() + nameWithType: TextView.MoveHome() +- uid: Terminal.Gui.TextView.MoveHome* + name: MoveHome + href: api/Terminal.Gui/Terminal.Gui.TextView.html#Terminal_Gui_TextView_MoveHome_ + commentId: Overload:Terminal.Gui.TextView.MoveHome + isSpec: "True" + fullName: Terminal.Gui.TextView.MoveHome + nameWithType: TextView.MoveHome - uid: Terminal.Gui.TextView.PositionCursor name: PositionCursor() href: api/Terminal.Gui/Terminal.Gui.TextView.html#Terminal_Gui_TextView_PositionCursor @@ -8865,7 +8949,7 @@ references: - uid: Terminal.Gui.TextView.TextChanged name: TextChanged href: api/Terminal.Gui/Terminal.Gui.TextView.html#Terminal_Gui_TextView_TextChanged - commentId: F:Terminal.Gui.TextView.TextChanged + commentId: E:Terminal.Gui.TextView.TextChanged fullName: Terminal.Gui.TextView.TextChanged nameWithType: TextView.TextChanged - uid: Terminal.Gui.TimeField @@ -8970,7 +9054,7 @@ references: - uid: Terminal.Gui.TimeField.TimeChanged name: TimeChanged href: api/Terminal.Gui/Terminal.Gui.TimeField.html#Terminal_Gui_TimeField_TimeChanged - commentId: F:Terminal.Gui.TimeField.TimeChanged + commentId: E:Terminal.Gui.TimeField.TimeChanged fullName: Terminal.Gui.TimeField.TimeChanged nameWithType: TimeField.TimeChanged - uid: Terminal.Gui.Toplevel @@ -9105,7 +9189,7 @@ references: - uid: Terminal.Gui.Toplevel.Ready name: Ready href: api/Terminal.Gui/Terminal.Gui.Toplevel.html#Terminal_Gui_Toplevel_Ready - commentId: F:Terminal.Gui.Toplevel.Ready + commentId: E:Terminal.Gui.Toplevel.Ready fullName: Terminal.Gui.Toplevel.Ready nameWithType: Toplevel.Ready - uid: Terminal.Gui.Toplevel.Redraw(Terminal.Gui.Rect) @@ -9254,7 +9338,7 @@ references: - uid: Terminal.Gui.View.Added name: Added href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_Added - commentId: F:Terminal.Gui.View.Added + commentId: E:Terminal.Gui.View.Added fullName: Terminal.Gui.View.Added nameWithType: View.Added - uid: Terminal.Gui.View.AddRune(System.Int32,System.Int32,System.Rune) @@ -9406,6 +9490,19 @@ references: isSpec: "True" fullName: Terminal.Gui.View.ColorScheme nameWithType: View.ColorScheme +- uid: Terminal.Gui.View.Data + name: Data + href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_Data + commentId: P:Terminal.Gui.View.Data + fullName: Terminal.Gui.View.Data + nameWithType: View.Data +- uid: Terminal.Gui.View.Data* + name: Data + href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_Data_ + commentId: Overload:Terminal.Gui.View.Data + isSpec: "True" + fullName: Terminal.Gui.View.Data + nameWithType: View.Data - uid: Terminal.Gui.View.Dispose(System.Boolean) name: Dispose(Boolean) href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_Dispose_System_Boolean_ @@ -9422,7 +9519,7 @@ references: - uid: Terminal.Gui.View.DrawContent name: DrawContent href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_DrawContent - commentId: F:Terminal.Gui.View.DrawContent + commentId: E:Terminal.Gui.View.DrawContent fullName: Terminal.Gui.View.DrawContent nameWithType: View.DrawContent - uid: Terminal.Gui.View.DrawFrame(Terminal.Gui.Rect,System.Int32,System.Boolean) @@ -9499,7 +9596,7 @@ references: - uid: Terminal.Gui.View.Enter name: Enter href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_Enter - commentId: F:Terminal.Gui.View.Enter + commentId: E:Terminal.Gui.View.Enter fullName: Terminal.Gui.View.Enter nameWithType: View.Enter - uid: Terminal.Gui.View.Focused @@ -9625,19 +9722,6 @@ references: isSpec: "True" fullName: Terminal.Gui.View.Frame nameWithType: View.Frame -- uid: Terminal.Gui.View.GetEnumerator - name: GetEnumerator() - href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_GetEnumerator - commentId: M:Terminal.Gui.View.GetEnumerator - fullName: Terminal.Gui.View.GetEnumerator() - nameWithType: View.GetEnumerator() -- uid: Terminal.Gui.View.GetEnumerator* - name: GetEnumerator - href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_GetEnumerator_ - commentId: Overload:Terminal.Gui.View.GetEnumerator - isSpec: "True" - fullName: Terminal.Gui.View.GetEnumerator - nameWithType: View.GetEnumerator - uid: Terminal.Gui.View.HasFocus name: HasFocus href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_HasFocus @@ -9738,7 +9822,7 @@ references: - uid: Terminal.Gui.View.KeyDown name: KeyDown href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_KeyDown - commentId: F:Terminal.Gui.View.KeyDown + commentId: E:Terminal.Gui.View.KeyDown fullName: Terminal.Gui.View.KeyDown nameWithType: View.KeyDown - uid: Terminal.Gui.View.KeyEventEventArgs @@ -9789,19 +9873,19 @@ references: - uid: Terminal.Gui.View.KeyPress name: KeyPress href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_KeyPress - commentId: F:Terminal.Gui.View.KeyPress + commentId: E:Terminal.Gui.View.KeyPress fullName: Terminal.Gui.View.KeyPress nameWithType: View.KeyPress - uid: Terminal.Gui.View.KeyUp name: KeyUp href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_KeyUp - commentId: F:Terminal.Gui.View.KeyUp + commentId: E:Terminal.Gui.View.KeyUp fullName: Terminal.Gui.View.KeyUp nameWithType: View.KeyUp - uid: Terminal.Gui.View.LayoutComplete name: LayoutComplete href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete - commentId: F:Terminal.Gui.View.LayoutComplete + commentId: E:Terminal.Gui.View.LayoutComplete fullName: Terminal.Gui.View.LayoutComplete nameWithType: View.LayoutComplete - uid: Terminal.Gui.View.LayoutEventArgs @@ -9826,7 +9910,7 @@ references: - uid: Terminal.Gui.View.LayoutStarted name: LayoutStarted href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_LayoutStarted - commentId: F:Terminal.Gui.View.LayoutStarted + commentId: E:Terminal.Gui.View.LayoutStarted fullName: Terminal.Gui.View.LayoutStarted nameWithType: View.LayoutStarted - uid: Terminal.Gui.View.LayoutStyle @@ -9858,7 +9942,7 @@ references: - uid: Terminal.Gui.View.Leave name: Leave href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_Leave - commentId: F:Terminal.Gui.View.Leave + commentId: E:Terminal.Gui.View.Leave fullName: Terminal.Gui.View.Leave nameWithType: View.Leave - uid: Terminal.Gui.View.MostFocused @@ -9877,13 +9961,13 @@ references: - uid: Terminal.Gui.View.MouseClick name: MouseClick href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_MouseClick - commentId: F:Terminal.Gui.View.MouseClick + commentId: E:Terminal.Gui.View.MouseClick fullName: Terminal.Gui.View.MouseClick nameWithType: View.MouseClick - uid: Terminal.Gui.View.MouseEnter name: MouseEnter href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter - commentId: F:Terminal.Gui.View.MouseEnter + commentId: E:Terminal.Gui.View.MouseEnter fullName: Terminal.Gui.View.MouseEnter nameWithType: View.MouseEnter - uid: Terminal.Gui.View.MouseEventArgs @@ -9934,7 +10018,7 @@ references: - uid: Terminal.Gui.View.MouseLeave name: MouseLeave href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave - commentId: F:Terminal.Gui.View.MouseLeave + commentId: E:Terminal.Gui.View.MouseLeave fullName: Terminal.Gui.View.MouseLeave nameWithType: View.MouseLeave - uid: Terminal.Gui.View.Move(System.Int32,System.Int32) @@ -10028,6 +10112,19 @@ references: isSpec: "True" fullName: Terminal.Gui.View.OnLeave nameWithType: View.OnLeave +- uid: Terminal.Gui.View.OnMouseClick(Terminal.Gui.View.MouseEventArgs) + name: OnMouseClick(View.MouseEventArgs) + href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_OnMouseClick_Terminal_Gui_View_MouseEventArgs_ + commentId: M:Terminal.Gui.View.OnMouseClick(Terminal.Gui.View.MouseEventArgs) + fullName: Terminal.Gui.View.OnMouseClick(Terminal.Gui.View.MouseEventArgs) + nameWithType: View.OnMouseClick(View.MouseEventArgs) +- uid: Terminal.Gui.View.OnMouseClick* + name: OnMouseClick + href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_OnMouseClick_ + commentId: Overload:Terminal.Gui.View.OnMouseClick + isSpec: "True" + fullName: Terminal.Gui.View.OnMouseClick + nameWithType: View.OnMouseClick - uid: Terminal.Gui.View.OnMouseEnter(Terminal.Gui.MouseEvent) name: OnMouseEnter(MouseEvent) href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_ @@ -10174,7 +10271,7 @@ references: - uid: Terminal.Gui.View.Removed name: Removed href: api/Terminal.Gui/Terminal.Gui.View.html#Terminal_Gui_View_Removed - commentId: F:Terminal.Gui.View.Removed + commentId: E:Terminal.Gui.View.Removed fullName: Terminal.Gui.View.Removed nameWithType: View.Removed - uid: Terminal.Gui.View.ScreenToView(System.Int32,System.Int32) @@ -10499,19 +10596,6 @@ references: isSpec: "True" fullName: Terminal.Gui.Window.Add nameWithType: Window.Add -- uid: Terminal.Gui.Window.GetEnumerator - name: GetEnumerator() - href: api/Terminal.Gui/Terminal.Gui.Window.html#Terminal_Gui_Window_GetEnumerator - commentId: M:Terminal.Gui.Window.GetEnumerator - fullName: Terminal.Gui.Window.GetEnumerator() - nameWithType: Window.GetEnumerator() -- uid: Terminal.Gui.Window.GetEnumerator* - name: GetEnumerator - href: api/Terminal.Gui/Terminal.Gui.Window.html#Terminal_Gui_Window_GetEnumerator_ - commentId: Overload:Terminal.Gui.Window.GetEnumerator - isSpec: "True" - fullName: Terminal.Gui.Window.GetEnumerator - nameWithType: Window.GetEnumerator - uid: Terminal.Gui.Window.MouseEvent(Terminal.Gui.MouseEvent) name: MouseEvent(MouseEvent) href: api/Terminal.Gui/Terminal.Gui.Window.html#Terminal_Gui_Window_MouseEvent_Terminal_Gui_MouseEvent_ @@ -10856,11 +10940,11 @@ references: isSpec: "True" fullName: UICatalog.Scenario.ScenarioCategory.ScenarioCategory nameWithType: Scenario.ScenarioCategory.ScenarioCategory -- uid: UICatalog.Scenario.ScenarioCategory.GetCategories(Type) +- uid: UICatalog.Scenario.ScenarioCategory.GetCategories(System.Type) name: GetCategories(Type) - href: api/UICatalog/UICatalog.Scenario.ScenarioCategory.html#UICatalog_Scenario_ScenarioCategory_GetCategories_Type_ - commentId: M:UICatalog.Scenario.ScenarioCategory.GetCategories(Type) - fullName: UICatalog.Scenario.ScenarioCategory.GetCategories(Type) + href: api/UICatalog/UICatalog.Scenario.ScenarioCategory.html#UICatalog_Scenario_ScenarioCategory_GetCategories_System_Type_ + commentId: M:UICatalog.Scenario.ScenarioCategory.GetCategories(System.Type) + fullName: UICatalog.Scenario.ScenarioCategory.GetCategories(System.Type) nameWithType: Scenario.ScenarioCategory.GetCategories(Type) - uid: UICatalog.Scenario.ScenarioCategory.GetCategories* name: GetCategories @@ -10869,11 +10953,11 @@ references: isSpec: "True" fullName: UICatalog.Scenario.ScenarioCategory.GetCategories nameWithType: Scenario.ScenarioCategory.GetCategories -- uid: UICatalog.Scenario.ScenarioCategory.GetName(Type) +- uid: UICatalog.Scenario.ScenarioCategory.GetName(System.Type) name: GetName(Type) - href: api/UICatalog/UICatalog.Scenario.ScenarioCategory.html#UICatalog_Scenario_ScenarioCategory_GetName_Type_ - commentId: M:UICatalog.Scenario.ScenarioCategory.GetName(Type) - fullName: UICatalog.Scenario.ScenarioCategory.GetName(Type) + href: api/UICatalog/UICatalog.Scenario.ScenarioCategory.html#UICatalog_Scenario_ScenarioCategory_GetName_System_Type_ + commentId: M:UICatalog.Scenario.ScenarioCategory.GetName(System.Type) + fullName: UICatalog.Scenario.ScenarioCategory.GetName(System.Type) nameWithType: Scenario.ScenarioCategory.GetName(Type) - uid: UICatalog.Scenario.ScenarioCategory.GetName* name: GetName @@ -10927,11 +11011,11 @@ references: isSpec: "True" fullName: UICatalog.Scenario.ScenarioMetadata.Description nameWithType: Scenario.ScenarioMetadata.Description -- uid: UICatalog.Scenario.ScenarioMetadata.GetDescription(Type) +- uid: UICatalog.Scenario.ScenarioMetadata.GetDescription(System.Type) name: GetDescription(Type) - href: api/UICatalog/UICatalog.Scenario.ScenarioMetadata.html#UICatalog_Scenario_ScenarioMetadata_GetDescription_Type_ - commentId: M:UICatalog.Scenario.ScenarioMetadata.GetDescription(Type) - fullName: UICatalog.Scenario.ScenarioMetadata.GetDescription(Type) + href: api/UICatalog/UICatalog.Scenario.ScenarioMetadata.html#UICatalog_Scenario_ScenarioMetadata_GetDescription_System_Type_ + commentId: M:UICatalog.Scenario.ScenarioMetadata.GetDescription(System.Type) + fullName: UICatalog.Scenario.ScenarioMetadata.GetDescription(System.Type) nameWithType: Scenario.ScenarioMetadata.GetDescription(Type) - uid: UICatalog.Scenario.ScenarioMetadata.GetDescription* name: GetDescription @@ -10940,11 +11024,11 @@ references: isSpec: "True" fullName: UICatalog.Scenario.ScenarioMetadata.GetDescription nameWithType: Scenario.ScenarioMetadata.GetDescription -- uid: UICatalog.Scenario.ScenarioMetadata.GetName(Type) +- uid: UICatalog.Scenario.ScenarioMetadata.GetName(System.Type) name: GetName(Type) - href: api/UICatalog/UICatalog.Scenario.ScenarioMetadata.html#UICatalog_Scenario_ScenarioMetadata_GetName_Type_ - commentId: M:UICatalog.Scenario.ScenarioMetadata.GetName(Type) - fullName: UICatalog.Scenario.ScenarioMetadata.GetName(Type) + href: api/UICatalog/UICatalog.Scenario.ScenarioMetadata.html#UICatalog_Scenario_ScenarioMetadata_GetName_System_Type_ + commentId: M:UICatalog.Scenario.ScenarioMetadata.GetName(System.Type) + fullName: UICatalog.Scenario.ScenarioMetadata.GetName(System.Type) nameWithType: Scenario.ScenarioMetadata.GetName(Type) - uid: UICatalog.Scenario.ScenarioMetadata.GetName* name: GetName @@ -11776,6 +11860,18 @@ references: commentId: F:Unix.Terminal.Curses.Event.ButtonShift fullName: Unix.Terminal.Curses.Event.ButtonShift nameWithType: Curses.Event.ButtonShift +- uid: Unix.Terminal.Curses.Event.ButtonWheeledDown + name: ButtonWheeledDown + href: api/Terminal.Gui/Unix.Terminal.Curses.Event.html#Unix_Terminal_Curses_Event_ButtonWheeledDown + commentId: F:Unix.Terminal.Curses.Event.ButtonWheeledDown + fullName: Unix.Terminal.Curses.Event.ButtonWheeledDown + nameWithType: Curses.Event.ButtonWheeledDown +- uid: Unix.Terminal.Curses.Event.ButtonWheeledUp + name: ButtonWheeledUp + href: api/Terminal.Gui/Unix.Terminal.Curses.Event.html#Unix_Terminal_Curses_Event_ButtonWheeledUp + commentId: F:Unix.Terminal.Curses.Event.ButtonWheeledUp + fullName: Unix.Terminal.Curses.Event.ButtonWheeledUp + nameWithType: Curses.Event.ButtonWheeledUp - uid: Unix.Terminal.Curses.Event.ReportMousePosition name: ReportMousePosition href: api/Terminal.Gui/Unix.Terminal.Curses.Event.html#Unix_Terminal_Curses_Event_ReportMousePosition
TypeSystem.Type t
List<System.String>System.Collections.Generic.List<System.String>

list of category names
TypeSystem.Type t
TypeSystem.Type t
TypeSystem.Type t
List<System.String>System.Collections.Generic.List<System.String>

list of category names
List<Type>System.Collections.Generic.List<System.Type>