GtkSharp/doc/en/Gtk/IMContextSimple.xml
Shane Landrum eebb000b14 2005-01-03 Shane Landrum <epicene@pobox.com>
* en/Gtk/IMContextSimple.xml
	* en/Gtk/IMContext.xml
	* en/Gtk/IMContextInfo.xml: Added docs.

svn path=/trunk/gtk-sharp/; revision=38299
2005-01-04 03:08:21 +00:00

123 lines
4.8 KiB
XML

<Type Name="IMContextSimple" FullName="Gtk.IMContextSimple">
<TypeSignature Language="C#" Value="public class IMContextSimple : Gtk.IMContext, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gtk-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 input method context supporting table-based input methods.
</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>Gtk.IMContext</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="protected override void Finalize ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Disposes the resources associated with the object.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IMContextSimple (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 IMContextSimple, 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 IMContextSimple ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Public constructor.</summary>
<returns>an object of type <see cref="T:Gtk.IMContextSimple" /></returns>
<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:Gtk.IMContextSimple" />.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected IMContextSimple (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>Protected Constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gtk.IMContextSimple" /></returns>
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
</Docs>
</Member>
<Member MemberName="AddTable">
<MemberSignature Language="C#" Value="public ushort AddTable (int max_seq_len, int n_seqs);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt16</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="max_seq_len" Type="System.Int32" />
<Parameter Name="n_seqs" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Adds an additional table to search to the input context.</summary>
<param name="max_seq_len">a <see cref="T:System.Int32" /></param>
<param name="n_seqs">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:System.UInt16" /></returns>
<remarks>
<para>
Each row of the table consists of <paramref name="max_seq_len"/> key symbols followed by two <see cref="T:System.UInt16" /> interpreted as the high and low words of a Unicode value. Tables are searched starting from the last added.
</para>
<para>
The table must be sorted in dictionary order on the numeric value of the key symbol fields. (Values beyond the length of the sequence should be zero.)
</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>