forked from enlightenment/efl
efl_ui_range_display: Update docs
This commit is contained in:
parent
5636bb8b0b
commit
47547ff088
|
@ -1,46 +1,42 @@
|
||||||
interface @beta Efl.Ui.Range_Display
|
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;
|
c_prefix: efl_ui_range;
|
||||||
methods {
|
methods {
|
||||||
@property range_value {
|
@property range_value {
|
||||||
[[Control the range value (in percentage) on a given range widget
|
[[Control the value (position) of the widget within its valid range.
|
||||||
|
|
||||||
Use this call to set range levels.
|
Values outside the limits defined in @.range_limits are ignored and an error
|
||||||
|
is printed.
|
||||||
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.]]
|
|
||||||
set {
|
set {
|
||||||
}
|
}
|
||||||
get {
|
get {
|
||||||
}
|
}
|
||||||
values {
|
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 {
|
@property range_limits {
|
||||||
|
[[Set the minimum and maximum values for given range widget.
|
||||||
|
|
||||||
|
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.
|
||||||
|
|
||||||
|
The default minimum and maximum values may be different for each class.
|
||||||
|
|
||||||
|
Note: maximum must be greater than minimum, otherwise behavior
|
||||||
|
is undefined.
|
||||||
|
]]
|
||||||
set {
|
set {
|
||||||
[[Set the minimum and maximum values for given range widget.
|
|
||||||
|
|
||||||
Define the allowed range of values to be selected by the user.
|
|
||||||
|
|
||||||
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 minimum and maximum values may be different for each class.
|
|
||||||
|
|
||||||
Warning: maximum must be greater than minimum, otherwise behavior
|
|
||||||
is undefined.
|
|
||||||
]]
|
|
||||||
}
|
}
|
||||||
get {
|
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 {
|
values {
|
||||||
min: double; [[The minimum value.]]
|
min: double; [[The minimum value.]]
|
||||||
|
@ -49,8 +45,8 @@ interface @beta Efl.Ui.Range_Display
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
events {
|
events {
|
||||||
changed: void; [[Emitted when the $range_value is getting changed]]
|
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]]
|
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]]
|
max,reached: void; [[Emitted when the $range_value has reached the maximum of @.range_limits.]]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue