chore: docs

This commit is contained in:
Ashley Wulber 2024-03-25 15:42:16 -04:00
parent 2c39b92611
commit 504d07cd83
No known key found for this signature in database
GPG key ID: 5216D4F46A90A820
2 changed files with 6 additions and 6 deletions

View file

@ -65,7 +65,7 @@ pub enum SourceEvent {
/// If [`None`], no mime types are accepted. /// If [`None`], no mime types are accepted.
Mime(Option<MimeType>), Mime(Option<MimeType>),
/// DnD Dropped. The operation is still ongoing until receiving a /// DnD Dropped. The operation is still ongoing until receiving a
/// [`Finished`] event. /// [`SourceEvent::Finished`] event.
Dropped, Dropped,
} }
@ -88,7 +88,7 @@ pub enum OfferEvent<T> {
/// An offer was dropped /// An offer was dropped
Drop, Drop,
/// If the selected action is ASK, the user must be presented with a choice. /// If the selected action is ASK, the user must be presented with a choice.
/// [`Clipboard::set_actions`] should then be called before data can be /// [`Clipboard::set_action`] should then be called before data can be
/// requested and th DnD operation can be finished. /// requested and th DnD operation can be finished.
SelectedAction(DndAction), SelectedAction(DndAction),
Data { Data {
@ -97,7 +97,7 @@ pub enum OfferEvent<T> {
}, },
} }
/// A rectangle with a logical location and size relative to a [`Surface`] /// A rectangle with a logical location and size relative to a [`DndSurface`]
#[derive(Debug, Default, Clone)] #[derive(Debug, Default, Clone)]
pub struct Rectangle { pub struct Rectangle {
pub x: f64, pub x: f64,
@ -128,7 +128,7 @@ pub struct DndDestinationRectangle {
pub enum DndRequest<T> { pub enum DndRequest<T> {
/// Init DnD /// Init DnD
InitDnD(Box<dyn crate::dnd::Sender<T> + Send>), InitDnd(Box<dyn crate::dnd::Sender<T> + Send>),
/// Register a surface for receiving Dnd events. /// Register a surface for receiving Dnd events.
Surface(DndSurface<T>, Vec<DndDestinationRectangle>), Surface(DndSurface<T>, Vec<DndDestinationRectangle>),
/// Start a Dnd operation with the given source surface and data. /// Start a Dnd operation with the given source surface and data.
@ -171,7 +171,7 @@ impl<T: RawSurface> Clipboard<T> {
&self, &self,
tx: Box<dyn Sender<T> + Send>, tx: Box<dyn Sender<T> + Send>,
) -> Result<(), SendError<crate::worker::Command<T>>> { ) -> Result<(), SendError<crate::worker::Command<T>>> {
self.request_sender.send(crate::worker::Command::DndRequest(DndRequest::InitDnD(tx))) self.request_sender.send(crate::worker::Command::DndRequest(DndRequest::InitDnd(tx)))
} }
/// Start a DnD operation on the given surface with some data /// Start a DnD operation on the given surface with some data

View file

@ -248,7 +248,7 @@ where
pub(crate) fn handle_dnd_request(&mut self, r: DndRequest<T>) { pub(crate) fn handle_dnd_request(&mut self, r: DndRequest<T>) {
match r { match r {
DndRequest::InitDnD(sender) => self.dnd_state.sender = Some(sender), DndRequest::InitDnd(sender) => self.dnd_state.sender = Some(sender),
DndRequest::Surface(s, dests) => { DndRequest::Surface(s, dests) => {
self.dnd_state.destinations.insert(s.surface.id(), (s, dests)); self.dnd_state.destinations.insert(s.surface.id(), (s, dests));
}, },