From a29164819070c40d5f5e6b60982fe3d4b2e4e685 Mon Sep 17 00:00:00 2001 From: Lee Mallabone Date: Tue, 4 Mar 2003 18:08:23 +0000 Subject: [PATCH] First draft of Paned docs, excluding events pending mailing list replies. svn path=/trunk/gtk-sharp/; revision=12185 --- doc/ChangeLog | 4 +++ doc/en/Gtk/HPaned.xml | 12 +++---- doc/en/Gtk/Paned.xml | 84 ++++++++++++++++++++++++++----------------- doc/en/Gtk/VPaned.xml | 12 +++---- 4 files changed, 67 insertions(+), 45 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 67f01b999..1fecd192d 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,7 @@ +2003-03-04 Lee Mallabone + + * en/Gtk/*Paned.xml: First draft at Paned docs. + 2003-03-02 Lee Mallabone * en/Gtk/SpinButtonUpdatePolicy.xml: diff --git a/doc/en/Gtk/HPaned.xml b/doc/en/Gtk/HPaned.xml index d8a21a6ec..28bdb06e5 100644 --- a/doc/en/Gtk/HPaned.xml +++ b/doc/en/Gtk/HPaned.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A container for two children, separated horizontally by a splitter bar. + s are added to this container using the and methods. See the documentation of for more information. Gtk.Paned @@ -79,9 +79,9 @@ - To be added - To be added: an object of type 'Gtk.HPaned' - To be added + Creates a new container, split horizontally. + A new HPaned. + diff --git a/doc/en/Gtk/Paned.xml b/doc/en/Gtk/Paned.xml index 2332443be..4e0ddbbd3 100644 --- a/doc/en/Gtk/Paned.xml +++ b/doc/en/Gtk/Paned.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,26 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Base class for containers that have two children separated by an adjustable pane. + This class provides methods for manipulating a panel with 2 child widgets, separated by a splitter. The concrete widgets that extend from this class are for a vertical splitter, and for a horizontal splitter. + A paned widget draws a separator between the two child widgets that the user can drag to adjust the division. + Each child widget has two options that can be set, and , (set with the and methods). If resize is , then when the Paned is resized, the respective child will expand or shrink along with the paned widget. If shrink is , then the respective child can be made smaller than it's requisition by the user. Setting shrink to allows the application to set a minimum size. If resize is for both children, then this exhibits exactly the same behaviour as if resize is for both children. + The application can set the position of the slider as if it were set by the user with the property. + +public Widget GetExampleFrame() +{ + HPaned splitter = new HPaned(); + Frame frame1 = new Frame("Example frame1"); + Frame frame2 = new Frame("Example frame2"); + + splitter.Pack1(frame1, true, false); + splitter.Pack2(frame2, false, false); + splitter.ShowAll(); + + return splitter; +} + + Gtk.Container @@ -41,11 +59,11 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Packs a child widget into the second part of the Paned container, (the bottom or right panes). + A widget for this container to manage. + Whether this child should expand when the Paned widget is resized. + Whether this child can be made smaller than its default size by the user. + @@ -60,12 +78,12 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added - + Packs a child widget into the first part of the Paned container, (the top or left panes). + A widget for this container to manage. + Whether this child should expand when the Paned widget is resized. + Whether this child can be made smaller than its default size by the user. + + @@ -77,9 +95,9 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added + Adds a child widget into the second part of the Paned container, (the bottom or right panes), with default packing settings. + A widget for this container to manage. + This is the same as calling with resize set to and shrink set to . @@ -92,9 +110,9 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added + Adds a child widget into the first part of the Paned container, (the top or left panes), with default packing settings. + A widget for this container to manage. + This is the same as calling with resize set to and shrink set to . @@ -166,9 +184,9 @@ - To be added - To be added: an object of type 'Gtk.Paned' - To be added + Internal constructor + + This class can not be instantiated directly - use or . @@ -190,9 +208,9 @@ Gtk.Widget - To be added - To be added: an object of type 'Gtk.Widget' - To be added + An accessor to the second child widget of this container + The child widget added with or . + @@ -202,9 +220,9 @@ Gtk.Widget - To be added - To be added: an object of type 'Gtk.Widget' - To be added + An accessor to the first child widget of this container + The child widget added with or . + @@ -217,9 +235,9 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' + Manage the position of the splitter bar that separates the 2 child widgets. + The number of pixels the splitter should appear from the left/top edge. + The current position ofh To be added @@ -300,4 +318,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/VPaned.xml b/doc/en/Gtk/VPaned.xml index 02886b8f3..980fe9858 100644 --- a/doc/en/Gtk/VPaned.xml +++ b/doc/en/Gtk/VPaned.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A container for two children, separated vertically by a splitter bar. + s are added to this container using the and methods. See the documentation of for more information. Gtk.Paned @@ -79,9 +79,9 @@ - To be added - To be added: an object of type 'Gtk.VPaned' - To be added + Creates a new container, split vertically. + A new VPaned. +