From 9d3c4431c7ff7c90fc762759cef5b4583ab8d8c2 Mon Sep 17 00:00:00 2001 From: Lee Mallabone Date: Mon, 14 Apr 2003 17:41:06 +0000 Subject: [PATCH] Document ClampPage after gaining an idea of what it does. svn path=/trunk/gtk-sharp/; revision=13605 --- doc/ChangeLog | 5 +++++ doc/en/Gtk/Adjustment.xml | 17 ++++++++++++----- 2 files changed, 17 insertions(+), 5 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 6ffb43ae9..64eeb01c1 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,8 @@ +2003-04-14 Lee Mallabone + + * en/Gtk/Adjustment.xml: Add sane docs to ClampPage, based on the + original C docs and comments from Miguel. + 2003-04-13 Lee Mallabone * en/Gtk/TreeSelection.xml: First draft. diff --git a/doc/en/Gtk/Adjustment.xml b/doc/en/Gtk/Adjustment.xml index 282363950..f5f1ecacd 100644 --- a/doc/en/Gtk/Adjustment.xml +++ b/doc/en/Gtk/Adjustment.xml @@ -91,12 +91,19 @@ - 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' + Used to inform the Adjustment's view that a new visible range should be displayed. + The lower value of the new range. + The upper value of the new range. - 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. + + This method should be used to set the currently visible range to (, ). If necessary, the current is changed to ensure that it is visible within the new scope. + + + If the specified range is larger than the , then only the start of it will make up the new "current page". + + + The event will be fired if the changes as a result of this method. must be called manually if the event should be fired. +