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

//! Helpers for zooming the whole GUI of an app (changing [`Context::pixels_per_point`].
//!
use crate::{Button, Context, Key, KeyboardShortcut, Modifiers, Ui};

/// The suggested keyboard shortcuts for global gui zooming.
pub mod kb_shortcuts {
    use super::{Key, KeyboardShortcut, Modifiers};

    /// Primary keyboard shortcut for zooming in (`Cmd` + `+`).
    pub const ZOOM_IN: KeyboardShortcut = KeyboardShortcut::new(Modifiers::COMMAND, Key::Plus);

    /// Secondary keyboard shortcut for zooming in (`Cmd` + `=`).
    ///
    /// On an English keyboard `+` is `Shift` + `=`,
    /// but it is annoying to have to press shift.
    /// So most browsers also allow `Cmd` + `=` for zooming in.
    /// We do the same.
    pub const ZOOM_IN_SECONDARY: KeyboardShortcut =
        KeyboardShortcut::new(Modifiers::COMMAND, Key::Equals);

    /// Keyboard shortcut for zooming in (`Cmd` + `-`).
    pub const ZOOM_OUT: KeyboardShortcut = KeyboardShortcut::new(Modifiers::COMMAND, Key::Minus);

    /// Keyboard shortcut for resetting zoom in (`Cmd` + `0`).
    pub const ZOOM_RESET: KeyboardShortcut = KeyboardShortcut::new(Modifiers::COMMAND, Key::Num0);
}

/// Let the user scale the GUI (change [`Context::zoom_factor`]) by pressing
/// Cmd+Plus, Cmd+Minus or Cmd+0, just like in a browser.
///
/// By default, [`crate::Context`] calls this function at the end of each frame,
/// controllable by [`crate::Options::zoom_with_keyboard`].
pub(crate) fn zoom_with_keyboard(ctx: &Context) {
    if ctx.input_mut(|i| i.consume_shortcut(&kb_shortcuts::ZOOM_RESET)) {
        ctx.set_zoom_factor(1.0);
    } else {
        if ctx.input_mut(|i| i.consume_shortcut(&kb_shortcuts::ZOOM_IN))
            || ctx.input_mut(|i| i.consume_shortcut(&kb_shortcuts::ZOOM_IN_SECONDARY))
        {
            zoom_in(ctx);
        }
        if ctx.input_mut(|i| i.consume_shortcut(&kb_shortcuts::ZOOM_OUT)) {
            zoom_out(ctx);
        }
    }
}

const MIN_ZOOM_FACTOR: f32 = 0.2;
const MAX_ZOOM_FACTOR: f32 = 5.0;

/// Make everything larger by increasing [`Context::zoom_factor`].
pub fn zoom_in(ctx: &Context) {
    let mut zoom_factor = ctx.zoom_factor();
    zoom_factor += 0.1;
    zoom_factor = zoom_factor.clamp(MIN_ZOOM_FACTOR, MAX_ZOOM_FACTOR);
    zoom_factor = (zoom_factor * 10.).round() / 10.;
    ctx.set_zoom_factor(zoom_factor);
}

/// Make everything smaller by decreasing [`Context::zoom_factor`].
pub fn zoom_out(ctx: &Context) {
    let mut zoom_factor = ctx.zoom_factor();
    zoom_factor -= 0.1;
    zoom_factor = zoom_factor.clamp(MIN_ZOOM_FACTOR, MAX_ZOOM_FACTOR);
    zoom_factor = (zoom_factor * 10.).round() / 10.;
    ctx.set_zoom_factor(zoom_factor);
}

/// Show buttons for zooming the ui.
///
/// This is meant to be called from within a menu (See [`Ui::menu_button`]).
pub fn zoom_menu_buttons(ui: &mut Ui) {
    fn button(ctx: &Context, text: &str, shortcut: &KeyboardShortcut) -> Button<'static> {
        let btn = Button::new(text);
        let zoom_with_keyboard = ctx.options(|o| o.zoom_with_keyboard);
        if zoom_with_keyboard {
            btn.shortcut_text(ctx.format_shortcut(shortcut))
        } else {
            btn
        }
    }

    if ui
        .add_enabled(
            ui.ctx().zoom_factor() < MAX_ZOOM_FACTOR,
            button(ui.ctx(), "Zoom In", &kb_shortcuts::ZOOM_IN),
        )
        .clicked()
    {
        zoom_in(ui.ctx());
        ui.close_menu();
    }

    if ui
        .add_enabled(
            ui.ctx().zoom_factor() > MIN_ZOOM_FACTOR,
            button(ui.ctx(), "Zoom Out", &kb_shortcuts::ZOOM_OUT),
        )
        .clicked()
    {
        zoom_out(ui.ctx());
        ui.close_menu();
    }

    if ui
        .add_enabled(
            ui.ctx().zoom_factor() != 1.0,
            button(ui.ctx(), "Reset Zoom", &kb_shortcuts::ZOOM_RESET),
        )
        .clicked()
    {
        ui.ctx().set_zoom_factor(1.0);
        ui.close_menu();
    }
}