[Gtk-sharp-list] Gtk.Fixed doc

[John Luke]

--=-QR4itLYwrZCC0BEU8CVN
Content-Type: text/plain
Content-Transfer-Encoding: 7bit

Hello,

Here is a first draft for gtk-sharp/doc/en/Gtk/Fixed.xml
It lacks examples.
Can someone commit if it is OK?

Thanks,
John Luke

--=-QR4itLYwrZCC0BEU8CVN
Content-Disposition: attachment; filename=Fixed.diff
Content-Type: text/x-patch; name=Fixed.diff; charset=UTF-8
Content-Transfer-Encoding: 7bit

Index: Fixed.xml
===================================================================
RCS file: /mono/gtk-sharp/doc/en/Gtk/Fixed.xml,v
retrieving revision 1.5
diff -u -r1.5 Fixed.xml
--- Fixed.xml	8 Mar 2003 06:28:12 -0000	1.5
+++ Fixed.xml	2 May 2003 21:34:27 -0000
@@ -7,8 +7,20 @@
   </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>
+    <summary>A container which allows you to position widgets at fixed coordinates</summary>
+    <remarks>
+			<para>The <see cref="T:Gtk.Fixed"/> widget is a container which can place child widgets at fixed positions and with fixed sizes, given in pixels. <see cref="T:Gtk.Fixed"/> performs no automatic layout management.</para>
+			<para>For most applications, you should not use this container! It keeps you from having to learn about the other Gtk# containers, but it results in broken applications. With <see cref="T:Gtk.Fixed"/>, the following things will result in truncated text, overlapping widgets, and other display bugs:
+				<list type="bullet">
+					<item>Themes, which may change widget sizes.</item>
+					<item>Fonts other than the one you used to write the app will of course change the size of widgets containing text; keep in mind that users may use a larger font because of difficulty reading the default, or they may be using Windows or the framebuffer port of GTK+, where different fonts are available.</item>
+					<item>Translation of text into other languages changes its size. Also, display of non-English text will use a different font in many cases.</item>
+				</list>
+			</para>
+			<para>In addition, the fixed widget can't properly be mirrored in right-to-left languages such as Hebrew and Arabic. i.e. normally GTK+ will flip the interface to put labels to the right of the thing they label, but it can't do that with <see cref="T:Gtk.Fixed"/>. So your application will not be usable in right-to-left languages.</para>
+			<para>Finally, fixed positioning makes it kind of annoying to add/remove GUI elements, since you have to reposition all the other elements. This is a long-term maintenance problem for your application.</para>
+			<para>If you know none of these things are an issue for your application, and prefer the simplicity of <see cref="T:Gtk.Fixed"/>, by all means use the widget. But you should be aware of the tradeoffs.</para>
+		</remarks>
   </Docs>
   <Base>
     <BaseTypeName>Gtk.Container</BaseTypeName>
@@ -41,11 +53,11 @@
         <Parameter Name="y" Type="System.Int32" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
-        <param name="widget">To be added: an object of type 'Gtk.Widget'</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>
-        <remarks>To be added</remarks>
+        <summary>Moves a child of a <see cref="T:Gtk.Fixed"/> container to the given position.</summary>
+        <param name="widget">an object of type <see cref="T:Gtk.Widget"/></param>
+        <param name="x">an object of type <see cref="T:System.Int32"/></param>
+        <param name="y">an object of type <see cref="T:System.Int32"/></param>
+        <remarks>Moves a child of a <see cref="T:Gtk.Fixed"/> container to the given position.</remarks>
       </Docs>
     </Member>
     <Member MemberName="Put">
@@ -60,11 +72,11 @@
         <Parameter Name="y" Type="System.Int32" />
       </Parameters>
       <Docs>
-        <summary>To be added</summary>
-        <param name="widget">To be added: an object of type 'Gtk.Widget'</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>
-        <remarks>To be added</remarks>
+        <summary>Adds a widget to a <see cref="T:Gtk.Fixed"/> container at the given position.</summary>
+        <param name="widget">an object of type <see cref="T:Gtk.Widget"/></param>
+        <param name="x">an object of type <see cref="T:System.Int32"/></param>
+        <param name="y">an object of type <see cref="T:System.Int32"/></param>
+        <remarks>Adds a widget to a <see cref="T:Gtk.Fixed"/> container at the given position.</remarks>
       </Docs>
     </Member>
     <Member MemberName="Finalize">
@@ -101,9 +113,9 @@
       <ReturnValue />
       <Parameters />
       <Docs>
-        <summary>To be added</summary>
-        <returns>To be added: an object of type 'Gtk.Fixed'</returns>
-        <remarks>To be added</remarks>
+        <summary>Creates a new <see cref="T:Gtk.Fixed"/> object.</summary>
+        <returns>an object of type <see cref="T:Gtk.Fixed"/></returns>
+        <remarks>Creates a new <see cref="T:Gtk.Fixed"/> object.</remarks>
       </Docs>
     </Member>
     <Member MemberName="GType">
@@ -113,8 +125,8 @@
         <ReturnType>System.UInt32</ReturnType>
       </ReturnValue>
       <Docs>
-        <summary>The GLib Type for Gtk.Fixed</summary>
-        <returns>The GLib Type for the Gtk.Fixed class.</returns>
+        <summary>The <see cref="T:GLib.Type"/> for <see cref="T:Gtk.Fixed"/></summary>
+        <returns>The <see cref="T:GLib.Type"/> for the <see cref="T:Gtk.Fixed"/> class.</returns>
         <remarks />
       </Docs>
     </Member>
@@ -128,10 +140,13 @@
         <Parameter Name="value" Type="System.Boolean" />
       </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>
+        <summary>Determines if <see cref="T:Gtk.Fixed"/> has a seperate <see cref="T:Gdk.Window"/></summary>
+        <param name="value">an object of type <see cref="T:System.Boolean"/></param>
+        <returns>an object of type <see cref="T:System.Boolean"/></returns>
+        <remarks>
+					<para>Gets whether the <see cref="T:Gtk.Fixed"/> has it's own <see cref="T:Gdk.Window"/>.</para>
+					<para>Sets whether a <see cref="T:Gtk.Fixed"/> widget is created with a separate <see cref="T:Gdk.Window"/> or not. (By default, it will be created without a seperate <see cref="T:Gdk.Window"/>). This function must be called while the <see cref="T:Gtk.Fixed"/> is not realized, for instance, immediately after the window is created.</para>
+				</remarks>
       </Docs>
     </Member>
     <Member MemberName=".ctor">
@@ -151,4 +166,4 @@
       </Docs>
     </Member>
   </Members>
-</Type>
\ No newline at end of file
+</Type>

--=-QR4itLYwrZCC0BEU8CVN--