From a875178314e78957adf3b4706a2c33ab5da25412 Mon Sep 17 00:00:00 2001 From: Duncan Mak Date: Wed, 19 Feb 2003 03:37:52 +0000 Subject: [PATCH] Documentation for the scrolling widgets and also Toolbar. svn path=/trunk/gtk-sharp/; revision=11710 --- doc/en/Gtk/HScrollbar.xml | 15 +++-- doc/en/Gtk/Scrollbar.xml | 4 +- doc/en/Gtk/ScrolledWindow.xml | 104 +++++++++++++++++++++++----------- doc/en/Gtk/Toolbar.xml | 2 +- doc/en/Gtk/VScrollbar.xml | 15 +++-- 5 files changed, 91 insertions(+), 49 deletions(-) diff --git a/doc/en/Gtk/HScrollbar.xml b/doc/en/Gtk/HScrollbar.xml index 94dcd1999..e11600576 100644 --- a/doc/en/Gtk/HScrollbar.xml +++ b/doc/en/Gtk/HScrollbar.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,11 @@ To be added - To be added - To be added + A horizontal scrollbar + + The widget is a widget arranged horizontally creating a scrollbar. See for details on scrollbars. pointers may be added to handle the adjustment of the scrollbar or it may be left in which case one will be created for you. See for details. + + Gtk.Scrollbar @@ -77,9 +80,9 @@ - To be added - To be added: an object of type 'Gtk.Adjustment' - To be added: an object of type 'Gtk.HScrollbar' + Creates a new horizontal scrollbar. + The to use, or to create a new adjustment. + The new To be added diff --git a/doc/en/Gtk/Scrollbar.xml b/doc/en/Gtk/Scrollbar.xml index c1cd2d8b5..7f0f2cc4c 100644 --- a/doc/en/Gtk/Scrollbar.xml +++ b/doc/en/Gtk/Scrollbar.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,7 +7,7 @@ To be added - To be added + Base class for and . To be added diff --git a/doc/en/Gtk/ScrolledWindow.xml b/doc/en/Gtk/ScrolledWindow.xml index f273425c3..1062bf7ce 100644 --- a/doc/en/Gtk/ScrolledWindow.xml +++ b/doc/en/Gtk/ScrolledWindow.xml @@ -7,8 +7,18 @@ To be added - To be added - To be added + Adds scrollbars to its child widget. + + + GtkScrolledWindow is a subclass: it's a container the accepts a single child widget. GtkScrolledWindow adds scrollbars to the child widget and optionally draws a beveled frame around the child widget. + + + The scrolled window can work in two ways. Some widgets have native scrolling support; these widgets have "slots" for objects. Widgets with native scroll support include , , and . + + + The position of the scrollbars is controlled by the scroll adjustments. See for the properties in an adjustment - for , used by , the property represents the position of the scrollbar, which must be between the and - . The property represents the size of the visible scrollable area. The and properties are used when the user asks to step down (using the small stepper arrows) or page down (using for example the PageDown key). + + Gtk.Bin @@ -39,9 +49,19 @@ - To be added + Used to add children without native scrolling capabilities. To be added: an object of type 'Gtk.Widget' - To be added + + + Used to add children without native scrolling capabilities. This is simply a convenience function; it is equivalent to adding the unscrollable child to a viewport, then adding the viewport to the scrolled window. If a child has native scrolling, use instead of this function. + + + The viewport scrolls the child by moving its , and takes the size of the child to be the size of its toplevel . This will be very wrong for most widgets that support native scrolling; for example, if you add a widget such as with a viewport, the whole widget will scroll, including the column headings. Thus, widgets with native scrolling support should not be used with the proxy. + + + A widget supports scrolling natively if the set_scroll_adjustments_signal field in GtkWidgetClass is non-zero, i.e. has been filled in with a valid signal identifier. + + @@ -55,10 +75,14 @@ - To be added - To be added: an object of type 'Gtk.PolicyType' - To be added: an object of type 'Gtk.PolicyType' - To be added + Sets the scrollbar policy for the horizontal and vertical scrollbars. + Policy for horizontal bar. + Policy for vertical bar. + + + Sets the scrollbar policy for the horizontal and vertical scrollbars. The policy determines when the scrollbar should appear; it is a value from the enumeration. If , the scrollbar is always present; if , the scrollbar is never present; if , the scrollbar is present only if needed (that is, if the slider part of the bar would be smaller than the trough - the display is larger than the page size). + + @@ -72,10 +96,14 @@ - To be added - To be added: an object of type 'Gtk.PolicyType&' - To be added: an object of type 'Gtk.PolicyType&' - To be added + Retrieves the current policy values for the horizontal and vertical scrollbars. + Location to store the policy for the horizontal scrollbar. + Location to store the policy for the horizontal scrollbar. + + + Retrieves the current policy values for the horizontal and vertical scrollbars. + + @@ -127,11 +155,15 @@ - To be added - To be added: an object of type 'Gtk.Adjustment' - To be added: an object of type 'Gtk.Adjustment' + Creates a new scrolled window. + Horizontal adjustment. + Vertical adjustment. To be added: an object of type 'Gtk.ScrolledWindow' - To be added + + + Creates a new scrolled window. The two arguments are the scrolled window's adjustments; these will be shared with the scrollbars and the child widget to keep the bars in sync with the child. Usually you want to pass for the adjustments, which will cause the scrolled window to create them for you. + + @@ -167,10 +199,14 @@ - To be added - To be added: an object of type 'Gtk.CornerType' - To be added: an object of type 'Gtk.CornerType' - To be added + Determines the location of the child widget with respect to the scrollbars. + Position of the child window. + + + + Determines the location of the child widget with respect to the scrollbars. The default is , meaning the child is in the top left, with the scrollbars underneath and to the right. Other values in are , , and . + + @@ -183,7 +219,7 @@ - To be added + When the horizontal scrollbar is displayed. To be added: an object of type 'Gtk.PolicyType' To be added: an object of type 'Gtk.PolicyType' To be added @@ -199,9 +235,9 @@ - To be added - To be added: an object of type 'Gtk.Adjustment' - To be added: an object of type 'Gtk.Adjustment' + Sets the for the horizontal scrollbar. + Horizontal scroll adjustment. + The horizontal GtkAdjustment. To be added @@ -215,7 +251,7 @@ - To be added + When the vertical scrollbar is displayed. To be added: an object of type 'Gtk.PolicyType' To be added: an object of type 'Gtk.PolicyType' To be added @@ -231,9 +267,9 @@ - To be added - To be added: an object of type 'Gtk.Adjustment' - To be added: an object of type 'Gtk.Adjustment' + Sets or Gets the for the vertical scrollbar. + Vertical scroll adjustment. + The vertical GtkAdjustment. To be added @@ -247,10 +283,10 @@ - To be added - To be added: an object of type 'Gtk.ShadowType' - To be added: an object of type 'Gtk.ShadowType' - To be added + Gets the shadow type of the scrolled window. + Kind of shadow to draw around scrolled window contents. + The current shadow type. + To be added. @@ -263,7 +299,7 @@ - To be added + Where the contents are located with respect to the scrollbars. To be added: an object of type 'Gtk.CornerType' To be added: an object of type 'Gtk.CornerType' To be added @@ -272,7 +308,7 @@ Event - + To be added diff --git a/doc/en/Gtk/Toolbar.xml b/doc/en/Gtk/Toolbar.xml index deb03da35..5491dac6e 100644 --- a/doc/en/Gtk/Toolbar.xml +++ b/doc/en/Gtk/Toolbar.xml @@ -203,7 +203,7 @@ The element's tooltip. Used for context-sensitive help about this toolbar element. The number of widgets to insert this widget after. - Unsets toolbar icon size set with , so that user preferences will be used to determine the toolbar style. + diff --git a/doc/en/Gtk/VScrollbar.xml b/doc/en/Gtk/VScrollbar.xml index 555be36bd..ce0f352e1 100644 --- a/doc/en/Gtk/VScrollbar.xml +++ b/doc/en/Gtk/VScrollbar.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,11 @@ To be added - To be added - To be added + A vertical scrollbar + + The widget is a widget arranged horizontally creating a scrollbar. See for details on scrollbars. pointers may be added to handle the adjustment of the scrollbar or it may be left in which case one will be created for you. See for details. + + Gtk.Scrollbar @@ -77,9 +80,9 @@ - To be added - To be added: an object of type 'Gtk.Adjustment' - To be added: an object of type 'Gtk.VScrollbar' + Creates a new vertical scrollbar. + The to use, or to create a new adjustment. + The new To be added