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 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
#[cfg(feature = "futures-support")] use futures_channel::oneshot; use webapi::event::{IEvent, IUiEvent, UiEvent, Event}; use webapi::events::mouse::{IMouseEvent, MouseEvent}; use webapi::file::File; use webcore::once::Once; use webcore::value::{Reference, Value}; use webcore::try_from::TryInto; use webapi::file_list::FileList; use webapi::html_elements::ImageElement; use webapi::dom_exception::NotSupportedError; use webapi::dom_exception::InvalidStateError; /// The DragEvent interface is a DOM event that represents a drag and drop interaction. /// The user initiates a drag by placing a pointer device (such as a mouse) on the touch surface /// and then dragging the pointer to a new location (such as another DOM element). /// /// This interface inherits properties from MouseEvent and Event. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/DragEvent) // https://www.w3.org/TR/html51/editing.html#dragevent-dragevent pub trait IDragEvent: IMouseEvent { /// The DataEvent.dataTransfer property holds the drag operation's data (as a DataTransfer object). /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/DragEvent/dataTransfer) // https://www.w3.org/TR/html51/editing.html#ref-for-dom-dragevent-datatransfer-1 #[inline] fn data_transfer(&self) -> Option<DataTransfer> { js!( return @{self.as_ref()}.dataTransfer; ).try_into().unwrap() } } /// A reference to a JavaScript object which implements the [IDragEvent](trait.IDragEvent.html) /// interface. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/DragEvent) // https://www.w3.org/TR/html51/editing.html#the-dragevent-interface #[derive(Clone, Debug, PartialEq, Eq, ReferenceType)] #[reference(instance_of = "DragEvent")] #[reference(subclass_of(Event, UiEvent, MouseEvent))] pub struct DragRelatedEvent(Reference); impl IEvent for DragRelatedEvent {} impl IUiEvent for DragRelatedEvent {} impl IMouseEvent for DragRelatedEvent {} impl IDragEvent for DragRelatedEvent {} /// The drag event is fired every few hundred milliseconds as an element or text selection is being /// dragged by the user. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/Events/drag) // https://www.w3.org/TR/html51/editing.html#eventdef-global-drag #[derive(Clone, Debug, PartialEq, Eq, ReferenceType)] #[reference(instance_of = "DragEvent")] #[reference(event = "drag")] #[reference(subclass_of(Event, UiEvent, MouseEvent, DragRelatedEvent))] pub struct DragEvent(Reference); impl IEvent for DragEvent {} impl IUiEvent for DragEvent {} impl IMouseEvent for DragEvent {} impl IDragEvent for DragEvent {} /// The dragstart event is fired when the user starts dragging an element or text selection. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/Events/dragstart) // https://www.w3.org/TR/html51/editing.html#eventdef-global-dragstart #[derive(Clone, Debug, PartialEq, Eq, ReferenceType)] #[reference(instance_of = "DragEvent")] #[reference(event = "dragstart")] #[reference(subclass_of(Event, UiEvent, MouseEvent, DragRelatedEvent))] pub struct DragStartEvent(Reference); impl IEvent for DragStartEvent {} impl IUiEvent for DragStartEvent {} impl IMouseEvent for DragStartEvent {} impl IDragEvent for DragStartEvent {} /// The dragenter event is fired when a dragged element or text selection enters a valid drop target. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/Events/dragenter) // https://www.w3.org/TR/html51/editing.html#eventdef-global-dragenter #[derive(Clone, Debug, PartialEq, Eq, ReferenceType)] #[reference(instance_of = "DragEvent")] #[reference(event = "dragenter")] #[reference(subclass_of(Event, UiEvent, MouseEvent, DragRelatedEvent))] pub struct DragEnterEvent(Reference); impl IEvent for DragEnterEvent {} impl IUiEvent for DragEnterEvent {} impl IMouseEvent for DragEnterEvent {} impl IDragEvent for DragEnterEvent {} /// The dragexit event is fired when an element is no longer the drag operation's immediate /// selection target. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/Events/dragexit) // https://www.w3.org/TR/html51/editing.html#eventdef-global-dragexit #[derive(Clone, Debug, PartialEq, Eq, ReferenceType)] #[reference(instance_of = "DragEvent")] #[reference(event = "dragexit")] #[reference(subclass_of(Event, UiEvent, MouseEvent, DragRelatedEvent))] pub struct DragExitEvent(Reference); impl IEvent for DragExitEvent {} impl IUiEvent for DragExitEvent {} impl IMouseEvent for DragExitEvent {} impl IDragEvent for DragExitEvent {} /// The dragleave event is fired when a dragged element or text selection leaves a valid drop target. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/Events/dragleave) // https://www.w3.org/TR/html51/editing.html#eventdef-global-dragleave #[derive(Clone, Debug, PartialEq, Eq, ReferenceType)] #[reference(instance_of = "DragEvent")] #[reference(event = "dragleave")] #[reference(subclass_of(Event, UiEvent, MouseEvent, DragRelatedEvent))] pub struct DragLeaveEvent(Reference); impl IEvent for DragLeaveEvent {} impl IUiEvent for DragLeaveEvent {} impl IMouseEvent for DragLeaveEvent {} impl IDragEvent for DragLeaveEvent {} /// The dragover event is fired when an element or text selection is being dragged over a valid drop /// target (every few hundred milliseconds). /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/Events/dragover) // https://www.w3.org/TR/html51/editing.html#eventdef-global-dragover #[derive(Clone, Debug, PartialEq, Eq, ReferenceType)] #[reference(instance_of = "DragEvent")] #[reference(event = "dragover")] #[reference(subclass_of(Event, UiEvent, MouseEvent, DragRelatedEvent))] pub struct DragOverEvent(Reference); impl IEvent for DragOverEvent {} impl IUiEvent for DragOverEvent {} impl IMouseEvent for DragOverEvent {} impl IDragEvent for DragOverEvent {} /// The drop event is fired when an element or text selection is dropped on a valid drop target. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/Events/drop) // https://www.w3.org/TR/html51/editing.html#eventdef-global-drop #[derive(Clone, Debug, PartialEq, Eq, ReferenceType)] #[reference(instance_of = "DragEvent")] #[reference(event = "drop")] #[reference(subclass_of(Event, UiEvent, MouseEvent, DragRelatedEvent))] pub struct DragDropEvent(Reference); impl IEvent for DragDropEvent {} impl IUiEvent for DragDropEvent {} impl IMouseEvent for DragDropEvent {} impl IDragEvent for DragDropEvent {} /// The dragend event is fired when a drag operation is being ended (by releasing a mouse button or /// hitting the escape key). /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/Events/dragend) // https://www.w3.org/TR/html51/editing.html#eventdef-global-dragend #[derive(Clone, Debug, PartialEq, Eq, ReferenceType)] #[reference(instance_of = "DragEvent")] #[reference(event = "dragend")] #[reference(subclass_of(Event, UiEvent, MouseEvent, DragRelatedEvent))] pub struct DragEndEvent(Reference); impl IEvent for DragEndEvent {} impl IUiEvent for DragEndEvent {} impl IMouseEvent for DragEndEvent {} impl IDragEvent for DragEndEvent {} /// 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)](https://developer.mozilla.org/en-US/docs/Web/API/DataTransfer) // https://www.w3.org/TR/html51/editing.html#datatransfer-datatransfer #[derive(Clone, Debug, PartialEq, Eq, ReferenceType)] #[reference(instance_of = "DataTransfer")] pub struct DataTransfer( Reference ); impl DataTransfer { /// Gets the type of drag-and-drop operation currently selected type. /// The value must be none, copy, link or move. /// /// [(JavaScript docs)](https://developer.mozilla.org/en-US/docs/Web/API/DataTransfer/dropEffect) // https://www.w3.org/TR/html51/editing.html#ref-for-dom-datatransfer-dropeffect-2 pub fn drop_effect( &self ) -> DropEffect { let v: String = js!( return @{self.as_ref()}.dropEffect; ).try_into().unwrap(); match v.as_ref() { "copy" => DropEffect::Copy, "move" => DropEffect::Move, "link" => DropEffect::Link, "none" => DropEffect::None, other => panic!("Expected valid dropEffect value, got {:?}", other), } } /// Sets the type of drag-and-drop operation currently selected. /// The value must be none, copy, link or move. /// /// [(Javascript docs)](https://developer.mozilla.org/en-US/docs/Web/API/Element/dropEffect) // https://www.w3.org/TR/html51/editing.html#ref-for-dom-datatransfer-dropeffect-2 pub fn set_drop_effect( &self, value: DropEffect ) { js! { @(no_return) @{self.as_ref()}.dropEffect = @{match value { DropEffect::Copy => "copy", DropEffect::Move => "move", DropEffect::Link => "link", DropEffect::None => "none", }}; } } /// 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)](https://developer.mozilla.org/en-US/docs/Web/API/DataTransfer/effectAllowed) // https://www.w3.org/TR/html51/editing.html#ref-for-dom-datatransfer-effectallowed-1 pub fn effect_allowed( &self ) -> EffectAllowed { let v: String = js!( return @{self.as_ref()}.effectAllowed; ).try_into().unwrap(); match v.as_ref() { "none" => EffectAllowed::None, "copy" => EffectAllowed::Copy, "copyLink" => EffectAllowed::CopyLink, "copyMove" => EffectAllowed::CopyMove, "link" => EffectAllowed::Link, "linkMove" => EffectAllowed::LinkMove, "move" => EffectAllowed::Move, "all" => EffectAllowed::All, "uninitialized" => EffectAllowed::Uninitialized, other => panic!("Expected valid effectAllowed value, got {:?}", other), } } /// 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)](https://developer.mozilla.org/en-US/docs/Web/API/Element/effectAllowed) // https://www.w3.org/TR/html51/editing.html#ref-for-dom-datatransfer-effectallowed-1 pub fn set_effect_allowed( &self, value: EffectAllowed ) { js! { @(no_return) @{self.as_ref()}.effectAllowed = @{match value { EffectAllowed::None => "none", EffectAllowed::Copy => "copy", EffectAllowed::CopyLink => "copyLink", EffectAllowed::CopyMove => "copyMove", EffectAllowed::Link => "link", EffectAllowed::LinkMove => "linkMove", EffectAllowed::Move => "move", EffectAllowed::All => "all", EffectAllowed::Uninitialized => "uninitialized", }}; } } /// Gives a DataTransferItemList object which is a list of all of the drag data. /// /// [(Javascript docs)](https://developer.mozilla.org/en-US/docs/Web/API/DataTransfer/items) // https://www.w3.org/TR/html51/editing.html#ref-for-dom-datatransfer-items-1 pub fn items( &self ) -> DataTransferItemList { js!( return @{self.as_ref()}.items; ).try_into().unwrap() } /// 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)](https://developer.mozilla.org/en-US/docs/Web/API/DataTransfer/files) // https://www.w3.org/TR/html51/editing.html#ref-for-dom-datatransfer-files-1 pub fn files( &self ) -> FileList { js!( return @{self.as_ref()}.files; ).try_into().unwrap() } /// An array of strings giving the formats that were set in the dragstart event. /// /// [(Javascript docs)](https://developer.mozilla.org/en-US/docs/Web/API/DataTransfer/types) // https://www.w3.org/TR/html51/editing.html#ref-for-dom-datatransfer-types-1 pub fn types( &self ) -> Vec<String> { js!( return @{self.as_ref()}.types; ).try_into().unwrap() } /// 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)](https://developer.mozilla.org/en-US/docs/Web/API/DataTransfer/clearData) // https://www.w3.org/TR/html51/editing.html#ref-for-dom-datatransfer-cleardata-1 pub fn clear_data( &self, format: Option<&str> ) { match format { None => js!(@(no_return) @{self.as_ref()}.clearData()), Some(x) => js!(@(no_return) @{self.as_ref()}.clearData(@{x})) }; } /// 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)](https://developer.mozilla.org/en-US/docs/Web/API/DataTransfer/getData) // https://www.w3.org/TR/html51/editing.html#ref-for-dom-datatransfer-getdata-1 pub fn get_data( &self, format: &str ) -> String { js!( return @{self.as_ref()}.getData(@{format}); ).try_into().unwrap() } /// 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)](https://developer.mozilla.org/en-US/docs/Web/API/DataTransfer/setData) // https://www.w3.org/TR/html51/editing.html#ref-for-dom-datatransfer-setdata-1 pub fn set_data( &self, format: &str, data: &str ) { js!(@(no_return) @{self.as_ref()}.setData(@{format}, @{data}); ); } /// Set the image to be used for dragging if a custom one is desired. /// /// [(Javascript docs)](https://developer.mozilla.org/en-US/docs/Web/API/DataTransfer/setDragImage) // https://www.w3.org/TR/html51/editing.html#ref-for-dom-datatransfer-setdragimage-1 pub fn set_drag_image( &self, img: &ImageElement, x_offset: i32, y_offset: i32 ) { js!(@(no_return) @{self.as_ref()}.setDragImage(@{img.as_ref()}, @{x_offset}, @{y_offset}); ); } } /// A DOMString representing the drag operation effect. // https://www.w3.org/TR/html51/editing.html#dom-datatransfer-dropeffect #[derive(Clone, Copy, Debug, PartialEq, Eq)] pub enum DropEffect { /// A copy of the source item is made at the new location Copy, /// An item is moved to a new location. Move, /// A link is established to the source at the new location. Link, /// The item may not be dropped. None, } /// A DOMString representing the drag operation that is allowed. // https://www.w3.org/TR/html51/editing.html#dom-datatransfer-effectallowed #[derive(Clone, Copy, Debug, PartialEq, Eq)] pub enum EffectAllowed { /// The item may not be dropped. None, /// A copy of the source item may be made at the new location. Copy, /// A copy or link operation is permitted. CopyLink, /// A copy or move operation is permitted. CopyMove, /// A link may be established to the source at the new location. Link, /// A link or move operation is permitted. LinkMove, /// An item may be moved to a new location. Move, /// All operations are permitted. All, /// The default value when the effect has not been set, equivalent to all. Uninitialized, } /// The DataTransferItemList object is a list of DataTransferItem objects representing items being /// dragged. /// During a drag operation, each DragEvent has a dataTransfer property and that property is a /// DataTransferItemList. /// /// [(Javascript docs)](https://developer.mozilla.org/en-US/docs/Web/API/DataTransferItemList) // https://www.w3.org/TR/html51/editing.html#datatransferitemlist-datatransferitemlist #[derive(Clone, Debug, PartialEq, Eq, ReferenceType)] #[reference(instance_of = "DataTransferItemList")] pub struct DataTransferItemList( Reference ); impl DataTransferItemList { /// An unsigned long that is the number of drag items in the list. /// /// [(Javascript docs)](https://developer.mozilla.org/en-US/docs/Web/API/DataTransferItemList/length) // https://www.w3.org/TR/html51/editing.html#ref-for-dom-datatransferitemlist-length-1 pub fn len( &self ) -> u32 { js!( return @{self.as_ref()}.length; ).try_into().unwrap() } /// Adds an item of kind "string" to the drag item list and returns /// a DataTransferItem object for the new item. /// /// [(Javascript docs)](https://developer.mozilla.org/en-US/docs/Web/API/DataTransferItemList/add) // https://www.w3.org/TR/html51/editing.html#ref-for-dom-datatransferitemlist-add-1 pub fn add_string( &self, data: &str, ty: &str ) -> Result<Option<DataTransferItem>, NotSupportedError> { js_try!( return @{self.as_ref()}.add(@{data}, @{ty}); ).unwrap() } /// Adds an item of kind "file" to the drag item list and returns /// a DataTransferItem object for the new item. /// /// [(Javascript docs)](https://developer.mozilla.org/en-US/docs/Web/API/DataTransferItemList/add) // https://www.w3.org/TR/html51/editing.html#ref-for-dom-datatransferitemlist-add-2 pub fn add_file( &self, file: &File ) -> Option<DataTransferItem> { js!( return @{self.as_ref()}.add(@{file}); ).try_into().unwrap() } /// Removes the drag item from the list at the given index. /// /// [(Javascript docs)](https://developer.mozilla.org/en-US/docs/Web/API/DataTransferItemList/remove) // https://www.w3.org/TR/html51/editing.html#ref-for-dom-datatransferitemlist-remove-1 pub fn remove( &self, index: u32 ) -> Result<(), InvalidStateError> { js_try!(@{self.as_ref()}.remove(@{index})).unwrap() } /// Removes all of the drag items from the list. /// /// [(Javascript docs)](https://developer.mozilla.org/en-US/docs/Web/API/DataTransferItemList/clear) // https://www.w3.org/TR/html51/editing.html#ref-for-dom-datatransferitemlist-clear-1 pub fn clear( &self ) { js!(@(no_return) @{self.as_ref()}.clear()); } /// Getter that returns a DataTransferItem at the given index. /// /// [(Javascript docs)](https://developer.mozilla.org/en-US/docs/Web/API/DataTransferItemList/DataTransferItem) // https://www.w3.org/TR/html51/editing.html#ref-for-datatransferitem-datatransferitem-1 pub fn index( &self, index: u32 ) -> Option<DataTransferItem> { let v: Value = js!( return @{self.as_ref()}[@{index}]; ); match v { Value::Reference(_) => Some(v.try_into().unwrap()), _ => None, } } /// Returns an iterator over the list pub fn iter( &self ) -> DataTransferItemIter { DataTransferItemIter { list: self.clone(), index: 0, } } } impl IntoIterator for DataTransferItemList { type Item = DataTransferItem; type IntoIter = DataTransferItemIter; #[inline] fn into_iter( self ) -> Self::IntoIter { DataTransferItemIter { list: self, index: 0 } } } impl< 'a > IntoIterator for &'a DataTransferItemList { type Item = DataTransferItem; type IntoIter = DataTransferItemIter; #[inline] fn into_iter( self ) -> Self::IntoIter { DataTransferItemIter { list: self.clone(), index: 0 } } } impl Iterator for DataTransferItemIter { type Item = DataTransferItem; fn next( &mut self ) -> Option< Self::Item > { let v = self.list.index(self.index); if v.is_some() { self.index += 1; } v } } #[derive(Debug)] pub struct DataTransferItemIter { list: DataTransferItemList, index: u32, } /// The DataTransferItem object represents one drag data item. During a drag operation, each drag /// event has a dataTransfer property which contains a list of drag data items. Each item in the /// list is a DataTransferItem object. /// /// [(Javascript docs)](https://developer.mozilla.org/en-US/docs/Web/API/DataTransferItem) // https://www.w3.org/TR/html51/editing.html#datatransferitem-datatransferitem #[derive(Clone, Debug, PartialEq, Eq, ReferenceType)] #[reference(instance_of = "DataTransferItem")] pub struct DataTransferItem( Reference ); impl DataTransferItem { /// The kind of drag data item, string or file. /// /// [(Javascript docs)](https://developer.mozilla.org/en-US/docs/Web/API/DataTransferItem/kind) // https://www.w3.org/TR/html51/editing.html#ref-for-dom-datatransferitem-kind-13 pub fn kind( &self ) -> DataTransferItemKind { let kind: String = js!( return @{self.as_ref()}.kind; ).try_into().unwrap(); match kind.as_ref() { "string" => DataTransferItemKind::String, "file" => DataTransferItemKind::File, other => DataTransferItemKind::__Other(OtherKind { name: String::from(other) }), } } /// The drag data item's type, typically a MIME type. /// /// [(Javascript docs)](https://developer.mozilla.org/en-US/docs/Web/API/DataTransferItem/type) // https://www.w3.org/TR/html51/editing.html#ref-for-dom-datatransferitem-type-2 pub fn ty( &self ) -> String { js!( return @{self.as_ref()}.type; ).try_into().unwrap() } /// Returns the File object associated with the drag data item /// (or null if the drag item is not a file) /// /// [(Javascript docs)](https://developer.mozilla.org/en-US/docs/Web/API/DataTransferItem/getAsFile) // https://www.w3.org/TR/html51/editing.html#ref-for-dom-datatransferitem-getasfile-1 pub fn get_as_file( &self ) -> Option<File> { js!( return @{self.as_ref()}.getAsFile(); ).try_into().unwrap() } /// Invokes the specified callback with the drag data item string as its argument. /// /// [(Javascript docs)](https://developer.mozilla.org/en-US/docs/Web/API/DataTransferItem/getAsString) // https://www.w3.org/TR/html51/editing.html#ref-for-dom-datatransferitem-getasstring-1 pub fn get_as_string<F>( &self, callback: F ) where F: FnOnce(String) + 'static { js!(@(no_return) @{self.as_ref()}.getAsString(@{Once(callback)}); ); } /// Invokes the specified callback with the drag data item string as its argument. /// /// [(Javascript docs)](https://developer.mozilla.org/en-US/docs/Web/API/DataTransferItem/getAsString) // https://www.w3.org/TR/html51/editing.html#ref-for-dom-datatransferitem-getasstring-1 #[cfg(feature = "futures-support")] pub fn get_as_string_future( &self ) -> oneshot::Receiver<String> { let (sender, receiver) = oneshot::channel(); let callback = |s: String| { match sender.send(s) { Ok(_) => {}, Err(_) => {}, }; }; js!(@(no_return) @{self.as_ref()}.getAsString(@{Once(callback)}); ); receiver } } /// The kind of drag data item, string or file. /// /// [(Javascript docs)](https://developer.mozilla.org/en-US/docs/Web/API/DataTransferItem/kind) // https://www.w3.org/TR/html51/editing.html#ref-for-dom-datatransferitem-kind-13 // TODO use #[non_exhaustive] when available #[derive(Clone, Debug, PartialEq, Eq)] pub enum DataTransferItemKind { /// If the drag data item is a file. File, /// If the kind of drag data item is a plain Unicode string. String, /// If the kind of drag data is something different (e.g. dragging an <img /> tag in Firefox) #[doc(hidden)] __Other(OtherKind), } impl DataTransferItemKind { /// Returns the string representation of this DataTransferItemKind /// Useful in case the browser returns a non-standard kind that you want to special case. pub fn as_str( &self ) -> &str { match *self { DataTransferItemKind::File => "file", DataTransferItemKind::String => "string", DataTransferItemKind::__Other( ref other_kind ) => &other_kind.name } } } #[derive(Clone, Debug, PartialEq, Eq)] pub struct OtherKind { name: String, } #[cfg(all(test, feature = "web_test"))] mod tests { use super::*; use webapi::event::ConcreteEvent; #[test] fn test_drag_event() { let event: DragRelatedEvent = js!( return new DragEvent( @{DragStartEvent::EVENT_TYPE}, { dataTransfer: new DataTransfer() } ); ).try_into().unwrap(); // effects assert_eq!(event.event_type(), DragStartEvent::EVENT_TYPE); assert_eq!(event.data_transfer().unwrap().effect_allowed(), EffectAllowed::None); assert_eq!(event.data_transfer().unwrap().drop_effect(), DropEffect::None); event.data_transfer().unwrap().set_effect_allowed(EffectAllowed::CopyMove); event.data_transfer().unwrap().set_drop_effect(DropEffect::Copy); // TODO how to test? can only set these during ondragstart event triggered in browser // assert_eq!(event.data_transfer().effect_allowed(), EffectAllowed::CopyMove); // assert_eq!(event.data_transfer().drop_effect(), DropEffect::Copy); // get, set, clear data event.data_transfer().unwrap().set_data("myformat", "mydata"); event.data_transfer().unwrap().set_data("myformat2", "mydata2"); event.data_transfer().unwrap().clear_data(Some("myformat3")); assert_eq!(event.data_transfer().unwrap().get_data("myformat"), String::from("mydata")); event.data_transfer().unwrap().clear_data(Some("myformat")); assert_eq!(event.data_transfer().unwrap().get_data("myformat"), String::from("")); assert_eq!(event.data_transfer().unwrap().get_data("myformat2"), String::from("mydata2")); event.data_transfer().unwrap().clear_data(None); assert_eq!(event.data_transfer().unwrap().get_data("myformat2"), String::from("")); let img = ImageElement::new(); event.data_transfer().unwrap().set_drag_image(&img, 10, 10); // types assert_eq!(event.data_transfer().unwrap().types().len(), 0); // items assert_eq!(event.data_transfer().unwrap().items().len(), 0); let data = "mydata"; let ty = "text/plain"; let item = event.data_transfer().unwrap().items().add_string(data, ty).unwrap().unwrap(); assert_eq!(item.ty(), ty); assert_eq!(item.kind(), DataTransferItemKind::String); // TODO(https://github.com/koute/stdweb/issues/128) fix when async unit testing is available // item.get_as_string().and_then(|s| { // assert_eq!(data, s); // assert_eq!(1, 1); // assert_eq!(2, 1); // }); let filename = "myname"; let file = js!(return new File(["content"], @{filename})).try_into().unwrap(); event.data_transfer().unwrap().items().add_file(&file).unwrap(); assert_eq!(event.data_transfer().unwrap().items().len(), 2); assert_eq!(event.data_transfer().unwrap().items().iter().count(), 2); assert!(event.data_transfer().unwrap().items().index(2).is_none()); assert_eq!(event.data_transfer().unwrap().files().len(), 1); let item = event.data_transfer().unwrap().items().index(1).unwrap(); assert_eq!(item.kind(), DataTransferItemKind::File); assert_eq!(item.get_as_file().unwrap().name(), filename); let result = event.data_transfer().unwrap().items().remove(0); assert!(result.is_ok()); assert_eq!(event.data_transfer().unwrap().items().len(), 1); event.data_transfer().unwrap().items().clear(); assert_eq!(event.data_transfer().unwrap().items().len(), 0); } }