Struct smithay_clipboard::Clipboard
source · pub struct Clipboard<T> { /* private fields */ }
Expand description
Access to a Wayland clipboard.
Implementations§
source§impl<T: RawSurface> Clipboard<T>
impl<T: RawSurface> Clipboard<T>
sourcepub fn init_dnd(
&self,
tx: Box<dyn Sender<T> + Send>,
) -> Result<(), SendError<Command<T>>>
pub fn init_dnd( &self, tx: Box<dyn Sender<T> + Send>, ) -> Result<(), SendError<Command<T>>>
Set up DnD operations for the Clipboard
sourcepub fn start_dnd<D: AsMimeTypes + Send + 'static>(
&self,
internal: bool,
source_surface: T,
icon_surface: Option<Icon<T>>,
content: D,
actions: DndAction,
)
pub fn start_dnd<D: AsMimeTypes + Send + 'static>( &self, internal: bool, source_surface: T, icon_surface: Option<Icon<T>>, content: D, actions: DndAction, )
Start a DnD operation on the given surface with some data
sourcepub fn register_dnd_destination(
&self,
surface: T,
rectangles: Vec<DndDestinationRectangle>,
)
pub fn register_dnd_destination( &self, surface: T, rectangles: Vec<DndDestinationRectangle>, )
Register a surface for receiving DnD offers Rectangles should be provided in order of decreasing priority. This method c~an be called multiple time for a single surface if the rectangles change.
sourcepub fn set_action(&self, action: DndAction)
pub fn set_action(&self, action: DndAction)
Set the final action after presenting the user with a choice
sourcepub fn peek_offer<D: AllowedMimeTypes + 'static>(
&self,
mime_type: Option<MimeType>,
) -> Result<D>
pub fn peek_offer<D: AllowedMimeTypes + 'static>( &self, mime_type: Option<MimeType>, ) -> Result<D>
Peek at the contents of a DnD offer
source§impl<T: 'static + Send + Clone> Clipboard<T>
impl<T: 'static + Send + Clone> Clipboard<T>
sourcepub unsafe fn new(display: *mut c_void) -> Self
pub unsafe fn new(display: *mut c_void) -> Self
Creates new clipboard which will be running on its own thread with its own event queue to handle clipboard requests.
§Safety
display
must be a valid *mut wl_display
pointer, and it must remain
valid for as long as Clipboard
object is alive.
sourcepub fn load<D: AllowedMimeTypes + 'static>(&self) -> Result<D>
pub fn load<D: AllowedMimeTypes + 'static>(&self) -> Result<D>
Load custom clipboard data.
Load the requested type from a clipboard on the last observed seat.
sourcepub fn load_text(&self) -> Result<String>
pub fn load_text(&self) -> Result<String>
Load clipboard data.
Loads content from a clipboard on a last observed seat.
sourcepub fn load_primary<D: AllowedMimeTypes + 'static>(&self) -> Result<D>
pub fn load_primary<D: AllowedMimeTypes + 'static>(&self) -> Result<D>
Load custom primary clipboard data.
Load the requested type from a primary clipboard on the last observed seat.
sourcepub fn load_primary_text(&self) -> Result<String>
pub fn load_primary_text(&self) -> Result<String>
Load primary clipboard data.
Loads content from a primary clipboard on a last observed seat.
sourcepub fn load_mime<D: TryFrom<(Vec<u8>, MimeType)>>(
&self,
allowed: impl Into<Cow<'static, [MimeType]>>,
) -> Result<D>
pub fn load_mime<D: TryFrom<(Vec<u8>, MimeType)>>( &self, allowed: impl Into<Cow<'static, [MimeType]>>, ) -> Result<D>
Load clipboard data for sepecific mime types.
Loads content from a primary clipboard on a last observed seat.
sourcepub fn load_primary_mime<D: TryFrom<(Vec<u8>, MimeType)>>(
&self,
allowed: impl Into<Cow<'static, [MimeType]>>,
) -> Result<D>
pub fn load_primary_mime<D: TryFrom<(Vec<u8>, MimeType)>>( &self, allowed: impl Into<Cow<'static, [MimeType]>>, ) -> Result<D>
Load primary clipboard data for specific mime types.
Loads content from a primary clipboard on a last observed seat.
sourcepub fn store<D: AsMimeTypes + Send + 'static>(&self, data: D)
pub fn store<D: AsMimeTypes + Send + 'static>(&self, data: D)
Store custom data to a clipboard.
Stores data of the provided type to a clipboard on a last observed seat.
sourcepub fn store_text<D: Into<String>>(&self, text: D)
pub fn store_text<D: Into<String>>(&self, text: D)
Store to a clipboard.
Stores to a clipboard on a last observed seat.
sourcepub fn store_primary<D: AsMimeTypes + Send + 'static>(&self, data: D)
pub fn store_primary<D: AsMimeTypes + Send + 'static>(&self, data: D)
Store custom data to a primary clipboard.
Stores data of the provided type to a primary clipboard on a last observed seat.
sourcepub fn store_primary_text<D: Into<String>>(&self, text: D)
pub fn store_primary_text<D: Into<String>>(&self, text: D)
Store to a primary clipboard.
Stores to a primary clipboard on a last observed seat.
Trait Implementations§
Auto Trait Implementations§
impl<T> Freeze for Clipboard<T>
impl<T> !RefUnwindSafe for Clipboard<T>
impl<T> Send for Clipboard<T>where
T: Send,
impl<T> !Sync for Clipboard<T>
impl<T> Unpin for Clipboard<T>
impl<T> !UnwindSafe for Clipboard<T>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.