GtkSharp/doc/en/Atk/Text.xml
Duncan Mak 7661dafe09 2003-02-14 Duncan Mak <duncan@ximian.com>
* en/*: Updated the docs and added a new Maintainer attribute, also
	fixed the generator to produce 'ref/out' modifiers for parameters.

svn path=/trunk/gtk-sharp/; revision=11599
2003-02-15 03:08:25 +00:00

355 lines
No EOL
15 KiB
XML

<Type Name="Text" FullName="Atk.Text">
<TypeSignature Language="C#" Value="public abstract interface Text;" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>atk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<Attributes />
</AssemblyInfo>
<ThreadSafetyStatement>To be added</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</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="GetCharacterAtOffset">
<MemberSignature Language="C#" Value="public virtual string GetCharacterAtOffset (int offset);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</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 'string'</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="GetTextAtOffset">
<MemberSignature Language="C#" Value="public virtual string GetTextAtOffset (int offset, Atk.TextBoundary boundary_type, int start_offset, 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" />
<Parameter Name="end_offset" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="offset">To be added: an object of type 'int'</param>
<param name="boundary_type">To be added: an object of type 'Atk.TextBoundary'</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 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetRunAttributes">
<MemberSignature Language="C#" Value="public virtual GLib.SList GetRunAttributes (int offset, int start_offset, 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" />
<Parameter Name="end_offset" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="offset">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 'GLib.SList'</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="GetCharacterExtents">
<MemberSignature Language="C#" Value="public virtual void GetCharacterExtents (int offset, int x, int y, int width, 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" />
<Parameter Name="y" Type="System.Int32" />
<Parameter Name="width" Type="System.Int32" />
<Parameter Name="height" Type="System.Int32" />
<Parameter Name="coords" Type="Atk.CoordType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="offset">To be added: an object of type 'int'</param>
<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="width">To be added: an object of type 'int'</param>
<param name="height">To be added: an object of type 'int'</param>
<param name="coords">To be added: an object of type 'Atk.CoordType'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetTextAfterOffset">
<MemberSignature Language="C#" Value="public virtual string GetTextAfterOffset (int offset, Atk.TextBoundary boundary_type, int start_offset, 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" />
<Parameter Name="end_offset" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="offset">To be added: an object of type 'int'</param>
<param name="boundary_type">To be added: an object of type 'Atk.TextBoundary'</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 'string'</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="GetTextBeforeOffset">
<MemberSignature Language="C#" Value="public virtual string GetTextBeforeOffset (int offset, Atk.TextBoundary boundary_type, int start_offset, 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" />
<Parameter Name="end_offset" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="offset">To be added: an object of type 'int'</param>
<param name="boundary_type">To be added: an object of type 'Atk.TextBoundary'</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 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetSelection">
<MemberSignature Language="C#" Value="public virtual string GetSelection (int selection_num, int start_offset, 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" />
<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 '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 AtkSharp.TextChangedHandler TextChanged;" />
<MemberType>Event</MemberType>
<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 />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="TextCaretMoved">
<MemberSignature Language="C#" Value="public virtual event AtkSharp.TextCaretMovedHandler TextCaretMoved;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>