The ATK interface implemented by valuators and components which display or select a value from a bounded range of values.
More...
|
| Value (Value && src) noexcept |
|
Value & | operator= (Value && src) noexcept |
|
| ~Value () noexcept override |
|
AtkValue * | gobj () |
| Provides access to the underlying C GObject.
|
|
const AtkValue * | gobj () const |
| Provides access to the underlying C GObject.
|
|
void | get_value_and_text (double & value, Glib::ustring & text) |
| Gets the current value and the human readable text alternative.
|
|
Range | get_range () const |
| Gets the range of this object.
|
|
double | get_increment () |
| Gets the minimum increment by which the value of this object may be changed.
|
|
void | set_value (const gdouble new_value) |
| Sets the value of this object.
|
|
The ATK interface implemented by valuators and components which display or select a value from a bounded range of values.
This should be implemented for components which either display a value from a bounded range, or which allow the user to specify a value from a bounded range, or both. For instance, most sliders and range controls, as well as dials, should have Atk::Object representations which implement Atk::Value on the component's behalf. Atk::Values may be read-only, in which case attempts to alter the value return false to indicate failure.
void Atk::Value::set_value |
( |
const gdouble | new_value | ) |
|
Sets the value of this object.
This method is intended to provide a way to change the value of the object. In any case, it is possible that the value can't be modified (ie: a read-only component). If the value changes due this call, it is possible that the text could change, and will trigger an Atk::Value::signal_value_changed() signal emission.
Note for implementors: the deprecated set_current_value() method returned true
or false
depending if the value was assigned or not. In the practice several implementors were not able to decide it, and returned true
in any case. For that reason it is not required anymore to return if the value was properly assigned or not.
- Since atkmm 2.12
- Parameters
-
new_value | A double which is the desired new accessible value. |
Glib::SignalProxy< void(double, const Glib::ustring &) Atk::Value::signal_value_changed) () |
- Slot Prototype:
void on_my_value_changed(double value, const Glib::ustring& text)
Flags: Run Last
The 'value-changed' signal is emitted when the current value that represent the object changes. value is the numerical representation of this new value. text is the human readable text alternative of value, and can be nullptr
if it is not available. Note that if there is a textual description associated with the new numeric value, that description should be included regardless of whether or not it has also changed.
Example: a password meter whose value changes as the user types their new password. Appropiate value text would be "weak", "acceptable" and "strong".
- Since atkmm 2.12
- Parameters
-
value | The new value in a numerical form. |
text | Human readable text alternative (also called description) of this object. nullptr if not available. |