From 1a71579b61a51d9ae357f4919ac026a89ca0e195 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Sat, 6 Feb 2016 16:19:13 +0100 Subject: [PATCH] level bar: Improve documentation The docs were not explaining at all what happens to existing level offsets when the min- or max-value of a level bar are changed. --- gtk/gtklevelbar.c | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/gtk/gtklevelbar.c b/gtk/gtklevelbar.c index 5661e0269f..6cffd980c9 100644 --- a/gtk/gtklevelbar.c +++ b/gtk/gtklevelbar.c @@ -34,6 +34,10 @@ * #GTK_LEVEL_BAR_OFFSET_HIGH and #GTK_LEVEL_BAR_OFFSET_FULL, with * values 0.25, 0.75 and 1.0 respectively. * + * Note that it is your responsibility to update preexisting offsets + * when changing the minimum or maximum value. GTK+ will simply clamp + * them to the new range. + * * ## Adding a custom offset on the bar * * |[ @@ -1266,6 +1270,9 @@ gtk_level_bar_set_value_internal (GtkLevelBar *self, * * Sets the value of the #GtkLevelBar:min-value property. * + * You probably want to update preexisting level offsets after calling + * this function. + * * Since: 3.6 */ void @@ -1297,6 +1304,9 @@ gtk_level_bar_set_min_value (GtkLevelBar *self, * * Sets the value of the #GtkLevelBar:max-value property. * + * You probably want to update preexisting level offsets after calling + * this function. + * * Since: 3.6 */ void