summaryrefslogtreecommitdiff
path: root/gtk/gtkhscale.c
diff options
context:
space:
mode:
authorJavier Jardón <jjardon@gnome.org>2011-04-11 03:04:20 +0100
committerJavier Jardón <jjardon@gnome.org>2011-04-11 03:27:08 +0100
commit62c878b0cd00c73685db8618d75d16d2d0e204bf (patch)
tree97701d43864d91de7d00afc2a9712a838202c137 /gtk/gtkhscale.c
parent610d46d12ee808c66f2821ac76e0c894f91aa32a (diff)
downloadgtk+-62c878b0cd00c73685db8618d75d16d2d0e204bf.tar.gz
Move documentation to inline comments: GtkHScale
Diffstat (limited to 'gtk/gtkhscale.c')
-rw-r--r--gtk/gtkhscale.c21
1 files changed, 21 insertions, 0 deletions
diff --git a/gtk/gtkhscale.c b/gtk/gtkhscale.c
index a8b86e459d..84ea86a6b1 100644
--- a/gtk/gtkhscale.c
+++ b/gtk/gtkhscale.c
@@ -33,6 +33,19 @@
#include "gtkorientable.h"
+/**
+ * SECTION:gtkhscale
+ * @Short_description: A horizontal slider widget for selecting a value from a range
+ * @Title: GtkHScale
+ *
+ * The #GtkHScale widget is used to allow the user to select a value using
+ * a horizontal slider. To create one, use gtk_hscale_new_with_range().
+ *
+ * The position to show the current value, and the number of decimal places
+ * shown can be set using the parent #GtkScale class's functions.
+ */
+
+
G_DEFINE_TYPE (GtkHScale, gtk_hscale, GTK_TYPE_SCALE)
static void
@@ -50,6 +63,14 @@ gtk_hscale_init (GtkHScale *hscale)
GTK_ORIENTATION_HORIZONTAL);
}
+/**
+ * gtk_hscale_new:
+ * @adjustment: the #GtkAdjustment which sets the range of the scale.
+ *
+ * Creates a new #GtkHScale.
+ *
+ * Returns: a new #GtkHScale.
+ */
GtkWidget *
gtk_hscale_new (GtkAdjustment *adjustment)
{