Struct DrawingToolShortcuts 

pub struct DrawingToolShortcuts { /* private fields */ }

Keyboard shortcuts for drawing tools

Examples

use egui_charts::ui::drawing_toolbar::DrawingToolShortcuts;
use egui_charts::drawings::DrawingToolType;
use egui::{KeyboardShortcut, Key, Modifiers};

let mut shortcuts = DrawingToolShortcuts::new();

// Add custom shortcut
shortcuts.add_shortcut(
    KeyboardShortcut::new(Modifiers::CTRL, Key::D),
    DrawingToolType::TrendLine
);

Implementations

impl DrawingToolShortcuts

pub fn new() -> Self

Create a DrawingToolShortcuts with default settings.

pub fn check(&self, ctx: &Context) -> Option<DrawingToolType>

Check for keyboard shortcuts and return the tool if one was triggered

Examples

use egui::{Event, Key, Modifiers, RawInput};
use egui_charts::drawings::DrawingToolType;
use egui_charts::ui::drawing_toolbar::DrawingToolShortcuts;

let shortcuts = DrawingToolShortcuts::new();
let ctx = egui::Context::default();

// A frame in which the user pressed Alt+T.
let mut input = RawInput::default();
input.events.push(Event::Key {
    key: Key::T,
    physical_key: None,
    pressed: true,
    repeat: false,
    modifiers: Modifiers::ALT,
});

let mut triggered = None;
ctx.run_ui(input, |ui| triggered = shortcuts.check(ui.ctx()))
    .drop_without_applying_deltas();
assert_eq!(triggered, Some(DrawingToolType::TrendLine));

pub fn add_shortcut( &mut self, shortcut: KeyboardShortcut, tool: DrawingToolType, )

Add a custom shortcut

Examples

let mut shortcuts = DrawingToolShortcuts::new();
shortcuts.add_shortcut(
    KeyboardShortcut::new(Modifiers::CTRL, Key::T),
    DrawingToolType::TrendLine
);

pub fn help_text(&self) -> Vec<(String, String)>

Get help text for shortcuts

Returns a list of (shortcut_text, tool_name) pairs, such as (“Alt+T”, “Trend Line”).

Examples

let shortcuts = DrawingToolShortcuts::new();
for (key, tool) in shortcuts.help_text() {
    println!("{}: {}", key, tool);
}

Trait Implementations

impl Default for DrawingToolShortcuts

fn default() -> Self

Returns the “default value” for a type.