2 * Copyright(c) 2022 Samsung Electronics Co., Ltd.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 using System.ComponentModel;
19 using System.Runtime.InteropServices;
20 using System.Collections.Generic;
21 using System.Diagnostics.CodeAnalysis;
22 using Tizen.NUI.BaseComponents;
27 /// DragAndDrop controls the drag objet and data.
29 [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Reliability", "CA2000: Dispose objects before losing scope", Justification = "It does not have ownership.")]
30 [EditorBrowsable(EditorBrowsableState.Never)]
31 public class DragAndDrop : BaseHandle
33 [EditorBrowsable(EditorBrowsableState.Never)]
34 public delegate void SourceEventHandler(SourceEventType sourceEventType);
35 private delegate void InternalSourceEventHandler(int sourceEventType);
36 public delegate void DragAndDropEventHandler(View targetView, DragEvent dragEvent);
37 private delegate void InternalDragAndDropEventHandler(global::System.IntPtr dragEvent);
38 private InternalSourceEventHandler sourceEventCb;
39 private Dictionary<View, InternalDragAndDropEventHandler> targetEventDictionary = new Dictionary<View, InternalDragAndDropEventHandler>();
40 private Window mDragWindow;
41 private const int shadowWidth = 150;
42 private const int shadowHeight = 150;
44 [EditorBrowsable(EditorBrowsableState.Never)]
45 private DragAndDrop() : this(Interop.DragAndDrop.New(), true)
47 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
50 private DragAndDrop(global::System.IntPtr cPtr, bool cMemoryOwn) : base(cPtr, cMemoryOwn)
56 /// Gets the singleton instance of DragAndDrop.
58 [EditorBrowsable(EditorBrowsableState.Never)]
59 public static DragAndDrop Instance { get; } = new DragAndDrop();
62 /// Starts drag and drop.
64 /// <param name="sourceView">The soruce view</param>
65 /// <param name="shadowView">The shadow view for drag object</param>
66 /// <param name="dragData">The data to send</param>
67 /// <param name="callback">The source event callback</param>
68 [EditorBrowsable(EditorBrowsableState.Never)]
69 public void StartDragAndDrop(View sourceView, View shadowView, DragData dragData, SourceEventHandler callback)
71 if (null == shadowView)
73 throw new ArgumentNullException(nameof(shadowView));
76 if (null == mDragWindow)
78 mDragWindow = new Window("DragWindow", new Rectangle(-shadowWidth, -shadowHeight, shadowWidth, shadowHeight), true)
80 BackgroundColor = Color.Transparent,
84 shadowView.SetSize(shadowWidth, shadowHeight);
85 shadowView.SetOpacity(0.9f);
87 mDragWindow.Add(shadowView);
90 sourceEventCb = (sourceEventType) =>
92 callback((SourceEventType)sourceEventType);
95 if (!Interop.DragAndDrop.StartDragAndDrop(SwigCPtr, View.getCPtr(sourceView), Window.getCPtr(mDragWindow), dragData.MimeType, dragData.Data,
96 new global::System.Runtime.InteropServices.HandleRef(this, Marshal.GetFunctionPointerForDelegate<Delegate>(sourceEventCb))))
98 throw new InvalidOperationException("Fail to StartDragAndDrop");
103 /// Adds listener for drop targets
105 /// <param name="targetView">The target view</param>
106 /// <param name="callback">The callback function to get drag event</param>
107 [EditorBrowsable(EditorBrowsableState.Never)]
108 public void AddListener(View targetView, DragAndDropEventHandler callback)
110 InternalDragAndDropEventHandler cb = (dragEvent) =>
112 DragType type = (DragType)Interop.DragAndDrop.GetAction(dragEvent);
113 DragEvent ev = new DragEvent();
114 global::System.IntPtr cPtr = Interop.DragAndDrop.GetPosition(dragEvent);
115 ev.Position = (cPtr == global::System.IntPtr.Zero) ? null : new Position(cPtr, false);
117 if (type == DragType.Enter)
120 callback(targetView, ev);
122 else if (type == DragType.Leave)
125 callback(targetView, ev);
127 else if (type == DragType.Move)
130 callback(targetView, ev);
132 else if (type == DragType.Drop)
135 ev.MimeType = Interop.DragAndDrop.GetMimeType(dragEvent);
136 ev.Data = Interop.DragAndDrop.GetData(dragEvent);
137 callback(targetView, ev);
141 targetEventDictionary.Add(targetView, cb);
143 if (!Interop.DragAndDrop.AddListener(SwigCPtr, View.getCPtr(targetView),
144 new global::System.Runtime.InteropServices.HandleRef(this, Marshal.GetFunctionPointerForDelegate<Delegate>(cb))))
146 throw new InvalidOperationException("Fail to AddListener");
151 /// Removes listener for drop targets
153 /// <param name="targetView">The target view</param>
154 /// <param name="callback">The callback function to remove</param>
155 [EditorBrowsable(EditorBrowsableState.Never)]
156 public void RemoveListener(View targetView, DragAndDropEventHandler callback)
158 if (!targetEventDictionary.ContainsKey(targetView))
160 throw new InvalidOperationException("Fail to RemoveListener");
163 InternalDragAndDropEventHandler cb = targetEventDictionary[targetView];
164 targetEventDictionary.Remove(targetView);
165 if (!Interop.DragAndDrop.RemoveListener(SwigCPtr, View.getCPtr(targetView),
166 new global::System.Runtime.InteropServices.HandleRef(this, Marshal.GetFunctionPointerForDelegate<Delegate>(cb))))
168 throw new InvalidOperationException("Fail to RemoveListener");