[gtk+] Scale: Improve docs of prop digits in other places
- From: Daniel Boles <dboles src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+] Scale: Improve docs of prop digits in other places
- Date: Sun, 19 Feb 2017 09:05:30 +0000 (UTC)
commit ebca0c6ebfc46c687c4fa084d4d5a7f49ea4bffe
Author: Daniel Boles <dboles src gnome org>
Date: Sun Feb 19 08:37:51 2017 +0000
Scale: Improve docs of prop digits in other places
There were places still implying that it was only used for display.
gtk/gtkscale.c | 14 +++++++++++---
1 files changed, 11 insertions(+), 3 deletions(-)
---
diff --git a/gtk/gtkscale.c b/gtk/gtkscale.c
index b2e4e19..45e51c1 100644
--- a/gtk/gtkscale.c
+++ b/gtk/gtkscale.c
@@ -759,10 +759,17 @@ gtk_scale_class_init (GtkScaleClass *class)
G_TYPE_STRING, 1,
G_TYPE_DOUBLE);
+ /**
+ * GtkScale:digits:
+ *
+ * The number of decimal places to which the value is rounded when it is
+ * changed. This also sets the number of digits shown in the displayed value
+ * when using the default handler for the #GtkScale:format-value signal.
+ */
properties[PROP_DIGITS] =
g_param_spec_int ("digits",
P_("Digits"),
- P_("The number of decimal places that are displayed in the value"),
+ P_("The number of decimal places to which the value is rounded"),
-1, MAX_DIGITS,
1,
GTK_PARAM_READWRITE|G_PARAM_EXPLICIT_NOTIFY);
@@ -1118,9 +1125,10 @@ gtk_scale_set_digits (GtkScale *scale,
* gtk_scale_get_digits:
* @scale: a #GtkScale
*
- * Gets the number of decimal places that are displayed in the value.
+ * Gets the number of decimal places to which the value is rounded on change.
+ * This number is also used by the default #GtkScale:format-value handler.
*
- * Returns: the number of decimal places that are displayed
+ * Returns: the number of decimal places
*/
gint
gtk_scale_get_digits (GtkScale *scale)
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]