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
//! Access the clipboard.
use std::{any::Any, sync::Arc};
use dnd::{DndAction, DndDestinationRectangle, DndSurface};
use mime::{self, AllowedMimeTypes, AsMimeTypes, ClipboardStoreData};
use crate::{widget::tree::State, window, Element};
/// A buffer for short-term storage and transfer within and between
/// applications.
pub trait Clipboard {
/// Reads the current content of the [`Clipboard`] as text.
fn read(&self) -> Option<String>;
/// Writes the given text contents to the [`Clipboard`].
fn write(&mut self, contents: String);
/// Read the current content of the primary [`Clipboard`] as text.
fn read_primary(&self) -> Option<String> {
None
}
/// Writes the given text contents to the primary [`Clipboard`].
fn write_primary(&mut self, _contents: String) {}
/// Consider using [`read_data`] instead
/// Reads the current content of the [`Clipboard`] as text.
fn read_data(&self, _mimes: Vec<String>) -> Option<(Vec<u8>, String)> {
None
}
/// Writes the given contents to the [`Clipboard`].
fn write_data(
&mut self,
_contents: ClipboardStoreData<
Box<dyn Send + Sync + 'static + mime::AsMimeTypes>,
>,
) {
}
/// Consider using [`read_primary_data`] instead
/// Reads the current content of the primary [`Clipboard`] as text.
fn read_primary_data(
&self,
_mimes: Vec<String>,
) -> Option<(Vec<u8>, String)> {
None
}
/// Writes the given text contents to the primary [`Clipboard`].
fn write_primary_data(
&mut self,
_contents: ClipboardStoreData<
Box<dyn Send + Sync + 'static + mime::AsMimeTypes>,
>,
) {
}
/// Starts a DnD operation.
fn register_dnd_destination(
&self,
_surface: DndSurface,
_rectangles: Vec<DndDestinationRectangle>,
) {
}
/// Set the final action for the DnD operation.
/// Only should be done if it is requested.
fn set_action(&self, _action: DndAction) {}
/// Registers Dnd destinations
fn start_dnd(
&self,
_internal: bool,
_source_surface: Option<DndSource>,
_icon_surface: Option<Box<dyn Any>>,
_content: Box<dyn AsMimeTypes + Send + 'static>,
_actions: DndAction,
) {
}
/// Ends a DnD operation.
fn end_dnd(&self) {}
/// Consider using [`peek_dnd`] instead
/// Peeks the data on the DnD with a specific mime type.
/// Will return an error if there is no ongoing DnD operation.
fn peek_dnd(&self, _mime: String) -> Option<(Vec<u8>, String)> {
None
}
}
/// Starts a DnD operation.
/// icon surface is a tuple of the icon element and optionally the icon element state.
pub fn start_dnd<T: 'static, R: 'static, M: 'static>(
clipboard: &mut dyn Clipboard,
internal: bool,
source_surface: Option<DndSource>,
icon_surface: Option<(Element<'static, M, T, R>, State)>,
content: Box<dyn AsMimeTypes + Send + 'static>,
actions: DndAction,
) {
clipboard.start_dnd(
internal,
source_surface,
icon_surface.map(|i| {
let i: Box<dyn Any> = Box::new(Arc::new(i));
i
}),
content,
actions,
);
}
/// A null implementation of the [`Clipboard`] trait.
#[derive(Debug, Clone, Copy)]
pub struct Null;
impl Clipboard for Null {
fn read(&self) -> Option<String> {
None
}
fn write(&mut self, _contents: String) {}
}
/// Reads the current content of the [`Clipboard`].
pub fn read_data<T: AllowedMimeTypes>(
clipboard: &mut dyn Clipboard,
) -> Option<T> {
clipboard
.read_data(T::allowed().into())
.and_then(|data| T::try_from(data).ok())
}
/// Reads the current content of the primary [`Clipboard`].
pub fn read_primary_data<T: AllowedMimeTypes>(
clipboard: &mut dyn Clipboard,
) -> Option<T> {
clipboard
.read_data(T::allowed().into())
.and_then(|data| T::try_from(data).ok())
}
/// Reads the current content of the primary [`Clipboard`].
pub fn peek_dnd<T: AllowedMimeTypes>(
clipboard: &mut dyn Clipboard,
mime: Option<String>,
) -> Option<T> {
let Some(mime) = mime.or_else(|| T::allowed().first().cloned().into())
else {
return None;
};
clipboard
.peek_dnd(mime)
.and_then(|data| T::try_from(data).ok())
}
/// Source of a DnD operation.
#[derive(Debug, Clone)]
pub enum DndSource {
/// A widget is the source of the DnD operation.
Widget(crate::id::Id),
/// A surface is the source of the DnD operation.
Surface(window::Id),
}
/// A list of DnD destination rectangles.
#[derive(Debug, Clone)]
pub struct DndDestinationRectangles {
/// The rectangle of the DnD destination.
rectangles: Vec<DndDestinationRectangle>,
}
impl DndDestinationRectangles {
/// Creates a new [`DndDestinationRectangles`].
pub fn new() -> Self {
Self {
rectangles: Vec::new(),
}
}
/// Creates a new [`DndDestinationRectangles`] with the given capacity.
pub fn with_capacity(capacity: usize) -> Self {
Self {
rectangles: Vec::with_capacity(capacity),
}
}
/// Pushes a new rectangle to the list of DnD destination rectangles.
pub fn push(&mut self, rectangle: DndDestinationRectangle) {
self.rectangles.push(rectangle);
}
/// Appends the list of DnD destination rectangles to the current list.
pub fn append(&mut self, other: &mut Vec<DndDestinationRectangle>) {
self.rectangles.append(other);
}
/// Returns the list of DnD destination rectangles.
/// This consumes the [`DndDestinationRectangles`].
pub fn into_rectangles(mut self) -> Vec<DndDestinationRectangle> {
self.rectangles.reverse();
self.rectangles
}
}
impl AsRef<[DndDestinationRectangle]> for DndDestinationRectangles {
fn as_ref(&self) -> &[DndDestinationRectangle] {
&self.rectangles
}
}