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.
This commit is contained in:
Matthias Clasen 2016-02-06 16:19:13 +01:00
parent 8776bb5324
commit 1a71579b61

View File

@ -34,6 +34,10 @@
* #GTK_LEVEL_BAR_OFFSET_HIGH and #GTK_LEVEL_BAR_OFFSET_FULL, with * #GTK_LEVEL_BAR_OFFSET_HIGH and #GTK_LEVEL_BAR_OFFSET_FULL, with
* values 0.25, 0.75 and 1.0 respectively. * 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 * ## Adding a custom offset on the bar
* *
* |[<!-- language="C" --> * |[<!-- language="C" -->
@ -1266,6 +1270,9 @@ gtk_level_bar_set_value_internal (GtkLevelBar *self,
* *
* Sets the value of the #GtkLevelBar:min-value property. * Sets the value of the #GtkLevelBar:min-value property.
* *
* You probably want to update preexisting level offsets after calling
* this function.
*
* Since: 3.6 * Since: 3.6
*/ */
void void
@ -1297,6 +1304,9 @@ gtk_level_bar_set_min_value (GtkLevelBar *self,
* *
* Sets the value of the #GtkLevelBar:max-value property. * Sets the value of the #GtkLevelBar:max-value property.
* *
* You probably want to update preexisting level offsets after calling
* this function.
*
* Since: 3.6 * Since: 3.6
*/ */
void void