GtkSharp/doc/en/Gtk/IMContext.xml
Joshua Tauberer 9d0a50175b Updated GtkSharp docs for monodoc's needs
svn path=/trunk/gtk-sharp/; revision=16463
2003-07-21 00:13:00 +00:00

323 lines
12 KiB
XML

<Type Name="IMContext" FullName="Gtk.IMContext">
<TypeSignature Language="C#" Value="public class IMContext : GLib.Object, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<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>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="FocusIn">
<MemberSignature Language="C#" Value="public void FocusIn ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="FocusOut">
<MemberSignature Language="C#" Value="public void FocusOut ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="DeleteSurrounding">
<MemberSignature Language="C#" Value="public bool DeleteSurrounding (int offset, int n_chars);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="offset" Type="System.Int32" />
<Parameter Name="n_chars" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="offset">To be added: an object of type 'int'</param>
<param name="n_chars">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="FilterKeypress">
<MemberSignature Language="C#" Value="public bool FilterKeypress (Gdk.EventKey evnt);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Gdk.EventKey" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="evnt">To be added: an object of type 'Gdk.EventKey'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetSurrounding">
<MemberSignature Language="C#" Value="public bool GetSurrounding (string text, int cursor_index);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="text" Type="System.String" />
<Parameter Name="cursor_index" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="text">To be added: an object of type 'string'</param>
<param name="cursor_index">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="GetPreeditString">
<MemberSignature Language="C#" Value="public void GetPreeditString (string str, Pango.AttrList attrs, int cursor_pos);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="str" Type="System.String" />
<Parameter Name="attrs" Type="Pango.AttrList" />
<Parameter Name="cursor_pos" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="str">To be added: an object of type 'string'</param>
<param name="attrs">To be added: an object of type 'Pango.AttrList'</param>
<param name="cursor_pos">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Reset">
<MemberSignature Language="C#" Value="public void Reset ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="protected virtual 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 IMContext (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 IMContext, 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="protected IMContext ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.IMContext'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static uint GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>The GLib Type for Gtk.IMContext</summary>
<returns>The GLib Type for the Gtk.IMContext class.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="ClientWindow">
<MemberSignature Language="C#" Value="public Gdk.Window ClientWindow { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Window</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Window'</param>
<returns>To be added: an object of type 'Gdk.Window'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CursorLocation">
<MemberSignature Language="C#" Value="public Gdk.Rectangle CursorLocation { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Rectangle</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Rectangle'</param>
<returns>To be added: an object of type 'Gdk.Rectangle'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="UsePreedit">
<MemberSignature Language="C#" Value="public bool UsePreedit { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="PreeditChanged">
<MemberSignature Language="C#" Value="public event EventHandler PreeditChanged;" />
<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="PreeditStart">
<MemberSignature Language="C#" Value="public event EventHandler PreeditStart;" />
<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="SurroundingDeleted">
<MemberSignature Language="C#" Value="public event GtkSharp.SurroundingDeletedHandler SurroundingDeleted;" />
<MemberType>Event</MemberType>
<ReturnValue><ReturnType>GtkSharp.SurroundingDeletedHandler</ReturnType></ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Commit">
<MemberSignature Language="C#" Value="public event GtkSharp.CommitHandler Commit;" />
<MemberType>Event</MemberType>
<ReturnValue><ReturnType>GtkSharp.CommitHandler</ReturnType></ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RetrieveSurrounding">
<MemberSignature Language="C#" Value="public event GtkSharp.RetrieveSurroundingHandler RetrieveSurrounding;" />
<MemberType>Event</MemberType>
<ReturnValue><ReturnType>GtkSharp.RetrieveSurroundingHandler</ReturnType></ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="PreeditEnd">
<MemberSignature Language="C#" Value="public event EventHandler PreeditEnd;" />
<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="SetSurrounding">
<MemberSignature Language="C#" Value="public void SetSurrounding (string text, int cursor_index);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="text" Type="System.String" />
<Parameter Name="cursor_index" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="text">To be added: an object of type 'string'</param>
<param name="cursor_index">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected IMContext (GLib.Type gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
<returns>Creates a new instance of IMContext, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gtk.IMContext" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>