diff --git a/Terminal.Gui/Core.cs b/Terminal.Gui/Core.cs
index 2bf0d78f7..fa0b41354 100644
--- a/Terminal.Gui/Core.cs
+++ b/Terminal.Gui/Core.cs
@@ -27,13 +27,13 @@ namespace Terminal.Gui {
///
public class Responder {
///
- /// Gets or sets a value indicating whether this
/// true if can focus; otherwise, false .
- /// Gets or sets a value indicating whether this
/// true if has focus; otherwise, false .
/// When you do not specify a Rect frame you can use the more flexible
/// Dim and Pos objects that can dynamically update the position of a view.
- /// The X and Y properties are of type
- /// Gets or sets a value indicating whether this
/// true if want mouse position reports; otherwise, false .
- /// Gets or sets a value indicating whether this
public virtual bool WantContinuousButtonPressed { get; set; } = false;
///
@@ -481,7 +481,7 @@ namespace Terminal.Gui {
public View SuperView => container;
///
- /// Initializes a new instance of the
@@ -494,7 +494,7 @@ namespace Terminal.Gui {
}
///
- /// Initializes a new instance of the
@@ -1484,20 +1484,20 @@ namespace Terminal.Gui {
///
public class Toplevel : View {
///
- /// Gets or sets whether the
public bool Running { get; set; }
///
- /// Fired once the Toplevel's
public event EventHandler Ready;
///
- /// Called from Application.RunLoop after the
internal virtual void OnReady ()
{
@@ -1505,7 +1505,7 @@ namespace Terminal.Gui {
}
///
- /// Initializes a new instance of the
///
- /// Initializes a new instance of the
public Toplevel () : base ()
{
@@ -1538,7 +1538,7 @@ namespace Terminal.Gui {
}
///
- /// Gets or sets a value indicating whether this
/// true if can focus; otherwise, false .
- /// A toplevel view that draws a frame around its region and has a "ContentView" subview where the contents are added.
+ /// A
public class Window : Toplevel, IEnumerable {
View contentView;
@@ -1772,7 +1772,7 @@ namespace Terminal.Gui {
}
///
- /// Initializes a new instance of the
///
- /// Initializes a new instance of the
///
- /// Initializes a new instance of the
@@ -1808,7 +1808,7 @@ namespace Terminal.Gui {
}
///
- /// Initializes a new instance of the
@@ -1829,7 +1829,7 @@ namespace Terminal.Gui {
}
///
- /// Enumerates the various views in the ContentView.
+ /// Enumerates the various
/// The enumerator.
public new IEnumerator GetEnumerator ()
@@ -1843,7 +1843,7 @@ namespace Terminal.Gui {
}
///
- /// Add the specified view to the ContentView.
+ /// Add the specified view to the
///
- /// The application driver for gui.cs
+ /// The application driver for Terminal.Gui.
///
///
///
@@ -1994,30 +1994,30 @@ namespace Terminal.Gui {
///
public static class Application {
///
- /// The current Console Driver in use.
+ /// The current
public static ConsoleDriver Driver;
///
- /// The Toplevel object used for the application on startup.
+ /// The
/// The top.
public static Toplevel Top { get; private set; }
///
- /// The current toplevel object. This is updated when Application.Run enters and leaves and points to the current toplevel.
+ /// The current
/// The current.
public static Toplevel Current { get; private set; }
///
- /// TThe current view object being redrawn.
+ /// TThe current
/// /// The current.
public static View CurrentView { get; set; }
///
- /// The mainloop driver for the applicaiton
+ /// The
/// The main loop.
public static Mono.Terminal.MainLoop MainLoop { get; private set; }
@@ -2025,8 +2025,7 @@ namespace Terminal.Gui {
static Stack toplevels = new Stack ();
///
- /// This event is raised on each iteration of the
- /// main loop.
+ /// This event is raised on each iteration of the
///
/// See also
- /// Initializes the Application
+ /// Initializes a new instance of
+ ///
+ ///
+ /// Call this method once per instance (or after
+ ///
+ /// Loads the right
+ ///
+ /// Creates a
+ ///
public static void Init () => Init (() => Toplevel.Create ());
internal static bool _initialized = false;
///
- /// Initializes the Application
+ /// Initializes the Terminal.Gui application
///
static void Init (Func topLevelFactory)
{
@@ -2120,7 +2130,7 @@ namespace Terminal.Gui {
}
///
- /// Captures the execution state for the provided TopLevel view.
+ /// Captures the execution state for the provided
public class RunState : IDisposable {
internal RunState (Toplevel view)
@@ -2130,13 +2140,13 @@ namespace Terminal.Gui {
internal Toplevel Toplevel;
///
- /// Releases alTop = l resource used by the
- /// Call Call
+ ///
public void Dispose ()
{
Dispose (true);
@@ -2342,15 +2352,15 @@ namespace Terminal.Gui {
public static event EventHandler Loaded;
///
- /// Building block API: Prepares the provided toplevel for execution.
+ /// Building block API: Prepares the provided
- /// The runstate handle that needs to be passed to the End() method upon completion.
+ /// The runstate handle that needs to be passed to the
///
/// This method prepares the provided toplevel for running with the focus,
/// it adds this to the list of toplevels, sets up the mainloop to process the
/// event, lays out the subviews, focuses the first element, and draws the
- /// toplevel in the screen. This is usually followed by executing
+ /// toplevel in the screen. This is usually followed by executing
/// the
@@ -2385,7 +2395,7 @@ namespace Terminal.Gui {
}
///
- /// Building block API: completes the execution of a Toplevel that was started with Begin.
+ /// Building block API: completes the execution of a
///
- /// Finalize the driver.
+ /// Shutdown an application initalized with
public static void Shutdown ()
{
@@ -2500,7 +2510,7 @@ namespace Terminal.Gui {
}
///
- /// Runs the application with the built-in toplevel view
+ /// Runs the application by calling
public static void Run ()
{
@@ -2508,7 +2518,7 @@ namespace Terminal.Gui {
}
///
- /// Runs the application with a new instance of the specified toplevel view
+ /// Runs the application by calling
public static void Run () where T : Toplevel, new()
{
@@ -2517,27 +2527,26 @@ namespace Terminal.Gui {
}
///
- /// Runs the main loop on the given container.
+ /// Runs the main loop on the given
///
///
/// This method is used to start processing events
/// for the main application, but it is also used to
- /// run modal dialog boxes.
+ /// run other modal
///
- /// To make a toplevel stop execution, set the "Running"
- /// property to false.
+ /// To make a
///
- /// This is equivalent to calling Begin on the toplevel view, followed by RunLoop with the
- /// returned value, and then calling end on the return value.
+ /// Calling
///
- /// Alternatively, if your program needs to control the main loop and needs to
- /// process events manually, you can invoke Begin to set things up manually and then
- /// repeatedly call RunLoop with the wait parameter set to false. By doing this
- /// the RunLoop method will only process any pending events, timers, idle handlers and
+ /// Alternatively, to have a program control the main loop and
+ /// process events manually, call
///
@@ -2549,15 +2558,23 @@ namespace Terminal.Gui {
}
///
- /// Stops running the most recent toplevel
+ /// Stops running the most recent
+ ///
+ ///
+ /// This will cause
+ ///
+ /// Calling
+ ///
public static void RequestStop ()
{
Current.Running = false;
}
///
- /// Event arguments for the
public class ResizedEventArgs : EventArgs {
///
diff --git a/Terminal.Gui/Dialogs/Dialog.cs b/Terminal.Gui/Dialogs/Dialog.cs
index 2aef337d5..82d696d73 100644
--- a/Terminal.Gui/Dialogs/Dialog.cs
+++ b/Terminal.Gui/Dialogs/Dialog.cs
@@ -11,21 +11,20 @@ using NStack;
namespace Terminal.Gui {
///
- /// The dialog box is a window that by default is centered and contains one
- /// or more buttons. It defaults to the Colors.Dialog color scheme and has a
- /// 1 cell padding around the edges.
+ /// The
///
- /// To run the dialog modally, create the Dialog, and pass this to Application.Run which
- /// will execute the dialog until it terminates via the [ESC] key, or when one of the views
- /// or buttons added to the dialog set the Running property on the Dialog to false.
+ /// To run the
public class Dialog : Window {
List buttons = new List ();
const int padding = 1;
///
- /// Initializes a new instance of the
///
- /// Adds a button to the dialog, its layout will be controled by the dialog
+ /// Adds a
///
- /// Lays out the subviews for the Dialog.
- ///
+ ///
- /// Base class for the OpenDialog and the SaveDialog
+ /// Base class for the
public class FileDialog : Dialog {
Button prompt, cancel;
@@ -426,7 +426,7 @@ namespace Terminal.Gui {
internal DirListView dirListView;
///
- /// Constructor for the OpenDialog and the SaveDialog.
+ /// Initializes a new instance of
///
- /// Gets or sets the prompt label for the button displayed to the user
+ /// Gets or sets the prompt label for the
/// The prompt.
public ustring Prompt {
@@ -535,13 +535,13 @@ namespace Terminal.Gui {
}
///
- /// Gets or sets a value indicating whether this
/// true if can create directories; otherwise, false .
- /// Gets or sets a value indicating whether this
/// true if is extension hidden; otherwise, false .
- /// Gets or sets a value indicating whether this
/// true if allows other file types; otherwise, false .
- /// The save dialog provides an interactive dialog box for users to pick a file to
+ /// The
///
///
- /// To use it, create an instance of the SaveDialog, and then
- /// call Application.Run on the resulting instance. This will run the dialog modally,
- /// and when this returns, the FileName property will contain the selected value or
+ /// To use, create an instance of
///
public class SaveDialog : FileDialog {
///
- /// Constructor of the save dialog.
+ /// Initializes a new
///
/// Gets the name of the file the user selected for saving, or null
- /// if the user canceled the dialog box.
+ /// if the user canceled the
/// The name of the file.
public ustring FileName {
@@ -628,7 +628,7 @@ namespace Terminal.Gui {
}
///
- /// The Open Dialog provides an interactive dialog box for users to select files or directories.
+ /// The
///
///
@@ -637,9 +637,9 @@ namespace Terminal.Gui {
/// you can control whether this should allow files or directories to be selected.
///
///
- /// To use it, create an instance of the OpenDialog, configure its properties, and then
- /// call Application.Run on the resulting instance. This will run the dialog modally,
- /// and when this returns, the list of filds will be available on the FilePaths property.
+ /// To use, create an instance of
///
/// To select more than one file, users can use the spacebar, or control-t.
@@ -647,7 +647,7 @@ namespace Terminal.Gui {
///
public class OpenDialog : FileDialog {
///
- /// Constructor of the Open Dialog.
+ /// Initializes a new
///
- /// Gets or sets a value indicating whether this
/// true if can choose files; otherwise, false . Defaults to true
- /// Gets or sets a value indicating whether this
/// true if can choose directories; otherwise, false defaults to false .
- /// Gets or sets a value indicating whether this
/// true if allows multiple selection; otherwise, false , defaults to false.
- /// Message box displays a modal message to the user, with a title, a message and a series of options that the user can choose from.
+ /// MessageBox displays a modal message to the user, with a title, a message and a series of options that the user can choose from.
///
///
- /// The difference between the Query and ErrorQuery method is the default set of colors used for the message box.
+ /// The difference between the
///
- /// The following example pops up a Message Box with 50 columns, and 7 lines, with the specified title and text, plus two buttons.
- /// The value -1 is returned when the user cancels the dialog by pressing the ESC key.
+ /// The following example pops up a
///
///
@@ -18,12 +17,11 @@ namespace Terminal.Gui {
/// quit = true;
/// else
/// quit = false;
- ///
///
///
public static class MessageBox {
///
- /// Presents a message with the specified title and message and a list of buttons to show to the user.
+ /// Presents a normal
/// The index of the selected button, or -1 if the user pressed ESC to close the dialog.
///
- /// Presents an error message box with the specified title and message and a list of buttons to show to the user.
+ /// Presents an error
/// The index of the selected button, or -1 if the user pressed ESC to close the dialog.
///
- /// Initializes a new instance of the
///
- /// Initializes a new instance of the
///
- /// The Key enumeration contains special encoding for some keys, but can also
+ /// The
///
@@ -320,18 +320,23 @@ namespace Terminal.Gui {
//public bool IsCtrl => ((uint)Key >= 1) && ((uint)Key <= 26);
public bool IsCtrl => (Key & Key.CtrlMask) != 0;
+ ///
+ /// Constructs a new
public KeyEvent ()
{
Key = Key.Unknown;
}
+
///
- /// Constructs a new KeyEvent from the provided Key value - can be a rune cast into a Key value
+ /// Constructs a new
public KeyEvent (Key k)
{
Key = k;
}
+ ///
- /// Returns a
- /// A
+ /// A
public override string ToString ()
{
return $"({X},{Y}:{Flags}";
diff --git a/Terminal.Gui/Types/PosDim.cs b/Terminal.Gui/Types/PosDim.cs
index c45669674..e9c7efd8f 100644
--- a/Terminal.Gui/Types/PosDim.cs
+++ b/Terminal.Gui/Types/PosDim.cs
@@ -229,11 +229,11 @@ namespace Terminal.Gui {
static PosCombine posCombine;
///
- /// Adds a
/// The left and right .
+ /// The left and right .
public static Pos operator + (Pos left, Pos right)
{
PosCombine newPos = new PosCombine (true, left, right);
@@ -247,11 +247,11 @@ namespace Terminal.Gui {
}
///
- /// Subtracts a
/// The left minus right .
+ /// The left minus right .
public static Pos operator - (Pos left, Pos right)
{
PosCombine newPos = new PosCombine (false, left, right);
@@ -390,7 +390,7 @@ namespace Terminal.Gui {
/// The percent
///
- /// This creates a
/// var textView = new TextView () {
@@ -451,7 +451,7 @@ namespace Terminal.Gui {
static DimFill zeroMargin;
///
- /// Creates a
/// The Fill dimension.
///
- /// Adds a
/// The left and right .
+ /// The left and right .
public static Dim operator + (Dim left, Dim right)
{
return new DimCombine (true, left, right);
}
///
- /// Subtracts a
/// The left minus right .
+ /// The left minus right .
public static Dim operator - (Dim left, Dim right)
{
return new DimCombine (false, left, right);
diff --git a/Terminal.Gui/Views/Button.cs b/Terminal.Gui/Views/Button.cs
index 8fd4e2a2c..774050634 100644
--- a/Terminal.Gui/Views/Button.cs
+++ b/Terminal.Gui/Views/Button.cs
@@ -10,18 +10,18 @@ using NStack;
namespace Terminal.Gui {
///
- /// Button is a view that provides an item that invokes a callback when activated.
+ /// Button is a
///
///
- /// Provides a button that can be clicked, or pressed with
- /// the enter key and processes hotkeys (the first uppercase
- /// letter in the button becomes the hotkey).
+ /// Provides a button showing text invokes an
///
- /// If the button is configured as the default (IsDefault) the button
- /// will respond to the return key is no other view processes it, and
- /// turns this into a clicked event.
+ /// When the button is configured as the default (
///
public class Button : View {
@@ -32,7 +32,7 @@ namespace Terminal.Gui {
bool is_default;
///
- /// Gets or sets a value indicating whether this
/// true if is default; otherwise, false .
- /// Clicked event, raised when the button is clicked.
+ /// Clicked
///
/// Client code can hook up to this event, it is
@@ -54,15 +54,14 @@ namespace Terminal.Gui {
public Action Clicked;
///
- /// Public constructor, creates a button based on
- /// the given text at position 0,0
+ /// Initializes a new instance of
///
- /// The size of the button is computed based on the
- /// text length. This button is not a default button.
+ /// The size of the
///
- /// Public constructor, creates a button based on
- /// the given text at the given position.
+ /// Initializes a new instance of
///
- /// The size of the button is computed based on the
- /// text length. This button is not a default button.
+ /// The size of the
///
- /// The text displayed by this widget.
+ /// The text displayed by this
public ustring Text {
get {
@@ -132,8 +130,7 @@ namespace Terminal.Gui {
}
///
- /// Public constructor, creates a button based on
- /// the given text at the given position.
+ /// Initializes a new instance of
///
/// If the value for is_default is true, a special
diff --git a/Terminal.Gui/Views/Checkbox.cs b/Terminal.Gui/Views/Checkbox.cs
index 06cb26ab3..056846b40 100644
--- a/Terminal.Gui/Views/Checkbox.cs
+++ b/Terminal.Gui/Views/Checkbox.cs
@@ -10,7 +10,7 @@ using NStack;
namespace Terminal.Gui {
///
- /// The Checkbox View shows an on/off toggle that the user can set
+ /// The
public class CheckBox : View {
ustring text;
@@ -18,17 +18,17 @@ namespace Terminal.Gui {
Rune hot_key;
///
- /// Toggled event, raised when the CheckButton is toggled.
+ /// Toggled event, raised when the
///
/// Client code can hook up to this event, it is
- /// raised when the checkbutton is activated either with
+ /// raised when the
public event EventHandler Toggled;
///
- /// Public constructor, creates a CheckButton based on the given text, uses Computed layout and sets the height and width.
+ /// Initializes a new instance of
/// true is checked.
@@ -42,23 +42,21 @@ namespace Terminal.Gui {
}
///
- /// Public constructor, creates a CheckButton based on
- /// the given text at an absolute position.
+ /// Initializes a new instance of
///
- /// The size of CheckButton is computed based on the
- /// text length. This CheckButton is not toggled.
+ /// The size of
public CheckBox (int x, int y, ustring s) : this (x, y, s, false)
{
}
///
- /// Public constructor, creates a CheckButton based on
- /// the given text at the given position and a state.
+ /// Initializes a new instance of
///
- /// The size of CheckButton is computed based on the
+ /// The size of
public CheckBox (int x, int y, ustring s, bool is_checked) : base (new Rect (x, y, s.Length + 4, 1))
@@ -70,12 +68,12 @@ namespace Terminal.Gui {
}
///
- /// The state of the checkbox.
+ /// The state of the
public bool Checked { get; set; }
///
- /// The text displayed by this widget.
+ /// The text displayed by this
public ustring Text {
get {
diff --git a/Terminal.Gui/Views/Clipboard.cs b/Terminal.Gui/Views/Clipboard.cs
index e0615da01..e24e79587 100644
--- a/Terminal.Gui/Views/Clipboard.cs
+++ b/Terminal.Gui/Views/Clipboard.cs
@@ -3,7 +3,8 @@ using NStack;
namespace Terminal.Gui {
///
- ///
+ /// Provides cut, copy, and paste support for the clipboard.
+ /// NOTE: Currently not implemented.
///
public static class Clipboard {
///
diff --git a/Terminal.Gui/Views/DateField.cs b/Terminal.Gui/Views/DateField.cs
index 0c82ea499..2215a56a2 100644
--- a/Terminal.Gui/Views/DateField.cs
+++ b/Terminal.Gui/Views/DateField.cs
@@ -11,12 +11,11 @@ using System.Linq;
using NStack;
namespace Terminal.Gui {
-
///
- /// Date edit widget
+ /// Date editing
///
- /// This widget provides date editing functionality, and mouse support.
+ /// The
public class DateField : TextField {
bool isShort;
@@ -31,13 +30,13 @@ namespace Terminal.Gui {
///
- /// Public constructor that creates a date edit field at an absolute position and fixed size.
+ /// Initializes a new instance of
///
- /// Gets or sets the date in the widget.
+ /// Gets or sets the date of the
///
///
@@ -189,6 +188,7 @@ namespace Terminal.Gui {
CursorPosition++;
}
+ ///
- /// The FrameView is a container frame that draws a frame around the contents
+ /// The FrameView is a container frame that draws a frame around the contents. It is similar to
+ /// a GroupBox in Windows.
///
public class FrameView : View {
View contentView;
ustring title;
///
- /// The title to be displayed for this window.
+ /// The title to be displayed for this
/// The title.
public ustring Title {
@@ -35,7 +36,7 @@ namespace Terminal.Gui {
}
///
- /// Initializes a new instance of the
///
- /// Initializes a new instance of the
///
- /// Initializes a new instance of the
///
- /// Add the specified view to the ContentView.
+ /// Add the specified
- ///
- /// Removes a widget from this container.
+ /// Removes a
///
///
@@ -121,7 +122,7 @@ namespace Terminal.Gui {
}
///
- /// Removes all widgets from this container.
+ /// Removes all
///
///
@@ -130,6 +131,7 @@ namespace Terminal.Gui {
contentView.RemoveAll();
}
+ ///
- /// An Hex viewer an editor view over a System.IO.Stream
+ /// An hex viewer and editor
///
///
- /// This provides a hex editor on top of a seekable stream with the left side showing an hex
- /// dump of the values in the stream and the right side showing the contents (filterd to
- /// non-control sequence ascii characters).
+ ///
///
/// Users can switch from one side to the other by using the tab key.
///
///
- /// If you want to enable editing, set the AllowsEdits property, once that is done, the user
- /// can make changes to the hexadecimal values of the stream. Any changes done are tracked
- /// in the Edits property which is a sorted dictionary indicating the position where the
- /// change was made and the new value. A convenience ApplyEdits method can be used to c
- /// apply the methods to the underlying stream.
+ /// To enable editing, set
///
- /// It is possible to control the first byte shown by setting the DisplayStart property
- /// to the offset that you want to start viewing.
+ /// Control the first byte shown by setting the
///
public class HexView : View {
@@ -41,9 +41,9 @@ namespace Terminal.Gui {
bool firstNibble, leftSide;
///
- /// Creates and instance of the HexView that will render a seekable stream in hex on the allocated view region.
+ /// Initialzies a
- ///
- /// The source stream to display on the hex view, the stream should support seeking.
+ /// Sets or gets the
/// The source.
public Stream Source {
@@ -82,7 +82,7 @@ namespace Terminal.Gui {
}
///
- /// Configures the initial offset to be displayed at the top
+ /// Sets or gets the offset into the
/// The display start.
public long DisplayStart {
@@ -212,9 +212,7 @@ namespace Terminal.Gui {
}
- ///
- /// Positions the cursor based for the hex view
- ///
+ ///
- /// Gets or sets a value indicating whether this
/// true if allow edits; otherwise, false .
- /// Gets a list of the edits done to the buffer which is a sorted dictionary with the positions where the edit took place and the value that was set.
+ /// Gets a
/// The edits.
public IReadOnlyDictionary Edits => edits;
///
- /// This method applies the edits to the stream and resets the contents of the Edits property
+ /// This method applies andy edits made to the
public void ApplyEdits ()
{
diff --git a/Terminal.Gui/Views/Label.cs b/Terminal.Gui/Views/Label.cs
index 3f5fb448b..1e5d9ba21 100644
--- a/Terminal.Gui/Views/Label.cs
+++ b/Terminal.Gui/Views/Label.cs
@@ -28,13 +28,13 @@ namespace Terminal.Gui {
///
Centered,
///
- /// Shows the line as justified text in the line.
+ /// Shows the text as justified text in the frame.
///
Justified
}
///
- /// Label view, displays a string at a given position, can include multiple lines.
+ /// The Label
public class Label : View {
List lines = new List ();
@@ -64,7 +64,7 @@ namespace Terminal.Gui {
}
///
- /// Public constructor: creates a label at the given
+ /// Initializes a new instance of
- /// Public constructor: creates a label at the given
+ /// Initializes a new instance of
@@ -84,7 +84,7 @@ namespace Terminal.Gui {
}
///
- /// Public constructor: creates a label and configures the default Width and Height based on the text, the result is suitable for Computed layout.
+ /// Initializes a new instance of
///
- /// Computes the number of lines needed to render the specified text by the Label control
+ /// Computes the number of lines needed to render the specified text by the
/// Number of lines.
///
- /// The text displayed by this widget.
+ /// The text displayed by the
public virtual ustring Text {
get => text;
@@ -238,7 +238,7 @@ namespace Terminal.Gui {
}
///
- /// Controls the text-alignemtn property of the label, changing it will redisplay the label.
+ /// Controls the text-alignemtn property of the label, changing it will redisplay the
/// The text alignment.
public TextAlignment TextAlignment {
@@ -251,7 +251,7 @@ namespace Terminal.Gui {
Attribute textColor = -1;
///
- /// The color used for the label
+ /// The color used for the
public Attribute TextColor {
get => textColor;
diff --git a/Terminal.Gui/Views/ListView.cs b/Terminal.Gui/Views/ListView.cs
index 7262fa478..e3c53557b 100644
--- a/Terminal.Gui/Views/ListView.cs
+++ b/Terminal.Gui/Views/ListView.cs
@@ -26,7 +26,7 @@ using NStack;
namespace Terminal.Gui {
///
- /// Implement this interface to provide your own custom rendering for a list.
+ /// Implement
public interface IListDataSource {
///
@@ -72,33 +72,34 @@ namespace Terminal.Gui {
}
///
- /// ListView widget renders a list of data.
+ /// ListView
///
///
- /// The ListView displays lists of data and allows the user to scroll through the data
- /// and optionally mark elements of the list (controlled by the AllowsMark property).
+ /// The
///
- /// The ListView can either render an arbitrary IList object (for example, arrays, List<T>
- /// and other collections) which are drawn by drawing the string/ustring contents or the
- /// result of calling ToString(). Alternatively, you can provide you own IListDataSource
- /// object that gives you full control of what is rendered.
+ /// By default
///
- /// The ListView can display any object that implements the System.Collection.IList interface,
- /// string values are converted into ustring values before rendering, and other values are
- /// converted into ustrings by calling ToString() and then converting to ustring.
+ ///
///
- /// If you must change the contents of the ListView, set the Source property (when you are
- /// providing your own rendering via the IListDataSource implementation) or call SetSource
- /// when you are providing an IList.
+ /// To change the contents of the ListView, set the
///
- /// When AllowsMark is set to true, then the rendering will prefix the list rendering with
- /// [x] or [ ] and bind the space character to toggle the selection. If you desire a different
- /// marking style do not set the property and provide your own custom rendering.
+ /// When
///
public class ListView : View {
@@ -107,9 +108,12 @@ namespace Terminal.Gui {
IListDataSource source;
///
- /// Gets or sets the IListDataSource backing this view, use SetSource() if you want to set a new IList source.
+ /// Gets or sets the
/// The source.
+ ///
+ /// Use
public IListDataSource Source {
get => source;
set {
@@ -121,9 +125,12 @@ namespace Terminal.Gui {
}
///
- /// Sets the source to an IList value, if you want to set a full IListDataSource, use the Source property.
+ /// Sets the source of the
- /// An item implementing the IList interface.
+ /// An object implementing the IList interface.
+ ///
+ /// Use the
public void SetSource (IList source)
{
if (source == null)
@@ -134,9 +141,12 @@ namespace Terminal.Gui {
}
///
- /// Sets the source to an IList value asynchronously, if you want to set a full IListDataSource, use the Source property.
+ /// Sets the source to an
/// An item implementing the IList interface.
+ ///
+ /// Use the
public Task SetSourceAsync (IList source)
{
return Task.Factory.StartNew (() => {
@@ -150,14 +160,13 @@ namespace Terminal.Gui {
bool allowsMarking;
///
- /// Gets or sets a value indicating whether this
/// true if allows marking elements of the list; otherwise, false .
///
- /// If set to true, this will default to rendering the marked with "[x]", and unmarked valued with "[ ]"
- /// spaces. If you desire a different rendering, you need to implement your own renderer. This will
- /// also by default process the space character as a toggle for the selection.
+ /// If set to true,
public bool AllowsMarking {
get => allowsMarking;
@@ -173,7 +182,7 @@ namespace Terminal.Gui {
public bool AllowsMultipleSelection { get; set; } = true;
///
- /// Gets or sets the item that is displayed at the top of the listview
+ /// Gets or sets the item that is displayed at the top of the
/// The top item.
public int TopItem {
@@ -190,7 +199,7 @@ namespace Terminal.Gui {
}
///
- /// Gets or sets the currently selected item.
+ /// Gets or sets the index of the currently selected item.
///
/// The selected item.
public int SelectedItem {
@@ -215,17 +224,20 @@ namespace Terminal.Gui {
}
///
- /// Initializes a new ListView that will display the contents of the object implementing the IList interface, with relative positioning
+ /// Initializes a new instance of
- ///
- /// Initializes a new ListView that will display the provided data source, uses relative positioning.
+ /// Initializes a new instance of
- ///
- /// Initializes a new instance of the
public ListView () : base ()
{
}
///
- /// Initializes a new ListView that will display the contents of the object implementing the IList interface with an absolute position.
+ /// Initializes a new instance of
///
- /// Initializes a new ListView that will display the provided data source with an absolute position
+ /// Initializes a new instance of
///
- /// Redraws the ListView
- ///
- ///
- /// This event is raised when the cursor selection has changed.
+ /// This event is raised when the selected item in the
public event EventHandler SelectedChanged;
///
- /// This event is raised on Enter key or Double Click to open the selected item.
+ /// This event is raised when the user Double Clicks on an item or presses ENTER to open the selected item.
///
public event EventHandler OpenSelectedItem;
- ///
- /// Handles cursor movement for this view, passes all other events.
- ///
- /// true , if key was processed, false otherwise.
- /// Moves to the next page.
+ /// Moves the selected item index to the next page.
///
///
- /// Moves to the previous page.
+ /// Moves the selected item index to the previous page.
///
///
- /// Moves to the next row.
+ /// Moves the selected item index to the next row.
///
///
- /// Moves to the previous row.
+ /// Moves the selected item index to the previous row.
///
///
- /// Positions the cursor in this view
- ///
+ ///
- /// This class is the built-in IListDataSource that renders arbitrary
- /// IList instances
+ /// Implements an
+ /// Implements support for rendering marked items.
public class ListWrapper : IListDataSource {
IList src;
BitArray marks;
int count;
///
- /// Constructor based on a source.
+ /// Initializes a new instance of
///
- /// Returns the amount of items in the source.
+ /// Gets the number of items in the
public int Count => src.Count;
@@ -577,7 +580,7 @@ namespace Terminal.Gui {
}
///
- /// Method that render to the appropriate type based on the type of the item passed to it.
+ /// Renders a
///
- /// Gets the item and value to use in an event handler.
+ ///
public class ListViewItemEventArgs : EventArgs {
///
- /// The item.
+ /// The index of the
public int Item { get; }
///
- /// The item value.
+ /// The the
public object Value { get; }
///
- /// Constructor to sets the item and value passed from.
+ /// Initializes a new instance of
- ///
- /// A menu item has a title, an associated help text, and an action to execute on activation.
+ /// A
public class MenuItem {
///
- /// constructor
+ /// Initializes a new instance of
public MenuItem ()
{
@@ -31,7 +31,7 @@ namespace Terminal.Gui {
}
///
- /// Initializes a new
///
- /// Initializes a new
///
- /// The hotkey is used when the menu is active, the shortcut can be triggered when the menu is not active.
+ /// 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
///
@@ -84,7 +81,7 @@ namespace Terminal.Gui {
public Key ShortCut;
///
- /// Gets or sets the title.
+ /// Gets or sets the title.
///
/// The title.
public ustring Title { get; set; }
@@ -118,7 +115,7 @@ namespace Terminal.Gui {
internal int Width => Title.Length + Help.Length + 1 + 2;
///
- /// Gets or sets the parent for this MenuBarItem
+ /// Gets or sets the parent for this
/// The parent.
internal MenuBarItem SubMenu { get; set; }
@@ -142,11 +139,11 @@ namespace Terminal.Gui {
}
///
- /// A menu bar item contains other menu items.
+ /// A
public class MenuBarItem : MenuItem {
///
- /// Initializes a new
///
- /// Initializes a new
///
- /// Initializes a new
///
- /// Gets or sets the children for this MenuBarItem
+ /// Gets or sets an array of
/// The children.
public MenuItem [] Children { get; set; }
@@ -524,11 +521,19 @@ namespace Terminal.Gui {
///
- /// A menu bar for your application.
+ /// The MenuBar provides a menu for Terminal.Gui applications.
///
+ ///
+ ///
+ /// The
+ ///
+ /// The
+ ///
public class MenuBar : View {
///
- /// The menus that were defined when the menubar was created. This can be updated if the menu is not currently visible.
+ /// Gets or sets the array of
/// The menu array.
public MenuBarItem [] Menus { get; set; }
@@ -543,9 +548,9 @@ namespace Terminal.Gui {
public bool UseKeysUpDownAsKeysLeftRight { get; set; } = true;
///
- /// Initializes a new instance of the
- ///
- /// Progress bar can indicate progress of an activity visually.
+ /// A Progress Bar view that can indicate progress of an activity visually.
///
///
///
- /// The progressbar can operate in two modes, percentage mode, or
+ ///
///
public class ProgressBar : View {
@@ -20,7 +19,7 @@ namespace Terminal.Gui {
int activityPos, delta;
///
- /// Initializes a new instance of the
///
- /// Initializes a new instance of the
public ProgressBar () : base ()
{
@@ -41,7 +40,7 @@ namespace Terminal.Gui {
float fraction;
///
- /// Gets or sets the progress indicator fraction to display, must be a value between 0 and 1.
+ /// Gets or sets the
/// The fraction representing the progress.
public float Fraction {
@@ -54,10 +53,10 @@ namespace Terminal.Gui {
}
///
- /// Notifies the progress bar that some progress has taken place.
+ /// Notifies the
///
- /// If the ProgressBar is is percentage mode, it switches to activity
+ /// If the
public void Pulse ()
@@ -80,6 +79,7 @@ namespace Terminal.Gui {
SetNeedsDisplay ();
}
+ ///
- /// Radio group shows a group of labels, only one of those can be selected at a given time
+ ///
public class RadioGroup : View {
int selected, cursor;
///
- /// Initializes a new instance of the
///
- /// The location of the cursor in the radio group
+ /// The location of the cursor in the
public int Cursor {
get => cursor;
@@ -35,11 +35,11 @@ namespace Terminal.Gui {
}
///
- /// Initializes a new instance of the
- ///
- /// Initializes a new instance of the
/// SelectionChanged;
///
@@ -137,6 +141,7 @@ namespace Terminal.Gui {
}
}
+ ///
- /// Initializes a new instance of the
///
- /// A statusbar item has a title, a shortcut aka hotkey, and an action to execute on activation.
- /// Such an item is ment to be as part of the global hotkeys of the application, which are available in the current context of the screen.
- /// The colour of the text will be changed after each ~. Having an statusbar item with a text of `~F1~ Help` will draw *F1* as shortcut and
- /// *Help* as standard text.
+ ///
public class StatusItem {
///
- /// Initializes a new
- ///
- /// This is the global setting that can be used as a global shortcut to invoke the action on the menu.
+ /// Gets the global shortcut to invoke the action on the menu.
///
public Key Shortcut { get; }
@@ -39,25 +42,30 @@ namespace Terminal.Gui {
/// Gets or sets the title.
///
/// The title.
+ ///
+ /// The colour of the
public ustring Title { get; }
///
/// Gets or sets the action to be invoked when the statusbar item is triggered
///
- /// Method to invoke.
+ /// Action to invoke.
public Action Action { get; }
};
///
- /// A statusbar for your application.
- /// The statusbar should be context sensitive. This means, if the main menu and an open text editor are visible, the items probably shown will
+ /// A status bar is a
public class StatusBar : View {
-// After attempting to implement this, I noticed that there are hard dependencies
-// on StatusBar and MenuBars within core. They will need to be refactored for having the
-// StatusBar work at the top
+ // After attempting to implement this, I noticed that there are hard dependencies
+ // on StatusBar and MenuBars within core. They will need to be refactored for having the
+ // StatusBar work at the top
#if SNAP_TO_TOP
///
/// The style supported by StatusBar
@@ -86,18 +94,18 @@ namespace Terminal.Gui {
public StatusBarStyle Style { get; set; } = StatusBarStyle.Default;
#endif
///
- /// The parent view of the StatusBar.
+ /// The parent view of the
public View Parent { get; set; }
///
- /// The items that compose the StatusBar
+ /// The items that compose the
public StatusItem [] Items { get; set; }
///
- /// Initializes a new instance of the
///
- /// Text data entry widget
+ /// Single-line text entry
///
- /// The Entry widget provides Emacs-like editing
- /// functionality, and mouse support.
+ /// The
public class TextField : View {
List text;
@@ -85,6 +84,7 @@ namespace Terminal.Gui {
WantMousePositionReports = true;
}
+ ///
- /// Sets or gets the text in the entry.
+ /// Sets or gets the text held by the view.
///
///
///
@@ -180,6 +181,7 @@ namespace Terminal.Gui {
Move (col, 0);
}
+ ///
+ /// Processes key presses for the
+ ///
+ /// The
+ ///
+ /// Keys
+ /// Function
+ ///
+ /// -
+ ///
Deletes the character before cursor.
+ ///
+ ///
+ ///
public override bool ProcessKey (KeyEvent kb)
{
// remember current cursor position
@@ -532,10 +553,10 @@ namespace Terminal.Gui {
return -1;
int i = p;
- if (Rune.IsPunctuation (text [p]) || Rune.IsWhiteSpace(text [p])) {
+ if (Rune.IsPunctuation (text [p]) || Rune.IsWhiteSpace (text [p])) {
for (; i < text.Count; i++) {
var r = text [i];
- if (Rune.IsLetterOrDigit(r))
+ if (Rune.IsLetterOrDigit (r))
break;
}
for (; i < text.Count; i++) {
@@ -565,7 +586,7 @@ namespace Terminal.Gui {
return 0;
var ti = text [i];
- if (Rune.IsPunctuation (ti) || Rune.IsSymbol(ti) || Rune.IsWhiteSpace(ti)) {
+ if (Rune.IsPunctuation (ti) || Rune.IsSymbol (ti) || Rune.IsWhiteSpace (ti)) {
for (; i >= 0; i--) {
if (Rune.IsLetterOrDigit (text [i]))
break;
@@ -606,6 +627,7 @@ namespace Terminal.Gui {
int start, length;
bool isButtonReleased = true;
+ ///
- /// Multi-line text editing view
+ /// Multi-line text editing
///
///
- /// The text view provides a multi-line text view. Users interact
+ ///
@@ -283,7 +283,7 @@ namespace Terminal.Gui {
//bool used;
///
- /// Raised when the Text of the TextView changes.
+ /// Raised when the
public event EventHandler TextChanged;
@@ -298,7 +298,7 @@ namespace Terminal.Gui {
public event EventHandler Changed;
#endif
///
- /// Public constructor, creates a view on the specified area, with absolute position and size.
+ /// Initalizes a
///
///
@@ -308,7 +308,8 @@ namespace Terminal.Gui {
}
///
- /// Public constructor, creates a view on the specified area, with dimensions controlled with the X, Y, Width and Height properties.
+ /// Initalizes a
public TextView () : base ()
{
@@ -321,7 +322,7 @@ namespace Terminal.Gui {
}
///
- /// Sets or gets the text in the entry.
+ /// Sets or gets the text in the
///
///
@@ -339,7 +340,7 @@ namespace Terminal.Gui {
}
///
- /// Loads the contents of the file into the TextView.
+ /// Loads the contents of the file into the
/// true , if file was loaded, false otherwise.
- /// Loads the contents of the stream into the TextView.
+ /// Loads the contents of the stream into the
/// true , if stream was loaded, false otherwise.
- /// Closes the contents of the stream into the TextView.
+ /// Closes the contents of the stream into the
/// true , if stream was closed, false otherwise.
- /// The current cursor row.
+ /// Gets the current cursor row.
///
public int CurrentRow => currentRow;
@@ -429,7 +430,7 @@ namespace Terminal.Gui {
bool isReadOnly = false;
///
- /// Indicates readonly attribute of TextView
+ /// Gets or sets whether the
/// Boolean value(Default false)
public bool ReadOnly {
@@ -523,10 +524,7 @@ namespace Terminal.Gui {
SetNeedsDisplay ();
}
- ///
- /// Redraw the text editor region
- ///
- ///
- /// Will scroll the view to display the specified row at the top
+ /// Will scroll the
///
- /// Time edit widget
+ /// Time editing
///
- /// This widget provides time editing functionality, and mouse support.
+ /// The
public class TimeField : TextField {
bool isShort;
@@ -32,7 +29,7 @@ namespace Terminal.Gui {
///
- /// Public constructor that creates a time edit field at an absolute position and fixed size.
+ /// Initializes a new instance of
///
- /// Gets or sets the time in the widget.
+ /// Gets or sets the time of the
///
///
@@ -119,7 +116,7 @@ namespace Terminal.Gui {
Text = time;
if (!DateTime.TryParseExact (text.ToString (), Format, CultureInfo.CurrentCulture, DateTimeStyles.None, out DateTime result) ||
- !isValidTime)
+ !isValidTime)
return false;
return true;
}
@@ -146,6 +143,7 @@ namespace Terminal.Gui {
CursorPosition++;
}
+ ///