GtkSharp/doc/en/Pango/TabArray.xml

<Type Name="TabArray" FullName="Pango.TabArray">
  <TypeSignature Language="C#" Value="public class TabArray : GLib.Opaque, IWrapper" Maintainer="auto" />
  <AssemblyInfo>
    <AssemblyName>pango-sharp</AssemblyName>
    <AssemblyPublicKey>
    </AssemblyPublicKey>
    <AssemblyVersion>0.0.0.0</AssemblyVersion>
    <AssemblyCulture>neutral</AssemblyCulture>
    <Attributes />
  </AssemblyInfo>
  <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
  <Docs>
    <summary>an object containing an array of tab stops.</summary>
    <remarks>Each tab stop has an alignment and a position.</remarks>
  </Docs>
  <Base>
    <BaseTypeName>GLib.Opaque</BaseTypeName>
  </Base>
  <Interfaces>
    <Interface>
      <InterfaceName>GLib.IWrapper</InterfaceName>
    </Interface>
  </Interfaces>
  <Attributes />
  <Members>
    <Member MemberName="Copy">
      <MemberSignature Language="C#" Value="public Pango.TabArray Copy ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Pango.TabArray</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Copies the existing <see cref="T:Pango.TabArray" /> to a new one.</summary>
        <returns>an object of type <see cref="T:Pango.TabArray" /></returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Resize">
      <MemberSignature Language="C#" Value="public void Resize (int new_size);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="new_size" Type="System.Int32" />
      </Parameters>
      <Docs>
        <summary>Sets the size of the tab array to the value specified by <paramref name="new_size" />.</summary>
        <param name="new_size">the new size of the array</param>
        <remarks>You must subsequently initialize any tabs that were added to the array.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Free">
      <MemberSignature Language="C#" Value="public void Free ();" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Frees all the resources for this object.</summary>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="SetTab">
      <MemberSignature Language="C#" Value="public void SetTab (int tab_index, Pango.TabAlign alignment, int location);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="tab_index" Type="System.Int32" />
        <Parameter Name="alignment" Type="Pango.TabAlign" />
        <Parameter Name="location" Type="System.Int32" />
      </Parameters>
      <Docs>
        <summary>Sets the specified <paramref name="alignment" /> and <paramref name="location" /> of the tab stop specified by <paramref name="tab_index" />.</summary>
        <param name="tab_index">the index of a tab stop</param>
        <param name="alignment">the tab alignment</param>
        <param name="location">the tab location in pango units</param>
        <remarks>The value of <paramref name="alignment" /> must always be <see cref="T:Pango.TabAlign.Left" /> in the current implementation.</remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public TabArray (IntPtr raw);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="raw" Type="System.IntPtr" />
      </Parameters>
      <Docs>
        <summary>Internal constructor</summary>
        <param name="raw">Pointer to the C object.</param>
        <returns>An instance of TabArray, wrapping the C object.</returns>
        <remarks>
          <para>This is an internal constructor, and should not be used by user code.</para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public TabArray (int initial_size, bool positions_in_pixels);" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters>
        <Parameter Name="initial_size" Type="System.Int32" />
        <Parameter Name="positions_in_pixels" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <summary>an object containing an array of tab stops</summary>
        <param name="initial_size">Initial number of tab stops to allocate, can be 0</param>
        <param name="positions_in_pixels">if <see langword="true" /> the tab positions are in pixel units</param>
        <returns>an object of type <see cref="T:Pango.TabArray" /></returns>
        <remarks>Creates a new <see cref="T:Pango.TabArray" /> with the number of tab stops specified by <paramref name="initial_size" />. If <paramref name="positions_in_pixels" /> is <see langword="true" />, the tab stop positions are specified in pixel units otherwise in pango units. All tab stops are initially at position 0.</remarks>
      </Docs>
    </Member>
    <Member MemberName="PositionsInPixels">
      <MemberSignature Language="C#" Value="public bool PositionsInPixels { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>returns <see langword="true" /> if the tab positions are specified in pixels and <see langword="false" /> if they are in pango units.</summary>
        <returns>an object of type <see cref="T:System.Boolean" /></returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Size">
      <MemberSignature Language="C#" Value="public int Size { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>returns the number of tab stops in the tab array.</summary>
        <returns>the number of tab stops in the array.</returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="GetTabs">
      <MemberSignature Language="C#" Value="public void GetTabs (out Pango.TabAlign alignments, out int locations);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="alignments" Type="Pango.TabAlign&amp;" RefType="out" />
        <Parameter Name="locations" Type="System.Int32&amp;" RefType="out" />
      </Parameters>
      <Docs>
        <summary>Gets the an array of alignments and positions.</summary>
        <param name="alignments">a <see cref="T:Pango.TabAlign&amp;" /></param>
        <param name="locations">a <see cref="T:System.Int32&amp;" /></param>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="GetTab">
      <MemberSignature Language="C#" Value="public void GetTab (int tab_index, out Pango.TabAlign alignment, out int location);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="tab_index" Type="System.Int32" />
        <Parameter Name="alignment" Type="Pango.TabAlign&amp;" RefType="out" />
        <Parameter Name="location" Type="System.Int32&amp;" RefType="out" />
      </Parameters>
      <Docs>
        <summary>Gets the alignment and position of the tab stop specified by <paramref name="tab_index" />.</summary>
        <param name="tab_index">the tab stop index</param>
        <param name="alignment">a <see cref="T:Pango.TabAlign&amp;" /></param>
        <param name="location">a <see cref="T:System.Int32&amp;" /></param>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="GType">
      <MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>GLib.GType</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>GType Property.</summary>
        <returns>a <see cref="T:GLib.GType" /></returns>
        <remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Pango.TabArray" />.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>