skyler
/
egui
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add `Context::open_url` and `Context::copy_text` (#3380) 

* Add Context::open_url

* Add `Context::copy_text`

* Fix doctest

* Fix another doctest
This commit is contained in:
Emil Ernerfeldt 2023-09-24 09:31:21 +02:00 committed by GitHub
parent d77c446572
commit 99a1b5b62e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 48 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
crates/egui/src/context.rs
View File

@ -551,10 +551,6 @@ impl Context {
) -> R {
self.write(move |ctx| writer(&mut ctx.memory.options.tessellation_options))
}
}
impl Context {
// ---------------------------------------------------------------------
/// If the given [`Id`] has been used previously the same frame at at different position,
/// then an error will be printed on screen.
@ -919,6 +915,31 @@ impl Context {
self.output_mut(|o| o.cursor_icon = cursor_icon);
}
/// Open an URL in a browser.
///
/// Equivalent to:
/// ```
/// # let ctx = egui::Context::default();
/// # let open_url = egui::OpenUrl::same_tab("http://www.example.com");
/// ctx.output_mut(|o| o.open_url = Some(open_url));
/// ```
pub fn open_url(&self, open_url: crate::OpenUrl) {
self.output_mut(|o| o.open_url = Some(open_url));
}
/// Copy the given text to the system clipboard.
///
/// Empty strings are ignored.
///
/// Equivalent to:
/// ```
/// # let ctx = egui::Context::default();
/// ctx.output_mut(|o| o.copied_text = "Copy this".to_owned());
/// ```
pub fn copy_text(&self, text: String) {
self.output_mut(|o| o.copied_text = text);
}
/// Format the given shortcut in a human-readable way (e.g. `Ctrl+Shift+X`).
///
/// Can be used to get the text for [`Button::shortcut_text`].

4
crates/egui/src/data/output.rs
View File

@ -92,7 +92,9 @@ pub struct PlatformOutput {
impl PlatformOutput {
/// Open the given url in a web browser.
///
/// If egui is running in a browser, the same tab will be reused.
#[deprecated = "Use Context::open_url instead"]
pub fn open_url(&mut self, url: impl ToString) {
self.open_url = Some(OpenUrl::same_tab(url));
}
@ -156,6 +158,8 @@ impl PlatformOutput {
}
/// What URL to open, and how.
///
/// Use with [`crate::Context::open_url`].
#[derive(Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
pub struct OpenUrl {

4
crates/egui/src/lib.rs
View File

@ -389,7 +389,9 @@ pub use {
context::{Context, RequestRepaintInfo},
data::{
input::*,
output::{self, CursorIcon, FullOutput, PlatformOutput, UserAttentionType, WidgetInfo},
output::{
self, CursorIcon, FullOutput, OpenUrl, PlatformOutput, UserAttentionType, WidgetInfo,
},
},
grid::Grid,
id::{Id, IdMap},

4
crates/egui/src/widgets/color_picker.rs
View File

@ -234,9 +234,9 @@ fn color_text_ui(ui: &mut Ui, color: impl Into<Color32>, alpha: Alpha) {
if ui.button("📋").on_hover_text("Click to copy").clicked() {
if alpha == Alpha::Opaque {
ui.output_mut(|o| o.copied_text = format!("{r}, {g}, {b}"));
ui.ctx().copy_text(format!("{r}, {g}, {b}"));
} else {
ui.output_mut(|o| o.copied_text = format!("{r}, {g}, {b}, {a}"));
ui.ctx().copy_text(format!("{r}, {g}, {b}, {a}"));
}
}

17
crates/egui/src/widgets/hyperlink.rs
View File

@ -118,21 +118,18 @@ impl Widget for Hyperlink {
let Self { url, text, new_tab } = self;
let response = ui.add(Link::new(text));
if response.clicked() {
let modifiers = ui.ctx().input(|i| i.modifiers);
ui.ctx().output_mut(|o| {
o.open_url = Some(crate::output::OpenUrl {
url: url.clone(),
new_tab: new_tab || modifiers.any(),
});
ui.ctx().open_url(crate::OpenUrl {
url: url.clone(),
new_tab: new_tab || modifiers.any(),
});
}
if response.middle_clicked() {
ui.ctx().output_mut(|o| {
o.open_url = Some(crate::output::OpenUrl {
url: url.clone(),
new_tab: true,
});
ui.ctx().open_url(crate::OpenUrl {
url: url.clone(),
new_tab: true,
});
}
response.on_hover_text(url)

2
crates/egui/src/widgets/text_edit/builder.rs
View File

@ -900,7 +900,7 @@ fn events(
let copy_if_not_password = |ui: &Ui, text: String| {
if !password {
ui.ctx().output_mut(|o| o.copied_text = text);
ui.ctx().copy_text(text);
}
};

2
crates/egui_demo_app/src/apps/http_app.rs
View File

@ -195,7 +195,7 @@ fn ui_resource(ui: &mut egui::Ui, resource: &Resource) {
if let Some(text) = &text {
let tooltip = "Click to copy the response body";
if ui.button("📋").on_hover_text(tooltip).clicked() {
ui.output_mut(|o| o.copied_text = text.clone());
ui.ctx().copy_text(text.clone());
}
ui.separator();
}

5
crates/egui_demo_app/src/wrap_app.rs
View File

@ -396,7 +396,8 @@ impl WrapApp {
{
selected_anchor = anchor;
if frame.is_web() {
ui.output_mut(|o| o.open_url(format!("#{anchor}")));
ui.ctx()
.open_url(egui::OpenUrl::same_tab(format!("#{anchor}")));
}
}
}
@ -408,7 +409,7 @@ impl WrapApp {
if clock_button(ui, crate::seconds_since_midnight()).clicked() {
self.state.selected_anchor = Anchor::Clock;
if frame.is_web() {
ui.output_mut(|o| o.open_url("#clock"));
ui.ctx().open_url(egui::OpenUrl::same_tab("#clock"));
}
}
}

2
crates/egui_demo_lib/src/demo/font_book.rs
View File

@ -93,7 +93,7 @@ impl super::View for FontBook {
};
if ui.add(button).on_hover_ui(tooltip_ui).clicked() {
ui.output_mut(|o| o.copied_text = chr.to_string());
ui.ctx().copy_text(chr.to_string());
}
}
}

2
examples/puffin_profiler/src/main.rs
View File

@ -28,7 +28,7 @@ impl eframe::App for MyApp {
ui.horizontal(|ui| {
ui.monospace(cmd);
if ui.small_button("📋").clicked() {
ui.output_mut(|o| o.copied_text = cmd.into());
ui.ctx().copy_text(cmd.into());
}
});