From 19f4715cee3c0f5ca06a40e05ef29efac49ebb29 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Sun, 10 Jun 2007 02:53:17 +0000 Subject: [PATCH] Some doc updates svn path=/trunk/; revision=18089 --- ChangeLog | 7 + docs/reference/ChangeLog | 4 + docs/reference/gtk/tmpl/gtkbox.sgml | 470 +++++++++++----------------- gtk/gtkbox.c | 153 ++++++++- gtk/gtkrange.c | 30 +- gtk/gtkscale.c | 21 +- 6 files changed, 354 insertions(+), 331 deletions(-) diff --git a/ChangeLog b/ChangeLog index e54b79bf64..8652d71a7c 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,10 @@ +2007-06-09 Matthias Clasen + + * gtk/gtkbox.c: Move docs inline. + + * gtk/gtkrange.c: + * gtk/gtkscale.c: Doc formatting improvements. + 2007-06-09 Matthias Clasen * gtk/gtkscalebutton.c: Add an icons property, make diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 5772e19019..4dacfab8b4 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,7 @@ +2007-06-09 Matthias Clasen + + * gtk/tmpl/gtkbox.sgml: Move docs inline + 2007-06-08 Matthias Clasen * gtk/gtk-sections.txt: Add gtk_rc_parse_color_full diff --git a/docs/reference/gtk/tmpl/gtkbox.sgml b/docs/reference/gtk/tmpl/gtkbox.sgml index ca62c782ee..ab26d6c4f5 100644 --- a/docs/reference/gtk/tmpl/gtkbox.sgml +++ b/docs/reference/gtk/tmpl/gtkbox.sgml @@ -5,138 +5,116 @@ GtkBox Base class for box containers - -GtkBox is an abstract widget which encapsulates functionallity for a -particular kind of container, one that organizes a variable number of -widgets into a rectangular area. GtkBox currently has two derived -classes, #GtkHBox and #GtkVBox. - - -The rectangular area of a GtkBox is organized into either a single row -or a single column of child widgets depending upon whether the box is -of type #GtkHBox or #GtkVBox, respectively. Thus, all children of a -GtkBox are allocated one dimension in common, which is the height of a -row, or the width of a column. - - -GtkBox uses a notion of packing. Packing refers to -adding widgets with reference to a particular position in a -#GtkContainer. For a GtkBox, there are two reference positions: the -start and the end of the box. For a -#GtkVBox, the start is defined as the top of the box and the end is -defined as the bottom. For a #GtkHBox the start is defined as the -left side and the end is defined as the right side. - - -Use repeated calls to gtk_box_pack_start() to pack widgets into a -GtkBox from start to end. Use gtk_box_pack_end() to add widgets from -end to start. You may intersperse these calls and add widgets from -both ends of the same GtkBox. - - -Use gtk_box_pack_start_defaults() or gtk_box_pack_end_defaults() -to pack widgets into a GtkBox if you do not need to specify the -expand, fill, or -padding attributes of the child to be -added. - - -Because GtkBox is a #GtkContainer, you may also use -gtk_container_add() to insert widgets into the box, and they will be -packed as if with gtk_box_pack_start_defaults(). Use -gtk_container_remove() to remove widgets from the GtkBox. - - -Use gtk_box_set_homogeneous() to specify whether or not all children -of the GtkBox are forced to get the same amount of space. - - -Use gtk_box_set_spacing() to determine how much space will be -minimally placed between all children in the GtkBox. - - -Use gtk_box_reorder_child() to move a GtkBox child to a different -place in the box. - - -Use gtk_box_set_child_packing() to reset the -expand, fill, -and padding attributes of any GtkBox child. -Use gtk_box_query_child_packing() to query these fields. + +GtkBox is an abstract widget which encapsulates functionality for a +particular kind of container, one that organizes a variable number of +widgets into a rectangular area. GtkBox currently has two derived +classes, #GtkHBox and #GtkVBox. + + +The rectangular area of a GtkBox is organized into either a single row +or a single column of child widgets depending upon whether the box is +of type #GtkHBox or #GtkVBox, respectively. Thus, all children of a +GtkBox are allocated one dimension in common, which is the height of a +row, or the width of a column. + + +GtkBox uses a notion of packing. Packing refers to +adding widgets with reference to a particular position in a +#GtkContainer. For a GtkBox, there are two reference positions: the +start and the end of the box. +For a #GtkVBox, the start is defined as the top of the box and the end is +defined as the bottom. For a #GtkHBox the start is defined as the +left side and the end is defined as the right side. + + +Use repeated calls to gtk_box_pack_start() to pack widgets into a +GtkBox from start to end. Use gtk_box_pack_end() to add widgets from +end to start. You may intersperse these calls and add widgets from +both ends of the same GtkBox. + + +Use gtk_box_pack_start_defaults() or gtk_box_pack_end_defaults() +to pack widgets into a GtkBox if you do not need to specify the +#GtkBox:expand, #GtkBox:fill, or #GtkBox:padding child properties +for the child to be added. + + +Because GtkBox is a #GtkContainer, you may also use +gtk_container_add() to insert widgets into the box, and they will be +packed as if with gtk_box_pack_start_defaults(). Use +gtk_container_remove() to remove widgets from the GtkBox. + + +Use gtk_box_set_homogeneous() to specify whether or not all children +of the GtkBox are forced to get the same amount of space. + + +Use gtk_box_set_spacing() to determine how much space will be +minimally placed between all children in the GtkBox. + + +Use gtk_box_reorder_child() to move a GtkBox child to a different +place in the box. + + +Use gtk_box_set_child_packing() to reset the #GtkBox:expand, +#GtkBox:fill and #GtkBox:padding child properties. +Use gtk_box_query_child_packing() to query these fields. - - - - -#GtkHBox -a derived class that organizes widgets into a row. - - - -#GtkVBox -a derived class that organizes widgets into a column. - - - -#GtkFrame -a #GtkWidget useful for drawing a border around a GtkBox. - - - -#GtkTable -a #GtkContainer for organizing widgets into a grid, -rather than independent rows or columns. - - - -#GtkLayout -a #GtkContainer for organizing widgets into arbitrary -layouts. - - - - + + + + +#GtkHBox +a derived class that organizes widgets into a row. + + + +#GtkVBox +a derived class that organizes widgets into a column. + + + +#GtkFrame +a #GtkWidget useful for drawing a border around a GtkBox. + + + +#GtkTable +a #GtkContainer for organizing widgets into a grid, +rather than independent rows or columns. + + + +#GtkLayout +a #GtkContainer for organizing widgets into arbitrary +layouts. + + + + - -The #GtkBox-struct describes an instance of GtkBox and contains the following fields. -(These fields should be considered read-only. They should never be set by -an application.) - - - - - - -#GList * children; -a list of children belonging the GtkBox. The data is a list of -structures of type #GtkBoxChild-struct. - - - -#gint16 spacing; -the number of pixels to put between children of the GtkBox, zero -by default. Use gtk_box_set_spacing() to set this field. - - - -#guint homogeneous; -a flag that if %TRUE forces all children to get equal space in -the GtkBox; %FALSE by default. Use gtk_box_set_homogeneous() to set this -field. - - + +The #GtkBox-struct describes an instance of GtkBox and contains the +following fields. (These fields should be considered read-only. +They should never be set by an application.) -@children: -@spacing: -@homogeneous: +@children: a list of children belonging the GtkBox. + The data is a list of structures of type #GtkBoxChild-struct. +@spacing: the number of pixels to put between children of the GtkBox, + zero by default. Use gtk_box_set_spacing() to set this field. +@homogeneous: a flag that if %TRUE forces all children to get equal + space in the GtkBox; %FALSE by default. Use gtk_box_set_homogeneous() + to set this field. @@ -174,145 +152,77 @@ field. - -The #GtkBoxChild-struct holds a child widget of GtkBox and describes -how the child is to be packed into the GtkBox. Use -gtk_box_query_child_packing() and gtk_box_set_child_packing() to query -and reset the padding, -expand, fill, -and pack fields. - - -#GtkBoxChild-struct contains the following fields. (These fields -should be considered read-only. They should never be directly set by an -application.) - - - - - - -#GtkWidget * widget; -the child widget, packed into the GtkBox. - - - -#guint16 padding; -the number of extra pixels to put between this child and its -neighbors, set when packed, zero by default. - - - -#guint expand; -flag indicates whether extra space should be given to this -child. Any extra space given to the parent GtkBox is divided up among -all children with this attribute set to %TRUE; set when packed, %TRUE by -default. - - - -#guint fill; -flag indicates whether any extra space given to this child due to its -expand attribute being set is actually -allocated to the child, rather than being used as padding -around the widget; set when packed, %TRUE by default. - - - -#guint pack; one of -#GtkPackType indicating whether the child is packed with reference to -the start (top/left) or end (bottom/right) of the GtkBox. - - + +The #GtkBoxChild-struct holds a child widget of GtkBox and describes +how the child is to be packed into the GtkBox. Use +gtk_box_query_child_packing() and gtk_box_set_child_packing() to query +and reset the padding, +expand, fill, +and pack fields. + + +#GtkBoxChild-struct contains the following fields. (These fields +should be considered read-only. They should never be directly set by an +application.) -@widget: -@padding: -@expand: -@fill: -@pack: +@widget: the child widget, packed into the GtkBox. +@padding: the number of extra pixels to put between this child and its + neighbors, set when packed, zero by default. +@expand: flag indicates whether extra space should be given to this + child. Any extra space given to the parent GtkBox is divided up + among all children with this attribute set to %TRUE; set when packed, + %TRUE by default. +@fill: flag indicates whether any extra space given to this child due + to its @expand attribute being set is actually allocated to the child, + rather than being used as padding around the widget; set when packed, + %TRUE by default. +@pack: one of #GtkPackType indicating whether the child is packed with + reference to the start (top/left) or end (bottom/right) of the GtkBox. @is_secondary: + - -Adds @child to @box, packed with reference to the start of @box. The -@child is packed after any other child packed with reference to the -start of @box. + + -@box: a #GtkBox. -@child: the #GtkWidget to be added to @box. -@expand: %TRUE if the new child is to be given extra space allocated to -@box. The extra space will be divided evenly between all children of -@box that use this option. -@fill: %TRUE if space given to @child by the @expand option is -actually allocated to @child, rather than just padding it. This -parameter has no effect if @expand is set to %FALSE. A child is -always allocated the full height of a #GtkHBox and the full width of a -#GtkVBox. This option affects the other dimension. -@padding: extra space in pixels to put between this child and its -neighbors, over and above the global amount specified by -spacing in #GtkBox-struct. If @child is a -widget at one of the reference ends of @box, then @padding pixels are also put -between @child and the reference edge of @box. +@box: +@child: +@expand: +@box +@fill: +@padding: - -Adds @child to @box, packed with reference to the end of @box. The -@child is packed after (away from end of) any other child packed with reference to the -end of @box. + + -@box: a #GtkBox. -@child: the #GtkWidget to be added to @box. -@expand: %TRUE if the new child is to be given extra space allocated to -@box. The extra space will be divided evenly between all children of -@box that use this option. -@fill: %TRUE if space given to @child by the @expand option is -actually allocated to @child, rather than just padding it. This -parameter has no effect if @expand is set to %FALSE. A child is -always allocated the full height of a #GtkHBox and the full width of a -#GtkVBox. This option affects the other dimension. -@padding: extra space in pixels to put between this child and its -neighbors, over and above the global amount specified by -spacing in #GtkBox-struct. If @child is a -widget at one of the reference ends of @box, then @padding pixels are also put -between @child and the reference edge of @box. +@box: +@child: +@expand: +@fill: +@padding: - -Adds @widget to @box, packed with reference to the start of @box. The -child is packed after any other child packed with reference to the -start of @box. - - -Parameters for how to pack the child @widget, -expand, fill, -and padding in #GtkBoxChild-struct, are given their default -values, %TRUE, %TRUE, and 0, respectively. + + -@box: a #GtkBox. -@widget: the #GtkWidget to be added to @box. +@box: +@widget: - -Adds @widget to @box, packed with reference to the end of @box. The -child is packed after (away from end of) any other child packed with -reference to the end of @box. - - -Parameters for how to pack the child @widget, -expand, fill, -and padding in #GtkBoxChild-struct, are given their default -values, %TRUE, %TRUE, and 0, respectively. + + -@box: a #GtkBox. -@widget: the #GtkWidget to be added to @box. +@box: +@widget: @@ -325,15 +235,12 @@ values, %TRUE, %TRUE, and 0, respectively. - -Sets the homogeneous field of -#GtkBox-struct, controlling whether or not all children of @box are -given equal space in the box. + + -@box: a #GtkBox. -@homogeneous: a boolean value, %TRUE to create equal allotments, -%FALSE for variable allotments. +@box: +@homogeneous: @@ -346,68 +253,45 @@ given equal space in the box. - -Sets the spacing field of #GtkBox-struct, -which is the number of pixels to place between children of @box. + + -@box: a #GtkBox. -@spacing: the number of pixels to put between children. +@box: +@spacing: - -Moves @child to a new @position in the list of @box children. The -list is the children field of -#GtkBox-struct, and contains both widgets packed #GTK_PACK_START as -well as widgets packed #GTK_PACK_END, in the order that these widgets -were added to @box. - - -A widget's position in the @box children list determines where the -widget is packed into @box. A child widget at some position in the -list will be packed just after all other widgets of the same packing -type that appear earlier in the list. + + -@box: a #GtkBox. -@child: the #GtkWidget to move. -@position: the new position for @child in the -children list of #GtkBox-struct, starting -from 0. If negative, indicates the end of the list. +@box: +@child: +@position: - -Returns information about how @child is packed into @box. + + -@box: a #GtkBox. -@child: the #GtkWidget of the child to query. -@expand: the returned value of the expand -field in #GtkBoxChild-struct. -@fill: the returned value of the fill field -in #GtkBoxChild-struct. -@padding: the returned value of the padding -field in #GtkBoxChild-struct. -@pack_type: the returned value of the pack -field in #GtkBoxChild-struct. +@box: +@child: +@expand: +@fill: +@padding: +@pack_type: - -Sets the way @child is packed into @box. + + -@box: a #GtkBox. -@child: the #GtkWidget of the child to set. -@expand: the new value of the expand field -in #GtkBoxChild-struct. -@fill: the new value of the fill field in -#GtkBoxChild-struct. -@padding: the new value of the padding -field in #GtkBoxChild-struct. -@pack_type: the new value of the pack field -in #GtkBoxChild-struct. - - +@box: +@child: +@expand: +@fill: +@padding: +@pack_type: diff --git a/gtk/gtkbox.c b/gtk/gtkbox.c index 7f8f23d4db..086a276252 100644 --- a/gtk/gtkbox.c +++ b/gtk/gtkbox.c @@ -329,6 +329,28 @@ gtk_box_get_child_property (GtkContainer *container, } } +/** + * gtk_box_pack_start: + * @box: a #GtkBox + * @child: the #GtkWidget to be added to @box + * @expand: %TRUE if the new child is to be given extra space allocated to + * @box. The extra space will be divided evenly between all children of + * @box that use this option + * @fill: %TRUE if space given to @child by the @expand option is + * actually allocated to @child, rather than just padding it. This + * parameter has no effect if @expand is set to %FALSE. A child is + * always allocated the full height of a #GtkHBox and the full width + * of a #GtkVBox. This option affects the other dimension + * @padding: extra space in pixels to put between this child and its + * neighbors, over and above the global amount specified by + * #GtkBox:spacing property. If @child is a widget at one of the + * reference ends of @box, then @padding pixels are also put between + * @child and the reference edge of @box + * + * Adds @child to @box, packed with reference to the start of @box. + * The @child is packed after any other child packed with reference + * to the start of @box. + */ void gtk_box_pack_start (GtkBox *box, GtkWidget *child, @@ -364,6 +386,28 @@ gtk_box_pack_start (GtkBox *box, gtk_widget_thaw_child_notify (child); } +/** + * gtk_box_pack_end: + * @box: a #GtkBox + * @child: the #GtkWidget to be added to @box + * @expand: %TRUE if the new child is to be given extra space allocated + * to @box. The extra space will be divided evenly between all children + * of @box that use this option + * @fill: %TRUE if space given to @child by the @expand option is + * actually allocated to @child, rather than just padding it. This + * parameter has no effect if @expand is set to %FALSE. A child is + * always allocated the full height of a #GtkHBox and the full width + * of a #GtkVBox. This option affects the other dimension + * @padding: extra space in pixels to put between this child and its + * neighbors, over and above the global amount specified by + * #GtkBox:spacing property. If @child is a widget at one of the + * reference ends of @box, then @padding pixels are also put between + * @child and the reference edge of @box + * + * Adds @child to @box, packed with reference to the end of @box. + * The @child is packed after (away from end of) any other child + * packed with reference to the end of @box. + */ void gtk_box_pack_end (GtkBox *box, GtkWidget *child, @@ -399,6 +443,19 @@ gtk_box_pack_end (GtkBox *box, gtk_widget_thaw_child_notify (child); } +/** + * gtk_box_pack_start_defaults: + * @box: a #GtkBox + * @widget: the #GtkWidget to be added to @box + * + * Adds @widget to @box, packed with reference to the start of @box. + * The child is packed after any other child packed with reference + * to the start of @box. + * + * Parameters for how to pack the child @widget, #GtkBox:expand, + * #GtkBox:fill and #GtkBox:padding, are given their default + * values, %TRUE, %TRUE, and 0, respectively. + */ void gtk_box_pack_start_defaults (GtkBox *box, GtkWidget *child) @@ -406,6 +463,19 @@ gtk_box_pack_start_defaults (GtkBox *box, gtk_box_pack_start (box, child, TRUE, TRUE, 0); } +/** + * gtk_box_pack_end_defaults: + * @box: a #GtkBox + * @widget: the #GtkWidget to be added to @box + * + * Adds @widget to @box, packed with reference to the end of @box. + * The child is packed after any other child packed with reference + * to the start of @box. + * + * Parameters for how to pack the child @widget, #GtkBox:expand, + * #GtkBox:fill and #GtkBox:padding, are given their default + * values, %TRUE, %TRUE, and 0, respectively. + */ void gtk_box_pack_end_defaults (GtkBox *box, GtkWidget *child) @@ -413,6 +483,16 @@ gtk_box_pack_end_defaults (GtkBox *box, gtk_box_pack_end (box, child, TRUE, TRUE, 0); } +/** + * gtk_box_set_homogeneous: + * @box: a #GtkBox + * @homogeneous: a boolean value, %TRUE to create equal allotments, + * %FALSE for variable allotments + * + * Sets the #GtkBox:homogeneous property of @box, controlling + * whether or not all children of @box are given equal space + * in the box. + */ void gtk_box_set_homogeneous (GtkBox *box, gboolean homogeneous) @@ -444,6 +524,14 @@ gtk_box_get_homogeneous (GtkBox *box) return box->homogeneous; } +/** + * gtk_box_set_spacing: + * @box: a #GtkBox + * @spacing: the number of pixels to put between children + * + * Sets the #GtkBox:spacing property of @box, which is the + * number of pixels to place between children of @box. + */ void gtk_box_set_spacing (GtkBox *box, gint spacing) @@ -474,6 +562,25 @@ gtk_box_get_spacing (GtkBox *box) return box->spacing; } +/** + * gtk_box_reorder_child: + * @box: a #GtkBox + * @child: the #GtkWidget to move + * @position: the new position for @child in the list of children + * of @box, starting from 0. If negative, indicates the end of + * the list + * + * Moves @child to a new @position in the list of @box children. + * The list is the children field of + * #GtkBox-struct, and contains both widgets packed #GTK_PACK_START + * as well as widgets packed #GTK_PACK_END, in the order that these + * widgets were added to @box. + * + * A widget's position in the @box children list determines where + * the widget is packed into @box. A child widget at some position + * in the list will be packed just after all other widgets of the + * same packing type that appear earlier in the list. + */ void gtk_box_reorder_child (GtkBox *box, GtkWidget *child, @@ -518,13 +625,24 @@ gtk_box_reorder_child (GtkBox *box, gtk_widget_queue_resize (child); } +/** + * gtk_box_query_child_packing: + * @box: a #GtkBox + * @child: the #GtkWidget of the child to query + * @expand: pointer to return location for #GtkBox:expand child property + * @fill: pointer to return location for #GtkBox:fill child property + * @padding: pointer to return location for #GtkBox:padding child property + * @pack_type: pointer to return location for #GtkBox:pack-type child property + * + * Returns information about how @child is packed into @box. + */ void -gtk_box_query_child_packing (GtkBox *box, - GtkWidget *child, - gboolean *expand, - gboolean *fill, - guint *padding, - GtkPackType *pack_type) +gtk_box_query_child_packing (GtkBox *box, + GtkWidget *child, + gboolean *expand, + gboolean *fill, + guint *padding, + GtkPackType *pack_type) { GList *list; GtkBoxChild *child_info = NULL; @@ -555,13 +673,24 @@ gtk_box_query_child_packing (GtkBox *box, } } +/** + * gtk_box_set_child_packing: + * @box: a #GtkBox + * @child: the #GtkWidget of the child to set + * @expand: the new value of the #GtkBox:expand child property + * @fill: the new value of the #GtkBox:fill child property + * @padding: the new value of the #GtkBox:padding child property + * @pack_type: the new value of the #GtkBox:pack-type child property + * + * Sets the way @child is packed into @box. + */ void -gtk_box_set_child_packing (GtkBox *box, - GtkWidget *child, - gboolean expand, - gboolean fill, - guint padding, - GtkPackType pack_type) +gtk_box_set_child_packing (GtkBox *box, + GtkWidget *child, + gboolean expand, + gboolean fill, + guint padding, + GtkPackType pack_type) { GList *list; GtkBoxChild *child_info = NULL; diff --git a/gtk/gtkrange.c b/gtk/gtkrange.c index bc15e6b53c..883fb5d1b9 100644 --- a/gtk/gtkrange.c +++ b/gtk/gtkrange.c @@ -282,11 +282,11 @@ gtk_range_class_init (GtkRangeClass *class) /** * GtkRange::change-value: - * @range: the range that received the signal. - * @scroll: the type of scroll action that was performed. - * @value: the new value resulting from the scroll action. + * @range: the range that received the signal + * @scroll: the type of scroll action that was performed + * @value: the new value resulting from the scroll action * @returns: %TRUE to prevent other handlers from being invoked for the - * signal. %FALSE to propagate the signal further. + * signal, %FALSE to propagate the signal further * * The ::change-value signal is emitted when a scroll action is * performed on a range. It allows an application to determine the @@ -363,7 +363,7 @@ gtk_range_class_init (GtkRangeClass *class) /** * GtkRange:show-fill-level: * - * The show-fill-level property controls wether fill level indicator + * The show-fill-level property controls whether fill level indicator * graphics are displayed on the trough. See * gtk_range_set_show_fill_level(). * @@ -380,9 +380,9 @@ gtk_range_class_init (GtkRangeClass *class) /** * GtkRange:restrict-to-fill-level: * - * The restrict-to-fill-level proeprty controls whether slider + * The restrict-to-fill-level property controls whether slider * movement is restricted to an upper boundary set by the - * fill-level. See gtk_range_set_restrict_to_fill_level(). + * fill level. See gtk_range_set_restrict_to_fill_level(). * * Since: 2.12 **/ @@ -441,7 +441,7 @@ gtk_range_class_init (GtkRangeClass *class) * * The spacing between the stepper buttons and thumb. Note that * setting this value to anything > 0 will automatically set the - * trough-under-steppers style property to TRUE as well. Also, + * trough-under-steppers style property to %TRUE as well. Also, * stepper-spacing won't have any effect if there are no steppers. */ gtk_widget_class_install_style_property (widget_class, @@ -479,6 +479,9 @@ gtk_range_class_init (GtkRangeClass *class) /** * GtkRange:trough-side-details: * + * When %TRUE, the parts of the trough on the two sides of the + * slider are drawn with different details. + * * Since: 2.10 */ gtk_widget_class_install_style_property (widget_class, @@ -493,7 +496,7 @@ gtk_range_class_init (GtkRangeClass *class) * * Whether to draw the trough across the full length of the range or * to exclude the steppers and their spacing. Note that setting the - * stepper-spacing style property to any value > 0 will + * #GtkRange:stepper-spacing style property to any value > 0 will * automatically enable trough-under-steppers too. * * Since: 2.10 @@ -659,7 +662,6 @@ gtk_range_get_adjustment (GtkRange *range) * continuous. #GTK_UPDATE_DISCONTINUOUS means that the value will only * be updated when the user releases the button and ends the slider * drag operation. - * **/ void gtk_range_set_update_policy (GtkRange *range, @@ -702,7 +704,6 @@ gtk_range_get_update_policy (GtkRange *range) * is normally 0 for #GtkScale and nonzero for #GtkScrollbar, and * indicates the size of the visible area of the widget being scrolled. * The page size affects the size of the scrollbar slider. - * **/ void gtk_range_set_adjustment (GtkRange *range, @@ -752,7 +753,6 @@ gtk_range_set_adjustment (GtkRange *range, * slider moves from top to bottom or left to right. Inverted * ranges have higher values at the top or on the right rather than * on the bottom or left. - * **/ void gtk_range_set_inverted (GtkRange *range, @@ -890,7 +890,6 @@ gtk_range_get_upper_stepper_sensitivity (GtkRange *range) * The step size is used when the user clicks the #GtkScrollbar * arrows or moves #GtkScale via arrow keys. The page size * is used for example when moving via Page Up or Page Down keys. - * **/ void gtk_range_set_increments (GtkRange *range, @@ -948,9 +947,8 @@ gtk_range_set_range (GtkRange *range, * * Sets the current value of the range; if the value is outside the * minimum or maximum range values, it will be clamped to fit inside - * them. The range emits the "value_changed" signal if the value - * changes. - * + * them. The range emits the #GtkRange::value-changed signal if the + * value changes. **/ void gtk_range_set_value (GtkRange *range, diff --git a/gtk/gtkscale.c b/gtk/gtkscale.c index 7cce057b9a..9e141e6825 100644 --- a/gtk/gtkscale.c +++ b/gtk/gtkscale.c @@ -595,8 +595,8 @@ gtk_scale_screen_changed (GtkWidget *widget, * @scale: a #GtkScale * @value: adjustment value * - * Emits "format_value" signal to format the value, if no user - * signal handlers, falls back to a default format. + * Emits #GtkScale::format-value signal to format the value, + * if no user signal handlers, falls back to a default format. * * Return value: formatted value **/ @@ -637,11 +637,12 @@ gtk_scale_finalize (GObject *object) * gtk_scale_get_layout: * @scale: A #GtkScale * - * Gets the #PangoLayout used to display the scale. The returned object - * is owned by the scale so does not need to be freed by the caller. + * Gets the #PangoLayout used to display the scale. + * The returned object is owned by the scale so does + * not need to be freed by the caller. * - * Return value: the #PangoLayout for this scale, or %NULL if the draw_value property - * is %FALSE. + * Return value: the #PangoLayout for this scale, or %NULL + * if the #GtkScale:draw-value property is %FALSE. * * Since: 2.4 **/ @@ -676,13 +677,13 @@ gtk_scale_get_layout (GtkScale *scale) * @x: location to store X offset of layout, or %NULL * @y: location to store Y offset of layout, or %NULL * - * Obtains the coordinates where the scale will draw the #PangoLayout - * representing the text in the scale. Remember + * Obtains the coordinates where the scale will draw the + * #PangoLayout representing the text in the scale. Remember * when using the #PangoLayout function you need to convert to * and from pixels using PANGO_PIXELS() or #PANGO_SCALE. * - * If the draw_value property is %FALSE, the return values are - * undefined. + * If the #GtkScale:draw-value property is %FALSE, the return + * values are undefined. * * Since: 2.4 **/