Files
Terminal.Gui/docfx/api/Terminal/Terminal.Size.yml
Miguel de Icaza e1b1b52e99 Added docs
2018-01-15 22:54:27 -05:00

645 lines
17 KiB
YAML

### YamlMime:ManagedReference
items:
- uid: Terminal.Size
id: Size
children:
- Terminal.Size.#ctor(Terminal.Point)
- Terminal.Size.#ctor(System.Int32,System.Int32)
- Terminal.Size.Add(Terminal.Size,Terminal.Size)
- Terminal.Size.Empty
- Terminal.Size.Equals(System.Object)
- Terminal.Size.GetHashCode
- Terminal.Size.Height
- Terminal.Size.IsEmpty
- Terminal.Size.op_Addition(Terminal.Size,Terminal.Size)
- Terminal.Size.op_Equality(Terminal.Size,Terminal.Size)
- Terminal.Size.op_Explicit(Terminal.Size to Terminal.Point)
- Terminal.Size.op_Inequality(Terminal.Size,Terminal.Size)
- Terminal.Size.op_Subtraction(Terminal.Size,Terminal.Size)
- Terminal.Size.Subtract(Terminal.Size,Terminal.Size)
- Terminal.Size.ToString
- Terminal.Size.Width
langs:
- csharp
name: Size
nameWithType: Size
fullName: Terminal.Size
type: Struct
assemblies:
- Terminal
namespace: Terminal
syntax:
content: public struct Size
inheritance:
- System.ValueType
implements: []
- uid: Terminal.Size.#ctor(Terminal.Point)
id: '#ctor(Terminal.Point)'
parent: Terminal.Size
langs:
- csharp
name: Size(Point)
nameWithType: Size.Size(Point)
fullName: Size.Size(Point)
type: Constructor
assemblies:
- Terminal
namespace: Terminal
summary: Size Constructor
remarks: Creates a Size from a Point value.
syntax:
content: public Size (Terminal.Point pt);
parameters:
- id: pt
type: Terminal.Point
description: To be added.
overload: Terminal.Size.#ctor*
exceptions: []
- uid: Terminal.Size.#ctor(System.Int32,System.Int32)
id: '#ctor(System.Int32,System.Int32)'
parent: Terminal.Size
langs:
- csharp
name: Size(Int32, Int32)
nameWithType: Size.Size(Int32, Int32)
fullName: Size.Size(Int32, Int32)
type: Constructor
assemblies:
- Terminal
namespace: Terminal
summary: Size Constructor
remarks: Creates a Size from specified dimensions.
syntax:
content: public Size (int width, int height);
parameters:
- id: width
type: System.Int32
description: To be added.
- id: height
type: System.Int32
description: To be added.
overload: Terminal.Size.#ctor*
exceptions: []
- uid: Terminal.Size.Add(Terminal.Size,Terminal.Size)
id: Add(Terminal.Size,Terminal.Size)
parent: Terminal.Size
langs:
- csharp
name: Add(Size, Size)
nameWithType: Size.Add(Size, Size)
fullName: Size.Add(Size, Size)
type: Method
assemblies:
- Terminal
namespace: Terminal
syntax:
content: public static Terminal.Size Add (Terminal.Size sz1, Terminal.Size sz2);
parameters:
- id: sz1
type: Terminal.Size
description: To be added.
- id: sz2
type: Terminal.Size
description: To be added.
return:
type: Terminal.Size
description: To be added.
overload: Terminal.Size.Add*
exceptions: []
- uid: Terminal.Size.Empty
id: Empty
parent: Terminal.Size
langs:
- csharp
name: Empty
nameWithType: Size.Empty
fullName: Size.Empty
type: Field
assemblies:
- Terminal
namespace: Terminal
syntax:
content: public static readonly Terminal.Size Empty;
return:
type: Terminal.Size
description: To be added.
exceptions: []
- uid: Terminal.Size.Equals(System.Object)
id: Equals(System.Object)
parent: Terminal.Size
langs:
- csharp
name: Equals(Object)
nameWithType: Size.Equals(Object)
fullName: Size.Equals(Object)
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: Equals Method
remarks: Checks equivalence of this Size and another object.
syntax:
content: public override bool Equals (object obj);
parameters:
- id: obj
type: System.Object
description: To be added.
return:
type: System.Boolean
description: To be added.
overload: Terminal.Size.Equals*
exceptions: []
- uid: Terminal.Size.GetHashCode
id: GetHashCode
parent: Terminal.Size
langs:
- csharp
name: GetHashCode()
nameWithType: Size.GetHashCode()
fullName: Size.GetHashCode()
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: GetHashCode Method
remarks: Calculates a hashing value.
syntax:
content: public override int GetHashCode ();
parameters: []
return:
type: System.Int32
description: To be added.
overload: Terminal.Size.GetHashCode*
exceptions: []
- uid: Terminal.Size.Height
id: Height
parent: Terminal.Size
langs:
- csharp
name: Height
nameWithType: Size.Height
fullName: Size.Height
type: Property
assemblies:
- Terminal
namespace: Terminal
summary: Height Property
remarks: The Height coordinate of the Size.
syntax:
content: public int Height { get; set; }
return:
type: System.Int32
description: To be added.
overload: Terminal.Size.Height*
exceptions: []
- uid: Terminal.Size.IsEmpty
id: IsEmpty
parent: Terminal.Size
langs:
- csharp
name: IsEmpty
nameWithType: Size.IsEmpty
fullName: Size.IsEmpty
type: Property
assemblies:
- Terminal
namespace: Terminal
summary: IsEmpty Property
remarks: Indicates if both Width and Height are zero.
syntax:
content: public bool IsEmpty { get; }
return:
type: System.Boolean
description: To be added.
overload: Terminal.Size.IsEmpty*
exceptions: []
- uid: Terminal.Size.op_Addition(Terminal.Size,Terminal.Size)
id: op_Addition(Terminal.Size,Terminal.Size)
parent: Terminal.Size
langs:
- csharp
name: op_Addition(Size, Size)
nameWithType: Size.op_Addition(Size, Size)
fullName: Size.op_Addition(Size, Size)
type: Operator
assemblies:
- Terminal
namespace: Terminal
summary: Addition Operator
remarks: Addition of two Size structures.
syntax:
content: public static Terminal.Size op_Addition (Terminal.Size sz1, Terminal.Size sz2);
parameters:
- id: sz1
type: Terminal.Size
description: To be added.
- id: sz2
type: Terminal.Size
description: To be added.
return:
type: Terminal.Size
description: To be added.
overload: Terminal.Size.op_Addition*
exceptions: []
- uid: Terminal.Size.op_Equality(Terminal.Size,Terminal.Size)
id: op_Equality(Terminal.Size,Terminal.Size)
parent: Terminal.Size
langs:
- csharp
name: op_Equality(Size, Size)
nameWithType: Size.op_Equality(Size, Size)
fullName: Size.op_Equality(Size, Size)
type: Operator
assemblies:
- Terminal
namespace: Terminal
summary: Equality Operator
remarks: "Compares two Size objects. The return value is\n based on the equivalence of the Width and Height \n properties of the two Sizes."
syntax:
content: public static bool op_Equality (Terminal.Size sz1, Terminal.Size sz2);
parameters:
- id: sz1
type: Terminal.Size
description: To be added.
- id: sz2
type: Terminal.Size
description: To be added.
return:
type: System.Boolean
description: To be added.
overload: Terminal.Size.op_Equality*
exceptions: []
- uid: Terminal.Size.op_Explicit(Terminal.Size to Terminal.Point)
id: op_Explicit(Terminal.Size to Terminal.Point)
parent: Terminal.Size
langs:
- csharp
name: op_Explicit(Size to Point)
nameWithType: Size.op_Explicit(Size to Point)
fullName: Size.op_Explicit(Size to Point)
type: Operator
assemblies:
- Terminal
namespace: Terminal
summary: Size to Point Conversion
remarks: "Returns a Point based on the dimensions of a given \n Size. Requires explicit cast."
syntax:
content: public static Terminal.Point op_Explicit (Terminal.Size size);
parameters:
- id: size
type: Terminal.Size
description: To be added.
return:
type: Terminal.Point
description: To be added.
overload: Terminal.Size.op_Explicit*
exceptions: []
- uid: Terminal.Size.op_Inequality(Terminal.Size,Terminal.Size)
id: op_Inequality(Terminal.Size,Terminal.Size)
parent: Terminal.Size
langs:
- csharp
name: op_Inequality(Size, Size)
nameWithType: Size.op_Inequality(Size, Size)
fullName: Size.op_Inequality(Size, Size)
type: Operator
assemblies:
- Terminal
namespace: Terminal
summary: Inequality Operator
remarks: "Compares two Size objects. The return value is\n based on the equivalence of the Width and Height \n properties of the two Sizes."
syntax:
content: public static bool op_Inequality (Terminal.Size sz1, Terminal.Size sz2);
parameters:
- id: sz1
type: Terminal.Size
description: To be added.
- id: sz2
type: Terminal.Size
description: To be added.
return:
type: System.Boolean
description: To be added.
overload: Terminal.Size.op_Inequality*
exceptions: []
- uid: Terminal.Size.op_Subtraction(Terminal.Size,Terminal.Size)
id: op_Subtraction(Terminal.Size,Terminal.Size)
parent: Terminal.Size
langs:
- csharp
name: op_Subtraction(Size, Size)
nameWithType: Size.op_Subtraction(Size, Size)
fullName: Size.op_Subtraction(Size, Size)
type: Operator
assemblies:
- Terminal
namespace: Terminal
summary: Subtraction Operator
remarks: Subtracts two Size structures.
syntax:
content: public static Terminal.Size op_Subtraction (Terminal.Size sz1, Terminal.Size sz2);
parameters:
- id: sz1
type: Terminal.Size
description: To be added.
- id: sz2
type: Terminal.Size
description: To be added.
return:
type: Terminal.Size
description: To be added.
overload: Terminal.Size.op_Subtraction*
exceptions: []
- uid: Terminal.Size.Subtract(Terminal.Size,Terminal.Size)
id: Subtract(Terminal.Size,Terminal.Size)
parent: Terminal.Size
langs:
- csharp
name: Subtract(Size, Size)
nameWithType: Size.Subtract(Size, Size)
fullName: Size.Subtract(Size, Size)
type: Method
assemblies:
- Terminal
namespace: Terminal
syntax:
content: public static Terminal.Size Subtract (Terminal.Size sz1, Terminal.Size sz2);
parameters:
- id: sz1
type: Terminal.Size
description: To be added.
- id: sz2
type: Terminal.Size
description: To be added.
return:
type: Terminal.Size
description: To be added.
overload: Terminal.Size.Subtract*
exceptions: []
- uid: Terminal.Size.ToString
id: ToString
parent: Terminal.Size
langs:
- csharp
name: ToString()
nameWithType: Size.ToString()
fullName: Size.ToString()
type: Method
assemblies:
- Terminal
namespace: Terminal
summary: ToString Method
remarks: Formats the Size as a string in coordinate notation.
syntax:
content: public override string ToString ();
parameters: []
return:
type: System.String
description: To be added.
overload: Terminal.Size.ToString*
exceptions: []
- uid: Terminal.Size.Width
id: Width
parent: Terminal.Size
langs:
- csharp
name: Width
nameWithType: Size.Width
fullName: Size.Width
type: Property
assemblies:
- Terminal
namespace: Terminal
summary: Width Property
remarks: The Width coordinate of the Size.
syntax:
content: public int Width { get; set; }
return:
type: System.Int32
description: To be added.
overload: Terminal.Size.Width*
exceptions: []
references:
- uid: System.ValueType
parent: System
isExternal: true
name: ValueType
nameWithType: ValueType
fullName: System.ValueType
- uid: Terminal.Size.#ctor(Terminal.Point)
parent: Terminal.Size
isExternal: false
name: Size(Point)
nameWithType: Size.Size(Point)
fullName: Size.Size(Point)
- uid: Terminal.Point
parent: Terminal
isExternal: false
name: Point
nameWithType: Point
fullName: Terminal.Point
- uid: Terminal.Size.#ctor(System.Int32,System.Int32)
parent: Terminal.Size
isExternal: false
name: Size(Int32, Int32)
nameWithType: Size.Size(Int32, Int32)
fullName: Size.Size(Int32, Int32)
- uid: System.Int32
parent: System
isExternal: true
name: Int32
nameWithType: Int32
fullName: System.Int32
- uid: Terminal.Size.Add(Terminal.Size,Terminal.Size)
parent: Terminal.Size
isExternal: false
name: Add(Size, Size)
nameWithType: Size.Add(Size, Size)
fullName: Size.Add(Size, Size)
- uid: Terminal.Size
parent: Terminal
isExternal: false
name: Size
nameWithType: Size
fullName: Terminal.Size
- uid: Terminal.Size.Empty
parent: Terminal.Size
isExternal: false
name: Empty
nameWithType: Size.Empty
fullName: Size.Empty
- uid: Terminal.Size.Equals(System.Object)
parent: Terminal.Size
isExternal: false
name: Equals(Object)
nameWithType: Size.Equals(Object)
fullName: Size.Equals(Object)
- uid: System.Boolean
parent: System
isExternal: true
name: Boolean
nameWithType: Boolean
fullName: System.Boolean
- uid: System.Object
parent: System
isExternal: true
name: Object
nameWithType: Object
fullName: System.Object
- uid: Terminal.Size.GetHashCode
parent: Terminal.Size
isExternal: false
name: GetHashCode()
nameWithType: Size.GetHashCode()
fullName: Size.GetHashCode()
- uid: Terminal.Size.Height
parent: Terminal.Size
isExternal: false
name: Height
nameWithType: Size.Height
fullName: Size.Height
- uid: Terminal.Size.IsEmpty
parent: Terminal.Size
isExternal: false
name: IsEmpty
nameWithType: Size.IsEmpty
fullName: Size.IsEmpty
- uid: Terminal.Size.op_Addition(Terminal.Size,Terminal.Size)
parent: Terminal.Size
isExternal: false
name: op_Addition(Size, Size)
nameWithType: Size.op_Addition(Size, Size)
fullName: Size.op_Addition(Size, Size)
- uid: Terminal.Size.op_Equality(Terminal.Size,Terminal.Size)
parent: Terminal.Size
isExternal: false
name: op_Equality(Size, Size)
nameWithType: Size.op_Equality(Size, Size)
fullName: Size.op_Equality(Size, Size)
- uid: Terminal.Size.op_Explicit(Terminal.Size to Terminal.Point)
parent: Terminal.Size
isExternal: false
name: op_Explicit(Size to Point)
nameWithType: Size.op_Explicit(Size to Point)
fullName: Size.op_Explicit(Size to Point)
- uid: Terminal.Size.op_Inequality(Terminal.Size,Terminal.Size)
parent: Terminal.Size
isExternal: false
name: op_Inequality(Size, Size)
nameWithType: Size.op_Inequality(Size, Size)
fullName: Size.op_Inequality(Size, Size)
- uid: Terminal.Size.op_Subtraction(Terminal.Size,Terminal.Size)
parent: Terminal.Size
isExternal: false
name: op_Subtraction(Size, Size)
nameWithType: Size.op_Subtraction(Size, Size)
fullName: Size.op_Subtraction(Size, Size)
- uid: Terminal.Size.Subtract(Terminal.Size,Terminal.Size)
parent: Terminal.Size
isExternal: false
name: Subtract(Size, Size)
nameWithType: Size.Subtract(Size, Size)
fullName: Size.Subtract(Size, Size)
- uid: Terminal.Size.ToString
parent: Terminal.Size
isExternal: false
name: ToString()
nameWithType: Size.ToString()
fullName: Size.ToString()
- uid: System.String
parent: System
isExternal: true
name: String
nameWithType: String
fullName: System.String
- uid: Terminal.Size.Width
parent: Terminal.Size
isExternal: false
name: Width
nameWithType: Size.Width
fullName: Size.Width
- uid: Terminal.Size.#ctor*
parent: Terminal.Size
isExternal: false
name: Size
nameWithType: Size.Size
fullName: Size.Size
- uid: Terminal.Size.Add*
parent: Terminal.Size
isExternal: false
name: Add
nameWithType: Size.Add
fullName: Size.Add
- uid: Terminal.Size.Equals*
parent: Terminal.Size
isExternal: false
name: Equals
nameWithType: Size.Equals
fullName: Size.Equals
- uid: Terminal.Size.GetHashCode*
parent: Terminal.Size
isExternal: false
name: GetHashCode
nameWithType: Size.GetHashCode
fullName: Size.GetHashCode
- uid: Terminal.Size.Height*
parent: Terminal.Size
isExternal: false
name: Height
nameWithType: Size.Height
fullName: Size.Height
- uid: Terminal.Size.IsEmpty*
parent: Terminal.Size
isExternal: false
name: IsEmpty
nameWithType: Size.IsEmpty
fullName: Size.IsEmpty
- uid: Terminal.Size.op_Addition*
parent: Terminal.Size
isExternal: false
name: op_Addition
nameWithType: Size.op_Addition
fullName: Size.op_Addition
- uid: Terminal.Size.op_Equality*
parent: Terminal.Size
isExternal: false
name: op_Equality
nameWithType: Size.op_Equality
fullName: Size.op_Equality
- uid: Terminal.Size.op_Explicit*
parent: Terminal.Size
isExternal: false
name: op_Explicit
nameWithType: Size.op_Explicit
fullName: Size.op_Explicit
- uid: Terminal.Size.op_Inequality*
parent: Terminal.Size
isExternal: false
name: op_Inequality
nameWithType: Size.op_Inequality
fullName: Size.op_Inequality
- uid: Terminal.Size.op_Subtraction*
parent: Terminal.Size
isExternal: false
name: op_Subtraction
nameWithType: Size.op_Subtraction
fullName: Size.op_Subtraction
- uid: Terminal.Size.Subtract*
parent: Terminal.Size
isExternal: false
name: Subtract
nameWithType: Size.Subtract
fullName: Size.Subtract
- uid: Terminal.Size.ToString*
parent: Terminal.Size
isExternal: false
name: ToString
nameWithType: Size.ToString
fullName: Size.ToString
- uid: Terminal.Size.Width*
parent: Terminal.Size
isExternal: false
name: Width
nameWithType: Size.Width
fullName: Size.Width