From f8c625b0f9e2b9345f01660abb85ca98003563a7 Mon Sep 17 00:00:00 2001 From: Lee Mallabone Date: Fri, 21 Mar 2003 18:52:24 +0000 Subject: [PATCH] First draft of Adjustment docs. svn path=/trunk/gtk-sharp/; revision=12734 --- doc/ChangeLog | 2 + doc/en/Gtk/Adjustment.xml | 109 ++++++++++++++++++++------------------ 2 files changed, 58 insertions(+), 53 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index c63488fe0..5a78cb26f 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,5 +1,7 @@ 2003-03-21 Lee Mallabone + * en/Gtk/Adjustment.xml: First draft; good docs for ClampPage missing. + * en/Gtk/CalendarDisplayOptions.xml: * en/Gtk/AnchorType.xml: Simple docs for these enums. diff --git a/doc/en/Gtk/Adjustment.xml b/doc/en/Gtk/Adjustment.xml index 085ad0baf..cf3ee497f 100644 --- a/doc/en/Gtk/Adjustment.xml +++ b/doc/en/Gtk/Adjustment.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 + Encapsulates an adjustable bounded value. + The Adjustment object represents a value with an associated and bound, together with a , , and a . + The Adjustment object does not update the value itself. Instead it is left up to the owner of the Adjustment to control the value. The owner of the Adjustment typically calls the and methods after changing the value or its bounds, respectively. This results in the emission of the or events respectively. + An Adjustment is used within several widgets, including , , and (which is a base class for , , , and ). + Gtk.Object @@ -37,13 +40,13 @@ - To be added - To be added: an object of type 'double' - To be added: an object of type 'double' - To be added: an object of type 'double' - To be added: an object of type 'double' - To be added: an object of type 'double' - To be added + Sets all the properties of the Adjustment at the same time. + The minimum value. + The maximum value. + The increment to use to make minor changes to the value. + The increment to use to make major changes to the value. + The page size. In a this is the size of the area that is currently visible. + When updating the values and properties of an Adjustment, remember to call the and/or methods to ensure the correct events are fired. @@ -54,8 +57,8 @@ - To be added - To be added + Fires the event. + This method should be called manually after changing properties to notify all listening objects that the Adjustment's has changed. @@ -66,8 +69,8 @@ - To be added - To be added + Fires the event. + This method should be called manually after changing properties to notify all listening objects that one or more of the Adjustment's bounds have changed. @@ -81,10 +84,10 @@ - To be added + Updates the to ensure that the range between lower and upper is in the current page (i.e. between value and value + page_size). To be added: an object of type 'double' To be added: an object of type 'double' - To be added + To be added: The docs for this function are very confusing, and not 100% in sync with the code of gtk+ 2.0.5.If the range is larger than the page size, then only the start of it will be in the current page. The event will be fired if the value changes as a result of this method. @@ -128,15 +131,15 @@ - To be added - To be added: an object of type 'double' - To be added: an object of type 'double' - To be added: an object of type 'double' - To be added: an object of type 'double' - To be added: an object of type 'double' - To be added: an object of type 'double' - To be added: an object of type 'Gtk.Adjustment' - To be added + Creates an Adjustment with the specified value and bounds. + The initial value. + The minimum value. + The maximum value. + The increment to use to make minor changes to the value. + The increment to use to make major changes to the value. + The page size. In a this is the size of the area that is currently visible. + A new Adjustment + @@ -145,9 +148,9 @@ - To be added - To be added: an object of type 'Gtk.Adjustment' - To be added + Internal constructor + + @@ -172,10 +175,10 @@ - To be added - To be added: an object of type 'double' - To be added: an object of type 'double' - To be added + Manage the size of a 'page'. + The new page size. + The current size of pages in this Adjustment. + In a this is the size of the area which is currently visible. @@ -188,10 +191,10 @@ - To be added - To be added: an object of type 'double' - To be added: an object of type 'double' - To be added + Manage the increment used to make major changes to the value. + A new value for the PageIncrement + The current PageIncrement. + The usefulness of this value is entirely dependent upon the context in whic hthe Adjustment is used. @@ -201,9 +204,9 @@ System.Double - To be added - To be added: an object of type 'double' - To be added + The increment to use to make minor changes to the value. + The current value used for step increments. + In a this increment is used when the mouse is clicked on the arrows at the top and bottom of the , to scroll by a small amount. @@ -213,9 +216,9 @@ System.Double - To be added - To be added: an object of type 'double' - To be added + Retrieve the upper bound of this Adjustment. + The maximum possible value that is currently allowed. + @@ -225,9 +228,9 @@ System.Double - To be added - To be added: an object of type 'double' - To be added + Retrieve the lower bound of this Adjustment. + The minimum possible value that is currently allowed. + @@ -240,10 +243,10 @@ - To be added - To be added: an object of type 'double' - To be added: an object of type 'double' - To be added + Manage the current . + A new value for this Adjustment. + The current value of this adjustment. + If you set this property, you should manually call so that all listening objects are notified of the change. @@ -252,8 +255,8 @@ - To be added - To be added + This event is fired when is called. + This event can be handled to be notified of changes to the Adjustment's value. However, this relies on all objects that change the calling . @@ -262,8 +265,8 @@ - To be added - To be added + This event is fired when is called. + If the Adjustment's properties change, (such as , etc.), it is up to whichever class changes the values to call to ensure this event is fired.