Files
Terminal.Gui/docfx/api/Terminal.Gui/Terminal.Gui.Pos.yml
Miguel de Icaza 948ca7994f Rebuild docs
2018-06-01 16:17:08 -04:00

582 lines
17 KiB
YAML

### YamlMime:ManagedReference
items:
- uid: Terminal.Gui.Pos
id: Pos
children:
- Terminal.Gui.Pos.#ctor
- Terminal.Gui.Pos.AnchorEnd(System.Int32)
- Terminal.Gui.Pos.At(System.Int32)
- Terminal.Gui.Pos.Bottom(Terminal.Gui.View)
- Terminal.Gui.Pos.Center
- Terminal.Gui.Pos.Left(Terminal.Gui.View)
- 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)
- Terminal.Gui.Pos.Right(Terminal.Gui.View)
- Terminal.Gui.Pos.Top(Terminal.Gui.View)
- Terminal.Gui.Pos.X(Terminal.Gui.View)
- Terminal.Gui.Pos.Y(Terminal.Gui.View)
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: >-
<p>
Use the Pos objects on the X or Y properties of a view to control the position.
</p>
<p>
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.
</p>
<p>
It is possible to reference coordinates of another view by using the methods
Left(View), Right(View), Bottom(View), Top(View). The X(View) and Y(View) are
aliases to Left(View) and Top(View) respectively.
</p>
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.At(System.Int32)
id: At(System.Int32)
parent: Terminal.Gui.Pos
langs:
- csharp
name: At(Int32)
nameWithType: Pos.At(Int32)
fullName: Pos.At(Int32)
type: Method
assemblies:
- Terminal.Gui
namespace: Terminal.Gui
summary: Creates an Absolute Pos from the specified integer value.
syntax:
content: public static Terminal.Gui.Pos At (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.At*
exceptions: []
- uid: Terminal.Gui.Pos.Bottom(Terminal.Gui.View)
id: Bottom(Terminal.Gui.View)
parent: Terminal.Gui.Pos
langs:
- csharp
name: Bottom(View)
nameWithType: Pos.Bottom(View)
fullName: Pos.Bottom(View)
type: Method
assemblies:
- Terminal.Gui
namespace: Terminal.Gui
summary: Returns a Pos object tracks the Bottom (Y+Height) coordinate of the specified view.
syntax:
content: public static Terminal.Gui.Pos Bottom (Terminal.Gui.View view);
parameters:
- id: view
type: Terminal.Gui.View
description: The view that will be tracked.
return:
type: Terminal.Gui.Pos
description: The Position that depends on the other view.
overload: Terminal.Gui.Pos.Bottom*
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.Left(Terminal.Gui.View)
id: Left(Terminal.Gui.View)
parent: Terminal.Gui.Pos
langs:
- csharp
name: Left(View)
nameWithType: Pos.Left(View)
fullName: Pos.Left(View)
type: Method
assemblies:
- Terminal.Gui
namespace: Terminal.Gui
summary: Returns a Pos object tracks the Left (X) position of the specified view.
syntax:
content: public static Terminal.Gui.Pos Left (Terminal.Gui.View view);
parameters:
- id: view
type: Terminal.Gui.View
description: The view that will be tracked.
return:
type: Terminal.Gui.Pos
description: The Position that depends on the other view.
overload: Terminal.Gui.Pos.Left*
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 <xref href="Terminal.Gui.Pos"></xref> to a <xref href="Terminal.Gui.Pos"></xref>, yielding a new <xref href="Terminal.Gui.Pos"></xref>.
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 <xref href="Terminal.Gui.Pos"></xref> to add.
- id: right
type: Terminal.Gui.Pos
description: The second <xref href="Terminal.Gui.Pos"></xref> to add.
return:
type: Terminal.Gui.Pos
description: The <xref href="Terminal.Gui.Pos"></xref> that is the sum of the values of <code>left</code> and <code>right</code>.
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 <xref href="Terminal.Gui.Pos"></xref> from a <xref href="Terminal.Gui.Pos"></xref>, yielding a new <xref href="Terminal.Gui.Pos"></xref>.
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 <xref href="Terminal.Gui.Pos"></xref> to subtract from (the minuend).
- id: right
type: Terminal.Gui.Pos
description: The <xref href="Terminal.Gui.Pos"></xref> to subtract (the subtrahend).
return:
type: Terminal.Gui.Pos
description: The <xref href="Terminal.Gui.Pos"></xref> that is the <code>left</code> minus <code>right</code>.
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: []
- uid: Terminal.Gui.Pos.Right(Terminal.Gui.View)
id: Right(Terminal.Gui.View)
parent: Terminal.Gui.Pos
langs:
- csharp
name: Right(View)
nameWithType: Pos.Right(View)
fullName: Pos.Right(View)
type: Method
assemblies:
- Terminal.Gui
namespace: Terminal.Gui
summary: Returns a Pos object tracks the Right (X+Width) coordinate of the specified view.
syntax:
content: public static Terminal.Gui.Pos Right (Terminal.Gui.View view);
parameters:
- id: view
type: Terminal.Gui.View
description: The view that will be tracked.
return:
type: Terminal.Gui.Pos
description: The Position that depends on the other view.
overload: Terminal.Gui.Pos.Right*
exceptions: []
- uid: Terminal.Gui.Pos.Top(Terminal.Gui.View)
id: Top(Terminal.Gui.View)
parent: Terminal.Gui.Pos
langs:
- csharp
name: Top(View)
nameWithType: Pos.Top(View)
fullName: Pos.Top(View)
type: Method
assemblies:
- Terminal.Gui
namespace: Terminal.Gui
summary: Returns a Pos object tracks the Top (Y) position of the specified view.
syntax:
content: public static Terminal.Gui.Pos Top (Terminal.Gui.View view);
parameters:
- id: view
type: Terminal.Gui.View
description: The view that will be tracked.
return:
type: Terminal.Gui.Pos
description: The Position that depends on the other view.
overload: Terminal.Gui.Pos.Top*
exceptions: []
- uid: Terminal.Gui.Pos.X(Terminal.Gui.View)
id: X(Terminal.Gui.View)
parent: Terminal.Gui.Pos
langs:
- csharp
name: X(View)
nameWithType: Pos.X(View)
fullName: Pos.X(View)
type: Method
assemblies:
- Terminal.Gui
namespace: Terminal.Gui
summary: Returns a Pos object tracks the Left (X) position of the specified view.
syntax:
content: public static Terminal.Gui.Pos X (Terminal.Gui.View view);
parameters:
- id: view
type: Terminal.Gui.View
description: The view that will be tracked.
return:
type: Terminal.Gui.Pos
description: The Position that depends on the other view.
overload: Terminal.Gui.Pos.X*
exceptions: []
- uid: Terminal.Gui.Pos.Y(Terminal.Gui.View)
id: Y(Terminal.Gui.View)
parent: Terminal.Gui.Pos
langs:
- csharp
name: Y(View)
nameWithType: Pos.Y(View)
fullName: Pos.Y(View)
type: Method
assemblies:
- Terminal.Gui
namespace: Terminal.Gui
summary: Returns a Pos object tracks the Top (Y) position of the specified view.
syntax:
content: public static Terminal.Gui.Pos Y (Terminal.Gui.View view);
parameters:
- id: view
type: Terminal.Gui.View
description: The view that will be tracked.
return:
type: Terminal.Gui.Pos
description: The Position that depends on the other view.
overload: Terminal.Gui.Pos.Y*
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.At(System.Int32)
parent: Terminal.Gui.Pos
isExternal: false
name: At(Int32)
nameWithType: Pos.At(Int32)
fullName: Pos.At(Int32)
- uid: Terminal.Gui.Pos.Bottom(Terminal.Gui.View)
parent: Terminal.Gui.Pos
isExternal: false
name: Bottom(View)
nameWithType: Pos.Bottom(View)
fullName: Pos.Bottom(View)
- uid: Terminal.Gui.View
parent: Terminal.Gui
isExternal: false
name: View
nameWithType: View
fullName: Terminal.Gui.View
- uid: Terminal.Gui.Pos.Center
parent: Terminal.Gui.Pos
isExternal: false
name: Center()
nameWithType: Pos.Center()
fullName: Pos.Center()
- uid: Terminal.Gui.Pos.Left(Terminal.Gui.View)
parent: Terminal.Gui.Pos
isExternal: false
name: Left(View)
nameWithType: Pos.Left(View)
fullName: Pos.Left(View)
- 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.Right(Terminal.Gui.View)
parent: Terminal.Gui.Pos
isExternal: false
name: Right(View)
nameWithType: Pos.Right(View)
fullName: Pos.Right(View)
- uid: Terminal.Gui.Pos.Top(Terminal.Gui.View)
parent: Terminal.Gui.Pos
isExternal: false
name: Top(View)
nameWithType: Pos.Top(View)
fullName: Pos.Top(View)
- uid: Terminal.Gui.Pos.X(Terminal.Gui.View)
parent: Terminal.Gui.Pos
isExternal: false
name: X(View)
nameWithType: Pos.X(View)
fullName: Pos.X(View)
- uid: Terminal.Gui.Pos.Y(Terminal.Gui.View)
parent: Terminal.Gui.Pos
isExternal: false
name: Y(View)
nameWithType: Pos.Y(View)
fullName: Pos.Y(View)
- 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.At*
parent: Terminal.Gui.Pos
isExternal: false
name: At
nameWithType: Pos.At
fullName: Pos.At
- uid: Terminal.Gui.Pos.Bottom*
parent: Terminal.Gui.Pos
isExternal: false
name: Bottom
nameWithType: Pos.Bottom
fullName: Pos.Bottom
- uid: Terminal.Gui.Pos.Center*
parent: Terminal.Gui.Pos
isExternal: false
name: Center
nameWithType: Pos.Center
fullName: Pos.Center
- uid: Terminal.Gui.Pos.Left*
parent: Terminal.Gui.Pos
isExternal: false
name: Left
nameWithType: Pos.Left
fullName: Pos.Left
- 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
- uid: Terminal.Gui.Pos.Right*
parent: Terminal.Gui.Pos
isExternal: false
name: Right
nameWithType: Pos.Right
fullName: Pos.Right
- uid: Terminal.Gui.Pos.Top*
parent: Terminal.Gui.Pos
isExternal: false
name: Top
nameWithType: Pos.Top
fullName: Pos.Top
- uid: Terminal.Gui.Pos.X*
parent: Terminal.Gui.Pos
isExternal: false
name: X
nameWithType: Pos.X
fullName: Pos.X
- uid: Terminal.Gui.Pos.Y*
parent: Terminal.Gui.Pos
isExternal: false
name: Y
nameWithType: Pos.Y
fullName: Pos.Y