diff --git a/docfx/api/Terminal.Gui/Terminal.Gui.Dim.yml b/docfx/api/Terminal.Gui/Terminal.Gui.Dim.yml new file mode 100644 index 000000000..02d2a6f20 --- /dev/null +++ b/docfx/api/Terminal.Gui/Terminal.Gui.Dim.yml @@ -0,0 +1,276 @@ +### YamlMime:ManagedReference +items: +- uid: Terminal.Gui.Dim + id: Dim + children: + - Terminal.Gui.Dim.#ctor + - Terminal.Gui.Dim.Fill(System.Int32) + - Terminal.Gui.Dim.op_Addition(Terminal.Gui.Dim,Terminal.Gui.Dim) + - Terminal.Gui.Dim.op_Implicit(System.Int32 to Terminal.Gui.Dim) + - Terminal.Gui.Dim.op_Subtraction(Terminal.Gui.Dim,Terminal.Gui.Dim) + - Terminal.Gui.Dim.Percent(System.Single) + langs: + - csharp + name: Dim + nameWithType: Dim + fullName: Terminal.Gui.Dim + type: Class + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + remarks: >- +

+ Use the Dim objects on the Width or Height properties of a view to control the position. +

+

+ These can be used to set the absolute position, when merely assigning an + integer value (via the implicit integer to Pos conversion), and they can be combined + to produce more useful layouts, like: Pos.Center - 3, which would shift the postion + of the view 3 characters to the left after centering for example. +

+ syntax: + content: public class Dim + inheritance: + - System.Object + implements: [] + inheritedMembers: [] +- uid: Terminal.Gui.Dim.#ctor + id: '#ctor' + parent: Terminal.Gui.Dim + langs: + - csharp + name: Dim() + nameWithType: Dim.Dim() + fullName: Dim.Dim() + type: Constructor + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + syntax: + content: public Dim (); + parameters: [] + overload: Terminal.Gui.Dim.#ctor* + exceptions: [] +- uid: Terminal.Gui.Dim.Fill(System.Int32) + id: Fill(System.Int32) + parent: Terminal.Gui.Dim + langs: + - csharp + name: Fill(Int32) + nameWithType: Dim.Fill(Int32) + fullName: Dim.Fill(Int32) + type: Method + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + summary: Creates a Dim object that fills the dimension, but leaves the specified number of colums for a margin. + syntax: + content: public static Terminal.Gui.Dim Fill (int margin = 0); + parameters: + - id: margin + type: System.Int32 + description: Margin to use. + return: + type: Terminal.Gui.Dim + description: The Fill dimension. + overload: Terminal.Gui.Dim.Fill* + exceptions: [] +- uid: Terminal.Gui.Dim.op_Addition(Terminal.Gui.Dim,Terminal.Gui.Dim) + id: op_Addition(Terminal.Gui.Dim,Terminal.Gui.Dim) + parent: Terminal.Gui.Dim + langs: + - csharp + name: op_Addition(Dim, Dim) + nameWithType: Dim.op_Addition(Dim, Dim) + fullName: Dim.op_Addition(Dim, Dim) + type: Operator + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + summary: Adds a to a , yielding a new . + syntax: + content: public static Terminal.Gui.Dim op_Addition (Terminal.Gui.Dim left, Terminal.Gui.Dim right); + parameters: + - id: left + type: Terminal.Gui.Dim + description: The first to add. + - id: right + type: Terminal.Gui.Dim + description: The second to add. + return: + type: Terminal.Gui.Dim + description: The that is the sum of the values of left and right. + overload: Terminal.Gui.Dim.op_Addition* + exceptions: [] +- uid: Terminal.Gui.Dim.op_Implicit(System.Int32 to Terminal.Gui.Dim) + id: op_Implicit(System.Int32 to Terminal.Gui.Dim) + parent: Terminal.Gui.Dim + langs: + - csharp + name: op_Implicit(Int32 to Dim) + nameWithType: Dim.op_Implicit(Int32 to Dim) + fullName: Dim.op_Implicit(Int32 to Dim) + type: Operator + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + summary: Creates an Absolute Pos from the specified integer value. + syntax: + content: public static Terminal.Gui.Dim op_Implicit (int n); + parameters: + - id: n + type: System.Int32 + description: The value to convert to the pos. + return: + type: Terminal.Gui.Dim + description: The Absolute Pos. + overload: Terminal.Gui.Dim.op_Implicit* + exceptions: [] +- uid: Terminal.Gui.Dim.op_Subtraction(Terminal.Gui.Dim,Terminal.Gui.Dim) + id: op_Subtraction(Terminal.Gui.Dim,Terminal.Gui.Dim) + parent: Terminal.Gui.Dim + langs: + - csharp + name: op_Subtraction(Dim, Dim) + nameWithType: Dim.op_Subtraction(Dim, Dim) + fullName: Dim.op_Subtraction(Dim, Dim) + type: Operator + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + summary: Subtracts a from a , yielding a new . + syntax: + content: public static Terminal.Gui.Dim op_Subtraction (Terminal.Gui.Dim left, Terminal.Gui.Dim right); + parameters: + - id: left + type: Terminal.Gui.Dim + description: The to subtract from (the minuend). + - id: right + type: Terminal.Gui.Dim + description: The to subtract (the subtrahend). + return: + type: Terminal.Gui.Dim + description: The that is the left minus right. + overload: Terminal.Gui.Dim.op_Subtraction* + exceptions: [] +- uid: Terminal.Gui.Dim.Percent(System.Single) + id: Percent(System.Single) + parent: Terminal.Gui.Dim + langs: + - csharp + name: Percent(Single) + nameWithType: Dim.Percent(Single) + fullName: Dim.Percent(Single) + type: Method + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + summary: Creates a percentage Dim object + syntax: + content: public static Terminal.Gui.Dim Percent (float n); + parameters: + - id: n + type: System.Single + description: A value between 0 and 100 representing the percentage. + return: + type: Terminal.Gui.Dim + description: The percent Dim object. + overload: Terminal.Gui.Dim.Percent* + exceptions: [] +references: +- uid: System.Object + parent: System + isExternal: true + name: Object + nameWithType: Object + fullName: System.Object +- uid: Terminal.Gui.Dim.#ctor + parent: Terminal.Gui.Dim + isExternal: false + name: Dim() + nameWithType: Dim.Dim() + fullName: Dim.Dim() +- uid: Terminal.Gui.Dim.Fill(System.Int32) + parent: Terminal.Gui.Dim + isExternal: false + name: Fill(Int32) + nameWithType: Dim.Fill(Int32) + fullName: Dim.Fill(Int32) +- uid: Terminal.Gui.Dim + parent: Terminal.Gui + isExternal: false + name: Dim + nameWithType: Dim + fullName: Terminal.Gui.Dim +- uid: System.Int32 + parent: System + isExternal: true + name: Int32 + nameWithType: Int32 + fullName: System.Int32 +- uid: Terminal.Gui.Dim.op_Addition(Terminal.Gui.Dim,Terminal.Gui.Dim) + parent: Terminal.Gui.Dim + isExternal: false + name: op_Addition(Dim, Dim) + nameWithType: Dim.op_Addition(Dim, Dim) + fullName: Dim.op_Addition(Dim, Dim) +- uid: Terminal.Gui.Dim.op_Implicit(System.Int32 to Terminal.Gui.Dim) + parent: Terminal.Gui.Dim + isExternal: false + name: op_Implicit(Int32 to Dim) + nameWithType: Dim.op_Implicit(Int32 to Dim) + fullName: Dim.op_Implicit(Int32 to Dim) +- uid: Terminal.Gui.Dim.op_Subtraction(Terminal.Gui.Dim,Terminal.Gui.Dim) + parent: Terminal.Gui.Dim + isExternal: false + name: op_Subtraction(Dim, Dim) + nameWithType: Dim.op_Subtraction(Dim, Dim) + fullName: Dim.op_Subtraction(Dim, Dim) +- uid: Terminal.Gui.Dim.Percent(System.Single) + parent: Terminal.Gui.Dim + isExternal: false + name: Percent(Single) + nameWithType: Dim.Percent(Single) + fullName: Dim.Percent(Single) +- uid: System.Single + parent: System + isExternal: true + name: Single + nameWithType: Single + fullName: System.Single +- uid: Terminal.Gui.Dim.#ctor* + parent: Terminal.Gui.Dim + isExternal: false + name: Dim + nameWithType: Dim.Dim + fullName: Dim.Dim +- uid: Terminal.Gui.Dim.Fill* + parent: Terminal.Gui.Dim + isExternal: false + name: Fill + nameWithType: Dim.Fill + fullName: Dim.Fill +- uid: Terminal.Gui.Dim.op_Addition* + parent: Terminal.Gui.Dim + isExternal: false + name: op_Addition + nameWithType: Dim.op_Addition + fullName: Dim.op_Addition +- uid: Terminal.Gui.Dim.op_Implicit* + parent: Terminal.Gui.Dim + isExternal: false + name: op_Implicit + nameWithType: Dim.op_Implicit + fullName: Dim.op_Implicit +- uid: Terminal.Gui.Dim.op_Subtraction* + parent: Terminal.Gui.Dim + isExternal: false + name: op_Subtraction + nameWithType: Dim.op_Subtraction + fullName: Dim.op_Subtraction +- uid: Terminal.Gui.Dim.Percent* + parent: Terminal.Gui.Dim + isExternal: false + name: Percent + nameWithType: Dim.Percent + fullName: Dim.Percent diff --git a/docfx/api/Terminal.Gui/Terminal.Gui.LayoutStyle.yml b/docfx/api/Terminal.Gui/Terminal.Gui.LayoutStyle.yml new file mode 100644 index 000000000..ece96a236 --- /dev/null +++ b/docfx/api/Terminal.Gui/Terminal.Gui.LayoutStyle.yml @@ -0,0 +1,86 @@ +### YamlMime:ManagedReference +items: +- uid: Terminal.Gui.LayoutStyle + id: LayoutStyle + children: + - Terminal.Gui.LayoutStyle.Absolute + - Terminal.Gui.LayoutStyle.Computed + langs: + - csharp + name: LayoutStyle + nameWithType: LayoutStyle + fullName: Terminal.Gui.LayoutStyle + type: Enum + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + summary: "Determines the LayoutStyle for a view, if Absolute, during LayoutSubviews, the\n value from the Frame will be used, if the value is Computer, then the Frame \n will be updated from the X, Y Pos objets and the Width and Heigh Dim objects." + syntax: + content: public enum LayoutStyle + inheritance: + - System.Enum +- uid: Terminal.Gui.LayoutStyle.Absolute + id: Absolute + parent: Terminal.Gui.LayoutStyle + langs: + - csharp + name: Absolute + nameWithType: LayoutStyle.Absolute + fullName: LayoutStyle.Absolute + type: Field + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + summary: The position and size of the view are based on the Frame value. + syntax: + content: Absolute + return: + type: Terminal.Gui.LayoutStyle + description: To be added. + exceptions: [] +- uid: Terminal.Gui.LayoutStyle.Computed + id: Computed + parent: Terminal.Gui.LayoutStyle + langs: + - csharp + name: Computed + nameWithType: LayoutStyle.Computed + fullName: LayoutStyle.Computed + type: Field + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + summary: >- + The position and size of the view will be computed based on the + X, Y, Width and Height properties and set on the Frame. + syntax: + content: Computed + return: + type: Terminal.Gui.LayoutStyle + description: To be added. + exceptions: [] +references: +- uid: System.Enum + parent: System + isExternal: true + name: Enum + nameWithType: Enum + fullName: System.Enum +- uid: Terminal.Gui.LayoutStyle.Absolute + parent: Terminal.Gui.LayoutStyle + isExternal: false + name: Absolute + nameWithType: LayoutStyle.Absolute + fullName: LayoutStyle.Absolute +- uid: Terminal.Gui.LayoutStyle + parent: Terminal.Gui + isExternal: false + name: LayoutStyle + nameWithType: LayoutStyle + fullName: Terminal.Gui.LayoutStyle +- uid: Terminal.Gui.LayoutStyle.Computed + parent: Terminal.Gui.LayoutStyle + isExternal: false + name: Computed + nameWithType: LayoutStyle.Computed + fullName: LayoutStyle.Computed diff --git a/docfx/api/Terminal.Gui/Terminal.Gui.Pos.yml b/docfx/api/Terminal.Gui/Terminal.Gui.Pos.yml new file mode 100644 index 000000000..6c60ce34c --- /dev/null +++ b/docfx/api/Terminal.Gui/Terminal.Gui.Pos.yml @@ -0,0 +1,311 @@ +### YamlMime:ManagedReference +items: +- uid: Terminal.Gui.Pos + id: Pos + children: + - Terminal.Gui.Pos.#ctor + - Terminal.Gui.Pos.AnchorEnd(System.Int32) + - Terminal.Gui.Pos.Center + - Terminal.Gui.Pos.op_Addition(Terminal.Gui.Pos,Terminal.Gui.Pos) + - Terminal.Gui.Pos.op_Implicit(System.Int32 to Terminal.Gui.Pos) + - Terminal.Gui.Pos.op_Subtraction(Terminal.Gui.Pos,Terminal.Gui.Pos) + - Terminal.Gui.Pos.Percent(System.Single) + langs: + - csharp + name: Pos + nameWithType: Pos + fullName: Terminal.Gui.Pos + type: Class + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + summary: "Describes a position which can be an absolute value, a percentage, centered, or \n relative to the ending dimension. Integer values are implicitly convertible to\n an absolute Pos. These objects are created using the static methods Percent,\n AnchorEnd and Center. The Pos objects can be combined with the addition and \n subtraction operators." + remarks: >- +

+ Use the Pos objects on the X or Y properties of a view to control the position. +

+

+ These can be used to set the absolute position, when merely assigning an + integer value (via the implicit integer to Pos conversion), and they can be combined + to produce more useful layouts, like: Pos.Center - 3, which would shift the postion + of the view 3 characters to the left after centering for example. +

+ syntax: + content: public class Pos + inheritance: + - System.Object + implements: [] + inheritedMembers: [] +- uid: Terminal.Gui.Pos.#ctor + id: '#ctor' + parent: Terminal.Gui.Pos + langs: + - csharp + name: Pos() + nameWithType: Pos.Pos() + fullName: Pos.Pos() + type: Constructor + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + syntax: + content: public Pos (); + parameters: [] + overload: Terminal.Gui.Pos.#ctor* + exceptions: [] +- uid: Terminal.Gui.Pos.AnchorEnd(System.Int32) + id: AnchorEnd(System.Int32) + parent: Terminal.Gui.Pos + langs: + - csharp + name: AnchorEnd(Int32) + nameWithType: Pos.AnchorEnd(Int32) + fullName: Pos.AnchorEnd(Int32) + type: Method + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + summary: "Creates a Pos object that is anchored to the end of the dimension, useful to flush \n the layout from the end." + syntax: + content: public static Terminal.Gui.Pos AnchorEnd (int margin = 0); + parameters: + - id: margin + type: System.Int32 + description: Optional margin to set aside. + return: + type: Terminal.Gui.Pos + description: The Pos object anchored to the end (the bottom or the right side). + overload: Terminal.Gui.Pos.AnchorEnd* + exceptions: [] +- uid: Terminal.Gui.Pos.Center + id: Center + parent: Terminal.Gui.Pos + langs: + - csharp + name: Center() + nameWithType: Pos.Center() + fullName: Pos.Center() + type: Method + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + summary: Returns a Pos object that can be used to center the views. + syntax: + content: public static Terminal.Gui.Pos Center (); + parameters: [] + return: + type: Terminal.Gui.Pos + description: The center Pos. + overload: Terminal.Gui.Pos.Center* + exceptions: [] +- uid: Terminal.Gui.Pos.op_Addition(Terminal.Gui.Pos,Terminal.Gui.Pos) + id: op_Addition(Terminal.Gui.Pos,Terminal.Gui.Pos) + parent: Terminal.Gui.Pos + langs: + - csharp + name: op_Addition(Pos, Pos) + nameWithType: Pos.op_Addition(Pos, Pos) + fullName: Pos.op_Addition(Pos, Pos) + type: Operator + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + summary: Adds a to a , yielding a new . + syntax: + content: public static Terminal.Gui.Pos op_Addition (Terminal.Gui.Pos left, Terminal.Gui.Pos right); + parameters: + - id: left + type: Terminal.Gui.Pos + description: The first to add. + - id: right + type: Terminal.Gui.Pos + description: The second to add. + return: + type: Terminal.Gui.Pos + description: The that is the sum of the values of left and right. + overload: Terminal.Gui.Pos.op_Addition* + exceptions: [] +- uid: Terminal.Gui.Pos.op_Implicit(System.Int32 to Terminal.Gui.Pos) + id: op_Implicit(System.Int32 to Terminal.Gui.Pos) + parent: Terminal.Gui.Pos + langs: + - csharp + name: op_Implicit(Int32 to Pos) + nameWithType: Pos.op_Implicit(Int32 to Pos) + fullName: Pos.op_Implicit(Int32 to Pos) + type: Operator + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + summary: Creates an Absolute Pos from the specified integer value. + syntax: + content: public static Terminal.Gui.Pos op_Implicit (int n); + parameters: + - id: n + type: System.Int32 + description: The value to convert to the pos. + return: + type: Terminal.Gui.Pos + description: The Absolute Pos. + overload: Terminal.Gui.Pos.op_Implicit* + exceptions: [] +- uid: Terminal.Gui.Pos.op_Subtraction(Terminal.Gui.Pos,Terminal.Gui.Pos) + id: op_Subtraction(Terminal.Gui.Pos,Terminal.Gui.Pos) + parent: Terminal.Gui.Pos + langs: + - csharp + name: op_Subtraction(Pos, Pos) + nameWithType: Pos.op_Subtraction(Pos, Pos) + fullName: Pos.op_Subtraction(Pos, Pos) + type: Operator + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + summary: Subtracts a from a , yielding a new . + syntax: + content: public static Terminal.Gui.Pos op_Subtraction (Terminal.Gui.Pos left, Terminal.Gui.Pos right); + parameters: + - id: left + type: Terminal.Gui.Pos + description: The to subtract from (the minuend). + - id: right + type: Terminal.Gui.Pos + description: The to subtract (the subtrahend). + return: + type: Terminal.Gui.Pos + description: The that is the left minus right. + overload: Terminal.Gui.Pos.op_Subtraction* + exceptions: [] +- uid: Terminal.Gui.Pos.Percent(System.Single) + id: Percent(System.Single) + parent: Terminal.Gui.Pos + langs: + - csharp + name: Percent(Single) + nameWithType: Pos.Percent(Single) + fullName: Pos.Percent(Single) + type: Method + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + summary: Creates a percentage Pos object + syntax: + content: public static Terminal.Gui.Pos Percent (float n); + parameters: + - id: n + type: System.Single + description: A value between 0 and 100 representing the percentage. + return: + type: Terminal.Gui.Pos + description: The percent Pos object. + overload: Terminal.Gui.Pos.Percent* + exceptions: [] +references: +- uid: System.Object + parent: System + isExternal: true + name: Object + nameWithType: Object + fullName: System.Object +- uid: Terminal.Gui.Pos.#ctor + parent: Terminal.Gui.Pos + isExternal: false + name: Pos() + nameWithType: Pos.Pos() + fullName: Pos.Pos() +- uid: Terminal.Gui.Pos.AnchorEnd(System.Int32) + parent: Terminal.Gui.Pos + isExternal: false + name: AnchorEnd(Int32) + nameWithType: Pos.AnchorEnd(Int32) + fullName: Pos.AnchorEnd(Int32) +- uid: Terminal.Gui.Pos + parent: Terminal.Gui + isExternal: false + name: Pos + nameWithType: Pos + fullName: Terminal.Gui.Pos +- uid: System.Int32 + parent: System + isExternal: true + name: Int32 + nameWithType: Int32 + fullName: System.Int32 +- uid: Terminal.Gui.Pos.Center + parent: Terminal.Gui.Pos + isExternal: false + name: Center() + nameWithType: Pos.Center() + fullName: Pos.Center() +- uid: Terminal.Gui.Pos.op_Addition(Terminal.Gui.Pos,Terminal.Gui.Pos) + parent: Terminal.Gui.Pos + isExternal: false + name: op_Addition(Pos, Pos) + nameWithType: Pos.op_Addition(Pos, Pos) + fullName: Pos.op_Addition(Pos, Pos) +- uid: Terminal.Gui.Pos.op_Implicit(System.Int32 to Terminal.Gui.Pos) + parent: Terminal.Gui.Pos + isExternal: false + name: op_Implicit(Int32 to Pos) + nameWithType: Pos.op_Implicit(Int32 to Pos) + fullName: Pos.op_Implicit(Int32 to Pos) +- uid: Terminal.Gui.Pos.op_Subtraction(Terminal.Gui.Pos,Terminal.Gui.Pos) + parent: Terminal.Gui.Pos + isExternal: false + name: op_Subtraction(Pos, Pos) + nameWithType: Pos.op_Subtraction(Pos, Pos) + fullName: Pos.op_Subtraction(Pos, Pos) +- uid: Terminal.Gui.Pos.Percent(System.Single) + parent: Terminal.Gui.Pos + isExternal: false + name: Percent(Single) + nameWithType: Pos.Percent(Single) + fullName: Pos.Percent(Single) +- uid: System.Single + parent: System + isExternal: true + name: Single + nameWithType: Single + fullName: System.Single +- uid: Terminal.Gui.Pos.#ctor* + parent: Terminal.Gui.Pos + isExternal: false + name: Pos + nameWithType: Pos.Pos + fullName: Pos.Pos +- uid: Terminal.Gui.Pos.AnchorEnd* + parent: Terminal.Gui.Pos + isExternal: false + name: AnchorEnd + nameWithType: Pos.AnchorEnd + fullName: Pos.AnchorEnd +- uid: Terminal.Gui.Pos.Center* + parent: Terminal.Gui.Pos + isExternal: false + name: Center + nameWithType: Pos.Center + fullName: Pos.Center +- uid: Terminal.Gui.Pos.op_Addition* + parent: Terminal.Gui.Pos + isExternal: false + name: op_Addition + nameWithType: Pos.op_Addition + fullName: Pos.op_Addition +- uid: Terminal.Gui.Pos.op_Implicit* + parent: Terminal.Gui.Pos + isExternal: false + name: op_Implicit + nameWithType: Pos.op_Implicit + fullName: Pos.op_Implicit +- uid: Terminal.Gui.Pos.op_Subtraction* + parent: Terminal.Gui.Pos + isExternal: false + name: op_Subtraction + nameWithType: Pos.op_Subtraction + fullName: Pos.op_Subtraction +- uid: Terminal.Gui.Pos.Percent* + parent: Terminal.Gui.Pos + isExternal: false + name: Percent + nameWithType: Pos.Percent + fullName: Pos.Percent diff --git a/docfx/articles/overview.md b/docfx/articles/overview.md new file mode 100644 index 000000000..2b472cec6 --- /dev/null +++ b/docfx/articles/overview.md @@ -0,0 +1,43 @@ +Overview +======== + +`Terminal.Gui` is a library intended to create console-based +applications using C#. The framework has been designed to make it +easy to write applications that will work on monochrome terminals, as +well as modern color terminals with mouse support. + +This library provides a text-based toolkit as works in a way similar +to graphic toolkits. There are many controls that can be used to +create your applications and it is event based, meaning that you +create the user interface, hook up various events and then let the +a processing loop run your application, and your code is invoked via +one or more callbacks. + +The simplest application looks like this: + +``` +using Terminal.Gui; + +class Demo { + static int Main () + { + Application.Init (); + + var n = MessageBox.Query (50, 7, "Question", "Do you like console apps?", "Yes", "No"); + + return n; + } +} +``` + +This example shows a prompt and returns an integer value depending on +which value was selected by the user (Yes, No, or if they use chose +not to make a decision and instead pressed the ESC key). + +More interesting user interfaces can be created by composing some of +the various views that are included. In the following sections, you +will see how applications are put together. + +View +==== + diff --git a/docfx/articles/views.md b/docfx/articles/views.md new file mode 100644 index 000000000..48c5a5367 --- /dev/null +++ b/docfx/articles/views.md @@ -0,0 +1,2 @@ +Views +===== diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Dim.html b/docs/api/Terminal.Gui/Terminal.Gui.Dim.html new file mode 100644 index 000000000..3cc899fe1 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Dim.html @@ -0,0 +1,386 @@ + + + + + + + + Class Dim + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.LayoutStyle.html b/docs/api/Terminal.Gui/Terminal.Gui.LayoutStyle.html new file mode 100644 index 000000000..5d5767f5a --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.LayoutStyle.html @@ -0,0 +1,144 @@ + + + + + + + + Enum LayoutStyle + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.Pos.html b/docs/api/Terminal.Gui/Terminal.Gui.Pos.html new file mode 100644 index 000000000..d8484cef0 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.Pos.html @@ -0,0 +1,419 @@ + + + + + + + + Class Pos + + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/docs/articles/overview.html b/docs/articles/overview.html new file mode 100644 index 000000000..edf931150 --- /dev/null +++ b/docs/articles/overview.html @@ -0,0 +1,132 @@ + + + + + + + + Overview + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/docs/articles/views.html b/docs/articles/views.html new file mode 100644 index 000000000..6a89b0265 --- /dev/null +++ b/docs/articles/views.html @@ -0,0 +1,102 @@ + + + + + + + + Views + + + + + + + + + + + + + + +
+
+ + + + +
+ + + +
+ + + + + + diff --git a/ecmadocs/en/Terminal.Gui/Dim.xml b/ecmadocs/en/Terminal.Gui/Dim.xml new file mode 100644 index 000000000..d0189eb24 --- /dev/null +++ b/ecmadocs/en/Terminal.Gui/Dim.xml @@ -0,0 +1,155 @@ + + + + + Terminal.Gui + 1.0.0.0 + + + System.Object + + + + + + + Use the Dim objects on the Width or Height properties of a view to control the position. + + + These can be used to set the absolute position, when merely assigning an + integer value (via the implicit integer to Pos conversion), and they can be combined + to produce more useful layouts, like: Pos.Center - 3, which would shift the postion + of the view 3 characters to the left after centering for example. + + + + + + + + Constructor + + 1.0.0.0 + + + + To be added. + To be added. + + + + + + Method + + 1.0.0.0 + + + Terminal.Gui.Dim + + + + + + Margin to use. + + Creates a Dim object that fills the dimension, but leaves the specified number of colums for a margin. + + The Fill dimension. + To be added. + + + + + + Method + + 1.0.0.0 + + + Terminal.Gui.Dim + + + + + + + The first to add. + The second to add. + + Adds a to a , yielding a new . + + The that is the sum of the values of left and right. + To be added. + + + + + + Method + + 1.0.0.0 + + + Terminal.Gui.Dim + + + + + + The value to convert to the pos. + + Creates an Absolute Pos from the specified integer value. + + The Absolute Pos. + To be added. + + + + + + Method + + 1.0.0.0 + + + Terminal.Gui.Dim + + + + + + + The to subtract from (the minuend). + The to subtract (the subtrahend). + + Subtracts a from a , yielding a new . + + The that is the left minus right. + To be added. + + + + + + Method + + 1.0.0.0 + + + Terminal.Gui.Dim + + + + + + A value between 0 and 100 representing the percentage. + + Creates a percentage Dim object + + The percent Dim object. + To be added. + + + + diff --git a/ecmadocs/en/Terminal.Gui/LayoutStyle.xml b/ecmadocs/en/Terminal.Gui/LayoutStyle.xml new file mode 100644 index 000000000..41d63ba10 --- /dev/null +++ b/ecmadocs/en/Terminal.Gui/LayoutStyle.xml @@ -0,0 +1,54 @@ + + + + + Terminal.Gui + 1.0.0.0 + + + System.Enum + + + + Determines the LayoutStyle for a view, if Absolute, during LayoutSubviews, the + value from the Frame will be used, if the value is Computer, then the Frame + will be updated from the X, Y Pos objets and the Width and Heigh Dim objects. + + To be added. + + + + + + Field + + 1.0.0.0 + + + Terminal.Gui.LayoutStyle + + + + The position and size of the view are based on the Frame value. + + + + + + + Field + + 1.0.0.0 + + + Terminal.Gui.LayoutStyle + + + + The position and size of the view will be computed based on the + X, Y, Width and Height properties and set on the Frame. + + + + + diff --git a/ecmadocs/en/Terminal.Gui/Pos.xml b/ecmadocs/en/Terminal.Gui/Pos.xml new file mode 100644 index 000000000..0be74e2ea --- /dev/null +++ b/ecmadocs/en/Terminal.Gui/Pos.xml @@ -0,0 +1,181 @@ + + + + + Terminal.Gui + 1.0.0.0 + + + System.Object + + + + + Describes a position which can be an absolute value, a percentage, centered, or + relative to the ending dimension. Integer values are implicitly convertible to + an absolute Pos. These objects are created using the static methods Percent, + AnchorEnd and Center. The Pos objects can be combined with the addition and + subtraction operators. + + + + Use the Pos objects on the X or Y properties of a view to control the position. + + + These can be used to set the absolute position, when merely assigning an + integer value (via the implicit integer to Pos conversion), and they can be combined + to produce more useful layouts, like: Pos.Center - 3, which would shift the postion + of the view 3 characters to the left after centering for example. + + + + + + + + Constructor + + 1.0.0.0 + + + + To be added. + To be added. + + + + + + Method + + 1.0.0.0 + + + Terminal.Gui.Pos + + + + + + Optional margin to set aside. + + Creates a Pos object that is anchored to the end of the dimension, useful to flush + the layout from the end. + + The Pos object anchored to the end (the bottom or the right side). + To be added. + + + + + + Method + + 1.0.0.0 + + + Terminal.Gui.Pos + + + + + Returns a Pos object that can be used to center the views. + + The center Pos. + To be added. + + + + + + Method + + 1.0.0.0 + + + Terminal.Gui.Pos + + + + + + + The first to add. + The second to add. + + Adds a to a , yielding a new . + + The that is the sum of the values of left and right. + To be added. + + + + + + Method + + 1.0.0.0 + + + Terminal.Gui.Pos + + + + + + The value to convert to the pos. + + Creates an Absolute Pos from the specified integer value. + + The Absolute Pos. + To be added. + + + + + + Method + + 1.0.0.0 + + + Terminal.Gui.Pos + + + + + + + The to subtract from (the minuend). + The to subtract (the subtrahend). + + Subtracts a from a , yielding a new . + + The that is the left minus right. + To be added. + + + + + + Method + + 1.0.0.0 + + + Terminal.Gui.Pos + + + + + + A value between 0 and 100 representing the percentage. + + Creates a percentage Pos object + + The percent Pos object. + To be added. + + + +