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

doc/ChangeLog

@@ -1,3 +1,9 @@
+2005-01-03  Shane Landrum  <epicene@pobox.com>
+
+	* en/Gtk/IMContextSimple.xml
+	* en/Gtk/IMContext.xml
+	* en/Gtk/IMContextInfo.xml: Added docs.
+
 2005-01-03  Shane Landrum  <epicene@pobox.com>
 
 	* en/Gtk/HButtonBox.xml

doc/en/Gtk/IMContext.xml

@@ -68,11 +68,35 @@
         <Parameter Name="n_chars" Type="System.Int32" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+	  Asks the widget that the input context is attached to to delete
+	  characters around the cursor position by emitting the
+	  <see cref="E:Gtk.IMContext.DeleteSurrounding"/> signal. 
+	</summary>
         <param name="offset">a <see cref="T:System.Int32" /></param>
         <param name="n_chars">a <see cref="T:System.Int32" /></param>
-        <returns>a <see cref="T:System.Boolean" /></returns>
+        <returns>a <see cref="T:System.Boolean" />, <see langword="true"/> if the signal was handled.</returns>
-        <remarks />
+        <remarks>
+	  <para>
+	    Note that <paramref name="offset"/> and <paramref name="n_chars"/>
+	    are in characters not in bytes, which differs from the usage other
+	    places in <see cref="T:Gtk.IMContext"/>.
+	  </para>
+	  <para>
+	    In order to use this function, you should first call
+	    <see cref="M:Gtk.IMContext.GetSurrounding"/>
+	    to get the current context, and
+	    call this function immediately afterwards to make sure that you
+	    know what you are deleting. You should also account for the fact
+	    that even if the signal was handled, the input context might not
+	    have deleted all the characters that were requested to be deleted.
+	  </para>
+	  <para>
+	    This function is used by an input method that wants to make
+	    subsitutions in the existing text in response to new input. It is
+	    not useful for applications.
+	  </para>
+	</remarks>
       </Docs>
     </Member>
     <Member MemberName="FilterKeypress">
@@ -141,10 +165,17 @@
       <Parameters>
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+	  Set the client window for the input context; this is the
+	  <see cref="T:Gdk.Window"/> in which the input appears. 
+	</summary>
         <param name="value">a <see cref="T:Gdk.Window" /></param>
         <returns>a <see cref="T:Gdk.Window" /></returns>
-        <remarks />
+        <remarks>
+	  The client window is
+	  used in order to correctly position status windows. It may
+	  also be used for purposes internal to the input method.
+	</remarks>
       </Docs>
     </Member>
     <Member MemberName="CursorLocation">
@@ -156,10 +187,15 @@
       <Parameters>
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+	  Notify the input method that a change in cursor 
+	  position has been made. 
+	</summary>
         <param name="value">a <see cref="T:Gdk.Rectangle" /></param>
         <returns>a <see cref="T:Gdk.Rectangle" /></returns>
-        <remarks />
+        <remarks>
+	  The location is relative to the client window.
+	</remarks>
       </Docs>
     </Member>
     <Member MemberName="UsePreedit">
@@ -171,10 +207,17 @@
       <Parameters>
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>
+	  Whether the IM context should use the preedit string
+	  to display feedback. 
+	</summary>
         <param name="value">a <see cref="T:System.Boolean" /></param>
         <returns>a <see cref="T:System.Boolean" /></returns>
-        <remarks />
+        <remarks>
+	  If <paramref name="use_preedit"/> is <see langword="false"/> (default
+	  is <see langword="true"/>), then the IM context may use some other method to display
+	  feedback, such as displaying it in a child of the root window.
+	</remarks>
       </Docs>
     </Member>
     <Member MemberName="PreeditChanged">
@@ -185,7 +228,7 @@
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
+        <summary>Event fired when the preedit string is changed.</summary>
         <remarks />
       </Docs>
     </Member>

doc/en/Gtk/IMContextInfo.xml

@@ -41,7 +41,7 @@
         <Parameter Name="raw" Type="System.IntPtr" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <summary>Public constructor for internal use only. Do not use.</summary>
         <param name="raw">a <see cref="T:IntPtr" /></param>
         <returns>a <see cref="T:Gtk.IMContextInfo" /></returns>
         <remarks />

doc/en/Gtk/IMContextSimple.xml

@@ -10,7 +10,9 @@
   </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>
+    <summary>
+      An input method context supporting table-based input methods.
+    </summary>
     <remarks />
   </Docs>
   <Base>
@@ -60,7 +62,7 @@
       <ReturnValue />
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
+        <summary>Public constructor.</summary>
         <returns>an object of type <see cref="T:Gtk.IMContextSimple" /></returns>
         <remarks />
       </Docs>
@@ -103,11 +105,18 @@
         <Parameter Name="n_seqs" Type="System.Int32" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
+        <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 />
+        <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>