pub struct DragValue<'a> {
get_set_value: Box<dyn FnMut(Option<f64>) -> f64 + 'a>,
speed: f64,
prefix: String,
suffix: String,
range: RangeInclusive<f64>,
clamp_to_range: bool,
min_decimals: usize,
max_decimals: Option<usize>,
custom_formatter: Option<Box<dyn Fn(f64, RangeInclusive<usize>) -> String + 'a>>,
custom_parser: Option<Box<dyn Fn(&str) -> Option<f64> + 'a>>,
update_while_editing: bool,
}
Expand description
A numeric value that you can change by dragging the number. More compact than a Slider
.
ui.add(egui::DragValue::new(&mut my_f32).speed(0.1));
Fields§
§get_set_value: Box<dyn FnMut(Option<f64>) -> f64 + 'a>
§speed: f64
§prefix: String
§suffix: String
§range: RangeInclusive<f64>
§clamp_to_range: bool
§min_decimals: usize
§max_decimals: Option<usize>
§custom_formatter: Option<Box<dyn Fn(f64, RangeInclusive<usize>) -> String + 'a>>
§custom_parser: Option<Box<dyn Fn(&str) -> Option<f64> + 'a>>
§update_while_editing: bool
Implementations§
source§impl<'a> DragValue<'a>
impl<'a> DragValue<'a>
pub fn new<Num: Numeric>(value: &'a mut Num) -> Self
pub fn from_get_set(get_set_value: impl 'a + FnMut(Option<f64>) -> f64) -> Self
sourcepub fn speed(self, speed: impl Into<f64>) -> Self
pub fn speed(self, speed: impl Into<f64>) -> Self
How much the value changes when dragged one point (logical pixel).
Should be finite and greater than zero.
sourcepub fn clamp_range<Num: Numeric>(self, range: RangeInclusive<Num>) -> Self
👎Deprecated: Use range
instead
pub fn clamp_range<Num: Numeric>(self, range: RangeInclusive<Num>) -> Self
range
insteadSets valid range for the value.
By default all values are clamped to this range, even when not interacted with.
You can change this behavior by passing false
to Slider::clamp_to_range
.
sourcepub fn range<Num: Numeric>(self, range: RangeInclusive<Num>) -> Self
pub fn range<Num: Numeric>(self, range: RangeInclusive<Num>) -> Self
Sets valid range for dragging the value.
By default all values are clamped to this range, even when not interacted with.
You can change this behavior by passing false
to Slider::clamp_to_range
.
sourcepub fn clamp_to_range(self, clamp_to_range: bool) -> Self
pub fn clamp_to_range(self, clamp_to_range: bool) -> Self
If set to true
, all incoming and outgoing values will be clamped to the sliding Self::range
(if any).
If set to false
, a value outside of the range that is set programmatically or by user input will not be changed.
Dragging will be restricted to the range regardless of this setting.
Default: true
.
sourcepub fn suffix(self, suffix: impl ToString) -> Self
pub fn suffix(self, suffix: impl ToString) -> Self
Add a suffix to the number, this can be e.g. a unit (“°” or “ m“)
sourcepub fn min_decimals(self, min_decimals: usize) -> Self
pub fn min_decimals(self, min_decimals: usize) -> Self
Set a minimum number of decimals to display. Normally you don’t need to pick a precision, as the slider will intelligently pick a precision for you. Regardless of precision the slider will use “smart aim” to help the user select nice, round values.
sourcepub fn max_decimals(self, max_decimals: usize) -> Self
pub fn max_decimals(self, max_decimals: usize) -> Self
Set a maximum number of decimals to display. Values will also be rounded to this number of decimals. Normally you don’t need to pick a precision, as the slider will intelligently pick a precision for you. Regardless of precision the slider will use “smart aim” to help the user select nice, round values.
pub fn max_decimals_opt(self, max_decimals: Option<usize>) -> Self
sourcepub fn fixed_decimals(self, num_decimals: usize) -> Self
pub fn fixed_decimals(self, num_decimals: usize) -> Self
Set an exact number of decimals to display. Values will also be rounded to this number of decimals. Normally you don’t need to pick a precision, as the slider will intelligently pick a precision for you. Regardless of precision the slider will use “smart aim” to help the user select nice, round values.
sourcepub fn custom_formatter(
self,
formatter: impl 'a + Fn(f64, RangeInclusive<usize>) -> String,
) -> Self
pub fn custom_formatter( self, formatter: impl 'a + Fn(f64, RangeInclusive<usize>) -> String, ) -> Self
Set custom formatter defining how numbers are converted into text.
A custom formatter takes a f64
for the numeric value and a RangeInclusive<usize>
representing
the decimal range i.e. minimum and maximum number of decimal places shown.
The default formatter is Style::number_formatter
.
See also: DragValue::custom_parser
ui.add(egui::DragValue::new(&mut my_i32)
.range(0..=((60 * 60 * 24) - 1))
.custom_formatter(|n, _| {
let n = n as i32;
let hours = n / (60 * 60);
let mins = (n / 60) % 60;
let secs = n % 60;
format!("{hours:02}:{mins:02}:{secs:02}")
})
.custom_parser(|s| {
let parts: Vec<&str> = s.split(':').collect();
if parts.len() == 3 {
parts[0].parse::<i32>().and_then(|h| {
parts[1].parse::<i32>().and_then(|m| {
parts[2].parse::<i32>().map(|s| {
((h * 60 * 60) + (m * 60) + s) as f64
})
})
})
.ok()
} else {
None
}
}));
sourcepub fn custom_parser(self, parser: impl 'a + Fn(&str) -> Option<f64>) -> Self
pub fn custom_parser(self, parser: impl 'a + Fn(&str) -> Option<f64>) -> Self
Set custom parser defining how the text input is parsed into a number.
A custom parser takes an &str
to parse into a number and returns a f64
if it was successfully parsed
or None
otherwise.
See also: DragValue::custom_formatter
ui.add(egui::DragValue::new(&mut my_i32)
.range(0..=((60 * 60 * 24) - 1))
.custom_formatter(|n, _| {
let n = n as i32;
let hours = n / (60 * 60);
let mins = (n / 60) % 60;
let secs = n % 60;
format!("{hours:02}:{mins:02}:{secs:02}")
})
.custom_parser(|s| {
let parts: Vec<&str> = s.split(':').collect();
if parts.len() == 3 {
parts[0].parse::<i32>().and_then(|h| {
parts[1].parse::<i32>().and_then(|m| {
parts[2].parse::<i32>().map(|s| {
((h * 60 * 60) + (m * 60) + s) as f64
})
})
})
.ok()
} else {
None
}
}));
sourcepub fn binary(self, min_width: usize, twos_complement: bool) -> Self
pub fn binary(self, min_width: usize, twos_complement: bool) -> Self
Set custom_formatter
and custom_parser
to display and parse numbers as binary integers. Floating point
numbers are not supported.
min_width
specifies the minimum number of displayed digits; if the number is shorter than this, it will be
prefixed with additional 0s to match min_width
.
If twos_complement
is true, negative values will be displayed as the 2’s complement representation. Otherwise
they will be prefixed with a ‘-’ sign.
§Panics
Panics if min_width
is 0.
ui.add(egui::DragValue::new(&mut my_i32).binary(64, false));
sourcepub fn octal(self, min_width: usize, twos_complement: bool) -> Self
pub fn octal(self, min_width: usize, twos_complement: bool) -> Self
Set custom_formatter
and custom_parser
to display and parse numbers as octal integers. Floating point
numbers are not supported.
min_width
specifies the minimum number of displayed digits; if the number is shorter than this, it will be
prefixed with additional 0s to match min_width
.
If twos_complement
is true, negative values will be displayed as the 2’s complement representation. Otherwise
they will be prefixed with a ‘-’ sign.
§Panics
Panics if min_width
is 0.
ui.add(egui::DragValue::new(&mut my_i32).octal(22, false));
sourcepub fn hexadecimal(
self,
min_width: usize,
twos_complement: bool,
upper: bool,
) -> Self
pub fn hexadecimal( self, min_width: usize, twos_complement: bool, upper: bool, ) -> Self
Set custom_formatter
and custom_parser
to display and parse numbers as hexadecimal integers. Floating point
numbers are not supported.
min_width
specifies the minimum number of displayed digits; if the number is shorter than this, it will be
prefixed with additional 0s to match min_width
.
If twos_complement
is true, negative values will be displayed as the 2’s complement representation. Otherwise
they will be prefixed with a ‘-’ sign.
§Panics
Panics if min_width
is 0.
ui.add(egui::DragValue::new(&mut my_i32).hexadecimal(16, false, true));
sourcepub fn update_while_editing(self, update: bool) -> Self
pub fn update_while_editing(self, update: bool) -> Self
Update the value on each key press when text-editing the value.
Default: true
.
If false
, the value will only be updated when user presses enter or deselects the value.