diff options
| author | Javier Jardón <jjardon@gnome.org> | 2010-05-21 02:19:14 +0200 |
|---|---|---|
| committer | Javier Jardón <jjardon@gnome.org> | 2010-05-21 03:09:43 +0200 |
| commit | 2f28e88dea53aff6d082ac2a7cdd17defa6c8e29 (patch) | |
| tree | 7c82dfda0fbcb7f932b463cfcbd33ee6997d597e /gtk/gtkrange.c | |
| parent | 6847407edaea351f6e7f4bca6933ae1c7347537a (diff) | |
| download | gtk+-2f28e88dea53aff6d082ac2a7cdd17defa6c8e29.tar.gz | |
Move documentation to inline comments: GtkRange
Diffstat (limited to 'gtk/gtkrange.c')
| -rw-r--r-- | gtk/gtkrange.c | 29 |
1 files changed, 25 insertions, 4 deletions
diff --git a/gtk/gtkrange.c b/gtk/gtkrange.c index a4fcee4254..6d94219746 100644 --- a/gtk/gtkrange.c +++ b/gtk/gtkrange.c @@ -41,6 +41,22 @@ #include "gtkintl.h" #include "gtkalias.h" + +/** + * SECTION:gtkrange + * @Short_description: Base class for widgets which visualize an adjustment + * @Title: GtkRange + * + * #GtkRange is the common base class for widgets which visualize an + * adjustment, e.g #GtkScale or #GtkScroolbar. + * + * Apart from signals for monitoring the parameters of the adjustment, + * #GtkRange provides properties and methods for influencing the sensitivity + * of the "steppers". It also provides properties and methods for setting a + * "fill level" on range widgets. See gtk_range_set_fill_level(). + */ + + #define SCROLL_DELAY_FACTOR 5 /* Scroll repeat multiplier */ #define UPDATE_DELAY 300 /* Delay for queued update */ @@ -272,7 +288,7 @@ gtk_range_class_init (GtkRangeClass *class) /** * GtkRange::value-changed: - * @range: the #GtkRange + * @range: the #GtkRange that received the signal * * Emitted when the range value changes. */ @@ -284,7 +300,12 @@ gtk_range_class_init (GtkRangeClass *class) NULL, NULL, _gtk_marshal_VOID__VOID, G_TYPE_NONE, 0); - + + /** + * GtkRange::adjust-bounds: + * @range: the #GtkRange that received the signal + * @value: the value before we clamp + */ signals[ADJUST_BOUNDS] = g_signal_new (I_("adjust-bounds"), G_TYPE_FROM_CLASS (gobject_class), @@ -297,7 +318,7 @@ gtk_range_class_init (GtkRangeClass *class) /** * GtkRange::move-slider: - * @range: the #GtkRange + * @range: the #GtkRange that received the signal * @step: how to move the slider * * Virtual function that moves the slider. Used for keybindings. @@ -314,7 +335,7 @@ gtk_range_class_init (GtkRangeClass *class) /** * GtkRange::change-value: - * @range: the range that received the signal + * @range: the #GtkRange 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 |