Struct stdweb::web::event::DataTransfer

pub struct DataTransfer(_);

The DataTransfer object is used to hold the data that is being dragged during a drag and drop operation.

It may hold one or more data items, each of one or more data types. For more information about drag and drop, see HTML Drag and Drop API.

(JavaScript docs)

Methods

impl DataTransfer

pub fn drop_effect(&self) -> DropEffect

Gets the type of drag-and-drop operation currently selected type. The value must be none, copy, link or move.

(JavaScript docs)

pub fn set_drop_effect(&self, value: DropEffect)

Sets the type of drag-and-drop operation currently selected. The value must be none, copy, link or move.

(Javascript docs)

pub fn effect_allowed(&self) -> EffectAllowed

Provides all of the types of operations that are possible. Must be one of none, copy, copyLink, copyMove, link, linkMove, move, all or uninitialized.

(JavaScript docs)

pub fn set_effect_allowed(&self, value: EffectAllowed)

Sets the effect that is allowed for a drag operation. Must be one of none, copy, copyLink, copyMove, link, linkMove, move, all or uninitialized.

(Javascript docs)

pub fn items(&self) -> DataTransferItemList

Gives a DataTransferItemList object which is a list of all of the drag data.

(Javascript docs)

pub fn files(&self) -> FileList

Contains a list of all the local files available on the data transfer. If the drag operation doesn't involve dragging files, this property is an empty list.

(Javascript docs)

pub fn types(&self) -> Vec<String>

An array of strings giving the formats that were set in the dragstart event.

(Javascript docs)

pub fn clear_data(&self, format: Option<&str>)

Remove the data associated with a given type. The type argument is optional. If the type is empty or not specified, the data associated with all types is removed. If data for the specified type does not exist, or the data transfer contains no data, this method will have no effect.

(Javascript docs)

pub fn get_data(&self, format: &str) -> String

Retrieves the data for a given type, or an empty string if data for that type does not exist or the data transfer contains no data.

(Javascript docs)

pub fn set_data(&self, format: &str, data: &str)

Set the data for a given type. If data for the type does not exist, it is added at the end, such that the last item in the types list will be the new format. If data for the type already exists, the existing data is replaced in the same position.

(Javascript docs)

pub fn set_drag_image(&self, img: &ImageElement, x_offset: i32, y_offset: i32)

Set the image to be used for dragging if a custom one is desired.

(Javascript docs)

Trait Implementations

impl JsSerialize for DataTransfer

impl TryFrom<DataTransfer> for Reference

type Error = Void

The type returned in the event of a conversion error.

fn try_from(value: DataTransfer) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Reference> for DataTransfer

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(reference: Reference) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_r> TryFrom<&'_r Reference> for DataTransfer

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(reference: &Reference) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for DataTransfer

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_r> TryFrom<&'_r Value> for DataTransfer

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl InstanceOf for DataTransfer

fn instance_of(reference: &Reference) -> bool

Checks whenever a given Reference if of type Self.

impl ReferenceType for DataTransfer

unsafe fn from_reference_unchecked(reference: Reference) -> Self

Converts a given reference into a concrete reference-like wrapper. Doesn't do any type checking; highly unsafe to use!

impl AsRef<Reference> for DataTransfer

fn as_ref(&self) -> &Reference

Performs the conversion.

impl From<DataTransfer> for Reference

fn from(value: DataTransfer) -> Self

Performs the conversion.

impl Clone for DataTransfer

fn clone(&self) -> DataTransfer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Eq for DataTransfer

impl PartialEq<DataTransfer> for DataTransfer

fn eq(&self, other: &DataTransfer) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &DataTransfer) -> bool

This method tests for !=.

impl Debug for DataTransfer

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.