diff --git a/ChangeLog b/ChangeLog index 0f154a12ae..5899e25784 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,5 +1,6 @@ 2008-12-28 Matthias Clasen + * gtk/gtkscrolledwindow.c: * gtk/gtkscale.c: Merge docs inline. 2008-12-28 Ryan Lortie diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 797dee0944..e844d256a3 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,5 +1,6 @@ 2008-12-28 Matthias Clasen + * gtk/tmpl/gtkscrolledwindow.sgml: * gtk/tmpl/gtkscale.sgml: Merge docs inline. 2008-12-28 Matthias Clasen diff --git a/docs/reference/gtk/tmpl/gtkscrolledwindow.sgml b/docs/reference/gtk/tmpl/gtkscrolledwindow.sgml index aac0384978..2bae2743e2 100644 --- a/docs/reference/gtk/tmpl/gtkscrolledwindow.sgml +++ b/docs/reference/gtk/tmpl/gtkscrolledwindow.sgml @@ -82,7 +82,7 @@ only be accessed using the functions below. -@scrolledwindow: the object which received the signal. +@scrolledwindow: @arg1: @@ -90,7 +90,7 @@ only be accessed using the functions below. -@scrolledwindow: the object which received the signal. +@scrolledwindow: @arg1: @arg2: @Returns: @@ -142,38 +142,30 @@ only be accessed using the functions below. -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 %NULL for the adjustments, which will cause the scrolled window -to create them for you. + -@hadjustment: Horizontal adjustment. -@vadjustment: Vertical adjustment. -@Returns: New scrolled window. +@hadjustment: +@vadjustment: +@Returns: -Returns the horizontal scrollbar's adjustment, used to connect the -horizontal scrollbar to the child widget's horizontal scroll -functionality. + -@scrolled_window: A #GtkScrolledWindow. -@Returns: The horizontal #GtkAdjustment. +@scrolled_window: +@Returns: -Returns the vertical scrollbar's adjustment, used to connect the -vertical scrollbar to the child widget's vertical scroll -functionality. + -@scrolled_window: A #GtkScrolledWindow. -@Returns: The vertical #GtkAdjustment. +@scrolled_window: +@Returns: @@ -196,59 +188,30 @@ functionality. -Sets the scrollbar policy for the horizontal and vertical scrollbars. -The policy determines when the scrollbar should appear; it is a value -from the #GtkPolicyType enumeration. If %GTK_POLICY_ALWAYS, the -scrollbar is always present; if %GTK_POLICY_NEVER, the scrollbar is -never present; if %GTK_POLICY_AUTOMATIC, 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). + -@scrolled_window: A #GtkScrolledWindow. -@hscrollbar_policy: Policy for horizontal bar. -@vscrollbar_policy: Policy for vertical bar. +@scrolled_window: +@hscrollbar_policy: +@vscrollbar_policy: -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 -gtk_container_add() instead of this function. + - -The viewport scrolls the child by moving its #GdkWindow, and takes the -size of the child to be the size of its toplevel #GdkWindow. This will -be very wrong for most widgets that support native scrolling; for -example, if you add a widget such as #GtkTreeView with a viewport, the -whole widget will scroll, including the column headings. Thus, widgets -with native scrolling support should not be used with the #GtkViewport 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. - - -@scrolled_window: A #GtkScrolledWindow. -@child: Widget you want to scroll. +@scrolled_window: +@child: -Determines the location of the child widget with respect to the -scrollbars. The default is %GTK_CORNER_TOP_LEFT, meaning the child is -in the top left, with the scrollbars underneath and to the right. -Other values in #GtkCornerType are %GTK_CORNER_TOP_RIGHT, -%GTK_CORNER_BOTTOM_LEFT, and %GTK_CORNER_BOTTOM_RIGHT. + -@scrolled_window: A #GtkScrolledWindow. -@window_placement: Position of the child window. +@scrolled_window: +@window_placement: @@ -270,20 +233,20 @@ Other values in #GtkCornerType are %GTK_CORNER_TOP_RIGHT, -Sets the #GtkAdjustment for the horizontal scrollbar. + -@scrolled_window: A #GtkScrolledWindow. -@hadjustment: Horizontal scroll adjustment. +@scrolled_window: +@hadjustment: -Sets the #GtkAdjustment for the vertical scrollbar. + -@scrolled_window: A #GtkScrolledWindow. -@vadjustment: Vertical scroll adjustment. +@scrolled_window: +@vadjustment: diff --git a/gtk/gtkscrolledwindow.c b/gtk/gtkscrolledwindow.c index 3f8d717582..ff274a983e 100644 --- a/gtk/gtkscrolledwindow.c +++ b/gtk/gtkscrolledwindow.c @@ -588,12 +588,14 @@ gtk_scrolled_window_set_policy (GtkScrolledWindow *scrolled_window, /** * gtk_scrolled_window_get_policy: * @scrolled_window: a #GtkScrolledWindow - * @hscrollbar_policy: location to store the policy for the horizontal scrollbar, or %NULL. - * @vscrollbar_policy: location to store the policy for the horizontal scrollbar, or %NULL. + * @hscrollbar_policy: location to store the policy for the horizontal + * scrollbar, or %NULL. + * @vscrollbar_policy: location to store the policy for the vertical + * scrollbar, or %NULL. * * Retrieves the current policy values for the horizontal and vertical * scrollbars. See gtk_scrolled_window_set_policy(). - **/ + */ void gtk_scrolled_window_get_policy (GtkScrolledWindow *scrolled_window, GtkPolicyType *hscrollbar_policy, @@ -665,6 +667,7 @@ gtk_scrolled_window_set_placement_set (GtkScrolledWindow *scrolled_window, * * Sets the placement of the contents with respect to the scrollbars * for the scrolled window. + * * The default is %GTK_CORNER_TOP_LEFT, meaning the child is * in the top left, with the scrollbars underneath and to the right. * Other values in #GtkCornerType are %GTK_CORNER_TOP_RIGHT, @@ -672,7 +675,7 @@ gtk_scrolled_window_set_placement_set (GtkScrolledWindow *scrolled_window, * * See also gtk_scrolled_window_get_placement() and * gtk_scrolled_window_unset_placement(). - **/ + */ void gtk_scrolled_window_set_placement (GtkScrolledWindow *scrolled_window, GtkCornerType window_placement)