[gtk+] Move documentation to inline comments: GtkRange
- From: Javier Jardón <jjardon src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+] Move documentation to inline comments: GtkRange
- Date: Fri, 21 May 2010 01:10:08 +0000 (UTC)
commit 2f28e88dea53aff6d082ac2a7cdd17defa6c8e29
Author: Javier Jardón <jjardon gnome org>
Date: Fri May 21 02:19:14 2010 +0200
Move documentation to inline comments: GtkRange
docs/reference/gtk/tmpl/.gitignore | 1 +
docs/reference/gtk/tmpl/gtkrange.sgml | 424 ---------------------------------
gtk/gtkenums.h | 11 +-
gtk/gtkrange.c | 29 ++-
4 files changed, 36 insertions(+), 429 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 83f383b..f298ba4 100644
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -9,6 +9,7 @@ gtkpagesetupunixdialog.sgml
gtkprinter.sgml
gtkradioaction.sgml
gtkradiobutton.sgml
+gtkrange.sgml
gtkrecentaction.sgml
gtkrecentchooser.sgml
gtkrecentchooserwidget.sgml
diff --git a/gtk/gtkenums.h b/gtk/gtkenums.h
index 2bb021e..6d9b491 100644
--- a/gtk/gtkenums.h
+++ b/gtk/gtkenums.h
@@ -140,7 +140,16 @@ typedef enum
GTK_ICON_SIZE_DIALOG
} GtkIconSize;
-/* automatic sensitivity */
+/**
+ * GtkSensitivityType:
+ * @GTK_SENSITIVITY_AUTO: The arrow is made insensitive if the
+ * thumb is at the end
+ * @GTK_SENSITIVITY_ON: The arrow is always sensitive
+ * @GTK_SENSITIVITY_OFF: The arrow is always insensitive
+ *
+ * Determines how GTK+ handles the sensitivity of stepper arrows
+ * at the end of range widgets.
+ */
typedef enum
{
GTK_SENSITIVITY_AUTO,
diff --git a/gtk/gtkrange.c b/gtk/gtkrange.c
index a4fcee4..6d94219 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
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]