appcui 0.4.17

A feature-rich and cross-platform TUI/CUI framework for Rust, enabling modern terminal-based applications on Windows, Linux, and macOS. Includes built-in UI components like buttons, menus, list views, tree views, checkboxes, and more. Perfect for building fast and interactive CLI tools and text-based interfaces.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
use crate::prelude::*;
use crate::ui::hslider::{events::EventData, Flags, Type};
use crate::ui::common::NumberFormat;

const TICK_SCALE: u64 = 1000;

#[CustomControl(overwrite=OnPaint+OnKeyPressed+OnMouseEvent+OnResize, internal=true)]
pub struct HSlider<T>
where
    T: Number + 'static,
{
    value: T,
    min: T,
    max: T,
    step: T,
    tick_value: u32,
    hslider_type: Type,
    marker_pos: u32,
    buffer_value: String,
    buffer_value_max_len: u32,
    hslider_width: u32,
    hslider_pos: u32,
    format: NumberFormat,
    flags: Flags,
    pressed: bool,
    tick_normal_size: u32,
    tick_last_size: u32,
    tick_index: usize,
}

impl<T> HSlider<T>
where
    T: Number + 'static,
{
    /// Creates a horizontal slider bounded by `min` and `max`, with the given `step`, visual `hslider_type` and `flags`.
    /// The initial value is set to `min`.
    ///
    /// # Examples
    /// ```rust,no_run
    /// use appcui::prelude::*;
    ///
    /// let slider = HSlider::new(0, 10, 1, hslider::Type::Standard, layout!("x:1,y:1,w:20,h:1"), hslider::Flags::None);
    /// ```
    pub fn new(min: T, max: T, step: T, hslider_type: Type, layout: Layout, hslider_falgs: Flags) -> Self {
        Self::inner_create(min, max, step, hslider_type, hslider_falgs, layout, StatusFlags::None)
    }
    fn inner_create(min: T, max: T, step: T, hslider_type: Type, hslider_falgs: Flags, layout: Layout, status: StatusFlags) -> Self {
        let mut hslider = HSlider {
            base: ControlBase::with_status_flags(layout, StatusFlags::Visible | StatusFlags::Enabled | StatusFlags::AcceptInput | status),
            value: min,
            min,
            max,
            step,
            tick_value: 0,
            hslider_type,
            marker_pos: 0,
            flags: hslider_falgs,
            pressed: false,
            buffer_value: String::new(),
            format: NumberFormat::Decimal,
            hslider_width: 0,
            hslider_pos: 0,
            buffer_value_max_len: 0,
            tick_normal_size: 0,
            tick_last_size: 0,
            tick_index: 0,
        };
        hslider.update_metrics();
        hslider.set_buffer_value();
        hslider.set_size_bounds(1, 1, u16::MAX, 1);
        hslider
    }

    /// Sets the number of tick marks displayed along the slider.
    /// The ticks are only shown when the `Ticks` flag is set and `val` is at least 2.
    pub fn set_ticks(&mut self, val: u32) {
        self.tick_value = val;
        self.rebuild_ticks();
        self.sync_tick_index();
        self.marker_pos = self.get_marker_x_position();
        self.request_update();
    }

    /// Sets the current value of the slider.
    /// The value is clamped to the `[min, max]` range, and the marker is repositioned accordingly.
    pub fn set_value(&mut self, value: T) {
        let v = value.to_f64().clamp(self.min.to_f64(), self.max.to_f64());
        self.value = T::from_f64(v);
        self.sync_tick_index();
        self.marker_pos = self.get_marker_x_position();
        self.set_buffer_value();
        self.request_update();
        self.emit_value_changed();
    }

    /// Sets the lower bound of the slider.
    /// If the current value falls below the new minimum, it is clamped up to it.
    pub fn set_min(&mut self, min: T) {
        self.min = min;
        let v = self.value.to_f64().clamp(self.min.to_f64(), self.max.to_f64());
        self.value = T::from_f64(v);
        self.update_metrics();
        self.sync_tick_index();
        self.marker_pos = self.get_marker_x_position();
        self.set_buffer_value();
        self.request_update();
        self.emit_value_changed();
    }

    /// Sets the upper bound of the slider.
    /// If the current value exceeds the new maximum, it is clamped down to it.
    pub fn set_max(&mut self, max: T) {
        self.max = max;
        let v = self.value.to_f64().clamp(self.min.to_f64(), self.max.to_f64());
        self.value = T::from_f64(v);
        self.update_metrics();
        self.sync_tick_index();
        self.marker_pos = self.get_marker_x_position();
        self.set_buffer_value();
        self.request_update();
        self.emit_value_changed();
    }

    /// Sets the increment used when the slider value changes by one step.
    pub fn set_step(&mut self, step: T) {
        self.step = step;
    }

    /// Returns the number of tick marks configured for the slider.
    pub fn ticks(&self) -> u32 {
        self.tick_value
    }

    /// Returns the current value of the slider.
    pub fn value(&self) -> T {
        self.value
    }

    /// Returns the lower bound of the slider.
    pub fn min(&self) -> T {
        self.min
    }

    /// Returns the upper bound of the slider.
    pub fn max(&self) -> T {
        self.max
    }

    /// Returns the increment used when the slider value changes by one step.
    pub fn step(&self) -> T {
        self.step
    }

    fn rebuild_ticks(&mut self) {
        if self.tick_value < 2 {
            self.tick_normal_size = 0;
            self.tick_last_size = 0;
            self.tick_index = 0;
            return;
        }
        let (lo, hi) = self.track_bounds();
        let span = (hi - lo) as u64 * TICK_SCALE;
        let segs = (self.tick_value - 1) as u64;
        let mut normal = (span + segs / 2) / segs;
        if segs > 1 && normal * (segs - 1) > span {
            normal = span / (segs - 1);
        }
        self.tick_normal_size = normal as u32;
        self.tick_last_size = (span - normal * (segs - 1)) as u32;
        self.tick_index = self.tick_index.min(segs as usize);
    }

    fn ticks_active(&self) -> bool {
        self.flags.contains(Flags::Ticks) && self.tick_value >= 2
    }

    fn tick_index_from_x(&self, x: u32) -> usize {
        let (lo, hi) = self.track_bounds();
        let x = x.clamp(lo, hi);
        let segs = (self.tick_value - 1) as u64;
        let normal = self.tick_normal_size as u64;
        let prev_x = lo + ((normal * (segs - 1) + TICK_SCALE / 2) / TICK_SCALE) as u32;
        if x + x >= prev_x + hi {
            return segs as usize;
        }
        if normal == 0 {
            return 0;
        }
        let rel = (x - lo) as u64 * TICK_SCALE;
        (((rel + normal / 2) / normal).min(segs - 1)) as usize
    }

    fn sync_tick_index(&mut self) {
        if self.ticks_active() {
            self.tick_index = self.value_to_tick_index(self.value);
            self.value = self.index_to_value(self.tick_index);
        } else {
            self.tick_index = 0;
        }
    }

    fn value_to_tick_index(&self, value: T) -> usize {
        if self.tick_value < 2 {
            return 0;
        }
        let min = self.min.to_f64();
        let max = self.max.to_f64();
        if max - min == 0.0 {
            return 0;
        }
        let n = (self.tick_value - 1) as f64;
        let seg = (max - min) / n;
        (((value.to_f64() - min) / seg).round() as i64).clamp(0, (self.tick_value - 1) as i64) as usize
    }

    fn index_to_value(&self, idx: usize) -> T {
        if self.tick_value < 2 {
            return self.min;
        }
        let n = (self.tick_value - 1) as usize;
        if idx == 0 {
            return self.min;
        }
        if idx >= n {
            return self.max;
        }
        let min = self.min.to_f64();
        let max = self.max.to_f64();
        T::from_f64(min + idx as f64 * (max - min) / n as f64)
    }

    fn set_buffer_value(&mut self) {
        self.value.write_to_string(&mut self.buffer_value, self.format);
    }

    fn update_metrics(&mut self) {
        self.hslider_pos = 0;
        self.hslider_width = self.size().width;
        if self.flags.contains(Flags::ShowValue) || self.flags.contains(Flags::ValueAsMarker) {
            let mut b = String::new();
            self.min.write_to_string(&mut b, self.format);
            let mut val = b.len();
            self.max.write_to_string(&mut b, self.format);
            val = val.max(b.len());
            if self.flags.contains(Flags::ShowValue) {
                self.hslider_width = self.hslider_width.saturating_sub(val as u32 + 1);
            }
            self.buffer_value_max_len = val as u32;
        }
        if self.hslider_type.char_set().left_cap.is_some() {
            self.hslider_pos += 1;
            self.hslider_width = self.hslider_width.saturating_sub(1);
        }
        if self.hslider_type.char_set().right_cap.is_some() {
            self.hslider_width = self.hslider_width.saturating_sub(1);
        }

        self.rebuild_ticks();

        let (lo, hi) = self.marker_bounds();
        self.marker_pos = self.marker_pos.clamp(lo, hi);
    }

    fn marker_width(&self) -> u32 {
        if self.flags.contains(Flags::ValueAsMarker) {
            self.buffer_value_max_len.max(1)
        } else {
            1
        }
    }

    fn track_bounds(&self) -> (u32, u32) {
        let val1 = if self.hslider_type.char_set().left_marker.is_some() { 1 } else { 0 };
        let val2 = 1 + if self.hslider_type.char_set().right_marker.is_some() { 1 } else { 0 };
        let lo = self.hslider_pos + val1;
        let hi = (self.hslider_pos + self.hslider_width).saturating_sub(val2);
        (lo.min(hi), hi)
    }

    fn marker_bounds(&self) -> (u32, u32) {
        let (lo, hi) = self.track_bounds();
        (lo, hi.saturating_sub(self.marker_width() - 1).max(lo))
    }

    fn add_step_value(&mut self) {
        let old = self.value;
        if self.ticks_active() {
            if self.tick_index + 1 >= self.tick_value as usize {
                return;
            }
            self.tick_index += 1;
            self.value = self.index_to_value(self.tick_index);
        } else {
            let new_val = T::from_f64((self.value.to_f64() + self.step.to_f64()).min(self.max.to_f64()));
            if self.value == new_val {
                return;
            }
            self.value = new_val;
        }
        self.marker_pos = self.get_marker_x_position();
        self.set_buffer_value();
        self.request_update();
        if self.value != old {
            self.emit_value_changed();
        }
    }

    fn sub_step_value(&mut self) {
        let old = self.value;
        if self.ticks_active() {
            if self.tick_index == 0 {
                return;
            }
            self.tick_index -= 1;
            self.value = self.index_to_value(self.tick_index);
        } else {
            let new_val = T::from_f64((self.value.to_f64() - self.step.to_f64()).max(self.min.to_f64()));
            if self.value == new_val {
                return;
            }
            self.value = new_val;
        }
        self.marker_pos = self.get_marker_x_position();
        self.set_buffer_value();
        self.request_update();
        if self.value != old {
            self.emit_value_changed();
        }
    }

    fn set_marker_position_from_x(&mut self, x: i32) {
        let (lo, hi) = self.marker_bounds();
        let mw = self.marker_width();

        let changed = if self.ticks_active() {
            let idx = self.tick_index_from_x(x.max(0) as u32);
            self.tick_index = idx;
            let new_val = self.index_to_value(idx);
            let changed = new_val != self.value;
            self.value = new_val;
            changed
        } else {
            let clamped = ((x - (mw as i32) / 2).max(0) as u32).clamp(lo, hi);
            let span = hi.saturating_sub(lo);
            let min = self.min.to_f64();
            let max = self.max.to_f64();
            let raw = if span == 0 {
                min
            } else {
                min + ((clamped - lo) as f64 / span as f64) * (max - min)
            };
            let step = self.step.to_f64();
            let snapped = if step > 0.0 {
                (min + ((raw - min) / step).round() * step).clamp(min, max)
            } else {
                raw.clamp(min, max)
            };
            let new_val = T::from_f64(snapped);
            let changed = new_val != self.value;
            self.value = new_val;
            changed
        };

        self.marker_pos = self.get_marker_x_position();
        self.set_buffer_value();
        self.request_update();
        if changed {
            self.emit_value_changed();
        }
    }

    fn get_marker_x_position(&self) -> u32 {
        if self.ticks_active() {
            let (tlo, _) = self.track_bounds();
            let segs = (self.tick_value - 1) as u64;
            let idx = (self.tick_index as u64).min(segs);
            let normal = self.tick_normal_size as u64;
            let offset = if idx == segs {
                normal * (segs - 1) + self.tick_last_size as u64
            } else {
                idx * normal
            };
            let tick_x = tlo + ((offset + TICK_SCALE / 2) / TICK_SCALE) as u32;
            let (lo, hi) = self.marker_bounds();
            return tick_x.saturating_sub(self.marker_width() / 2).clamp(lo, hi);
        }
        let (lo, hi) = self.marker_bounds();
        let span = hi.saturating_sub(lo);
        if span == 0 {
            return lo;
        }
        let value = self.value.to_f64();
        let min = self.min.to_f64();
        let max = self.max.to_f64();
        if max - min == 0.0 {
            return lo;
        }
        let rel = ((value - min) / (max - min) * span as f64).round().clamp(0.0, span as f64) as u32;
        lo + rel
    }

    fn paint_standard(&self, surface: &mut Surface, theme: &Theme) {
        let hslider_theme = &theme.hslider;

        let left_marker_line_attr = hslider_theme.before_line;
        let right_marker_line_attr = hslider_theme.after_line;

        let left_tick_attr = hslider_theme.before_line;
        let right_tick_attr = hslider_theme.after_line;

        let marker_attr = match () {
            _ if !self.is_enabled() => hslider_theme.marker.inactive,
            _ if self.pressed => hslider_theme.marker.pressed_or_selected,
            _ if self.has_focus() => hslider_theme.marker.focused,
            _ if self.is_mouse_over() => hslider_theme.marker.hovered,
            _ => hslider_theme.marker.normal,
        };
        let left_marker_attr = match () {
            _ if !self.is_enabled() => hslider_theme.marker_border.inactive,
            _ if self.pressed => hslider_theme.marker_border.pressed_or_selected,
            _ if self.has_focus() => hslider_theme.marker_border.focused,
            _ if self.is_mouse_over() => hslider_theme.marker_border.hovered,
            _ => hslider_theme.marker_border.normal,
        };
        let right_marker_attr = left_marker_attr;

        let left_cap_attr = hslider_theme.cap;
        let right_cap_attr = hslider_theme.cap;

        let text_attr = match () {
            _ if !self.is_enabled() => theme.text.inactive,
            _ if self.has_focus() => theme.text.focused,
            _ if self.is_mouse_over() => theme.text.hovered,
            _ => theme.text.normal,
        };

        let mw = self.marker_width();

        let left_marker_line = Character::with_attributes(self.hslider_type.char_set().left_marker_line, left_marker_line_attr);
        let size = self.marker_pos.saturating_sub(self.hslider_pos);
        surface.fill_horizontal_line_with_size(self.hslider_pos as i32, 0, size, left_marker_line);

        let right_marker_line = Character::with_attributes(self.hslider_type.char_set().right_marker_line, right_marker_line_attr);
        let right_start = self.marker_pos + mw;
        let size = (self.hslider_pos + self.hslider_width).saturating_sub(right_start);
        surface.fill_horizontal_line_with_size(right_start as i32, 0, size, right_marker_line);

        if self.flags.contains(Flags::Ticks) && self.tick_value >= 2 {
            let marker_start = self.marker_pos;
            let marker_end = self.marker_pos + mw;

            let left_tick = Character::with_attributes(self.hslider_type.char_set().left_tick, left_tick_attr);
            let right_tick = Character::with_attributes(self.hslider_type.char_set().right_tick, right_tick_attr);
            let tick_left = Character::with_attributes(self.hslider_type.char_set().tick, left_marker_line_attr);
            let tick_right = Character::with_attributes(self.hslider_type.char_set().tick, right_marker_line_attr);

            let draw_tick = |surface: &mut Surface, x: u32, ch| {
                if x < marker_start || x >= marker_end {
                    surface.write_char(x as i32, 0, ch);
                }
            };

            let (tlo, _) = self.track_bounds();
            let segs = (self.tick_value - 1) as u64;
            let normal = self.tick_normal_size as u64;
            for k in 1..segs {
                let x = tlo + ((k * normal + TICK_SCALE / 2) / TICK_SCALE) as u32;
                let ch = if x < marker_start { tick_left } else { tick_right };
                draw_tick(surface, x, ch);
            }
            draw_tick(surface, tlo, left_tick);
            let last = normal * (segs - 1) + self.tick_last_size as u64;
            draw_tick(surface, tlo + ((last + TICK_SCALE / 2) / TICK_SCALE) as u32, right_tick);
        }

        if let Some(code) = self.hslider_type.char_set().left_marker {
            let left_marker = Character::with_attributes(code, left_marker_attr);
            surface.write_char(self.marker_pos.saturating_sub(1) as i32, 0, left_marker);
        }

        if let Some(code) = self.hslider_type.char_set().right_marker {
            let right_marker = Character::with_attributes(code, right_marker_attr);
            surface.write_char((self.marker_pos + mw) as i32, 0, right_marker);
        }

        let marker = Character::with_attributes(self.hslider_type.char_set().marker, marker_attr);
        if self.flags.contains(Flags::ValueAsMarker) {
            surface.write_string(
                self.marker_pos as i32 + self.buffer_value_max_len.saturating_sub(self.buffer_value.len() as u32) as i32,
                0,
                &self.buffer_value,
                text_attr,
                false,
            );
        } else {
            surface.write_char(self.marker_pos as i32, 0, marker);
        }

        if let Some(code) = self.hslider_type.char_set().left_cap {
            let left_cap = Character::with_attributes(code, left_cap_attr);
            surface.write_char(self.hslider_pos.saturating_sub(1) as i32, 0, left_cap);
        }

        if let Some(code) = self.hslider_type.char_set().right_cap {
            let right_cap = Character::with_attributes(code, right_cap_attr);
            surface.write_char((self.hslider_pos + self.hslider_width) as i32, 0, right_cap);
        }

        if self.flags.contains(Flags::ShowValue) {
            let cap = if self.hslider_type.char_set().right_cap.is_some() { 1 } else { 0 };
            let pad = self.buffer_value_max_len.saturating_sub(self.buffer_value.len() as u32);
            let text_x = (self.hslider_pos + self.hslider_width + pad) as i32 + cap + 1;
            surface.write_string(text_x, 0, &self.buffer_value, text_attr, false);
        }
    }

    fn emit_value_changed(&mut self) {
        self.raise_event(ControlEvent {
            emitter: self.handle,
            receiver: self.event_processor,
            data: ControlEventData::HSliderEvents(EventData {
                type_id: std::any::TypeId::of::<T>(),
            }),
        });
    }
}

impl<T> OnKeyPressed for HSlider<T>
where
    T: Number + 'static,
{
    fn on_key_pressed(&mut self, key: Key, _character: char) -> EventProcessStatus {
        match key.value() {
            key!("Left") => {
                self.sub_step_value();
                self.hide_tooltip();
                EventProcessStatus::Processed
            }
            key!("Right") => {
                self.add_step_value();
                self.hide_tooltip();
                EventProcessStatus::Processed
            }
            _ => EventProcessStatus::Ignored,
        }
    }
}

impl<T> OnPaint for HSlider<T>
where
    T: Number + 'static,
{
    fn on_paint(&self, surface: &mut Surface, theme: &Theme) {
        self.paint_standard(surface, theme);
    }
}
impl<T> OnMouseEvent for HSlider<T>
where
    T: Number + 'static,
{
    fn on_mouse_event(&mut self, event: &MouseEvent) -> EventProcessStatus {
        match event {
            MouseEvent::Pressed(mouse) => {
                self.pressed = true;
                self.set_marker_position_from_x(mouse.x);
                self.show_tooltip(&self.buffer_value);
                EventProcessStatus::Processed
            }
            MouseEvent::Released(_) => {
                self.pressed = false;
                self.hide_tooltip();
                self.request_update();
                EventProcessStatus::Processed
            }
            MouseEvent::Drag(mouse) => {
                self.set_marker_position_from_x(mouse.x);
                self.show_tooltip(&self.buffer_value);
                EventProcessStatus::Processed
            }
            MouseEvent::Enter => {
                self.show_tooltip(&self.buffer_value);
                EventProcessStatus::Processed
            }
            MouseEvent::Leave => {
                self.pressed = false;
                self.hide_tooltip();
                self.request_update();
                EventProcessStatus::Processed
            }
            MouseEvent::Wheel(dir) => {
                match dir {
                    MouseWheelDirection::Down | MouseWheelDirection::Right => {
                        self.sub_step_value();
                        self.show_tooltip(&self.buffer_value);
                    }
                    MouseWheelDirection::Up | MouseWheelDirection::Left => {
                        self.add_step_value();
                        self.show_tooltip(&self.buffer_value);
                    }
                }
                EventProcessStatus::Processed
            }
            _ => EventProcessStatus::Ignored,
        }
    }
}

impl<T> OnResize for HSlider<T>
where
    T: Number + 'static,
{
    fn on_resize(&mut self, _old_size: Size, _new_size: Size) {
        self.update_metrics();
        self.marker_pos = self.get_marker_x_position();
    }
}