gui-cs.Terminal.Gui/ecmadocs/en/Terminal.Gui/Pos.xml

<Type Name="Pos" FullName="Terminal.Gui.Pos">
  <TypeSignature Language="C#" Value="public class Pos" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Pos extends System.Object" />
  <AssemblyInfo>
    <AssemblyName>Terminal.Gui</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            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.
            </summary>
    <remarks>
      <para>
                Use the Pos objects on the X or Y properties of a view to control the position.
              </para>
      <para>
                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.
              </para>
      <para>
                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.
              </para>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Pos ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters />
      <Docs>
        <summary>To be added.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="AnchorEnd">
      <MemberSignature Language="C#" Value="public static Terminal.Gui.Pos AnchorEnd (int margin = 0);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Terminal.Gui.Pos AnchorEnd(int32 margin) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.Pos</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="margin" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="margin">Optional margin to set aside.</param>
        <summary>
            Creates a Pos object that is anchored to the end of the dimension, useful to flush 
            the layout from the end.
            </summary>
        <returns>The Pos object anchored to the end (the bottom or the right side).</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="At">
      <MemberSignature Language="C#" Value="public static Terminal.Gui.Pos At (int n);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Terminal.Gui.Pos At(int32 n) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.Pos</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="n" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="n">The value to convert to the pos.</param>
        <summary>
            Creates an Absolute Pos from the specified integer value.
            </summary>
        <returns>The Absolute Pos.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Bottom">
      <MemberSignature Language="C#" Value="public static Terminal.Gui.Pos Bottom (Terminal.Gui.View view);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Terminal.Gui.Pos Bottom(class Terminal.Gui.View view) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.Pos</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="view" Type="Terminal.Gui.View" />
      </Parameters>
      <Docs>
        <param name="view">The view that will be tracked.</param>
        <summary>
            Returns a Pos object tracks the Bottom (Y+Height) coordinate of the specified view.
            </summary>
        <returns>The Position that depends on the other view.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Center">
      <MemberSignature Language="C#" Value="public static Terminal.Gui.Pos Center ();" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Terminal.Gui.Pos Center() cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.Pos</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>
            Returns a Pos object that can be used to center the views.
            </summary>
        <returns>The center Pos.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Left">
      <MemberSignature Language="C#" Value="public static Terminal.Gui.Pos Left (Terminal.Gui.View view);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Terminal.Gui.Pos Left(class Terminal.Gui.View view) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.Pos</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="view" Type="Terminal.Gui.View" />
      </Parameters>
      <Docs>
        <param name="view">The view that will be tracked.</param>
        <summary>
            Returns a Pos object tracks the Left (X) position of the specified view.
            </summary>
        <returns>The Position that depends on the other view.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="op_Addition">
      <MemberSignature Language="C#" Value="public static Terminal.Gui.Pos op_Addition (Terminal.Gui.Pos left, Terminal.Gui.Pos right);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname class Terminal.Gui.Pos op_Addition(class Terminal.Gui.Pos left, class Terminal.Gui.Pos right) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.Pos</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="left" Type="Terminal.Gui.Pos" />
        <Parameter Name="right" Type="Terminal.Gui.Pos" />
      </Parameters>
      <Docs>
        <param name="left">The first <see cref="T:Terminal.Gui.Pos" /> to add.</param>
        <param name="right">The second <see cref="T:Terminal.Gui.Pos" /> to add.</param>
        <summary>
            Adds a <see cref="T:Terminal.Gui.Pos" /> to a <see cref="T:Terminal.Gui.Pos" />, yielding a new <see cref="T:Terminal.Gui.Pos" />.
            </summary>
        <returns>The <see cref="T:Terminal.Gui.Pos" /> that is the sum of the values of <c>left</c> and <c>right</c>.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="op_Implicit">
      <MemberSignature Language="C#" Value="public static Terminal.Gui.Pos op_Implicit (int n);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname class Terminal.Gui.Pos op_Implicit(int32 n) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.Pos</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="n" Type="System.Int32" />
      </Parameters>
      <Docs>
        <param name="n">The value to convert to the pos.</param>
        <summary>
            Creates an Absolute Pos from the specified integer value.
            </summary>
        <returns>The Absolute Pos.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="op_Subtraction">
      <MemberSignature Language="C#" Value="public static Terminal.Gui.Pos op_Subtraction (Terminal.Gui.Pos left, Terminal.Gui.Pos right);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname class Terminal.Gui.Pos op_Subtraction(class Terminal.Gui.Pos left, class Terminal.Gui.Pos right) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.Pos</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="left" Type="Terminal.Gui.Pos" />
        <Parameter Name="right" Type="Terminal.Gui.Pos" />
      </Parameters>
      <Docs>
        <param name="left">The <see cref="T:Terminal.Gui.Pos" /> to subtract from (the minuend).</param>
        <param name="right">The <see cref="T:Terminal.Gui.Pos" /> to subtract (the subtrahend).</param>
        <summary>
            Subtracts a <see cref="T:Terminal.Gui.Pos" /> from a <see cref="T:Terminal.Gui.Pos" />, yielding a new <see cref="T:Terminal.Gui.Pos" />.
            </summary>
        <returns>The <see cref="T:Terminal.Gui.Pos" /> that is the <c>left</c> minus <c>right</c>.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Percent">
      <MemberSignature Language="C#" Value="public static Terminal.Gui.Pos Percent (float n);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Terminal.Gui.Pos Percent(float32 n) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.Pos</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="n" Type="System.Single" />
      </Parameters>
      <Docs>
        <param name="n">A value between 0 and 100 representing the percentage.</param>
        <summary>
            Creates a percentage Pos object
            </summary>
        <returns>The percent Pos object.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Right">
      <MemberSignature Language="C#" Value="public static Terminal.Gui.Pos Right (Terminal.Gui.View view);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Terminal.Gui.Pos Right(class Terminal.Gui.View view) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.Pos</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="view" Type="Terminal.Gui.View" />
      </Parameters>
      <Docs>
        <param name="view">The view that will be tracked.</param>
        <summary>
            Returns a Pos object tracks the Right (X+Width) coordinate of the specified view.
            </summary>
        <returns>The Position that depends on the other view.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Top">
      <MemberSignature Language="C#" Value="public static Terminal.Gui.Pos Top (Terminal.Gui.View view);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Terminal.Gui.Pos Top(class Terminal.Gui.View view) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.Pos</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="view" Type="Terminal.Gui.View" />
      </Parameters>
      <Docs>
        <param name="view">The view that will be tracked.</param>
        <summary>
            Returns a Pos object tracks the Top (Y) position of the specified view.
            </summary>
        <returns>The Position that depends on the other view.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="X">
      <MemberSignature Language="C#" Value="public static Terminal.Gui.Pos X (Terminal.Gui.View view);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Terminal.Gui.Pos X(class Terminal.Gui.View view) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.Pos</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="view" Type="Terminal.Gui.View" />
      </Parameters>
      <Docs>
        <param name="view">The view that will be tracked.</param>
        <summary>
            Returns a Pos object tracks the Left (X) position of the specified view.
            </summary>
        <returns>The Position that depends on the other view.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Y">
      <MemberSignature Language="C#" Value="public static Terminal.Gui.Pos Y (Terminal.Gui.View view);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Terminal.Gui.Pos Y(class Terminal.Gui.View view) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Terminal.Gui.Pos</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="view" Type="Terminal.Gui.View" />
      </Parameters>
      <Docs>
        <param name="view">The view that will be tracked.</param>
        <summary>
            Returns a Pos object tracks the Top (Y) position of the specified view.
            </summary>
        <returns>The Position that depends on the other view.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>