summaryrefslogtreecommitdiff
path: root/docs/reference/gtk/tmpl/gtkscale.sgml
diff options
context:
space:
mode:
authorHavoc Pennington <hp@redhat.com>2001-06-05 20:07:02 +0000
committerHavoc Pennington <hp@src.gnome.org>2001-06-05 20:07:02 +0000
commitb32e7c9bb82396e4930957bb649a2e1cd57f00c1 (patch)
treeb95893653c899c31699a91803eebeb1e934e7f1e /docs/reference/gtk/tmpl/gtkscale.sgml
parent451b224324864047842dfe009834a0fe53728147 (diff)
downloadgdk-pixbuf-b32e7c9bb82396e4930957bb649a2e1cd57f00c1.tar.gz
clamp the value to the range that was set
2001-06-05 Havoc Pennington <hp@redhat.com> * gtk/gtkspinbutton.c (gtk_spin_button_set_range): clamp the value to the range that was set * gtk/gtkrange.c: add value_changed signal, primarily intended for use with GtkScale (gtk_range_set_increments): new function (gtk_range_set_range): new function with weird name (gtk_range_set_value): new function (gtk_range_get_value): new function * gtk/gtkspinbutton.c (gtk_spin_button_get_value): rename from gtk_spin_button_get_value_as_float(). Compat #define added for get_value_as_float. * gtk/gtkhscale.c (gtk_hscale_new_with_range): new function * gtk/gtkvscale.c (gtk_vscale_new_with_range): new function 2001-06-05 Havoc Pennington <hp@redhat.com> * test-loaders.c (main): use putenv not setenv, reported by Armin Theissen
Diffstat (limited to 'docs/reference/gtk/tmpl/gtkscale.sgml')
-rw-r--r--docs/reference/gtk/tmpl/gtkscale.sgml30
1 files changed, 26 insertions, 4 deletions
diff --git a/docs/reference/gtk/tmpl/gtkscale.sgml b/docs/reference/gtk/tmpl/gtkscale.sgml
index 3f765150b..2a3383272 100644
--- a/docs/reference/gtk/tmpl/gtkscale.sgml
+++ b/docs/reference/gtk/tmpl/gtkscale.sgml
@@ -6,8 +6,17 @@ a base class for #GtkHScale and #GtkVScale.
<!-- ##### SECTION Long_Description ##### -->
<para>
+A #GtkScale is a slider control used to select a numeric value.
+To use it, you'll probably want to investigate the methods on
+its base class, #GtkRange, in addition to the methods for #GtkScale itself.
+To set the value of a scale, you would normally use gtk_range_set_value().
+To detect changes to the value, you would normally use the "value_changed"
+signal.
+</para>
+<para>
The #GtkScale widget is an abstract class, used only for deriving the
-subclasses #GtkHScale and #GtkVScale.
+subclasses #GtkHScale and #GtkVScale. To create a scale widget,
+call gtk_hscale_new_with_range() or gtk_vscale_new_with_range().
</para>
<!-- ##### SECTION See_Also ##### -->
@@ -74,12 +83,25 @@ Sets the position in which the current value is displayed.
<!-- ##### SIGNAL GtkScale::format-value ##### -->
<para>
-
+Signal which allows you to change how the scale value is displayed. Connect a
+signal handler which returns an allocated string representing @value.
+That string will then be used to display the scale's value.
+Here's an example signal handler which displays a value 1.0 as
+with "-->1.0<--".
+<programlisting>
+static gchar*
+format_value_callback (GtkScale *scale,
+ gdouble value)
+{
+ return g_strdup_printf ("-->%0.*g<--",
+ gtk_scale_get_digits (scale), value);
+}
+</programlisting>
</para>
@scale: the object which received the signal.
-@arg1:
-@Returns:
+@value: value to format
+@Returns: allocated string representing @value
<!-- ##### ARG GtkScale:digits ##### -->
<para>