efl_ui_range_display: Update docs
authorXavi Artigas <xavierartigas@yahoo.es>
Tue, 27 Aug 2019 14:38:12 +0000 (16:38 +0200)
committerHosang Kim <hosang12.kim@samsung.com>
Wed, 28 Aug 2019 05:05:04 +0000 (14:05 +0900)
src/lib/efl/interfaces/efl_ui_range_display.eo

index 172f58a..5e67edb 100644 (file)
@@ -1,46 +1,42 @@
 interface @beta Efl.Ui.Range_Display
 {
-   [[Interface that contains properties regarding the displaying of a range.]]
+   [[Interface that contains properties regarding the displaying of a value within a range.
+
+     A value range contains a value restricted between specified minimum and maximum
+     limits at all times.
+     This can be used for progressbars, sliders or spinners, for example.
+   ]]
    c_prefix: efl_ui_range;
    methods {
       @property range_value {
-         [[Control the range value (in percentage) on a given range widget
-
-           Use this call to set range levels.
+         [[Control the value (position) of the widget within its valid range.
 
-           Note: If you pass a value out of the specified interval for
-           $val, it will be interpreted as the closest of the boundary
-           values in the interval.]]
+           Values outside the limits defined in @.range_limits are ignored and an error
+           is printed.
+         ]]
          set {
          }
          get {
          }
          values {
-            val: double; [[The range value (must be between $0.0 and 1.0)]]
+            val: double; [[The range value (must be within the bounds of @.range_limits).]]
          }
       }
       @property range_limits {
-         set {
-            [[Set the minimum and maximum values for given range widget.
+         [[Set the minimum and maximum values for given range widget.
 
-              Define the allowed range of values to be selected by the user.
+           If the current value is less than $min, it will be updated to $min.
+           If it is bigger then $max, will be updated to $max. The resulting value
+           can be obtained with @Efl.Ui.Range_Display.range_value.get.
 
-              If actual value is less than $min, it will be updated to $min.
-              If it is bigger then $max, will be updated to $max. The actual value
-              can be obtained with @Efl.Ui.Range_Display.range_value.get
+           The default minimum and maximum values may be different for each class.
 
-              The minimum and maximum values may be different for each class.
-
-              Warning: maximum must be greater than minimum, otherwise behavior
-              is undefined.
-            ]]
+           Note: maximum must be greater than minimum, otherwise behavior
+           is undefined.
+         ]]
+         set {
          }
          get {
-            [[Get the minimum and maximum values of the given range widget.
-
-              Note: If only one value is needed, the other pointer can be passed
-              as $null.
-            ]]
          }
          values {
             min: double; [[The minimum value.]]
@@ -49,8 +45,8 @@ interface @beta Efl.Ui.Range_Display
       }
    }
    events {
-      changed: void; [[Emitted when the $range_value is getting changed]]
-      min,reached: void; [[Emitted when the $range_value has reached the minimum of $range_limits]]
-      max,reached: void; [[Emitted when the $range_value has reached the maximum of $range_limits]]
+      changed: void; [[Emitted when the @.range_value is getting changed.]]
+      min,reached: void; [[Emitted when the @.range_value has reached the minimum of @.range_limits.]]
+      max,reached: void; [[Emitted when the $range_value has reached the maximum of @.range_limits.]]
    }
 }