Crate drag

source ·
Expand description

Start a drag operation out of a window on macOS, Windows and Linux (via GTK).

Tested for tao (latest), winit (latest), wry (v0.24) and tauri (v1) windows.

Due to the GTK-based implementation, winit currently cannot leverage this crate on Linux yet.

  • Add the drag dependency:

$ cargo add drag

  • Use the drag::start_drag function. It takes a &T: raw_window_handle::HasRawWindowHandle type on macOS and Windows, and a &gtk::ApplicationWindow on Linux:

  • tao:

    let event_loop = tao::event_loop::EventLoop::new();
let window = tao::window::WindowBuilder::new().build(&event_loop).unwrap();

let item = drag::DragItem::Files(vec![std::fs::canonicalize("./examples/icon.png").unwrap()]);
let preview_icon = drag::Image::File("./examples/icon.png".into());

drag::start_drag(
  #[cfg(target_os = "linux")]
  {
    use tao::platform::unix::WindowExtUnix;
    window.gtk_window()
  },
  #[cfg(not(target_os = "linux"))]
  &window,
  item,
  preview_icon,
  |result, cursor_position| {
    println!("drag result: {result:?}");
  },
  drag::Options::default(),
);
    • wry:
    let event_loop = wry::application::event_loop::EventLoop::new();
let window = wry::application::window::WindowBuilder::new().build(&event_loop).unwrap();
let webview = wry::webview::WebViewBuilder::new(window).unwrap().build().unwrap();

let item = drag::DragItem::Files(vec![std::fs::canonicalize("./examples/icon.png").unwrap()]);
let preview_icon = drag::Image::File("./examples/icon.png".into());

drag::start_drag(
  #[cfg(target_os = "linux")]
  {
    use wry::application::platform::unix::WindowExtUnix;
    webview.window().gtk_window()
  },
  #[cfg(not(target_os = "linux"))]
  &webview.window(),
  item,
  preview_icon,
  |result, cursor_position| {
    println!("drag result: {result:?}");
  },
  drag::Options::default(),
);
    • winit:
    let event_loop = winit::event_loop::EventLoop::new().unwrap();
let window = winit::window::WindowBuilder::new().build(&event_loop).unwrap();

let item = drag::DragItem::Files(vec![std::fs::canonicalize("./examples/icon.png").unwrap()]);
let preview_icon = drag::Image::File("./examples/icon.png".into());

let _ = drag::start_drag(&window, item, preview_icon, |result, cursor_position| {
  println!("drag result: {result:?}");
}, Default::default());

Structs§

Enums§

Functions§

Type Aliases§