From 1aabed9f630632266f4057821f8c96d8f93af74d Mon Sep 17 00:00:00 2001 From: John Luke Date: Fri, 4 Jul 2003 02:09:49 +0000 Subject: [PATCH] add first draft svn path=/trunk/gtk-sharp/; revision=15911 --- doc/ChangeLog | 4 + doc/en/Gtk/Container.xml | 200 +++++++++++++++++++++++++-------------- 2 files changed, 132 insertions(+), 72 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 9a31096db..6bc29993c 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2003-07-02 John Luke + + * en/Gtk/Container.xml: add first draft + 2003-07-02 John Luke * en/Gtk/TreeSelection.xml: fix method signatures, small updates diff --git a/doc/en/Gtk/Container.xml b/doc/en/Gtk/Container.xml index 3e5c478ff..8254e17da 100644 --- a/doc/en/Gtk/Container.xml +++ b/doc/en/Gtk/Container.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,33 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Base class for widgets which contain other widgets + + + A Gtk# user interface is constructed by nesting widgets inside widgets. + widgets are the inner nodes in the resulting tree of widgets: they contain other widgets. + So, for example, you might have a containing a containing a . + If you wanted an image instead of a textual label inside the frame, you might replace the widget with a widget. + + + There are two major kinds of widgets in Gtk#. Both are subclasses of the abstract base class. + + + The first type of widget has a single child widget and derives from . + These containers are decorators, which add some kind of functionality to the child. + For example, a makes its child into a clickable button; + a draws a frame around its child and a places its child widget inside a top-level . + + + The second type of can have more than one child; its purpose is to manage layout. + This means that these containers assign sizes and positions to their children. + For example, a arranges its children in a horizontal row, and a arranges the widgets it contains in a two-dimensional grid. + + + To fulfill its task, a layout must negotiate the size requirements with its parent and its children. + This negotiation is carried out in two phases, size requisition and size allocation. + + Gtk.Widget @@ -51,9 +76,13 @@ - To be added - To be added: an object of type 'GLib.List' - To be added + Sets a focus chain, overriding the one computed automatically by Gtk#. + an object of type + + In principle each in the chain should be a descendant of the , + but this is not enforced by this method, since it is allowed to set the focus chain before you pack the widgets, or have a widget in the chain that is not always packed. + The necessary checks are done when the focus chain is actually traversed. + @@ -66,9 +95,12 @@ - To be added - To be added: an object of type 'Gtk.Callback' - To be added + Invokes callback on each non-internal child of . + an object of type + + See for details on what constitutes an "internal" child. + Most applications should use , rather than . + @@ -83,11 +115,11 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'string' - To be added: an object of type 'IntPtr' - To be added + Gets the values of one or more child properties for child and container. + an object of type + an object of type + an object of type + Gets the values of one or more child properties for child and container. @@ -100,10 +132,13 @@ - To be added - To be added: an object of type 'GLib.List' - To be added: an object of type 'bool' - To be added + Retrieves the focus chain of the container + an object of type + an object of type + + If no focus chain has been explicitly set, Gtk# computes the focus chain based on the positions of the children. + In that case, Gtk# stores in focusable_widgets and returns . + @@ -116,9 +151,14 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added + Adds a to the . + an object of type + + Typically used for simple containers such as , , or ; + for more complicated layout containers such as or , this function will pick default packing parameters that may not be correct. + So consider functions such as and as an alternative to in those cases. + A may be added to only one at a time; you can not place the same widget inside two different containers. + @@ -131,9 +171,9 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added + Removes a from the . + an object of type + must be inside . @@ -144,8 +184,8 @@ - To be added - To be added + Removes a focus chain. + Removes a focus chain explicitly set with . @@ -158,9 +198,13 @@ - To be added - To be added: an object of type 'Gtk.Callback' - To be added + Invokes callback on each child of . + an object of type + + This includes children that are considered "internal" (implementation details of the ). + "Internal" children generally were not added by the user of the , but were added by the container implementation itself. + Most applications should use , rather than . + @@ -187,11 +231,11 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'string' - To be added: an object of type 'GLib.Value' - To be added + Sets a child property for child and . + an object of type + an object of type + an object of type + Sets a child property for child and . @@ -203,7 +247,7 @@ To be added - To be added: an object of type 'uint' + an object of type To be added @@ -219,11 +263,11 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'string' - To be added: an object of type 'GLib.Value' - To be added + Gets a child property for child and . + an object of type + an object of type + an object of type + Gets a child property for child and . @@ -237,10 +281,22 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'Gdk.EventExpose' - To be added + Send synthetic expose events to all children that do not have their own . + an object of type + an object of type + + + When a receives an expose event, it must send synthetic expose events to all children that do not have their own s. + This function provides a convenient way of doing this. + A , when it receives an expose event, calls once for each child, passing in the event the received. + + + takes care of deciding whether an expose event needs to be sent to the child, intersecting the event's area with the child area, and sending the event. + + + In most cases, a can either simply inherit the expose implementation from , or do some drawing and then chain to the expose implementation from . + + @@ -255,11 +311,11 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'string' - To be added: an object of type 'IntPtr' - To be added + Sets one or more child properties for child and . + an object of type + an object of type + an object of type + Sets one or more child properties for child and . @@ -297,7 +353,7 @@ To be added - To be added: an object of type 'Gtk.Container' + an object of type To be added @@ -308,8 +364,8 @@ System.UInt32 - The GLib Type for Gtk.Container - The GLib Type for the Gtk.Container class. + The for + The for the class. @@ -324,8 +380,8 @@ To be added - To be added: an object of type 'Gtk.Adjustment' - To be added: an object of type 'Gtk.Adjustment' + an object of type + an object of type To be added @@ -337,7 +393,7 @@ To be added - To be added: an object of type 'GLib.List' + an object of type To be added @@ -352,8 +408,8 @@ To be added - To be added: an object of type 'Gtk.Adjustment' - To be added: an object of type 'Gtk.Adjustment' + an object of type + an object of type To be added @@ -368,8 +424,8 @@ To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'Gtk.Widget' + an object of type + an object of type To be added @@ -384,8 +440,8 @@ To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' + an object of type + an object of type To be added @@ -400,8 +456,8 @@ To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'Gtk.Widget' + an object of type + an object of type To be added @@ -416,8 +472,8 @@ To be added - To be added: an object of type 'Gtk.ResizeMode' - To be added: an object of type 'Gtk.ResizeMode' + an object of type + an object of type To be added @@ -432,8 +488,8 @@ To be added - To be added: an object of type 'uint' - To be added: an object of type 'uint' + an object of type + an object of type To be added @@ -444,7 +500,7 @@ To be added - To be added + @@ -454,7 +510,7 @@ To be added - To be added + @@ -464,7 +520,7 @@ To be added - To be added + @@ -474,7 +530,7 @@ To be added - To be added + @@ -494,4 +550,4 @@ - \ No newline at end of file +