From d78941e312b31c249811b397c5b94dac68bcd5cc Mon Sep 17 00:00:00 2001 From: Lee Mallabone Date: Sat, 8 Mar 2003 21:09:16 +0000 Subject: [PATCH] First draft for document for Gtk.Table. svn path=/trunk/gtk-sharp/; revision=12355 --- doc/ChangeLog | 10 +++ doc/en/Gtk/Table.xml | 146 +++++++++++++++++++++++++------------------ 2 files changed, 95 insertions(+), 61 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 6b23b0a87..fc91cc360 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,8 @@ +2003-03-08 Lee Mallabone + + * en/Gtk/Table.xml: First draft of table docs. Have left spacing + properties as todo items until I sort the API - it's a bit of a mess. + 2003-03-08 Duncan Mak * en/*/*.xml: Removed all the Deprecated nodes now. @@ -24,6 +29,11 @@ is a possible place for customized scripts to generate template documentation, similar to the GType property and GType constructors. +2003-03-05 Lee Mallabone + + * en/Gtk/Statusbar.xml: + * en/GtkSharp/TextP*.xml: Statusbar docs for widget and relevant event handlers. + 2003-03-05 Duncan Mak * en/Gtk/Curve.xml diff --git a/doc/en/Gtk/Table.xml b/doc/en/Gtk/Table.xml index 4060e532f..222b3cb5d 100644 --- a/doc/en/Gtk/Table.xml +++ b/doc/en/Gtk/Table.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,30 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Pack widgets in grid/table patterns. + The Table widget allows a programmer to arrange widgets in rows and columns, making it easy to align many widgets adjacent to each other, horizontally and vertically. + Tables are created with a specific size - the number of rows and columns. This can be changed dynamically with the method. Widgets are packed into the table with methods. + The layout of a table can be altered by setting the spacing between rows and columns. This is done with the and properties, respectively. The spacing of individual cells can be adjusted with . + The following shows how to create a table with three widgets: + +public Widget MakeTableTester() +{ + // Create a table with 2 rows and 1 column + Table tableLayout = new Table(2, 1, false); + Label longLabel = new Label("This is a label that spans at least two Entry widgets"); + + // Attach the label over the entire first row + tableLayout.Attach(longLabel, 0, 2, 0, 1); + // Attach an entry to each cell in the second row + tableLayout.Attach(new Entry(), 0, 1, 1, 2); + tableLayout.Attach(new Entry(), 1, 2, 1, 2); + + tableLayout.ShowAll(); + return tableLayout; +} + + + Gtk.Container @@ -40,10 +62,10 @@ - To be added - To be added: an object of type 'uint' - To be added: an object of type 'uint' - To be added + Sets the spacing around a specified column. + A zero-indexed column number to adjust the spacing of. + The number of pixels on each side of the . + To adjust the spacing between all columns, use the property. @@ -56,10 +78,10 @@ - To be added - To be added: an object of type 'uint' - To be added: an object of type 'uint' - To be added + The spacing currently set for a given column. + A zero-indexed column number to retrieve spacing information from. + The number of pixels of spacing assigned to the specified . + @@ -73,10 +95,10 @@ - To be added - To be added: an object of type 'uint' - To be added: an object of type 'uint' - To be added + Resizes the table so that the specified number of and are available for widget packing. + The new number of rows this table should allow. + The new number of columns this table should allow. + @@ -97,17 +119,19 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'uint' - To be added: an object of type 'uint' - To be added: an object of type 'uint' - To be added: an object of type 'uint' - To be added: an object of type 'Gtk.AttachOptions' - To be added: an object of type 'Gtk.AttachOptions' - To be added: an object of type 'uint' - To be added: an object of type 'uint' - To be added + Packs a widget into the table. + The to add. + The column number to attach the left side of to. + The column number to attach the right side of to. + The row number to attach the top of to. + The row number to attach the bottom of to. + The horizontal packing options for this . + The vertical packing options for this . + The number of pixels of padding to add to the left and right of . + The number of pixels of padding to add to the top and bottom of . + You can pack widgets into the Table using default packing and padding with the convenience method. + Child widgets can span as many table cells as they wish, allowing the programmer to create complex grids of Widgets. + @@ -124,13 +148,13 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'uint' - To be added: an object of type 'uint' - To be added: an object of type 'uint' - To be added: an object of type 'uint' - To be added + Packs a widget into the table with default packing options. + The to add. + The column number to attach the left side of to. + The column number to attach the right side of to. + The row number to attach the top of to. + The row number to attach the bottom of to. + To pack widgets into the table with more control over size and padding, use the alternative method. @@ -171,12 +195,12 @@ - To be added - To be added: an object of type 'uint' - To be added: an object of type 'uint' - To be added: an object of type 'bool' - To be added: an object of type 'Gtk.Table' - To be added + Creates a new Table widget. + The number of rows in this table. + The number of columns in this table. + Whether all table cells are forced to be the same size. + A new Table. + The size of the table can be altered after its creation using the method. @@ -185,9 +209,9 @@ - To be added - To be added: an object of type 'Gtk.Table' - To be added + Internal constructor + + @@ -212,10 +236,10 @@ - To be added - To be added: an object of type 'uint' - To be added: an object of type 'uint' - To be added + Sets the space between every column equal to . + The number of pixels to place between every column. + + @@ -225,9 +249,9 @@ System.UInt32 - To be added - To be added: an object of type 'uint' - To be added + Retrieve the spacing that gets placed between newly added rows by default. + Spacing between rows that will be added, in pixels. + @@ -284,10 +308,10 @@ - To be added - To be added: an object of type 'uint' - To be added: an object of type 'uint' - To be added + Manage the number of columns in this Table. + The number of columns that this table should have. + The number of columns this table currently has. + @@ -300,10 +324,10 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Manage whether all cells must be of equal size. + to set all cells to an equal size, otherwise. + if all cells are currently equally sized, otherwise. + @@ -332,10 +356,10 @@ - To be added - To be added: an object of type 'uint' - To be added: an object of type 'uint' - To be added + Manage the number of rows in this Table. + The number of rows that this table should have. + The number of rows this table currently has. +