From 9083728e6d17d0e84da8897c5320c047baa4856d Mon Sep 17 00:00:00 2001 From: Lee Mallabone Date: Sat, 15 Mar 2003 10:41:15 +0000 Subject: [PATCH] First draft of Alignment and Bin docs. svn path=/trunk/gtk-sharp/; revision=12522 --- doc/ChangeLog | 5 +++ doc/en/Gtk/Alignment.xml | 73 +++++++++++++++++++++------------------- doc/en/Gtk/Bin.xml | 14 ++++---- 3 files changed, 51 insertions(+), 41 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 19bc46bd1..35fa120bf 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,8 @@ +2003-03-15 Lee Mallabone + + * en/Gtk/Bin.xml: + * en/Gtk/Alignment.xml: First drafts. + 2003-03-12 Lee Mallabone * en/Gtk/PositionType.xml: diff --git a/doc/en/Gtk/Alignment.xml b/doc/en/Gtk/Alignment.xml index 834356073..cc4709b55 100644 --- a/doc/en/Gtk/Alignment.xml +++ b/doc/en/Gtk/Alignment.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,11 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A container that controls the alignment and size of its child. + An Alignment widget controls the alignment and size of its child widget. It has four settings: , , , and . + The scale settings are used to specify how much the child widget should expand to fill the space allocated to the Alignment. The values can range from 0 (meaning the child doesn't expand at all) to 1 (meaning the child expands to fill all of the available space). + The alignment settings are used to position the child widget within the available area. The values range from 0 (top or left) to 1 (bottom or right). If the scale settings are both set to 1, (making the child expand), the alignment settings have no effect. + To add a child to an Alignment, use the method from the class. Gtk.Bin @@ -42,12 +45,12 @@ - To be added - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added + Adjusts all the alignment and scale properties. + The horizontal alignment of the child widget, from 0 (left) to 1 (right). + The vertical alignment of the child widget, from 0 (top) to 1 (bottom). + The amount that the child widget expands horizontally to fill up unused space, from 0 to 1. + The amount that the child widget expands vertically to fill up unused space, from 0 to 1. + For the scale parameters, a value of 0 indicates that the child widget should never expand. A value of 1 indicates that the child widget will expand to fill all of the space allocated for the Alignment. @@ -89,13 +92,13 @@ - To be added - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added: an object of type 'Gtk.Alignment' - To be added + Creates a new Alignment with the specified alignment and spacing. + The horizontal alignment of the child widget, from 0 (left) to 1 (right). + The vertical alignment of the child widget, from 0 (top) to 1 (bottom). + The amount that the child widget expands horizontally to fill up unused space, from 0 to 1. + The amount that the child widget expands vertically to fill up unused space, from 0 to 1. + A new Alignment. + @@ -104,9 +107,9 @@ - To be added - To be added: an object of type 'Gtk.Alignment' - To be added + Internal constructor + + @@ -131,10 +134,10 @@ - To be added - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added + Manage the vertical alignment of the child widget. + A new vertical alignment for the child widget. + The child widget's current vertical alignment. + This property is a value between 0 and 1 where 0 indicates alignment at the top of the container, and 1 indicates alignment at the bottom of the container. @@ -147,10 +150,10 @@ - To be added - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added + Manage the horizontal alignment of the child widget. + A new horizontal alignment for the child widget. + The child widget's current horizontal alignment. + This property is a value between 0 and 1, where 0 indicates no child expansion, and 1 indicates the child expands to fill the Alignment's allocated horizontal size. @@ -163,10 +166,10 @@ - To be added - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added + Manage the horizontal expansion of the child widget. + The proportion that the child widget should expand horizontally. + The current horizontal expansion of the child widget. + This property is a value between 0 and 1, where 0 indicates no child expansion, and 1 indicates the child expands to fill the Alignment's allocated horizontal size. @@ -179,10 +182,10 @@ - To be added - To be added: an object of type 'float' - To be added: an object of type 'float' - To be added + Manage the vertical expansion of the child widget. + The proportion that the child widget should expand vertically. + The current vertical expansion of the child widget. + This property is a value between 0 and 1, where 0 indicates no child expansion, and 1 indicates the child expands to fill the Alignment's allocated vertical size. diff --git a/doc/en/Gtk/Bin.xml b/doc/en/Gtk/Bin.xml index 0f82cd8e9..d8eac7728 100644 --- a/doc/en/Gtk/Bin.xml +++ b/doc/en/Gtk/Bin.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,10 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A container with just one child. + A Bin widget is a with just one child. It is used to create subclasses, since it provides common code needed for handling a single child . + Many GTK+ widgets are subclasses of Bin, including , , , , and . + To place a child widget inside this container, use the standard method. Gtk.Container @@ -63,9 +65,9 @@ - To be added - To be added: an object of type 'Gtk.Bin' - To be added + Internal constructor + +