diff --git a/Core.cs b/Core.cs index 1b69173ba..d3f77802e 100644 --- a/Core.cs +++ b/Core.cs @@ -112,13 +112,45 @@ namespace Terminal { } } + /// + /// 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. + /// + /// + /// + /// The View defines the base functionality for user interface elements in Terminal/gui.cs. Views + /// can contain one or more subviews, can respond to user input and render themselves on the screen. + /// + /// + /// Views are created with a specified rectangle region (the frame) that is relative to the container + /// that they are added into. + /// + /// + /// Subviews can be added to a View by calling the Add method. The container of a view is the + /// Superview. + /// + /// + /// Developers can call the SetNeedsDisplay method on the view to flag a region or the entire view + /// as requiring to be redrawn. + /// + /// public class View : Responder, IEnumerable { string id = ""; View container = null; View focused = null; + + /// + /// Points to the current driver in use by the view, it is a convenience property + /// for simplifying the development of new views. + /// public static ConsoleDriver Driver = Application.Driver; - public static IList empty = new List (0).AsReadOnly (); + + static IList empty = new List (0).AsReadOnly (); List subviews; + + /// + /// This returns a list of the subviews contained by this view. + /// + /// The subviews. public IList Subviews => subviews == null ? empty : subviews.AsReadOnly (); internal Rect NeedDisplay { get; private set; } = Rect.Empty; @@ -138,7 +170,14 @@ namespace Terminal { /// true if want mouse position reports; otherwise, false. public virtual bool WantMousePositionReports { get; set; } = false; - // The frame for this view + /// + /// Gets or sets the frame for the view. + /// + /// The frame. + /// + /// Altering the Frame of a view will trigger the redrawing of the + /// view as well as the redrawing of the affected regions in the superview. + /// public Rect Frame { get => frame; set { @@ -152,12 +191,20 @@ namespace Terminal { } } + /// + /// Gets an enumerator that enumerates the subviews in this view. + /// + /// The enumerator. public IEnumerator GetEnumerator () { foreach (var v in subviews) yield return v; } + /// + /// The bounds represent the View-relative rectangle used for this view. Updates to the Bounds update the Frame, and has the same side effects as updating the frame. + /// + /// The bounds. public Rect Bounds { get => new Rect (Point.Empty, Frame.Size); set { @@ -165,8 +212,16 @@ namespace Terminal { } } + /// + /// Returns the container for this view, or null if this view has not been added to a container. + /// + /// The super view. public View SuperView => container; + /// + /// Initializes a new instance of the class with the specified frame. This is the default constructor. + /// + /// The region covered by this view. public View (Rect frame) { this.Frame = frame; @@ -182,6 +237,10 @@ namespace Terminal { SetNeedsDisplay (Frame); } + /// + /// Flags the specified rectangle region on this view as needing to be repainted. + /// + /// The region that must be flagged for repaint. public void SetNeedsDisplay (Rect region) { if (NeedDisplay.IsEmpty) @@ -205,6 +264,9 @@ namespace Terminal { internal bool childNeedsDisplay; + /// + /// Flags this view for requiring the children views to be repainted. + /// public void ChildNeedsDisplay () { childNeedsDisplay = true; @@ -230,6 +292,10 @@ namespace Terminal { SetNeedsDisplay (); } + /// + /// Adds the specified views to the view. + /// + /// Array of one or more views (can be optional parameter). public void Add (params View [] views) { if (views == null) @@ -305,6 +371,7 @@ namespace Terminal { /// View-based row. /// Absolute column, display relative. /// Absolute row, display relative. + /// Whether to clip the result of the ViewToScreen method, if set to true, the rcol, rrow values are clamped to the screen dimensions. internal void ViewToScreen (int col, int row, out int rcol, out int rrow, bool clipped = true) { // Computes the real row, col relative to the screen. @@ -428,6 +495,10 @@ namespace Terminal { Move (frame.X, frame.Y); } + /// + /// Gets or sets a value indicating whether this has focus. + /// + /// true if has focus; otherwise, false. public override bool HasFocus { get { return base.HasFocus; @@ -444,6 +515,10 @@ namespace Terminal { /// The focused. public View Focused => focused; + /// + /// Returns the most focused view in the chain of subviews (the leaf view that has the focus). + /// + /// The most focused. public View MostFocused { get { if (Focused == null) @@ -471,6 +546,9 @@ namespace Terminal { Driver.AddCh (ch); } + /// + /// Removes the SetNeedsDisplay and the ChildNeedsDisplay setting on this view. + /// protected void ClearNeedsDisplay () { NeedDisplay = Rect.Empty; @@ -693,10 +771,19 @@ namespace Terminal { return false; } + /// + /// This virtual method is 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. + /// public virtual void LayoutSubviews () { } + /// + /// Returns a that represents the current . + /// + /// A that represents the current . public override string ToString () { return $"{GetType ().Name}({id})({Frame})"; @@ -715,10 +802,18 @@ namespace Terminal { public class Toplevel : View { public bool Running; + /// + /// Initializes a new instance of the class. + /// + /// Frame. public Toplevel (Rect frame) : base (frame) { } + /// + /// Convenience factory method that creates a new toplevel with the current terminal dimensions. + /// + /// The create. public static Toplevel Create () { return new Toplevel (new Rect (0, 0, Driver.Cols, Driver.Rows)); @@ -780,6 +875,10 @@ namespace Terminal { View contentView; string title; + /// + /// The title to be displayed for this window. + /// + /// The title. public string Title { get => title; set { @@ -921,9 +1020,27 @@ namespace Terminal { /// /// public class Application { + /// + /// The current Console Driver in use. + /// public static ConsoleDriver Driver = new CursesDriver (); + + /// + /// The Toplevel object used for the application on startup. + /// + /// 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. public static Toplevel Current { get; private set; } + + /// + /// The mainloop driver for the applicaiton + /// + /// The main loop. public static Mono.Terminal.MainLoop MainLoop { get; private set; } static Stack toplevels = new Stack (); diff --git a/Driver.cs b/Driver.cs index 67f805a38..bae92ab84 100644 --- a/Driver.cs +++ b/Driver.cs @@ -72,6 +72,9 @@ namespace Terminal { HLine, } + /// + /// ConsoleDriver is an abstract class that defines the requirements for a console driver. One implementation if the CursesDriver, and another one uses the .NET Console one. + /// public abstract class ConsoleDriver { public abstract int Cols { get; } public abstract int Rows { get; } @@ -107,6 +110,9 @@ namespace Terminal { public abstract void StopReportingMouseMoves (); } + /// + /// This is the Curses driver for the gui.cs/Terminal framework. + /// public class CursesDriver : ConsoleDriver { Action terminalResized; diff --git a/Event.cs b/Event.cs index 6630bc6d1..02f66010b 100644 --- a/Event.cs +++ b/Event.cs @@ -162,6 +162,11 @@ namespace Terminal { /// public MouseFlags Flags; + + /// + /// Returns a that represents the current . + /// + /// A that represents the current . public override string ToString() { return $"({X},{Y}:{Flags}"; diff --git a/README.md b/README.md index 86c8fa59a..028a67584 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ It is an updated version of [gui.cs](https://github.com/mono/mono-curses/blob/master/gui.cs) that I wrote for [mono-curses](https://github.com/mono/mono-curses) +# API Documentation + +Go to the [API documentation](https://migueldeicaza.github.io/gui.cs/api/Terminal.html) for details. + # Running and Building To run this, you will need a peer checkout of mono-ncurses to this diff --git a/Views/Label.cs b/Views/Label.cs index d55a57ff4..50010e86b 100644 --- a/Views/Label.cs +++ b/Views/Label.cs @@ -180,6 +180,10 @@ namespace Terminal { } } + /// + /// Controls the text-alignemtn property of the label, changing it will redisplay the label. + /// + /// The text alignment. public TextAlignment TextAlignment { get => textAlignment; set { @@ -188,10 +192,10 @@ namespace Terminal { } } + Attribute textColor = -1; /// /// The color used for the label /// - Attribute textColor = -1; public Attribute TextColor { get => textColor; set { diff --git a/Views/Menu.cs b/Views/Menu.cs index bed3d516a..6ba0f12a5 100644 --- a/Views/Menu.cs +++ b/Views/Menu.cs @@ -16,6 +16,13 @@ namespace Terminal { /// A menu item has a title, an associated help text, and an action to execute on activation. /// public class MenuItem { + + /// + /// Initializes a new . + /// + /// Title for the menu item. + /// Help text to display. + /// Action to invoke when the menu item is activated. public MenuItem (string title, string help, Action action) { Title = title ?? ""; @@ -35,15 +42,37 @@ namespace Terminal { } } - // 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 + // + // + + /// + /// 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 + /// public char HotKey; + + /// + /// This is the global setting that can be used as a global shortcut to invoke the action on the menu. + /// public Key ShortCut; + /// + /// Gets or sets the title. + /// + /// The title. public string Title { get; set; } + + /// + /// Gets or sets the help text for the menu item. + /// + /// The help text. public string Help { get; set; } + + /// + /// Gets or sets the action to be invoked when the menu is triggered + /// + /// Method to invoke. public Action Action { get; set; } internal int Width => Title.Length + Help.Length + 1 + 2; } @@ -222,10 +251,19 @@ namespace Terminal { /// A menu bar for your application. /// 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. + /// + /// The menu array. public MenuBarItem [] Menus { get; set; } int selected; Action action; + + /// + /// Initializes a new instance of the class with the specified set of toplevel menu items. + /// + /// Menus. public MenuBar (MenuBarItem [] menus) : base (new Rect (0, 0, Application.Driver.Cols, 1)) { Menus = menus; diff --git a/Views/RadioGroup.cs b/Views/RadioGroup.cs index 088a52465..9a18c51bc 100644 --- a/Views/RadioGroup.cs +++ b/Views/RadioGroup.cs @@ -36,7 +36,8 @@ namespace Terminal { /// The x coordinate. /// The y coordinate. /// Radio labels, the strings can contain hotkeys using an undermine before the letter. - /// The item to be selected, the value is clamped to the number of items. /// + /// The item to be selected, the value is clamped to the number of items. + /// public RadioGroup (int x, int y, string [] radioLabels, int selected = 0) : this (MakeRect (x, y, radioLabels), radioLabels, selected) { } diff --git a/docfx/api/Terminal/Terminal.Application.yml b/docfx/api/Terminal/Terminal.Application.yml index 81d0acbfd..f02787817 100644 --- a/docfx/api/Terminal/Terminal.Application.yml +++ b/docfx/api/Terminal/Terminal.Application.yml @@ -91,11 +91,12 @@ items: assemblies: - Terminal namespace: Terminal + summary: The current toplevel object. This is updated when Application.Run enters and leaves and points to the current toplevel. syntax: content: public static Terminal.Toplevel Current { get; } return: type: Terminal.Toplevel - description: To be added. + description: The current. overload: Terminal.Application.Current* exceptions: [] - uid: Terminal.Application.DebugDrawBounds @@ -128,6 +129,7 @@ items: assemblies: - Terminal namespace: Terminal + summary: The current Console Driver in use. syntax: content: public static Terminal.ConsoleDriver Driver; return: @@ -227,11 +229,12 @@ items: assemblies: - Terminal namespace: Terminal + summary: The mainloop driver for the applicaiton syntax: content: public static Mono.Terminal.MainLoop MainLoop { get; } return: type: Mono.Terminal.MainLoop - description: To be added. + description: The main loop. overload: Terminal.Application.MainLoop* exceptions: [] - uid: Terminal.Application.MakeCenteredRect(Terminal.Size) @@ -401,11 +404,12 @@ items: assemblies: - Terminal namespace: Terminal + summary: The Toplevel object used for the application on startup. syntax: content: public static Terminal.Toplevel Top { get; } return: type: Terminal.Toplevel - description: To be added. + description: The top. overload: Terminal.Application.Top* exceptions: [] - uid: Terminal.Application.UngrabMouse diff --git a/docfx/api/Terminal/Terminal.Button.yml b/docfx/api/Terminal/Terminal.Button.yml index 6e1f144ed..aca985f7a 100644 --- a/docfx/api/Terminal/Terminal.Button.yml +++ b/docfx/api/Terminal/Terminal.Button.yml @@ -50,7 +50,6 @@ items: - Terminal.View.DrawHotString(System.String,System.Boolean,Terminal.ColorScheme) - Terminal.View.DrawHotString(System.String,Terminal.Attribute,Terminal.Attribute) - Terminal.View.Driver - - Terminal.View.empty - Terminal.View.EnsureFocus - Terminal.View.Focused - Terminal.View.FocusFirst @@ -649,12 +648,6 @@ references: name: Driver nameWithType: View.Driver fullName: View.Driver -- uid: Terminal.View.empty - parent: Terminal.View - isExternal: false - name: empty - nameWithType: View.empty - fullName: View.empty - uid: Terminal.View.EnsureFocus parent: Terminal.View isExternal: false diff --git a/docfx/api/Terminal/Terminal.CheckBox.yml b/docfx/api/Terminal/Terminal.CheckBox.yml index 1fcc49ed7..163ac1b19 100644 --- a/docfx/api/Terminal/Terminal.CheckBox.yml +++ b/docfx/api/Terminal/Terminal.CheckBox.yml @@ -41,7 +41,6 @@ items: - Terminal.View.DrawHotString(System.String,System.Boolean,Terminal.ColorScheme) - Terminal.View.DrawHotString(System.String,Terminal.Attribute,Terminal.Attribute) - Terminal.View.Driver - - Terminal.View.empty - Terminal.View.EnsureFocus - Terminal.View.Focused - Terminal.View.FocusFirst @@ -515,12 +514,6 @@ references: name: Driver nameWithType: View.Driver fullName: View.Driver -- uid: Terminal.View.empty - parent: Terminal.View - isExternal: false - name: empty - nameWithType: View.empty - fullName: View.empty - uid: Terminal.View.EnsureFocus parent: Terminal.View isExternal: false diff --git a/docfx/api/Terminal/Terminal.ConsoleDriver.yml b/docfx/api/Terminal/Terminal.ConsoleDriver.yml index 90a9e67fe..8873c9659 100644 --- a/docfx/api/Terminal/Terminal.ConsoleDriver.yml +++ b/docfx/api/Terminal/Terminal.ConsoleDriver.yml @@ -32,6 +32,7 @@ items: assemblies: - Terminal namespace: Terminal + summary: ConsoleDriver is an abstract class that defines the requirements for a console driver. One implementation if the CursesDriver, and another one uses the .NET Console one. syntax: content: public abstract class ConsoleDriver inheritance: diff --git a/docfx/api/Terminal/Terminal.CursesDriver.yml b/docfx/api/Terminal/Terminal.CursesDriver.yml index 56bdf3a21..639dbf598 100644 --- a/docfx/api/Terminal/Terminal.CursesDriver.yml +++ b/docfx/api/Terminal/Terminal.CursesDriver.yml @@ -32,6 +32,7 @@ items: assemblies: - Terminal namespace: Terminal + summary: This is the Curses driver for the gui.cs/Terminal framework. syntax: content: 'public class CursesDriver : Terminal.ConsoleDriver' inheritance: diff --git a/docfx/api/Terminal/Terminal.Dialog.yml b/docfx/api/Terminal/Terminal.Dialog.yml index 5dd8d1175..fb3953bff 100644 --- a/docfx/api/Terminal/Terminal.Dialog.yml +++ b/docfx/api/Terminal/Terminal.Dialog.yml @@ -41,7 +41,6 @@ items: - Terminal.View.DrawHotString(System.String,System.Boolean,Terminal.ColorScheme) - Terminal.View.DrawHotString(System.String,Terminal.Attribute,Terminal.Attribute) - Terminal.View.Driver - - Terminal.View.empty - Terminal.View.EnsureFocus - Terminal.View.Focused - Terminal.View.FocusFirst @@ -354,12 +353,6 @@ references: name: Driver nameWithType: View.Driver fullName: View.Driver -- uid: Terminal.View.empty - parent: Terminal.View - isExternal: false - name: empty - nameWithType: View.empty - fullName: View.empty - uid: Terminal.View.EnsureFocus parent: Terminal.View isExternal: false diff --git a/docfx/api/Terminal/Terminal.Label.yml b/docfx/api/Terminal/Terminal.Label.yml index 9688603e1..7dd0e372d 100644 --- a/docfx/api/Terminal/Terminal.Label.yml +++ b/docfx/api/Terminal/Terminal.Label.yml @@ -41,7 +41,6 @@ items: - Terminal.View.DrawHotString(System.String,System.Boolean,Terminal.ColorScheme) - Terminal.View.DrawHotString(System.String,Terminal.Attribute,Terminal.Attribute) - Terminal.View.Driver - - Terminal.View.empty - Terminal.View.EnsureFocus - Terminal.View.Focused - Terminal.View.FocusFirst @@ -206,11 +205,12 @@ items: assemblies: - Terminal namespace: Terminal + summary: Controls the text-alignemtn property of the label, changing it will redisplay the label. syntax: content: public Terminal.TextAlignment TextAlignment { get; set; } return: type: Terminal.TextAlignment - description: To be added. + description: The text alignment. overload: Terminal.Label.TextAlignment* exceptions: [] - uid: Terminal.Label.TextColor @@ -225,6 +225,7 @@ items: assemblies: - Terminal namespace: Terminal + summary: The color used for the label syntax: content: public Terminal.Attribute TextColor { get; set; } return: @@ -449,12 +450,6 @@ references: name: Driver nameWithType: View.Driver fullName: View.Driver -- uid: Terminal.View.empty - parent: Terminal.View - isExternal: false - name: empty - nameWithType: View.empty - fullName: View.empty - uid: Terminal.View.EnsureFocus parent: Terminal.View isExternal: false diff --git a/docfx/api/Terminal/Terminal.MenuBar.yml b/docfx/api/Terminal/Terminal.MenuBar.yml index e7249441b..9243c8c13 100644 --- a/docfx/api/Terminal/Terminal.MenuBar.yml +++ b/docfx/api/Terminal/Terminal.MenuBar.yml @@ -40,7 +40,6 @@ items: - Terminal.View.DrawHotString(System.String,System.Boolean,Terminal.ColorScheme) - Terminal.View.DrawHotString(System.String,Terminal.Attribute,Terminal.Attribute) - Terminal.View.Driver - - Terminal.View.empty - Terminal.View.EnsureFocus - Terminal.View.Focused - Terminal.View.FocusFirst @@ -77,12 +76,13 @@ items: assemblies: - Terminal namespace: Terminal + summary: Initializes a new instance of the class with the specified set of toplevel menu items. syntax: content: public MenuBar (Terminal.MenuBarItem[] menus); parameters: - id: menus type: Terminal.MenuBarItem[] - description: To be added. + description: Menus. overload: Terminal.MenuBar.#ctor* exceptions: [] - uid: Terminal.MenuBar.Menus @@ -97,11 +97,12 @@ items: assemblies: - Terminal namespace: Terminal + summary: The menus that were defined when the menubar was created. This can be updated if the menu is not currently visible. syntax: content: public Terminal.MenuBarItem[] Menus { get; set; } return: type: Terminal.MenuBarItem[] - description: To be added. + description: The menu array. overload: Terminal.MenuBar.Menus* exceptions: [] - uid: Terminal.MenuBar.MouseEvent(Terminal.MouseEvent) @@ -427,12 +428,6 @@ references: name: Driver nameWithType: View.Driver fullName: View.Driver -- uid: Terminal.View.empty - parent: Terminal.View - isExternal: false - name: empty - nameWithType: View.empty - fullName: View.empty - uid: Terminal.View.EnsureFocus parent: Terminal.View isExternal: false diff --git a/docfx/api/Terminal/Terminal.MenuItem.yml b/docfx/api/Terminal/Terminal.MenuItem.yml index bbc62f898..c7fc5a367 100644 --- a/docfx/api/Terminal/Terminal.MenuItem.yml +++ b/docfx/api/Terminal/Terminal.MenuItem.yml @@ -37,18 +37,19 @@ items: assemblies: - Terminal namespace: Terminal + summary: Initializes a new . syntax: content: public MenuItem (string title, string help, Action action); parameters: - id: title type: System.String - description: To be added. + description: Title for the menu item. - id: help type: System.String - description: To be added. + description: Help text to display. - id: action type: System.Action - description: To be added. + description: Action to invoke when the menu item is activated. overload: Terminal.MenuItem.#ctor* exceptions: [] - uid: Terminal.MenuItem.Action @@ -63,11 +64,12 @@ items: assemblies: - Terminal namespace: Terminal + summary: Gets or sets the action to be invoked when the menu is triggered syntax: content: public Action Action { get; set; } return: type: System.Action - description: To be added. + description: Method to invoke. overload: Terminal.MenuItem.Action* exceptions: [] - uid: Terminal.MenuItem.Help @@ -82,11 +84,12 @@ items: assemblies: - Terminal namespace: Terminal + summary: Gets or sets the help text for the menu item. syntax: content: public string Help { get; set; } return: type: System.String - description: To be added. + description: The help text. overload: Terminal.MenuItem.Help* exceptions: [] - uid: Terminal.MenuItem.HotKey @@ -101,6 +104,7 @@ items: assemblies: - Terminal namespace: Terminal + summary: "The hotkey is used when the menu is active, the shortcut can be triggered when the menu is not active. \n For example HotKey would be \"N\" when the File Menu is open (assuming there is a \"_New\" entry\n if the ShortCut is set to \"Control-N\", this would be a global hotkey that would trigger as well" syntax: content: public char HotKey; return: @@ -119,6 +123,7 @@ items: assemblies: - Terminal namespace: Terminal + summary: This is the global setting that can be used as a global shortcut to invoke the action on the menu. syntax: content: public Terminal.Key ShortCut; return: @@ -137,11 +142,12 @@ items: assemblies: - Terminal namespace: Terminal + summary: Gets or sets the title. syntax: content: public string Title { get; set; } return: type: System.String - description: To be added. + description: The title. overload: Terminal.MenuItem.Title* exceptions: [] references: diff --git a/docfx/api/Terminal/Terminal.MouseEvent.yml b/docfx/api/Terminal/Terminal.MouseEvent.yml index 0acae6304..038ca5829 100644 --- a/docfx/api/Terminal/Terminal.MouseEvent.yml +++ b/docfx/api/Terminal/Terminal.MouseEvent.yml @@ -53,12 +53,13 @@ items: assemblies: - Terminal namespace: Terminal + summary: Returns a that represents the current . syntax: content: public override string ToString (); parameters: [] return: type: System.String - description: To be added. + description: A that represents the current . overload: Terminal.MouseEvent.ToString* exceptions: [] - uid: Terminal.MouseEvent.X diff --git a/docfx/api/Terminal/Terminal.RadioGroup.yml b/docfx/api/Terminal/Terminal.RadioGroup.yml index 3e52b3c9d..b29bd642d 100644 --- a/docfx/api/Terminal/Terminal.RadioGroup.yml +++ b/docfx/api/Terminal/Terminal.RadioGroup.yml @@ -43,7 +43,6 @@ items: - Terminal.View.DrawHotString(System.String,System.Boolean,Terminal.ColorScheme) - Terminal.View.DrawHotString(System.String,Terminal.Attribute,Terminal.Attribute) - Terminal.View.Driver - - Terminal.View.empty - Terminal.View.EnsureFocus - Terminal.View.Focused - Terminal.View.FocusFirst @@ -562,12 +561,6 @@ references: name: Driver nameWithType: View.Driver fullName: View.Driver -- uid: Terminal.View.empty - parent: Terminal.View - isExternal: false - name: empty - nameWithType: View.empty - fullName: View.empty - uid: Terminal.View.EnsureFocus parent: Terminal.View isExternal: false diff --git a/docfx/api/Terminal/Terminal.ScrollView.yml b/docfx/api/Terminal/Terminal.ScrollView.yml index d1f94fa9b..b78259e0f 100644 --- a/docfx/api/Terminal/Terminal.ScrollView.yml +++ b/docfx/api/Terminal/Terminal.ScrollView.yml @@ -34,7 +34,6 @@ items: - Terminal.View.DrawHotString(System.String,System.Boolean,Terminal.ColorScheme) - Terminal.View.DrawHotString(System.String,Terminal.Attribute,Terminal.Attribute) - Terminal.View.Driver - - Terminal.View.empty - Terminal.View.EnsureFocus - Terminal.View.Focused - Terminal.View.FocusFirst @@ -210,12 +209,6 @@ references: name: Driver nameWithType: View.Driver fullName: View.Driver -- uid: Terminal.View.empty - parent: Terminal.View - isExternal: false - name: empty - nameWithType: View.empty - fullName: View.empty - uid: Terminal.View.EnsureFocus parent: Terminal.View isExternal: false diff --git a/docfx/api/Terminal/Terminal.TextField.yml b/docfx/api/Terminal/Terminal.TextField.yml index 07dcdf2e1..af517963c 100644 --- a/docfx/api/Terminal/Terminal.TextField.yml +++ b/docfx/api/Terminal/Terminal.TextField.yml @@ -46,7 +46,6 @@ items: - Terminal.View.DrawHotString(System.String,System.Boolean,Terminal.ColorScheme) - Terminal.View.DrawHotString(System.String,Terminal.Attribute,Terminal.Attribute) - Terminal.View.Driver - - Terminal.View.empty - Terminal.View.EnsureFocus - Terminal.View.Focused - Terminal.View.FocusFirst @@ -573,12 +572,6 @@ references: name: Driver nameWithType: View.Driver fullName: View.Driver -- uid: Terminal.View.empty - parent: Terminal.View - isExternal: false - name: empty - nameWithType: View.empty - fullName: View.empty - uid: Terminal.View.EnsureFocus parent: Terminal.View isExternal: false diff --git a/docfx/api/Terminal/Terminal.Toplevel.yml b/docfx/api/Terminal/Terminal.Toplevel.yml index 0ddb99ca0..b6bdbb55c 100644 --- a/docfx/api/Terminal/Terminal.Toplevel.yml +++ b/docfx/api/Terminal/Terminal.Toplevel.yml @@ -45,7 +45,6 @@ items: - Terminal.View.DrawHotString(System.String,System.Boolean,Terminal.ColorScheme) - Terminal.View.DrawHotString(System.String,Terminal.Attribute,Terminal.Attribute) - Terminal.View.Driver - - Terminal.View.empty - Terminal.View.EnsureFocus - Terminal.View.Focused - Terminal.View.FocusFirst @@ -85,12 +84,13 @@ items: assemblies: - Terminal namespace: Terminal + summary: Initializes a new instance of the class. syntax: content: public Toplevel (Terminal.Rect frame); parameters: - id: frame type: Terminal.Rect - description: To be added. + description: Frame. overload: Terminal.Toplevel.#ctor* exceptions: [] - uid: Terminal.Toplevel.CanFocus @@ -124,12 +124,13 @@ items: assemblies: - Terminal namespace: Terminal + summary: Convenience factory method that creates a new toplevel with the current terminal dimensions. syntax: content: public static Terminal.Toplevel Create (); parameters: [] return: type: Terminal.Toplevel - description: To be added. + description: The create. overload: Terminal.Toplevel.Create* exceptions: [] - uid: Terminal.Toplevel.ProcessKey(Terminal.KeyEvent) @@ -348,12 +349,6 @@ references: name: Driver nameWithType: View.Driver fullName: View.Driver -- uid: Terminal.View.empty - parent: Terminal.View - isExternal: false - name: empty - nameWithType: View.empty - fullName: View.empty - uid: Terminal.View.EnsureFocus parent: Terminal.View isExternal: false diff --git a/docfx/api/Terminal/Terminal.View.yml b/docfx/api/Terminal/Terminal.View.yml index f5c09eaf8..b72a9e6be 100644 --- a/docfx/api/Terminal/Terminal.View.yml +++ b/docfx/api/Terminal/Terminal.View.yml @@ -15,7 +15,6 @@ items: - Terminal.View.DrawHotString(System.String,Terminal.Attribute,Terminal.Attribute) - Terminal.View.DrawHotString(System.String,System.Boolean,Terminal.ColorScheme) - Terminal.View.Driver - - Terminal.View.empty - Terminal.View.EnsureFocus - Terminal.View.Focused - Terminal.View.FocusFirst @@ -53,6 +52,8 @@ items: assemblies: - Terminal namespace: Terminal + summary: 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. + remarks: "

\n The View defines the base functionality for user interface elements in Terminal/gui.cs. Views\n can contain one or more subviews, can respond to user input and render themselves on the screen.\n

\n

\n Views are created with a specified rectangle region (the frame) that is relative to the container\n that they are added into. \n

\n

\n Subviews can be added to a View by calling the Add method. The container of a view is the \n Superview.\n

\n

\n Developers can call the SetNeedsDisplay method on the view to flag a region or the entire view\n as requiring to be redrawn.\n

" syntax: content: 'public class View : Terminal.Responder, System.Collections.IEnumerable' inheritance: @@ -84,12 +85,13 @@ items: assemblies: - Terminal namespace: Terminal + summary: Initializes a new instance of the class with the specified frame. This is the default constructor. syntax: content: public View (Terminal.Rect frame); parameters: - id: frame type: Terminal.Rect - description: To be added. + description: The region covered by this view. overload: Terminal.View.#ctor* exceptions: [] - uid: Terminal.View.Add(Terminal.View) @@ -125,12 +127,13 @@ items: assemblies: - Terminal namespace: Terminal + summary: Adds the specified views to the view. syntax: content: public void Add (Terminal.View[] views); parameters: - id: views type: Terminal.View[] - description: To be added. + description: Array of one or more views (can be optional parameter). overload: Terminal.View.Add* exceptions: [] - uid: Terminal.View.AddCh(System.Int32,System.Int32,System.Int32) @@ -172,11 +175,12 @@ items: assemblies: - Terminal namespace: Terminal + summary: The bounds represent the View-relative rectangle used for this view. Updates to the Bounds update the Frame, and has the same side effects as updating the frame. syntax: content: public Terminal.Rect Bounds { get; set; } return: type: Terminal.Rect - description: To be added. + description: The bounds. overload: Terminal.View.Bounds* exceptions: [] - uid: Terminal.View.ChildNeedsDisplay @@ -191,6 +195,7 @@ items: assemblies: - Terminal namespace: Terminal + summary: Flags this view for requiring the children views to be repainted. syntax: content: public void ChildNeedsDisplay (); parameters: [] @@ -230,6 +235,7 @@ items: assemblies: - Terminal namespace: Terminal + summary: Removes the SetNeedsDisplay and the ChildNeedsDisplay setting on this view. syntax: content: protected void ClearNeedsDisplay (); parameters: [] @@ -325,30 +331,15 @@ items: assemblies: - Terminal namespace: Terminal + summary: >- + Points to the current driver in use by the view, it is a convenience property + for simplifying the development of new views. syntax: content: public static Terminal.ConsoleDriver Driver; return: type: Terminal.ConsoleDriver description: To be added. exceptions: [] -- uid: Terminal.View.empty - id: empty - parent: Terminal.View - langs: - - csharp - name: empty - nameWithType: View.empty - fullName: View.empty - type: Field - assemblies: - - Terminal - namespace: Terminal - syntax: - content: public static System.Collections.Generic.IList empty; - return: - type: System.Collections.Generic.IList{Terminal.View} - description: To be added. - exceptions: [] - uid: Terminal.View.EnsureFocus id: EnsureFocus parent: Terminal.View @@ -477,11 +468,13 @@ items: assemblies: - Terminal namespace: Terminal + summary: Gets or sets the frame for the view. + remarks: "Altering the Frame of a view will trigger the redrawing of the \n view as well as the redrawing of the affected regions in the superview." syntax: content: public Terminal.Rect Frame { get; set; } return: type: Terminal.Rect - description: To be added. + description: The frame. overload: Terminal.View.Frame* exceptions: [] - uid: Terminal.View.GetEnumerator @@ -496,6 +489,7 @@ items: assemblies: - Terminal namespace: Terminal + summary: Gets an enumerator that enumerates the subviews in this view. syntax: content: >- [System.Runtime.CompilerServices.IteratorStateMachine(typeof(Terminal.View/d__23))] @@ -504,7 +498,7 @@ items: parameters: [] return: type: System.Collections.IEnumerator - description: To be added. + description: The enumerator. overload: Terminal.View.GetEnumerator* exceptions: [] attributes: @@ -521,11 +515,12 @@ items: assemblies: - Terminal namespace: Terminal + summary: Gets or sets a value indicating whether this has focus. syntax: content: public override bool HasFocus { get; } return: type: System.Boolean - description: To be added. + description: true if has focus; otherwise, false. overload: Terminal.View.HasFocus* exceptions: [] - uid: Terminal.View.Id @@ -559,6 +554,7 @@ items: assemblies: - Terminal namespace: Terminal + summary: "This virtual method is invoked when a view starts executing or \n when the dimensions of the view have changed, for example in \n response to the container view or terminal resizing." syntax: content: public virtual void LayoutSubviews (); parameters: [] @@ -576,11 +572,12 @@ items: assemblies: - Terminal namespace: Terminal + summary: Returns the most focused view in the chain of subviews (the leaf view that has the focus). syntax: content: public Terminal.View MostFocused { get; } return: type: Terminal.View - description: To be added. + description: The most focused. overload: Terminal.View.MostFocused* exceptions: [] - uid: Terminal.View.Move(System.Int32,System.Int32) @@ -835,12 +832,13 @@ items: assemblies: - Terminal namespace: Terminal + summary: Flags the specified rectangle region on this view as needing to be repainted. syntax: content: public void SetNeedsDisplay (Terminal.Rect region); parameters: - id: region type: Terminal.Rect - description: To be added. + description: The region that must be flagged for repaint. overload: Terminal.View.SetNeedsDisplay* exceptions: [] - uid: Terminal.View.Subviews @@ -855,11 +853,12 @@ items: assemblies: - Terminal namespace: Terminal + summary: This returns a list of the subviews contained by this view. syntax: content: public System.Collections.Generic.IList Subviews { get; } return: type: System.Collections.Generic.IList{Terminal.View} - description: To be added. + description: The subviews. overload: Terminal.View.Subviews* exceptions: [] - uid: Terminal.View.SuperView @@ -874,11 +873,12 @@ items: assemblies: - Terminal namespace: Terminal + summary: Returns the container for this view, or null if this view has not been added to a container. syntax: content: public Terminal.View SuperView { get; } return: type: Terminal.View - description: To be added. + description: The super view. overload: Terminal.View.SuperView* exceptions: [] - uid: Terminal.View.ToString @@ -893,12 +893,13 @@ items: assemblies: - Terminal namespace: Terminal + summary: Returns a that represents the current . syntax: content: public override string ToString (); parameters: [] return: type: System.String - description: To be added. + description: A that represents the current . overload: Terminal.View.ToString* exceptions: [] - uid: Terminal.View.WantMousePositionReports @@ -1062,37 +1063,6 @@ references: name: ConsoleDriver nameWithType: ConsoleDriver fullName: Terminal.ConsoleDriver -- uid: Terminal.View.empty - parent: Terminal.View - isExternal: false - name: empty - nameWithType: View.empty - fullName: View.empty -- uid: System.Collections.Generic.IList`1 - name: IList - nameWithType: IList - fullName: System.Collections.Generic.IList -- uid: System.Collections.Generic.IList{Terminal.View} - parent: System.Collections.Generic - isExternal: true - name: IList - nameWithType: IList - fullName: System.Collections.Generic.IList - spec.csharp: - - uid: System.Collections.Generic.IList`1 - name: IList - nameWithType: IList - fullName: System.Collections.Generic.IList - - name: < - nameWithType: < - fullName: < - - uid: Terminal.View - name: View - nameWithType: View - fullName: Terminal.View - - name: '>' - nameWithType: '>' - fullName: '>' - uid: Terminal.View.EnsureFocus parent: Terminal.View isExternal: false @@ -1261,6 +1231,31 @@ references: name: Subviews nameWithType: View.Subviews fullName: View.Subviews +- uid: System.Collections.Generic.IList`1 + name: IList + nameWithType: IList + fullName: System.Collections.Generic.IList +- uid: System.Collections.Generic.IList{Terminal.View} + parent: System.Collections.Generic + isExternal: true + name: IList + nameWithType: IList + fullName: System.Collections.Generic.IList + spec.csharp: + - uid: System.Collections.Generic.IList`1 + name: IList + nameWithType: IList + fullName: System.Collections.Generic.IList + - name: < + nameWithType: < + fullName: < + - uid: Terminal.View + name: View + nameWithType: View + fullName: Terminal.View + - name: '>' + nameWithType: '>' + fullName: '>' - uid: Terminal.View.SuperView parent: Terminal.View isExternal: false diff --git a/docfx/api/Terminal/Terminal.Window.yml b/docfx/api/Terminal/Terminal.Window.yml index c31addbd4..b42cabc97 100644 --- a/docfx/api/Terminal/Terminal.Window.yml +++ b/docfx/api/Terminal/Terminal.Window.yml @@ -45,7 +45,6 @@ items: - Terminal.View.DrawHotString(System.String,System.Boolean,Terminal.ColorScheme) - Terminal.View.DrawHotString(System.String,Terminal.Attribute,Terminal.Attribute) - Terminal.View.Driver - - Terminal.View.empty - Terminal.View.EnsureFocus - Terminal.View.Focused - Terminal.View.FocusFirst @@ -169,11 +168,12 @@ items: assemblies: - Terminal namespace: Terminal + summary: The title to be displayed for this window. syntax: content: public string Title { get; set; } return: type: System.String - description: To be added. + description: The title. overload: Terminal.Window.Title* exceptions: [] references: @@ -363,12 +363,6 @@ references: name: Driver nameWithType: View.Driver fullName: View.Driver -- uid: Terminal.View.empty - parent: Terminal.View - isExternal: false - name: empty - nameWithType: View.empty - fullName: View.empty - uid: Terminal.View.EnsureFocus parent: Terminal.View isExternal: false diff --git a/docs/api/Terminal.html b/docs/api/Terminal.html index 339236ea7..5eaf87f2f 100644 --- a/docs/api/Terminal.html +++ b/docs/api/Terminal.html @@ -92,9 +92,11 @@

Color scheme definitions

ConsoleDriver

-
+

ConsoleDriver is an abstract class that defines the requirements for a console driver. One implementation if the CursesDriver, and another one uses the .NET Console one.

+

CursesDriver

-
+

This is the Curses driver for the gui.cs/Terminal framework.

+

Dialog

The dialog box is a window that by default is centered and contains one or more buttons.

@@ -128,7 +130,8 @@

Toplevel views can be modally executed.

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.

+

Window

A toplevel view that draws a frame around its region and has a "ContentView" subview where the contents are added.

diff --git a/docs/api/Terminal/Terminal.Application.html b/docs/api/Terminal/Terminal.Application.html index b126767b2..78e1bdfff 100644 --- a/docs/api/Terminal/Terminal.Application.html +++ b/docs/api/Terminal/Terminal.Application.html @@ -141,7 +141,8 @@

Driver

-
+

The current Console Driver in use.

+
Declaration
@@ -195,7 +196,8 @@

Current

-
+

The current toplevel object. This is updated when Application.Run enters and leaves and points to the current toplevel.

+
Declaration
@@ -212,7 +214,7 @@ Toplevel -

To be added.

+

The current.

@@ -221,7 +223,8 @@

MainLoop

-
+

The mainloop driver for the applicaiton

+
Declaration
@@ -238,7 +241,7 @@ Mono.Terminal.MainLoop -

To be added.

+

The main loop.

@@ -247,7 +250,8 @@

Top

-
+

The Toplevel object used for the application on startup.

+
Declaration
@@ -264,7 +268,7 @@ Toplevel -

To be added.

+

The top.

diff --git a/docs/api/Terminal/Terminal.Button.html b/docs/api/Terminal/Terminal.Button.html index 13675eeac..d68a3e7e2 100644 --- a/docs/api/Terminal/Terminal.Button.html +++ b/docs/api/Terminal/Terminal.Button.html @@ -120,9 +120,6 @@ - diff --git a/docs/api/Terminal/Terminal.CheckBox.html b/docs/api/Terminal/Terminal.CheckBox.html index e0b68ac64..330f1bd21 100644 --- a/docs/api/Terminal/Terminal.CheckBox.html +++ b/docs/api/Terminal/Terminal.CheckBox.html @@ -119,9 +119,6 @@ - diff --git a/docs/api/Terminal/Terminal.ConsoleDriver.html b/docs/api/Terminal/Terminal.ConsoleDriver.html index 0d6989742..28c11762d 100644 --- a/docs/api/Terminal/Terminal.ConsoleDriver.html +++ b/docs/api/Terminal/Terminal.ConsoleDriver.html @@ -72,7 +72,8 @@

Class ConsoleDriver

-
+

ConsoleDriver is an abstract class that defines the requirements for a console driver. One implementation if the CursesDriver, and another one uses the .NET Console one.

+
Inheritance
diff --git a/docs/api/Terminal/Terminal.CursesDriver.html b/docs/api/Terminal/Terminal.CursesDriver.html index 2837354ca..179969914 100644 --- a/docs/api/Terminal/Terminal.CursesDriver.html +++ b/docs/api/Terminal/Terminal.CursesDriver.html @@ -72,7 +72,8 @@

Class CursesDriver

-
+

This is the Curses driver for the gui.cs/Terminal framework.

+
Inheritance
diff --git a/docs/api/Terminal/Terminal.Dialog.html b/docs/api/Terminal/Terminal.Dialog.html index 577b8e9cd..61b1159fb 100644 --- a/docs/api/Terminal/Terminal.Dialog.html +++ b/docs/api/Terminal/Terminal.Dialog.html @@ -129,9 +129,6 @@ - diff --git a/docs/api/Terminal/Terminal.Label.html b/docs/api/Terminal/Terminal.Label.html index 747592859..45d3529be 100644 --- a/docs/api/Terminal/Terminal.Label.html +++ b/docs/api/Terminal/Terminal.Label.html @@ -123,9 +123,6 @@ - @@ -330,7 +327,8 @@

TextAlignment

-
+

Controls the text-alignemtn property of the label, changing it will redisplay the label.

+
Declaration
@@ -347,7 +345,7 @@ TextAlignment -

To be added.

+

The text alignment.

@@ -356,7 +354,8 @@

TextColor

-
+

The color used for the label

+
Declaration
diff --git a/docs/api/Terminal/Terminal.MenuBar.html b/docs/api/Terminal/Terminal.MenuBar.html index 346ad65b2..70d3b6d21 100644 --- a/docs/api/Terminal/Terminal.MenuBar.html +++ b/docs/api/Terminal/Terminal.MenuBar.html @@ -120,9 +120,6 @@ - @@ -208,7 +205,8 @@

MenuBar(MenuBarItem[])

-
+

Initializes a new instance of the MenuBar class with the specified set of toplevel menu items.

+
Declaration
@@ -227,7 +225,7 @@ MenuBarItem[] menus -

To be added.

+

Menus.

@@ -238,7 +236,8 @@

Menus

-
+

The menus that were defined when the menubar was created. This can be updated if the menu is not currently visible.

+
Declaration
@@ -255,7 +254,7 @@ MenuBarItem[] -

To be added.

+

The menu array.

diff --git a/docs/api/Terminal/Terminal.MenuItem.html b/docs/api/Terminal/Terminal.MenuItem.html index 88d8168b7..7cb693eaf 100644 --- a/docs/api/Terminal/Terminal.MenuItem.html +++ b/docs/api/Terminal/Terminal.MenuItem.html @@ -92,7 +92,8 @@

MenuItem(String, String, Action)

-
+

Initializes a new MenuItem.

+
Declaration
@@ -111,19 +112,19 @@ System.String title -

To be added.

+

Title for the menu item.

System.String help -

To be added.

+

Help text to display.

System.Action action -

To be added.

+

Action to invoke when the menu item is activated.

@@ -133,7 +134,9 @@

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
@@ -158,7 +161,8 @@

ShortCut

-
+

This is the global setting that can be used as a global shortcut to invoke the action on the menu.

+
Declaration
@@ -186,7 +190,8 @@

Action

-
+

Gets or sets the action to be invoked when the menu is triggered

+
Declaration
@@ -203,7 +208,7 @@ System.Action -

To be added.

+

Method to invoke.

@@ -212,7 +217,8 @@

Help

-
+

Gets or sets the help text for the menu item.

+
Declaration
@@ -229,7 +235,7 @@ System.String -

To be added.

+

The help text.

@@ -238,7 +244,8 @@

Title

-
+

Gets or sets the title.

+
Declaration
@@ -255,7 +262,7 @@ System.String -

To be added.

+

The title.

diff --git a/docs/api/Terminal/Terminal.MouseEvent.html b/docs/api/Terminal/Terminal.MouseEvent.html index 3d6174aeb..d030049a4 100644 --- a/docs/api/Terminal/Terminal.MouseEvent.html +++ b/docs/api/Terminal/Terminal.MouseEvent.html @@ -167,7 +167,8 @@

ToString()

-
+

Returns a System.String that represents the current MouseEvent.

+
Declaration
@@ -184,7 +185,7 @@ System.String -

To be added.

+

A System.String that represents the current MouseEvent.

diff --git a/docs/api/Terminal/Terminal.RadioGroup.html b/docs/api/Terminal/Terminal.RadioGroup.html index b71a52231..916decebd 100644 --- a/docs/api/Terminal/Terminal.RadioGroup.html +++ b/docs/api/Terminal/Terminal.RadioGroup.html @@ -120,9 +120,6 @@ - diff --git a/docs/api/Terminal/Terminal.ScrollView.html b/docs/api/Terminal/Terminal.ScrollView.html index ecd2b2822..2e1b6a1ba 100644 --- a/docs/api/Terminal/Terminal.ScrollView.html +++ b/docs/api/Terminal/Terminal.ScrollView.html @@ -122,9 +122,6 @@ - diff --git a/docs/api/Terminal/Terminal.TextField.html b/docs/api/Terminal/Terminal.TextField.html index 0d01ff758..dc3e08e55 100644 --- a/docs/api/Terminal/Terminal.TextField.html +++ b/docs/api/Terminal/Terminal.TextField.html @@ -117,9 +117,6 @@ - diff --git a/docs/api/Terminal/Terminal.Toplevel.html b/docs/api/Terminal/Terminal.Toplevel.html index 5aa6be135..1d9ffcd8d 100644 --- a/docs/api/Terminal/Terminal.Toplevel.html +++ b/docs/api/Terminal/Terminal.Toplevel.html @@ -121,9 +121,6 @@ - @@ -223,7 +220,8 @@

Toplevel(Rect)

-
+

Initializes a new instance of the Toplevel class.

+
Declaration
@@ -242,7 +240,7 @@ Rect frame -

To be added.

+

Frame.

@@ -308,7 +306,8 @@

Create()

-
+

Convenience factory method that creates a new toplevel with the current terminal dimensions.

+
Declaration
@@ -325,7 +324,7 @@ Toplevel -

To be added.

+

The create.

diff --git a/docs/api/Terminal/Terminal.View.html b/docs/api/Terminal/Terminal.View.html index c4b600370..bbdcf029c 100644 --- a/docs/api/Terminal/Terminal.View.html +++ b/docs/api/Terminal/Terminal.View.html @@ -72,7 +72,8 @@

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
@@ -103,13 +104,30 @@ 
public class View : Terminal.Responder, System.Collections.IEnumerable
+
Remarks
+

+ The View defines the base functionality for user interface elements in Terminal/gui.cs. Views + can contain one or more subviews, can respond to user input and render themselves on the screen. +

+

+ Views are created with a specified rectangle region (the frame) that is relative to the container + that they are added into.

+

+ Subviews can be added to a View by calling the Add method. The container of a view is the + Superview. +

+

+ Developers can call the SetNeedsDisplay method on the view to flag a region or the entire view + as requiring to be redrawn. +

Constructors

View(Rect)

-
+

Initializes a new instance of the View class with the specified frame. This is the default constructor.

+
Declaration
@@ -128,7 +146,7 @@ Rect frame -

To be added.

+

The region covered by this view.

@@ -138,7 +156,9 @@

Driver

-
+

Points to the current driver in use by the view, it is a convenience property + for simplifying the development of new views.

+
Declaration
@@ -160,38 +180,14 @@ - - -

empty

-
-
-
Declaration
-
- 
public static System.Collections.Generic.IList<Terminal.View> empty;
-
-
Field Value
- - - - - - - - - - - - - -
TypeDescription
System.Collections.Generic.IList<View>

To be added.

-

Properties

Bounds

-
+

The bounds represent the View-relative rectangle used for this view. Updates to the Bounds update the Frame, and has the same side effects as updating the frame.

+
Declaration
@@ -208,7 +204,7 @@ Rect -

To be added.

+

The bounds.

@@ -244,7 +240,8 @@

Frame

-
+

Gets or sets the frame for the view.

+
Declaration
@@ -261,16 +258,21 @@ Rect -

To be added.

+

The frame.

+
Remarks
+

Altering the Frame of a view will trigger the redrawing of the + view as well as the redrawing of the affected regions in the superview.

+

HasFocus

-
+

Gets or sets a value indicating whether this View has focus.

+
Declaration
@@ -287,7 +289,7 @@ System.Boolean -

To be added.

+

true if has focus; otherwise, false.

@@ -322,7 +324,8 @@

MostFocused

-
+

Returns the most focused view in the chain of subviews (the leaf view that has the focus).

+
Declaration
@@ -339,7 +342,7 @@ View -

To be added.

+

The most focused.

@@ -348,7 +351,8 @@

Subviews

-
+

This returns a list of the subviews contained by this view.

+
Declaration
@@ -365,7 +369,7 @@ System.Collections.Generic.IList<View> -

To be added.

+

The subviews.

@@ -374,7 +378,8 @@

SuperView

-
+

Returns the container for this view, or null if this view has not been added to a container.

+
Declaration
@@ -391,7 +396,7 @@ View -

To be added.

+

The super view.

@@ -458,7 +463,8 @@

Add(View[])

-
+

Adds the specified views to the view.

+
Declaration
@@ -477,7 +483,7 @@ View[] views -

To be added.

+

Array of one or more views (can be optional parameter).

@@ -527,7 +533,8 @@

ChildNeedsDisplay()

-
+

Flags this view for requiring the children views to be repainted.

+
Declaration
@@ -552,7 +559,8 @@

ClearNeedsDisplay()

-
+

Removes the SetNeedsDisplay and the ChildNeedsDisplay setting on this view.

+
Declaration
@@ -766,7 +774,8 @@

GetEnumerator()

-
+

Gets an enumerator that enumerates the subviews in this view.

+
Declaration
@@ -784,7 +793,7 @@ public System.Collections.IEnumerator GetEnumerator (); System.Collections.IEnumerator -

To be added.

+

The enumerator.

@@ -793,7 +802,10 @@ public System.Collections.IEnumerator GetEnumerator ();

LayoutSubviews()

-
+

This virtual method is 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
@@ -1145,7 +1157,8 @@ public System.Collections.IEnumerator GetEnumerator ();

SetNeedsDisplay(Rect)

-
+

Flags the specified rectangle region on this view as needing to be repainted.

+
Declaration
@@ -1164,7 +1177,7 @@ public System.Collections.IEnumerator GetEnumerator (); Rect region -

To be added.

+

The region that must be flagged for repaint.

@@ -1173,7 +1186,8 @@ public System.Collections.IEnumerator GetEnumerator ();

ToString()

-
+

Returns a System.String that represents the current View.

+
Declaration
@@ -1190,7 +1204,7 @@ public System.Collections.IEnumerator GetEnumerator (); System.String -

To be added.

+

A System.String that represents the current View.

diff --git a/docs/api/Terminal/Terminal.Window.html b/docs/api/Terminal/Terminal.Window.html index 93eac6f58..3498a07b8 100644 --- a/docs/api/Terminal/Terminal.Window.html +++ b/docs/api/Terminal/Terminal.Window.html @@ -131,9 +131,6 @@ - @@ -259,7 +256,8 @@

Title

-
+

The title to be displayed for this window.

+
Declaration
@@ -276,7 +274,7 @@ System.String -

To be added.

+

The title.

diff --git a/docs/manifest.json b/docs/manifest.json index 786d9fab4..bc8cb7503 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -1 +1 @@ -{"homepages":[],"source_base_path":"/cvs/gui.cs/docfx","xrefmap":"xrefmap.yml","files":[{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Color.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Color.html","hash":"QNYr3es+bd7JHveIbEflog=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.TextAlignment.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.TextAlignment.html","hash":"VCohI9t1lob2fztxD5ZXcQ=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Attribute.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Attribute.html","hash":"3VQuiTvkwZuhrXRBU2slvA=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Colors.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Colors.html","hash":"hTNKl1AMUmC3DJCMsvGY/A=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.KeyEvent.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.KeyEvent.html","hash":"qCPAyivNpN13W4XhvZhTIw=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.TextField.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.TextField.html","hash":"vNAv5zOutAd57qU3v3mikQ=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.MenuItem.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.MenuItem.html","hash":"YESkMu2u25kAcXiejhgAig=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.ScrollView.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.ScrollView.html","hash":"JdH6xbUoQBVbPkd+L3Xv+w=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Application.RunState.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Application.RunState.html","hash":"ENFDgaI1CPsZ7cP3ufSnZQ=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.CursesDriver.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.CursesDriver.html","hash":"b/PJGhZgQ/9Xu3V4y2oS0w=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.MenuBarItem.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.MenuBarItem.html","hash":"6L7xElRY0i4gyn9ONrpJ6w=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Responder.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Responder.html","hash":"DJWHT+iWnN2wV1qbzFu1pw=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Window.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Window.html","hash":"s0XkI5cjcobPHvvlP0xsEQ=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal.yml","output":{".html":{"relative_path":"api/Terminal.html","hash":"o7mlJfZhTW8LS+EdoNKnfQ=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.MouseEvent.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.MouseEvent.html","hash":"HIHtD+qFH3WvBj/cfwhM+A=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.SpecialChar.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.SpecialChar.html","hash":"R83rZy9pvm8QGnzp5wLbVw=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Size.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Size.html","hash":"dbCoQlSvlIB2xUcAe5/e0g=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.CheckBox.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.CheckBox.html","hash":"VGVCzZH2OK49M9yvJqp/wQ=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Button.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Button.html","hash":"xyHuTJ0ARDJRVzuxYNdCJg=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.ColorScheme.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.ColorScheme.html","hash":"6FoPQFMOgLRgfGsmkgmkaA=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Key.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Key.html","hash":"Own6isULkMxAXV/FAnz6Cg=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.View.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.View.html","hash":"o9KCL2ZMk3kj5Lyu3JRckg=="}},"is_incremental":false,"version":""},{"type":"Toc","source_relative_path":"api/toc.yml","output":{".html":{"relative_path":"api/toc.html","hash":"/1PuhFzoQidfNv/AYOeP3Q=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Application.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Application.html","hash":"EgNXqZEXYWLtYx1GJ/I0IA=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Label.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Label.html","hash":"PPna40UufanNt4IfQDHkeA=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.RadioGroup.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.RadioGroup.html","hash":"1G/nvAw6z76o4mHsIhZF9g=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Point.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Point.html","hash":"cailyrfD9Y/tr5b2596SYw=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Rect.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Rect.html","hash":"z7sIdX73IQ86xDKIzN3RGw=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.ConsoleDriver.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.ConsoleDriver.html","hash":"g6/7h5zh9bz9WQJ/POPyow=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.MenuBar.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.MenuBar.html","hash":"LOwfbxUaY2p1aQpV1N5GbQ=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Dialog.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Dialog.html","hash":"rxleAMZRMAMdbTAqZ2iIZA=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.MessageBox.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.MessageBox.html","hash":"94sXhl7NmT8q7uBZbSy8hA=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.MouseFlags.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.MouseFlags.html","hash":"HuTdvqKEXLOsX6vasFWkKw=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Toplevel.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Toplevel.html","hash":"D3aHlAyHQqT3EnnYIQUxZQ=="}},"is_incremental":false,"version":""}],"version_info":{}} \ No newline at end of file +{"homepages":[],"source_base_path":"/cvs/gui.cs/docfx","xrefmap":"xrefmap.yml","files":[{"type":"Toc","source_relative_path":"api/toc.yml","output":{".html":{"relative_path":"api/toc.html","hash":"/1PuhFzoQidfNv/AYOeP3Q=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Button.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Button.html","hash":"AOrIPmOl0LyuL4Q/Cuu8BA=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.ColorScheme.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.ColorScheme.html","hash":"6FoPQFMOgLRgfGsmkgmkaA=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Colors.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Colors.html","hash":"hTNKl1AMUmC3DJCMsvGY/A=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.MenuBar.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.MenuBar.html","hash":"JlY39x34qaenJ2sqRvbSmA=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal.yml","output":{".html":{"relative_path":"api/Terminal.html","hash":"gKZ6HXyXx9kNlkc/A80Bxw=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Point.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Point.html","hash":"cailyrfD9Y/tr5b2596SYw=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Toplevel.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Toplevel.html","hash":"6QFcwHvBMGr4KRO14KdUeg=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.MouseFlags.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.MouseFlags.html","hash":"HuTdvqKEXLOsX6vasFWkKw=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.TextAlignment.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.TextAlignment.html","hash":"VCohI9t1lob2fztxD5ZXcQ=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Key.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Key.html","hash":"Own6isULkMxAXV/FAnz6Cg=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Label.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Label.html","hash":"GNOBfpMNzt2uVW2Q+1Ey5A=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.MouseEvent.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.MouseEvent.html","hash":"tWBrDmGanq6Qsj86XzS8PA=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.SpecialChar.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.SpecialChar.html","hash":"R83rZy9pvm8QGnzp5wLbVw=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Application.RunState.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Application.RunState.html","hash":"ENFDgaI1CPsZ7cP3ufSnZQ=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Size.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Size.html","hash":"dbCoQlSvlIB2xUcAe5/e0g=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.MenuItem.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.MenuItem.html","hash":"04liHi2Olqjby/8vkUCYZw=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.ScrollView.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.ScrollView.html","hash":"PFSt/2ITlr9wLK74F8m00A=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Color.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Color.html","hash":"QNYr3es+bd7JHveIbEflog=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.CursesDriver.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.CursesDriver.html","hash":"LEZNZrmyRxai7iKgBohTRw=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.RadioGroup.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.RadioGroup.html","hash":"QkLYZiszmBsvejc4WEQFoQ=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.TextField.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.TextField.html","hash":"VzXgT8lAfrrwVgGjkD42Ig=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.MessageBox.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.MessageBox.html","hash":"94sXhl7NmT8q7uBZbSy8hA=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.View.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.View.html","hash":"llGOc9vdREYzWTnQmkROaQ=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Window.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Window.html","hash":"OW2Ls4Mv/Inyh4ICiG3r0w=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Attribute.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Attribute.html","hash":"3VQuiTvkwZuhrXRBU2slvA=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.ConsoleDriver.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.ConsoleDriver.html","hash":"/ImK0726/L9Ybxj8sFUZ2A=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Dialog.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Dialog.html","hash":"FPmLQK56P2foDCD+uZGAUA=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.KeyEvent.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.KeyEvent.html","hash":"qCPAyivNpN13W4XhvZhTIw=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Application.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Application.html","hash":"FAr59mG5AW6pAQJFGZ7MXw=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.MenuBarItem.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.MenuBarItem.html","hash":"6L7xElRY0i4gyn9ONrpJ6w=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Responder.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Responder.html","hash":"DJWHT+iWnN2wV1qbzFu1pw=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.CheckBox.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.CheckBox.html","hash":"QV/9sfxbXNgScZkUqgolqg=="}},"is_incremental":false,"version":""},{"type":"ManagedReference","source_relative_path":"api/Terminal/Terminal.Rect.yml","output":{".html":{"relative_path":"api/Terminal/Terminal.Rect.html","hash":"z7sIdX73IQ86xDKIzN3RGw=="}},"is_incremental":false,"version":""}],"version_info":{}} \ No newline at end of file diff --git a/docs/xrefmap.yml b/docs/xrefmap.yml index 91e82ab8c..78f7d5269 100644 --- a/docs/xrefmap.yml +++ b/docs/xrefmap.yml @@ -2841,11 +2841,6 @@ references: href: api/Terminal/Terminal.View.html#Terminal_View_Driver fullName: View.Driver nameWithType: View.Driver -- uid: Terminal.View.empty - name: empty - href: api/Terminal/Terminal.View.html#Terminal_View_empty - fullName: View.empty - nameWithType: View.empty - uid: Terminal.View.EnsureFocus name: EnsureFocus() href: api/Terminal/Terminal.View.html#Terminal_View_EnsureFocus diff --git a/ecmadocs/en/Terminal/Application.xml b/ecmadocs/en/Terminal/Application.xml index b93503309..6972e9b02 100644 --- a/ecmadocs/en/Terminal/Application.xml +++ b/ecmadocs/en/Terminal/Application.xml @@ -73,8 +73,10 @@ Terminal.Toplevel - To be added. - To be added. + + The current toplevel object. This is updated when Application.Run enters and leaves and points to the current toplevel. + + The current. To be added. @@ -104,7 +106,9 @@ Terminal.ConsoleDriver - To be added. + + The current Console Driver in use. + To be added. @@ -197,8 +201,10 @@ Mono.Terminal.MainLoop - To be added. - To be added. + + The mainloop driver for the applicaiton + + The main loop. To be added. @@ -363,8 +369,10 @@ Terminal.Toplevel - To be added. - To be added. + + The Toplevel object used for the application on startup. + + The top. To be added. diff --git a/ecmadocs/en/Terminal/ConsoleDriver.xml b/ecmadocs/en/Terminal/ConsoleDriver.xml index 1475c2ffb..827c582dd 100644 --- a/ecmadocs/en/Terminal/ConsoleDriver.xml +++ b/ecmadocs/en/Terminal/ConsoleDriver.xml @@ -10,7 +10,9 @@ - To be added. + + ConsoleDriver is an abstract class that defines the requirements for a console driver. One implementation if the CursesDriver, and another one uses the .NET Console one. + To be added. diff --git a/ecmadocs/en/Terminal/CursesDriver.xml b/ecmadocs/en/Terminal/CursesDriver.xml index 51490ce3c..61e555ce8 100644 --- a/ecmadocs/en/Terminal/CursesDriver.xml +++ b/ecmadocs/en/Terminal/CursesDriver.xml @@ -10,7 +10,9 @@ - To be added. + + This is the Curses driver for the gui.cs/Terminal framework. + To be added. diff --git a/ecmadocs/en/Terminal/Label.xml b/ecmadocs/en/Terminal/Label.xml index 2f9366dc8..a0d7f51c4 100644 --- a/ecmadocs/en/Terminal/Label.xml +++ b/ecmadocs/en/Terminal/Label.xml @@ -135,8 +135,10 @@ Terminal.TextAlignment - To be added. - To be added. + + Controls the text-alignemtn property of the label, changing it will redisplay the label. + + The text alignment. To be added. @@ -151,7 +153,9 @@ Terminal.Attribute - To be added. + + The color used for the label + To be added. To be added. diff --git a/ecmadocs/en/Terminal/MenuBar.xml b/ecmadocs/en/Terminal/MenuBar.xml index cbe47ec0d..31e92b7a1 100644 --- a/ecmadocs/en/Terminal/MenuBar.xml +++ b/ecmadocs/en/Terminal/MenuBar.xml @@ -27,8 +27,10 @@ - To be added. - To be added. + Menus. + + Initializes a new instance of the class with the specified set of toplevel menu items. + To be added. @@ -43,8 +45,10 @@ Terminal.MenuBarItem[] - To be added. - To be added. + + The menus that were defined when the menubar was created. This can be updated if the menu is not currently visible. + + The menu array. To be added. diff --git a/ecmadocs/en/Terminal/MenuItem.xml b/ecmadocs/en/Terminal/MenuItem.xml index 5e20358f7..6c22152e7 100644 --- a/ecmadocs/en/Terminal/MenuItem.xml +++ b/ecmadocs/en/Terminal/MenuItem.xml @@ -29,10 +29,12 @@ - To be added. - To be added. - To be added. - To be added. + Title for the menu item. + Help text to display. + Action to invoke when the menu item is activated. + + Initializes a new . + To be added. @@ -47,8 +49,10 @@ System.Action - To be added. - To be added. + + Gets or sets the action to be invoked when the menu is triggered + + Method to invoke. To be added. @@ -63,8 +67,10 @@ System.String - To be added. - To be added. + + Gets or sets the help text for the menu item. + + The help text. To be added. @@ -79,7 +85,11 @@ System.Char - To be added. + + 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 + To be added. @@ -94,7 +104,9 @@ Terminal.Key - To be added. + + This is the global setting that can be used as a global shortcut to invoke the action on the menu. + To be added. @@ -109,8 +121,10 @@ System.String - To be added. - To be added. + + Gets or sets the title. + + The title. To be added. diff --git a/ecmadocs/en/Terminal/MouseEvent.xml b/ecmadocs/en/Terminal/MouseEvent.xml index 03edfdb61..2f407163a 100644 --- a/ecmadocs/en/Terminal/MouseEvent.xml +++ b/ecmadocs/en/Terminal/MouseEvent.xml @@ -45,8 +45,10 @@ - To be added. - To be added. + + Returns a that represents the current . + + A that represents the current . To be added. diff --git a/ecmadocs/en/Terminal/Toplevel.xml b/ecmadocs/en/Terminal/Toplevel.xml index 786821d09..bf49809b3 100644 --- a/ecmadocs/en/Terminal/Toplevel.xml +++ b/ecmadocs/en/Terminal/Toplevel.xml @@ -32,8 +32,10 @@ - To be added. - To be added. + Frame. + + Initializes a new instance of the class. + To be added. @@ -65,8 +67,10 @@ - To be added. - To be added. + + Convenience factory method that creates a new toplevel with the current terminal dimensions. + + The create. To be added. diff --git a/ecmadocs/en/Terminal/View.xml b/ecmadocs/en/Terminal/View.xml index 03ae5aedf..b9d213f50 100644 --- a/ecmadocs/en/Terminal/View.xml +++ b/ecmadocs/en/Terminal/View.xml @@ -14,8 +14,27 @@ - To be added. - To be added. + + 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. + + + + The View defines the base functionality for user interface elements in Terminal/gui.cs. Views + can contain one or more subviews, can respond to user input and render themselves on the screen. + + + Views are created with a specified rectangle region (the frame) that is relative to the container + that they are added into. + + + Subviews can be added to a View by calling the Add method. The container of a view is the + Superview. + + + Developers can call the SetNeedsDisplay method on the view to flag a region or the entire view + as requiring to be redrawn. + + @@ -29,8 +48,10 @@ - To be added. - To be added. + The region covered by this view. + + Initializes a new instance of the class with the specified frame. This is the default constructor. + To be added. @@ -75,8 +96,10 @@ - To be added. - To be added. + Array of one or more views (can be optional parameter). + + Adds the specified views to the view. + To be added. @@ -116,8 +139,10 @@ Terminal.Rect - To be added. - To be added. + + The bounds represent the View-relative rectangle used for this view. Updates to the Bounds update the Frame, and has the same side effects as updating the frame. + + The bounds. To be added. @@ -133,7 +158,9 @@ - To be added. + + Flags this view for requiring the children views to be repainted. + To be added. @@ -171,7 +198,9 @@ - To be added. + + Removes the SetNeedsDisplay and the ChildNeedsDisplay setting on this view. + To be added. @@ -259,22 +288,10 @@ Terminal.ConsoleDriver - To be added. - To be added. - - - - - - Field - - 0.0.0.0 - - - System.Collections.Generic.IList<Terminal.View> - - - To be added. + + Points to the current driver in use by the view, it is a convenience property + for simplifying the development of new views. + To be added. @@ -401,9 +418,14 @@ Terminal.Rect - To be added. - To be added. - To be added. + + Gets or sets the frame for the view. + + The frame. + + Altering the Frame of a view will trigger the redrawing of the + view as well as the redrawing of the affected regions in the superview. + @@ -423,8 +445,10 @@ - To be added. - To be added. + + Gets an enumerator that enumerates the subviews in this view. + + The enumerator. To be added. @@ -439,8 +463,11 @@ System.Boolean - To be added. - To be added. + + Gets or sets a value indicating whether this has focus. + + + true if has focus; otherwise, false. To be added. @@ -472,7 +499,11 @@ - To be added. + + This virtual method is 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. + To be added. @@ -487,8 +518,10 @@ Terminal.View - To be added. - To be added. + + Returns the most focused view in the chain of subviews (the leaf view that has the focus). + + The most focused. To be added. @@ -734,8 +767,10 @@ - To be added. - To be added. + The region that must be flagged for repaint. + + Flags the specified rectangle region on this view as needing to be repainted. + To be added. @@ -750,8 +785,10 @@ System.Collections.Generic.IList<Terminal.View> - To be added. - To be added. + + This returns a list of the subviews contained by this view. + + The subviews. To be added. @@ -766,8 +803,10 @@ Terminal.View - To be added. - To be added. + + Returns the container for this view, or null if this view has not been added to a container. + + The super view. To be added. @@ -783,8 +822,10 @@ - To be added. - To be added. + + Returns a that represents the current . + + A that represents the current . To be added. diff --git a/ecmadocs/en/Terminal/Window.xml b/ecmadocs/en/Terminal/Window.xml index 0e5100669..f015adea2 100644 --- a/ecmadocs/en/Terminal/Window.xml +++ b/ecmadocs/en/Terminal/Window.xml @@ -110,8 +110,10 @@ System.String - To be added. - To be added. + + The title to be displayed for this window. + + The title. To be added.