GtkSharp/doc/en/Atk/Text.xml

<Type Name="Text" FullName="Atk.Text">
  <TypeSignature Language="C#" Value="public abstract interface Text;" Maintainer="auto" />
  <AssemblyInfo>
    <AssemblyName>atk-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>The interface implemented by components with text content.</summary>
    <remarks>
      <para>
        <see cref="T:Atk.Text" /> should be implemented by <see cref="T:Atk.Object" />s on behalf of widgets that have text content which is either attributed or otherwise non-trivial. <see cref="T:Atk.Object" />s whose text content is simple, unattributed, and very brief may expose that content via atk_object_get_name instead; however if the text is editable, multi-line, typically longer than three or four words, attributed, selectable, or if the object already uses the 'name' ATK property for other information, the <see cref="T:Atk.Text" /> interface should be used to expose the text content. In the case of editable text content, <see cref="T:Atk.EditableText" /> (a subtype of the <see cref="T:Atk.Text" /> interface) should be implemented instead.
</para>
      <para>
        <see cref="T:Atk.Text" /> provides not only traversal facilities and change notification for text content, but also caret tracking and glyph bounding box calculations. Note that the text strings are exposed as UTF-8, and are therefore potentially multi-byte, and caret-to-byte offset mapping makes no assumptions about the character length; also bounding box glyph-to-offset mapping may be complex for languages which use ligatures. 
</para>
    </remarks>
  </Docs>
  <Base />
  <Interfaces>
    <Interface>
      <InterfaceName>GLib.IWrapper</InterfaceName>
    </Interface>
  </Interfaces>
  <Attributes />
  <Members>
    <Member MemberName="GetOffsetAtPoint">
      <MemberSignature Language="C#" Value="public virtual int GetOffsetAtPoint (int x, int y, Atk.CoordType coords);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="x" Type="System.Int32" />
        <Parameter Name="y" Type="System.Int32" />
        <Parameter Name="coords" Type="Atk.CoordType" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="x">To be added: an object of type 'int'</param>
        <param name="y">To be added: an object of type 'int'</param>
        <param name="coords">To be added: an object of type 'Atk.CoordType'</param>
        <returns>To be added: an object of type 'int'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="SetSelection">
      <MemberSignature Language="C#" Value="public virtual bool SetSelection (int selection_num, int start_offset, int end_offset);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="selection_num" Type="System.Int32" />
        <Parameter Name="start_offset" Type="System.Int32" />
        <Parameter Name="end_offset" Type="System.Int32" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="selection_num">To be added: an object of type 'int'</param>
        <param name="start_offset">To be added: an object of type 'int'</param>
        <param name="end_offset">To be added: an object of type 'int'</param>
        <returns>To be added: an object of type 'bool'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="SetCaretOffset">
      <MemberSignature Language="C#" Value="public virtual bool SetCaretOffset (int offset);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="offset" Type="System.Int32" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="offset">To be added: an object of type 'int'</param>
        <returns>To be added: an object of type 'bool'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="RemoveSelection">
      <MemberSignature Language="C#" Value="public virtual bool RemoveSelection (int selection_num);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="selection_num" Type="System.Int32" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="selection_num">To be added: an object of type 'int'</param>
        <returns>To be added: an object of type 'bool'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetText">
      <MemberSignature Language="C#" Value="public virtual string GetText (int start_offset, int end_offset);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="start_offset" Type="System.Int32" />
        <Parameter Name="end_offset" Type="System.Int32" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="start_offset">To be added: an object of type 'int'</param>
        <param name="end_offset">To be added: an object of type 'int'</param>
        <returns>To be added: an object of type 'string'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="AddSelection">
      <MemberSignature Language="C#" Value="public virtual bool AddSelection (int start_offset, int end_offset);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="start_offset" Type="System.Int32" />
        <Parameter Name="end_offset" Type="System.Int32" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="start_offset">To be added: an object of type 'int'</param>
        <param name="end_offset">To be added: an object of type 'int'</param>
        <returns>To be added: an object of type 'bool'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="DefaultAttributes">
      <MemberSignature Language="C#" Value="public virtual GLib.SList DefaultAttributes { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>GLib.SList</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added</summary>
        <returns>To be added: an object of type 'GLib.SList'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="NSelections">
      <MemberSignature Language="C#" Value="public virtual int NSelections { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added</summary>
        <returns>To be added: an object of type 'int'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="CaretOffset">
      <MemberSignature Language="C#" Value="public virtual int CaretOffset { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added</summary>
        <returns>To be added: an object of type 'int'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="CharacterCount">
      <MemberSignature Language="C#" Value="public virtual int CharacterCount { get; };" />
      <MemberType>Property</MemberType>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>To be added</summary>
        <returns>To be added: an object of type 'int'</returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="TextChanged">
      <MemberSignature Language="C#" Value="public virtual event Atk.TextChangedHandler TextChanged;" />
      <MemberType>Event</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextChangedHandler</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added</summary>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="TextSelectionChanged">
      <MemberSignature Language="C#" Value="public virtual event EventHandler TextSelectionChanged;" />
      <MemberType>Event</MemberType>
      <ReturnValue>
        <ReturnType>System.EventHandler</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added</summary>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="TextCaretMoved">
      <MemberSignature Language="C#" Value="public virtual event Atk.TextCaretMovedHandler TextCaretMoved;" />
      <MemberType>Event</MemberType>
      <ReturnValue>
        <ReturnType>Atk.TextCaretMovedHandler</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added</summary>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="TextAttributesChanged">
      <MemberSignature Language="C#" Value="public virtual event EventHandler TextAttributesChanged;" />
      <MemberType>Event</MemberType>
      <ReturnValue>
        <ReturnType>System.EventHandler</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>To be added</summary>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetTextAfterOffset">
      <MemberSignature Language="C#" Value="public virtual string GetTextAfterOffset (int offset, Atk.TextBoundary boundary_type, out int start_offset, out int end_offset);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="offset" Type="System.Int32" />
        <Parameter Name="boundary_type" Type="Atk.TextBoundary" />
        <Parameter Name="start_offset" Type="System.Int32&amp;" RefType="out" />
        <Parameter Name="end_offset" Type="System.Int32&amp;" RefType="out" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="offset">a <see cref="T:System.Int32" /></param>
        <param name="boundary_type">a <see cref="T:Atk.TextBoundary" /></param>
        <param name="start_offset">a <see cref="T:System.Int32&amp;" /></param>
        <param name="end_offset">a <see cref="T:System.Int32&amp;" /></param>
        <returns>a <see cref="T:System.String" /></returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetSelection">
      <MemberSignature Language="C#" Value="public virtual string GetSelection (int selection_num, out int start_offset, out int end_offset);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="selection_num" Type="System.Int32" />
        <Parameter Name="start_offset" Type="System.Int32&amp;" RefType="out" />
        <Parameter Name="end_offset" Type="System.Int32&amp;" RefType="out" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="selection_num">a <see cref="T:System.Int32" /></param>
        <param name="start_offset">a <see cref="T:System.Int32&amp;" /></param>
        <param name="end_offset">a <see cref="T:System.Int32&amp;" /></param>
        <returns>a <see cref="T:System.String" /></returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetTextBeforeOffset">
      <MemberSignature Language="C#" Value="public virtual string GetTextBeforeOffset (int offset, Atk.TextBoundary boundary_type, out int start_offset, out int end_offset);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="offset" Type="System.Int32" />
        <Parameter Name="boundary_type" Type="Atk.TextBoundary" />
        <Parameter Name="start_offset" Type="System.Int32&amp;" RefType="out" />
        <Parameter Name="end_offset" Type="System.Int32&amp;" RefType="out" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="offset">a <see cref="T:System.Int32" /></param>
        <param name="boundary_type">a <see cref="T:Atk.TextBoundary" /></param>
        <param name="start_offset">a <see cref="T:System.Int32&amp;" /></param>
        <param name="end_offset">a <see cref="T:System.Int32&amp;" /></param>
        <returns>a <see cref="T:System.String" /></returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetCharacterExtents">
      <MemberSignature Language="C#" Value="public virtual void GetCharacterExtents (int offset, out int x, out int y, out int width, out int height, Atk.CoordType coords);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="offset" Type="System.Int32" />
        <Parameter Name="x" Type="System.Int32&amp;" RefType="out" />
        <Parameter Name="y" Type="System.Int32&amp;" RefType="out" />
        <Parameter Name="width" Type="System.Int32&amp;" RefType="out" />
        <Parameter Name="height" Type="System.Int32&amp;" RefType="out" />
        <Parameter Name="coords" Type="Atk.CoordType" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="offset">a <see cref="T:System.Int32" /></param>
        <param name="x">a <see cref="T:System.Int32&amp;" /></param>
        <param name="y">a <see cref="T:System.Int32&amp;" /></param>
        <param name="width">a <see cref="T:System.Int32&amp;" /></param>
        <param name="height">a <see cref="T:System.Int32&amp;" /></param>
        <param name="coords">a <see cref="T:Atk.CoordType" /></param>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetRunAttributes">
      <MemberSignature Language="C#" Value="public virtual GLib.SList GetRunAttributes (int offset, out int start_offset, out int end_offset);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>GLib.SList</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="offset" Type="System.Int32" />
        <Parameter Name="start_offset" Type="System.Int32&amp;" RefType="out" />
        <Parameter Name="end_offset" Type="System.Int32&amp;" RefType="out" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="offset">a <see cref="T:System.Int32" /></param>
        <param name="start_offset">a <see cref="T:System.Int32&amp;" /></param>
        <param name="end_offset">a <see cref="T:System.Int32&amp;" /></param>
        <returns>a <see cref="T:GLib.SList" /></returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="GetTextAtOffset">
      <MemberSignature Language="C#" Value="public virtual string GetTextAtOffset (int offset, Atk.TextBoundary boundary_type, out int start_offset, out int end_offset);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="offset" Type="System.Int32" />
        <Parameter Name="boundary_type" Type="Atk.TextBoundary" />
        <Parameter Name="start_offset" Type="System.Int32&amp;" RefType="out" />
        <Parameter Name="end_offset" Type="System.Int32&amp;" RefType="out" />
      </Parameters>
      <Docs>
        <summary>To be added</summary>
        <param name="offset">a <see cref="T:System.Int32" /></param>
        <param name="boundary_type">a <see cref="T:Atk.TextBoundary" /></param>
        <param name="start_offset">a <see cref="T:System.Int32&amp;" /></param>
        <param name="end_offset">a <see cref="T:System.Int32&amp;" /></param>
        <returns>a <see cref="T:System.String" /></returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
  </Members>
</Type>