GtkSharp/doc/en/Atk/Hypertext.xml
Mike Kestner 45ea3ed705 updater run on docs for 2.4 api
svn path=/trunk/gtk-sharp/; revision=35718
2004-11-05 19:00:43 +00:00

82 lines
No EOL
3.2 KiB
XML

<Type Name="Hypertext" FullName="Atk.Hypertext">
<TypeSignature Language="C#" Value="public abstract interface Hypertext;" 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 which provides standard mechanism for manipulating hyperlinks.
</summary>
<remarks />
</Docs>
<Base />
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="GetLinkIndex">
<MemberSignature Language="C#" Value="public virtual int GetLinkIndex (int char_index);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="char_index" Type="System.Int32" />
</Parameters>
<Docs>
<summary>The index into the array of hyperlinks that is associated with the character specified by <paramref name="char_index" />, or -1 if there is no hyperlink associated with this character.</summary>
<param name="char_index"> a character index</param>
<returns> an index into the array of hyperlinks in hypertext</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="GetLink">
<MemberSignature Language="C#" Value="public virtual Atk.Hyperlink GetLink (int link_index);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Atk.Hyperlink</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="link_index" Type="System.Int32" />
</Parameters>
<Docs>
<summary>The link in this hypertext document at index <paramref name="link_index" /></summary>
<param name="link_index"> an integer specifying the desired link</param>
<returns> the link in this hypertext document at index <paramref name="link_index" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="NLinks">
<MemberSignature Language="C#" Value="public virtual int NLinks { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>The number of links within this hypertext document.</summary>
<returns>The number of links within this hypertext document.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="LinkSelected">
<MemberSignature Language="C#" Value="public virtual event Atk.LinkSelectedHandler LinkSelected;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Atk.LinkSelectedHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>