diff --git a/Avalonia.sln b/Avalonia.sln
index a0314b1c33..768fb50452 100644
--- a/Avalonia.sln
+++ b/Avalonia.sln
@@ -37,11 +37,12 @@ EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Shared", "Shared", "{A689DEF5-D50F-4975-8B72-124C9EB54066}"
ProjectSection(SolutionItems) = preProject
.editorconfig = .editorconfig
+ src\Shared\CallerArgumentExpressionAttribute.cs = src\Shared\CallerArgumentExpressionAttribute.cs
src\Shared\IsExternalInit.cs = src\Shared\IsExternalInit.cs
src\Shared\ModuleInitializer.cs = src\Shared\ModuleInitializer.cs
- src\Shared\NullableAttributes.cs = src\Shared\NullableAttributes.cs
src\Shared\SourceGeneratorAttributes.cs = src\Shared\SourceGeneratorAttributes.cs
src\Shared\StringCompatibilityExtensions.cs = src\Shared\StringCompatibilityExtensions.cs
+ src\Shared\StreamCompatibilityExtensions.cs = src\Shared\StreamCompatibilityExtensions.cs
EndProjectSection
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Avalonia.ReactiveUI", "src\Avalonia.ReactiveUI\Avalonia.ReactiveUI.csproj", "{6417B24E-49C2-4985-8DB2-3AB9D898EC91}"
diff --git a/api/Avalonia.nupkg.xml b/api/Avalonia.nupkg.xml
index 35d8c92717..4df9a900be 100644
--- a/api/Avalonia.nupkg.xml
+++ b/api/Avalonia.nupkg.xml
@@ -1,4 +1,4 @@
-
+
@@ -133,4 +133,76 @@
baseline/netstandard2.0/Avalonia.Controls.dll
target/netstandard2.0/Avalonia.Controls.dll
-
\ No newline at end of file
+
+ CP0006
+ M:Avalonia.Input.Platform.IClipboard.SetDataAsync(Avalonia.Input.IAsyncDataTransfer)
+ baseline/Avalonia/lib/net6.0/Avalonia.Base.dll
+ current/Avalonia/lib/net6.0/Avalonia.Base.dll
+
+
+ CP0006
+ M:Avalonia.Input.Platform.IClipboard.TryGetDataAsync
+ baseline/Avalonia/lib/net6.0/Avalonia.Base.dll
+ current/Avalonia/lib/net6.0/Avalonia.Base.dll
+
+
+ CP0006
+ M:Avalonia.Input.Platform.IClipboard.TryGetInProcessDataAsync
+ baseline/Avalonia/lib/net6.0/Avalonia.Base.dll
+ current/Avalonia/lib/net6.0/Avalonia.Base.dll
+
+
+ CP0006
+ M:Avalonia.Input.Platform.IPlatformDragSource.DoDragDropAsync(Avalonia.Input.PointerEventArgs,Avalonia.Input.IDataTransfer,Avalonia.Input.DragDropEffects)
+ baseline/Avalonia/lib/net6.0/Avalonia.Base.dll
+ current/Avalonia/lib/net6.0/Avalonia.Base.dll
+
+
+ CP0006
+ M:Avalonia.Input.Platform.IClipboard.SetDataAsync(Avalonia.Input.IAsyncDataTransfer)
+ baseline/Avalonia/lib/net8.0/Avalonia.Base.dll
+ current/Avalonia/lib/net8.0/Avalonia.Base.dll
+
+
+ CP0006
+ M:Avalonia.Input.Platform.IClipboard.TryGetDataAsync
+ baseline/Avalonia/lib/net8.0/Avalonia.Base.dll
+ current/Avalonia/lib/net8.0/Avalonia.Base.dll
+
+
+ CP0006
+ M:Avalonia.Input.Platform.IClipboard.TryGetInProcessDataAsync
+ baseline/Avalonia/lib/net8.0/Avalonia.Base.dll
+ current/Avalonia/lib/net8.0/Avalonia.Base.dll
+
+
+ CP0006
+ M:Avalonia.Input.Platform.IPlatformDragSource.DoDragDropAsync(Avalonia.Input.PointerEventArgs,Avalonia.Input.IDataTransfer,Avalonia.Input.DragDropEffects)
+ baseline/Avalonia/lib/net8.0/Avalonia.Base.dll
+ current/Avalonia/lib/net8.0/Avalonia.Base.dll
+
+
+ CP0006
+ M:Avalonia.Input.Platform.IClipboard.SetDataAsync(Avalonia.Input.IAsyncDataTransfer)
+ baseline/Avalonia/lib/netstandard2.0/Avalonia.Base.dll
+ current/Avalonia/lib/netstandard2.0/Avalonia.Base.dll
+
+
+ CP0006
+ M:Avalonia.Input.Platform.IClipboard.TryGetDataAsync
+ baseline/Avalonia/lib/netstandard2.0/Avalonia.Base.dll
+ current/Avalonia/lib/netstandard2.0/Avalonia.Base.dll
+
+
+ CP0006
+ M:Avalonia.Input.Platform.IClipboard.TryGetInProcessDataAsync
+ baseline/Avalonia/lib/netstandard2.0/Avalonia.Base.dll
+ current/Avalonia/lib/netstandard2.0/Avalonia.Base.dll
+
+
+ CP0006
+ M:Avalonia.Input.Platform.IPlatformDragSource.DoDragDropAsync(Avalonia.Input.PointerEventArgs,Avalonia.Input.IDataTransfer,Avalonia.Input.DragDropEffects)
+ baseline/Avalonia/lib/netstandard2.0/Avalonia.Base.dll
+ current/Avalonia/lib/netstandard2.0/Avalonia.Base.dll
+
+
diff --git a/native/Avalonia.Native/inc/com.h b/native/Avalonia.Native/inc/com.h
index 42a989e050..9a3f067dce 100644
--- a/native/Avalonia.Native/inc/com.h
+++ b/native/Avalonia.Native/inc/com.h
@@ -28,7 +28,8 @@ typedef DWORD ULONG;
#define E_UNEXPECTED 0x8000FFFFL
#define E_HANDLE 0x80070006L
#define E_INVALIDARG 0x80070057L
-#define COR_E_INVALIDOPERATION 0x80131509L
+#define COR_E_INVALIDOPERATION 0x80131509L
+#define COR_E_OBJECTDISPOSED 0x80131622L
struct IUnknown
{
diff --git a/native/Avalonia.Native/src/OSX/Avalonia.Native.OSX.xcodeproj/project.pbxproj b/native/Avalonia.Native/src/OSX/Avalonia.Native.OSX.xcodeproj/project.pbxproj
index 9a67ee0161..868551eac1 100644
--- a/native/Avalonia.Native/src/OSX/Avalonia.Native.OSX.xcodeproj/project.pbxproj
+++ b/native/Avalonia.Native/src/OSX/Avalonia.Native.OSX.xcodeproj/project.pbxproj
@@ -63,6 +63,7 @@
EDF8CDCD2964CB01001EE34F /* PlatformSettings.mm in Sources */ = {isa = PBXBuildFile; fileRef = EDF8CDCC2964CB01001EE34F /* PlatformSettings.mm */; };
F10084842BFF1F9E0024303E /* TopLevelImpl.h in Headers */ = {isa = PBXBuildFile; fileRef = F10084832BFF1F9E0024303E /* TopLevelImpl.h */; };
F10084862BFF1FB40024303E /* TopLevelImpl.mm in Sources */ = {isa = PBXBuildFile; fileRef = F10084852BFF1FB40024303E /* TopLevelImpl.mm */; };
+ F931F8682E2D43A7004E081E /* clipboard.h in Headers */ = {isa = PBXBuildFile; fileRef = F931F8672E2D43A4004E081E /* clipboard.h */; };
/* End PBXBuildFile section */
/* Begin PBXFileReference section */
@@ -130,6 +131,7 @@
EDF8CDCC2964CB01001EE34F /* PlatformSettings.mm */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.objcpp; path = PlatformSettings.mm; sourceTree = ""; };
F10084832BFF1F9E0024303E /* TopLevelImpl.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = TopLevelImpl.h; sourceTree = ""; };
F10084852BFF1FB40024303E /* TopLevelImpl.mm */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.cpp.objcpp; path = TopLevelImpl.mm; sourceTree = ""; };
+ F931F8672E2D43A4004E081E /* clipboard.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = clipboard.h; sourceTree = ""; };
/* End PBXFileReference section */
/* Begin PBXFrameworksBuildPhase section */
@@ -189,6 +191,7 @@
1AFD334023E03C4F0042899B /* controlhost.mm */,
5BF943652167AD1D009CAE35 /* cursor.h */,
5B21A981216530F500CEE36E /* cursor.mm */,
+ F931F8672E2D43A4004E081E /* clipboard.h */,
5B8BD94E215BFEA6005ED2A7 /* clipboard.mm */,
1A465D0F246AB61600C5858B /* dnd.mm */,
AB8F7D6A21482D7F0057DBA5 /* platformthreading.mm */,
@@ -246,6 +249,7 @@
files = (
37155CE4233C00EB0034DCE9 /* menu.h in Headers */,
F10084842BFF1F9E0024303E /* TopLevelImpl.h in Headers */,
+ F931F8682E2D43A7004E081E /* clipboard.h in Headers */,
BC11A5BE2608D58F0017BAD0 /* automation.h in Headers */,
183916173528EC2737DBE5E1 /* WindowBaseImpl.h in Headers */,
1839171DCC651B0638603AC4 /* INSWindowHolder.h in Headers */,
diff --git a/native/Avalonia.Native/src/OSX/AvnView.mm b/native/Avalonia.Native/src/OSX/AvnView.mm
index 4cc495f321..6fe1c8ceeb 100644
--- a/native/Avalonia.Native/src/OSX/AvnView.mm
+++ b/native/Avalonia.Native/src/OSX/AvnView.mm
@@ -868,7 +868,7 @@ static void ConvertTilt(NSPoint tilt, float* xTilt, float* yTilt)
return NSDragOperationNone;
int reffects = (int)parent->TopLevelEvents
->DragEvent(type, point, modifiers, effects,
- CreateClipboard([info draggingPasteboard], nil),
+ CreateClipboard([info draggingPasteboard]),
GetAvnDataObjectHandleFromDraggingInfo(info));
NSDragOperation ret = static_cast(0);
diff --git a/native/Avalonia.Native/src/OSX/StorageProvider.mm b/native/Avalonia.Native/src/OSX/StorageProvider.mm
index 92278a85e9..4a82eeaea7 100644
--- a/native/Avalonia.Native/src/OSX/StorageProvider.mm
+++ b/native/Avalonia.Native/src/OSX/StorageProvider.mm
@@ -355,6 +355,35 @@ public:
}
}
+ virtual HRESULT TryResolveFileReferenceUri(IAvnString* fileUriStr, IAvnString** ret) override {
+ if (ret == nullptr)
+ return E_POINTER;
+
+ if (fileUriStr == nullptr)
+ {
+ *ret = nullptr;
+ return S_OK;
+ }
+
+ auto fileUri = [NSURL URLWithString:GetNSStringAndRelease(fileUriStr)];
+ if (fileUri == nil)
+ {
+ *ret = nullptr;
+ return S_OK;
+ }
+
+ auto filePathUri = [fileUri filePathURL];
+ if (fileUri == nil)
+ {
+ *ret = nullptr;
+ return S_OK;
+ }
+
+ *ret = CreateAvnString([filePathUri absoluteString]);
+ return S_OK;
+ }
+
+
private:
NSView* CreateAccessoryView() {
// The label. Add attributes per-OS to match the labels that macOS uses.
diff --git a/native/Avalonia.Native/src/OSX/TopLevelImpl.h b/native/Avalonia.Native/src/OSX/TopLevelImpl.h
index b18ad21d30..0be1439ec2 100644
--- a/native/Avalonia.Native/src/OSX/TopLevelImpl.h
+++ b/native/Avalonia.Native/src/OSX/TopLevelImpl.h
@@ -61,8 +61,13 @@ public:
virtual HRESULT GetCurrentDisplayId (CGDirectDisplayID* ret) override;
- virtual HRESULT BeginDragAndDropOperation(AvnDragDropEffects effects, AvnPoint point,
- IAvnClipboard* clipboard, IAvnDndResultCallback* cb, void* sourceHandle) override;
+ virtual HRESULT BeginDragAndDropOperation(
+ AvnDragDropEffects effects,
+ AvnPoint point,
+ IAvnClipboardDataSource* source,
+ IAvnDndResultCallback* callback,
+ void* sourceHandle) override;
+
protected:
NSCursor *cursor;
virtual void UpdateAppearance();
diff --git a/native/Avalonia.Native/src/OSX/TopLevelImpl.mm b/native/Avalonia.Native/src/OSX/TopLevelImpl.mm
index c247e48fe0..bdfc1be62f 100644
--- a/native/Avalonia.Native/src/OSX/TopLevelImpl.mm
+++ b/native/Avalonia.Native/src/OSX/TopLevelImpl.mm
@@ -7,6 +7,7 @@
#include "AvnTextInputMethod.h"
#include "AvnView.h"
#include "common.h"
+#include "clipboard.h"
TopLevelImpl::~TopLevelImpl() {
View = nullptr;
@@ -272,13 +273,15 @@ void TopLevelImpl::UpdateAppearance() {
}
-HRESULT TopLevelImpl::BeginDragAndDropOperation(AvnDragDropEffects effects, AvnPoint point, IAvnClipboard *clipboard, IAvnDndResultCallback *cb, void *sourceHandle) {
+HRESULT TopLevelImpl::BeginDragAndDropOperation(
+ AvnDragDropEffects effects,
+ AvnPoint point,
+ IAvnClipboardDataSource* source,
+ IAvnDndResultCallback* callback,
+ void* sourceHandle)
+{
START_COM_CALL;
- auto item = TryGetPasteboardItem(clipboard);
- [item setString:@"" forType:GetAvnCustomDataType()];
- if (item == nil)
- return E_INVALIDARG;
if (View == NULL)
return E_FAIL;
@@ -301,11 +304,19 @@ HRESULT TopLevelImpl::BeginDragAndDropOperation(AvnDragDropEffects effects, AvnP
}
}
- auto dragItem = [[NSDraggingItem alloc] initWithPasteboardWriter:item];
-
+ auto itemCount = source->GetItemCount();
+ auto draggingItems = [NSMutableArray arrayWithCapacity:itemCount];
auto dragItemImage = [NSImage imageNamed:NSImageNameMultipleDocuments];
NSRect dragItemRect = {(float) point.X, (float) point.Y, [dragItemImage size].width, [dragItemImage size].height};
- [dragItem setDraggingFrame:dragItemRect contents:dragItemImage];
+
+ for (auto i = 0; i < itemCount; ++i)
+ {
+ auto item = source->GetItem(i);
+ auto writeableItem = [[WriteableClipboardItem alloc] initWithItem:item source:source];
+ auto draggingItem = [[NSDraggingItem alloc] initWithPasteboardWriter:writeableItem];
+ [draggingItem setDraggingFrame:dragItemRect contents:dragItemImage];
+ [draggingItems addObject:draggingItem];
+ }
int op = 0;
int ieffects = (int) effects;
@@ -315,8 +326,10 @@ HRESULT TopLevelImpl::BeginDragAndDropOperation(AvnDragDropEffects effects, AvnP
op |= NSDragOperationLink;
if ((ieffects & (int) AvnDragDropEffects::Move) != 0)
op |= NSDragOperationMove;
- [View beginDraggingSessionWithItems:@[dragItem] event:nsevent
- source:CreateDraggingSource((NSDragOperation) op, cb, sourceHandle)];
+
+ [View beginDraggingSessionWithItems:draggingItems
+ event:nsevent
+ source:CreateDraggingSource((NSDragOperation) op, callback, sourceHandle)];
return S_OK;
}
diff --git a/native/Avalonia.Native/src/OSX/clipboard.h b/native/Avalonia.Native/src/OSX/clipboard.h
new file mode 100644
index 0000000000..fd0ddbf117
--- /dev/null
+++ b/native/Avalonia.Native/src/OSX/clipboard.h
@@ -0,0 +1,7 @@
+#pragma once
+
+#include "common.h"
+
+@interface WriteableClipboardItem : NSObject
+- (nonnull instancetype) initWithItem:(nonnull IAvnClipboardDataItem*)item source:(nonnull IAvnClipboardDataSource*)source;
+@end
diff --git a/native/Avalonia.Native/src/OSX/clipboard.mm b/native/Avalonia.Native/src/OSX/clipboard.mm
index 68f0e7d87a..45770f8c1e 100644
--- a/native/Avalonia.Native/src/OSX/clipboard.mm
+++ b/native/Avalonia.Native/src/OSX/clipboard.mm
@@ -1,206 +1,295 @@
+#import
#include "common.h"
+#include "clipboard.h"
#include "AvnString.h"
class Clipboard : public ComSingleObject
{
private:
- NSPasteboard* _pb;
- NSPasteboardItem* _item;
+ NSPasteboard* _pasteboard;
public:
FORWARD_IUNKNOWN()
- Clipboard(NSPasteboard* pasteboard, NSPasteboardItem* item)
+ Clipboard(NSPasteboard* pasteboard)
{
- if(pasteboard == nil && item == nil)
+ if (pasteboard == nil)
pasteboard = [NSPasteboard generalPasteboard];
- _pb = pasteboard;
- _item = item;
+ _pasteboard = pasteboard;
}
- NSPasteboardItem* TryGetItem()
+ virtual HRESULT GetFormats(int64_t changeCount, IAvnStringArray** ret) override
{
- return _item;
+ START_COM_ARP_CALL;
+
+ if (ret == nullptr)
+ return E_POINTER;
+
+ if (changeCount != [_pasteboard changeCount])
+ return COR_E_OBJECTDISPOSED;
+
+ auto types = [_pasteboard types];
+ *ret = types == nil ? nullptr : CreateAvnStringArray(types);
+ return S_OK;
}
-
- virtual HRESULT GetText (char* type, IAvnString**ppv) override
+
+ virtual HRESULT GetItemCount(int64_t changeCount, int* ret) override
{
- START_COM_CALL;
+ START_COM_ARP_CALL;
- @autoreleasepool
- {
- if(ppv == nullptr)
- {
- return E_POINTER;
- }
- NSString* typeString = [NSString stringWithUTF8String:(const char*)type];
- NSString* string = _item == nil ? [_pb stringForType:typeString] : [_item stringForType:typeString];
-
- *ppv = CreateAvnString(string);
-
- return S_OK;
- }
+ if (ret == nullptr)
+ return E_POINTER;
+
+ if (changeCount != [_pasteboard changeCount])
+ return COR_E_OBJECTDISPOSED;
+
+ auto items = [_pasteboard pasteboardItems];
+ *ret = items == nil ? 0 : (int)[items count];
+ return S_OK;
}
- virtual HRESULT SetStrings(char* type, IAvnStringArray*ppv) override
+ virtual HRESULT GetItemFormats(int index, int64_t changeCount, IAvnStringArray** ret) override
{
- START_COM_CALL;
+ START_COM_ARP_CALL;
- @autoreleasepool
- {
- NSArray* data = GetNSArrayOfStringsAndRelease(ppv);
- NSString* typeString = [NSString stringWithUTF8String:(const char*)type];
- if(_item == nil)
- [_pb setPropertyList: data forType: typeString];
- else
- [_item setPropertyList: data forType:typeString];
- return S_OK;
- }
+ if (ret == nullptr)
+ return E_POINTER;
+
+ if (changeCount != [_pasteboard changeCount])
+ return COR_E_OBJECTDISPOSED;
+
+ auto item = [[_pasteboard pasteboardItems] objectAtIndex:index];
+ auto types = [item types];
+ *ret = types == nil ? nullptr : CreateAvnStringArray(types);
+ return S_OK;
}
- virtual HRESULT GetStrings(char* type, IAvnStringArray**ppv) override
+ virtual HRESULT GetItemValueAsString(int index, int64_t changeCount, const char* format, IAvnString** ret) override
{
- START_COM_CALL;
+ START_COM_ARP_CALL;
- @autoreleasepool
- {
- *ppv= nil;
- NSString* typeString = [NSString stringWithUTF8String:(const char*)type];
- NSObject* data = _item == nil ? [_pb propertyListForType: typeString] : [_item propertyListForType: typeString];
- if(data == nil)
- return S_OK;
-
- if([data isKindOfClass: [NSString class]])
- {
- *ppv = CreateAvnStringArray((NSString*) data);
- return S_OK;
- }
-
- NSArray* arr = (NSArray*)data;
-
- for(int c = 0; c < [arr count]; c++)
- if(![[arr objectAtIndex:c] isKindOfClass:[NSString class]])
- return E_INVALIDARG;
-
- *ppv = CreateAvnStringArray(arr);
- return S_OK;
- }
+ if (ret == nullptr)
+ return E_POINTER;
+
+ if (changeCount != [_pasteboard changeCount])
+ return COR_E_OBJECTDISPOSED;
+
+ auto item = [[_pasteboard pasteboardItems] objectAtIndex:index];
+ auto value = [item stringForType:[NSString stringWithUTF8String:format]];
+ *ret = value == nil ? nullptr : CreateAvnString(value);
+ return S_OK;
}
- virtual HRESULT SetText (char* type, char* utf8String) override
+ virtual HRESULT GetItemValueAsBytes(int index, int64_t changeCount, const char* format, IAvnString** ret) override
{
- START_COM_CALL;
+ START_COM_ARP_CALL;
- @autoreleasepool
- {
- auto string = [NSString stringWithUTF8String:(const char*)utf8String];
- auto typeString = [NSString stringWithUTF8String:(const char*)type];
- if(_item == nil)
- [_pb setString: string forType: typeString];
- else
- [_item setString: string forType:typeString];
+ if (ret == nullptr)
+ return E_POINTER;
- return S_OK;
- }
+ if (changeCount != [_pasteboard changeCount])
+ return COR_E_OBJECTDISPOSED;
+
+ auto item = [[_pasteboard pasteboardItems] objectAtIndex:index];
+ auto value = [item dataForType:[NSString stringWithUTF8String:format]];
+
+ *ret = value == nil || [value length] == 0
+ ? nullptr
+ : CreateByteArray((void*)[value bytes], (int)[value length]);
+ return S_OK;
+ }
+
+ virtual HRESULT Clear(int64_t* ret) override
+ {
+ START_COM_ARP_CALL;
+
+ *ret = [_pasteboard clearContents];
+ return S_OK;
}
- virtual HRESULT SetBytes(char* type, void* bytes, int len) override
+ virtual HRESULT GetChangeCount(int64_t* ret) override
{
- START_COM_CALL;
+ START_COM_ARP_CALL;
- @autoreleasepool
+ *ret = [_pasteboard changeCount];
+ return S_OK;
+ }
+
+ virtual HRESULT SetData(IAvnClipboardDataSource* source) override
+ {
+ START_COM_ARP_CALL;
+
+ auto count = source->GetItemCount();
+ auto writeableItems = [NSMutableArray arrayWithCapacity:count];
+
+ for (auto i = 0; i < count; ++i)
{
- auto typeString = [NSString stringWithUTF8String:(const char*)type];
- auto data = [NSData dataWithBytes:bytes length:len];
- if(_item == nil)
- [_pb setData:data forType:typeString];
- else
- [_item setData:data forType:typeString];
- return S_OK;
+ auto item = source->GetItem(i);
+ auto writeableItem = [[WriteableClipboardItem alloc] initWithItem:item source:source];
+ [writeableItems addObject:writeableItem];
}
+
+ [_pasteboard writeObjects:writeableItems];
+ return S_OK;
}
-
- virtual HRESULT GetBytes(char* type, IAvnString**ppv) override
+
+ virtual bool IsTextFormat(const char *format) override
{
- START_COM_CALL;
+ START_COM_ARP_CALL;
+
+ auto formatString = [NSString stringWithUTF8String:format];
- @autoreleasepool
+ if (@available(macOS 11.0, *))
{
- *ppv = nil;
- auto typeString = [NSString stringWithUTF8String:(const char*)type];
- NSData*data;
- @try
- {
- if(_item)
- data = [_item dataForType:typeString];
- else
- data = [_pb dataForType:typeString];
- if(data == nil)
- return E_FAIL;
- }
- @catch(NSException* e)
- {
- return E_FAIL;
- }
- *ppv = CreateByteArray((void*)data.bytes, (int)data.length);
- return S_OK;
+ auto type = [UTType typeWithIdentifier:formatString];
+ return type != nil && [type conformsToType:UTTypeText];
+ }
+ else
+ {
+ return UTTypeConformsTo((__bridge CFStringRef)formatString, kUTTypeText);
}
}
+};
+
+extern IAvnClipboard* CreateClipboard(NSPasteboard* pb)
+{
+ return new Clipboard(pb);
+}
+
+
+@implementation WriteableClipboardItem
+{
+ IAvnClipboardDataItem* _item;
+ IAvnClipboardDataSource* _source;
+}
+
+- (nonnull WriteableClipboardItem*) initWithItem:(nonnull IAvnClipboardDataItem*)item source:(nonnull IAvnClipboardDataSource*)source
+{
+ self = [super init];
+ _item = item;
+ _source = source;
+
+ // Each item references its source so it doesn't get disposed too early.
+ source->AddRef();
+
+ return self;
+}
- virtual HRESULT Clear(int64_t* rv) override
+NSString* TryConvertFormatToUti(NSString* format)
+{
+ if (@available(macOS 11.0, *))
{
- START_COM_CALL;
-
- @autoreleasepool
+ auto type = [UTType typeWithIdentifier:format];
+ if (type == nil)
{
- if(_item != nil)
- {
- _item = [NSPasteboardItem new];
- return 0;
- }
+ if ([format containsString:@"/"])
+ type = [UTType typeWithMIMEType:format];
else
+ type = [UTType exportedTypeWithIdentifier:format];
+
+ if (type == nil)
{
- *rv = [_pb clearContents];
- [_pb setString:@"" forType:NSPasteboardTypeString];
+ // For now, we need to use the deprecated UTTypeCreatePreferredIdentifierForTag to create a dynamic UTI for arbitrary strings.
+ // This is only necessary because the old IDataObject can provide arbitrary types that aren't UTIs nor mime types.
+ // With the new DataFormat:
+ // - If the format is an application format, the managed side provides a UTI like net.avaloniaui.app.uti.xxx.
+ // - If the format is an OS format, the user has been warned that they MUST provide a name which is valid for the OS.
+ // TODO12: remove!
+ auto fromPasteboardType = UTTypeCreatePreferredIdentifierForTag(kUTTagClassNSPboardType, (__bridge CFStringRef)format, nil);
+ if (fromPasteboardType != nil)
+ return (__bridge_transfer NSString*)fromPasteboardType;
}
-
- return S_OK;
}
+
+ return type == nil ? nil : [type identifier];
}
-
- virtual HRESULT GetChangeCount(int64_t* rv) override
+ else
{
- START_COM_CALL;
- if(_item == nil)
- {
- *rv = [_pb changeCount];
- return S_OK;
- }
- return E_NOTIMPL;
+ auto bridgedFormat = (__bridge CFStringRef)format;
+ if (UTTypeIsDeclared(bridgedFormat))
+ return format;
+
+ auto fromMimeType = UTTypeCreatePreferredIdentifierForTag(kUTTagClassMIMEType, bridgedFormat, nil);
+ if (fromMimeType != nil)
+ return (__bridge_transfer NSString*)fromMimeType;
+
+ auto fromPasteboardType = UTTypeCreatePreferredIdentifierForTag(kUTTagClassNSPboardType, bridgedFormat, nil);
+ if (fromPasteboardType != nil)
+ return (__bridge_transfer NSString*)fromPasteboardType;
+
+ return nil;
}
+}
+
+- (nonnull NSArray*) writableTypesForPasteboard:(nonnull NSPasteboard*)pasteboard
+{
+ auto formats = _item->ProvideFormats();
+ if (formats == nullptr)
+ return [NSArray array];
- virtual HRESULT ObtainFormats(IAvnStringArray** ppv) override
+ auto count = formats->GetCount();
+ if (count == 0)
+ return [NSArray array];
+
+ auto utis = [NSMutableArray arrayWithCapacity:count];
+ IAvnString* format;
+ for (auto i = 0; i < count; ++i)
{
- START_COM_CALL;
-
- @autoreleasepool
- {
- *ppv = CreateAvnStringArray(_item == nil ? [_pb types] : [_item types]);
- return S_OK;
- }
+ if (formats->Get(i, &format) != S_OK)
+ continue;
+
+ // Only UTIs must be returned from writableTypesForPasteboard or an exception will be thrown
+ auto formatString = GetNSStringAndRelease(format);
+ auto uti = TryConvertFormatToUti(formatString);
+ if (uti != nil)
+ [utis addObject:uti];
}
-};
+ formats->Release();
+
+ [utis addObject:GetAvnCustomDataType()];
+
+ return utis;
+}
-extern IAvnClipboard* CreateClipboard(NSPasteboard* pb, NSPasteboardItem* item)
+- (NSPasteboardWritingOptions) writingOptionsForType:(NSPasteboardType)type pasteboard:(NSPasteboard*)pasteboard
{
- return new Clipboard(pb, item);
+ return [type isEqualToString:NSPasteboardTypeString] || [type isEqualToString:GetAvnCustomDataType()]
+ ? 0
+ : NSPasteboardWritingPromised;
}
-extern NSPasteboardItem* TryGetPasteboardItem(IAvnClipboard*cb)
+- (nullable id) pasteboardPropertyListForType:(nonnull NSPasteboardType)type
{
- auto clipboard = dynamic_cast(cb);
- if(clipboard == nil)
+ if ([type isEqualToString:GetAvnCustomDataType()])
+ return @"";
+
+ ComPtr value(_item->GetValue([type UTF8String]), true);
+ if (value.getRaw() == nullptr)
return nil;
- return clipboard->TryGetItem();
+
+ if (value->IsString())
+ return GetNSStringAndRelease(value->AsString());
+
+ auto length = value->GetByteLength();
+ auto buffer = malloc(length);
+ value->CopyBytesTo(buffer);
+ return [NSData dataWithBytesNoCopy:buffer length:length];
+}
+
+- (void) dealloc
+{
+ if (_item != nullptr)
+ {
+ _item->Release();
+ _item = nullptr;
+ }
+
+ if (_source != nullptr)
+ {
+ _source->Release();
+ _source = nullptr;
+ }
}
+
+@end
diff --git a/native/Avalonia.Native/src/OSX/common.h b/native/Avalonia.Native/src/OSX/common.h
index 36c157704d..819254b841 100644
--- a/native/Avalonia.Native/src/OSX/common.h
+++ b/native/Avalonia.Native/src/OSX/common.h
@@ -16,8 +16,7 @@ extern IAvnWindow* CreateAvnWindow(IAvnWindowEvents*events);
extern IAvnPopup* CreateAvnPopup(IAvnWindowEvents*events);
extern IAvnStorageProvider* CreateStorageProvider();
extern IAvnScreens* CreateScreens(IAvnScreenEvents* cb);
-extern IAvnClipboard* CreateClipboard(NSPasteboard*, NSPasteboardItem*);
-extern NSPasteboardItem* TryGetPasteboardItem(IAvnClipboard*);
+extern IAvnClipboard* CreateClipboard(NSPasteboard* pb);
extern NSObject* CreateDraggingSource(NSDragOperation op, IAvnDndResultCallback* cb, void* handle);
extern void* GetAvnDataObjectHandleFromDraggingInfo(NSObject* info);
extern NSString* GetAvnCustomDataType();
diff --git a/native/Avalonia.Native/src/OSX/dnd.mm b/native/Avalonia.Native/src/OSX/dnd.mm
index 531bdcccfd..aebe4afb88 100644
--- a/native/Avalonia.Native/src/OSX/dnd.mm
+++ b/native/Avalonia.Native/src/OSX/dnd.mm
@@ -14,9 +14,17 @@ extern AvnDragDropEffects ConvertDragDropEffects(NSDragOperation nsop)
extern NSString* GetAvnCustomDataType()
{
- char buffer[256];
- sprintf(buffer, "net.avaloniaui.inproc.uti.n%in", getpid());
- return [NSString stringWithUTF8String:buffer];
+ static NSString* result = nil;
+
+ if (result == nil)
+ {
+ const size_t bufferSize = 256;
+ char buffer[bufferSize];
+ snprintf(buffer, bufferSize, "net.avaloniaui.inproc.uti.n%in", getpid());
+ result = [NSString stringWithUTF8String:buffer];
+ }
+
+ return result;
}
@interface AvnDndSource : NSObject
diff --git a/native/Avalonia.Native/src/OSX/main.mm b/native/Avalonia.Native/src/OSX/main.mm
index 0e3621517e..f4e244efdd 100644
--- a/native/Avalonia.Native/src/OSX/main.mm
+++ b/native/Avalonia.Native/src/OSX/main.mm
@@ -312,18 +312,7 @@ public:
@autoreleasepool
{
- *ppv = ::CreateClipboard (nil, nil);
- return S_OK;
- }
- }
-
- virtual HRESULT CreateDndClipboard(IAvnClipboard** ppv) override
- {
- START_COM_CALL;
-
- @autoreleasepool
- {
- *ppv = ::CreateClipboard (nil, [NSPasteboardItem new]);
+ *ppv = ::CreateClipboard(nil);
return S_OK;
}
}
diff --git a/samples/ControlCatalog/Pages/ClipboardPage.xaml b/samples/ControlCatalog/Pages/ClipboardPage.xaml
index 0349936733..2c22348f6f 100644
--- a/samples/ControlCatalog/Pages/ClipboardPage.xaml
+++ b/samples/ControlCatalog/Pages/ClipboardPage.xaml
@@ -6,12 +6,10 @@
-
-
-
-
-
-
+
+
+
+
diff --git a/samples/ControlCatalog/Pages/ClipboardPage.xaml.cs b/samples/ControlCatalog/Pages/ClipboardPage.xaml.cs
index f471647c15..2fc8cc6616 100644
--- a/samples/ControlCatalog/Pages/ClipboardPage.xaml.cs
+++ b/samples/ControlCatalog/Pages/ClipboardPage.xaml.cs
@@ -10,21 +10,22 @@ using Avalonia.Input.Platform;
using Avalonia.Interactivity;
using Avalonia.Markup.Xaml;
using Avalonia.Media;
-using Avalonia.Platform;
using Avalonia.Platform.Storage;
-using Avalonia.Platform.Storage.FileIO;
using Avalonia.Threading;
namespace ControlCatalog.Pages
{
public partial class ClipboardPage : UserControl
{
+ private readonly DataFormat _customBinaryDataFormat =
+ DataFormat.CreateBytesApplicationFormat("controlcatalog-binary-data");
+
private INotificationManager? _notificationManager;
private INotificationManager NotificationManager => _notificationManager
??= new WindowNotificationManager(TopLevel.GetTopLevel(this)!);
private readonly DispatcherTimer _clipboardLastDataObjectChecker;
- private DataObject? _storedDataObject;
+ private DataTransfer? _storedDataTransfer;
public ClipboardPage()
{
_clipboardLastDataObjectChecker =
@@ -40,38 +41,20 @@ namespace ControlCatalog.Pages
}
private async void CopyText(object? sender, RoutedEventArgs args)
- {
- if (TopLevel.GetTopLevel(this)?.Clipboard is { } clipboard && ClipboardContent is { } clipboardContent)
- await clipboard.SetTextAsync(clipboardContent.Text ?? String.Empty);
- }
-
- private async void PasteText(object? sender, RoutedEventArgs args)
{
if (TopLevel.GetTopLevel(this)?.Clipboard is { } clipboard)
- {
- ClipboardContent.Text = await clipboard.GetTextAsync();
- }
+ await clipboard.SetTextAsync(ClipboardContent.Text ?? string.Empty);
}
- private async void CopyTextDataObject(object? sender, RoutedEventArgs args)
- {
- if (TopLevel.GetTopLevel(this)?.Clipboard is { } clipboard)
- {
- var dataObject = _storedDataObject = new DataObject();
- dataObject.Set(DataFormats.Text, ClipboardContent.Text ?? string.Empty);
- await clipboard.SetDataObjectAsync(dataObject);
- }
- }
-
- private async void PasteTextDataObject(object? sender, RoutedEventArgs args)
+ private async void PasteText(object? sender, RoutedEventArgs args)
{
if (TopLevel.GetTopLevel(this)?.Clipboard is { } clipboard)
{
- ClipboardContent.Text = await clipboard.GetDataAsync(DataFormats.Text) as string ?? string.Empty;
+ ClipboardContent.Text = await clipboard.TryGetTextAsync();
}
}
- private async void CopyFilesDataObject(object? sender, RoutedEventArgs args)
+ private async void CopyFiles(object? sender, RoutedEventArgs args)
{
if (TopLevel.GetTopLevel(this)?.Clipboard is { } clipboard)
{
@@ -105,10 +88,11 @@ namespace ControlCatalog.Pages
if (files.Count > 0)
{
- var dataObject = _storedDataObject = new DataObject();
- dataObject.Set(DataFormats.Files, files);
- await clipboard.SetDataObjectAsync(dataObject);
- NotificationManager.Show(new Notification("Success", "Copy completated.", NotificationType.Success));
+ var dataTransfer = _storedDataTransfer = new DataTransfer();
+ foreach (var file in files)
+ dataTransfer.Add(DataTransferItem.Create(DataFormat.File, file));
+ await clipboard.SetDataAsync(dataTransfer);
+ NotificationManager.Show(new Notification("Success", "Copy completed.", NotificationType.Success));
}
else
{
@@ -117,11 +101,11 @@ namespace ControlCatalog.Pages
}
}
- private async void PasteFilesDataObject(object? sender, RoutedEventArgs args)
+ private async void PasteFiles(object? sender, RoutedEventArgs args)
{
if (TopLevel.GetTopLevel(this)?.Clipboard is { } clipboard)
{
- var files = await clipboard.GetDataAsync(DataFormats.Files) as IEnumerable;
+ var files = await clipboard.TryGetFilesAsync();
ClipboardContent.Text = files != null ? string.Join(Environment.NewLine, files.Select(f => f.TryGetLocalPath() ?? f.Name)) : string.Empty;
}
@@ -131,11 +115,32 @@ namespace ControlCatalog.Pages
{
if (TopLevel.GetTopLevel(this)?.Clipboard is { } clipboard)
{
- var formats = await clipboard.GetFormatsAsync();
+ var formats = await clipboard.GetDataFormatsAsync();
ClipboardContent.Text = string.Join(Environment.NewLine, formats);
}
}
+ private async void CopyBinaryData(object? sender, RoutedEventArgs args)
+ {
+ if (TopLevel.GetTopLevel(this)?.Clipboard is { } clipboard)
+ {
+ var dataTransfer = _storedDataTransfer = new DataTransfer();
+ var bytes = new byte[10 * 1024 * 1024];
+ new Random().NextBytes(bytes);
+ dataTransfer.Add(DataTransferItem.Create(_customBinaryDataFormat, bytes));
+ await clipboard.SetDataAsync(dataTransfer);
+ }
+ }
+
+ private async void PasteBinaryData(object? sender, RoutedEventArgs args)
+ {
+ if (TopLevel.GetTopLevel(this)?.Clipboard is { } clipboard)
+ {
+ var bytes = await clipboard.TryGetValueAsync(_customBinaryDataFormat);
+ ClipboardContent.Text = bytes is null ? "" : $"{bytes.Length} bytes";
+ }
+ }
+
private async void Clear(object sender, RoutedEventArgs args)
{
if (TopLevel.GetTopLevel(this)?.Clipboard is { } clipboard)
@@ -159,22 +164,28 @@ namespace ControlCatalog.Pages
}
private Run OwnsClipboardDataObject => this.Get("OwnsClipboardDataObject");
- private bool _checkingClipboardDataObject;
+ private bool _checkingClipboardDataTransfer;
private async void CheckLastDataObject(object? sender, EventArgs e)
{
- if(_checkingClipboardDataObject)
+ if(_checkingClipboardDataTransfer)
return;
try
{
- _checkingClipboardDataObject = true;
- var task = TopLevel.GetTopLevel(this)?.Clipboard?.TryGetInProcessDataObjectAsync();
- var owns = task != null && (await task) == _storedDataObject && _storedDataObject != null;
+ _checkingClipboardDataTransfer = true;
+
+ var owns = false;
+ if (TopLevel.GetTopLevel(this)?.Clipboard is { } clipboard)
+ {
+ var dataTransfer = await clipboard.TryGetInProcessDataAsync();
+ owns = dataTransfer == _storedDataTransfer && dataTransfer is not null;
+ }
+
OwnsClipboardDataObject.Text = owns ? "Yes" : "No";
OwnsClipboardDataObject.Foreground = owns ? Brushes.Green : Brushes.Red;
}
finally
{
- _checkingClipboardDataObject = false;
+ _checkingClipboardDataTransfer = false;
}
}
}
diff --git a/samples/ControlCatalog/Pages/DragAndDropPage.xaml.cs b/samples/ControlCatalog/Pages/DragAndDropPage.xaml.cs
index b242d020b0..791f075d43 100644
--- a/samples/ControlCatalog/Pages/DragAndDropPage.xaml.cs
+++ b/samples/ControlCatalog/Pages/DragAndDropPage.xaml.cs
@@ -1,9 +1,11 @@
using System;
using System.Linq;
using System.Reflection;
+using System.Text;
using System.Threading.Tasks;
using Avalonia.Controls;
using Avalonia.Input;
+using Avalonia.Input.Platform;
using Avalonia.Markup.Xaml;
using Avalonia.Platform.Storage;
@@ -12,7 +14,10 @@ namespace ControlCatalog.Pages
public class DragAndDropPage : UserControl
{
private readonly TextBlock _dropState;
- private const string CustomFormat = "application/xxx-avalonia-controlcatalog-custom";
+
+ private readonly DataFormat _customFormat =
+ DataFormat.CreateStringApplicationFormat("xxx-avalonia-controlcatalog-custom");
+
public DragAndDropPage()
{
InitializeComponent();
@@ -22,13 +27,13 @@ namespace ControlCatalog.Pages
SetupDnd(
"Text",
- d => d.Set(DataFormats.Text, $"Text was dragged {++textCount} times"),
+ d => d.Add(DataTransferItem.Create(DataFormat.Text, $"Text was dragged {++textCount} times")),
DragDropEffects.Copy | DragDropEffects.Move | DragDropEffects.Link);
SetupDnd(
"Custom",
- d => d.Set(CustomFormat, "Test123"),
- DragDropEffects.Move);
+ d => d.Add(DataTransferItem.Create(_customFormat, "Test123")),
+ DragDropEffects.Copy | DragDropEffects.Move);
SetupDnd(
"Files",
@@ -38,13 +43,13 @@ namespace ControlCatalog.Pages
TopLevel.GetTopLevel(this) is { } topLevel &&
await topLevel.StorageProvider.TryGetFileFromPathAsync(name) is { } storageFile)
{
- d.Set(DataFormats.Files, new[] { storageFile });
+ d.Add(DataTransferItem.Create(DataFormat.File, storageFile));
}
},
DragDropEffects.Copy);
}
- private void SetupDnd(string suffix, Action factory, DragDropEffects effects) =>
+ private void SetupDnd(string suffix, Action factory, DragDropEffects effects) =>
SetupDnd(
suffix,
o =>
@@ -54,17 +59,17 @@ namespace ControlCatalog.Pages
},
effects);
- private void SetupDnd(string suffix, Func factory, DragDropEffects effects)
+ private void SetupDnd(string suffix, Func factory, DragDropEffects effects)
{
var dragMe = this.Get("DragMe" + suffix);
var dragState = this.Get("DragState" + suffix);
async void DoDrag(object? sender, PointerPressedEventArgs e)
{
- var dragData = new DataObject();
+ var dragData = new DataTransfer();
await factory(dragData);
- var result = await DragDrop.DoDragDrop(e, dragData, effects);
+ var result = await DragDrop.DoDragDropAsync(e, dragData, effects);
switch (result)
{
case DragDropEffects.Move:
@@ -97,9 +102,9 @@ namespace ControlCatalog.Pages
}
// Only allow if the dragged data contains text or filenames.
- if (!e.Data.Contains(DataFormats.Text)
- && !e.Data.Contains(DataFormats.Files)
- && !e.Data.Contains(CustomFormat))
+ if (!e.DataTransfer.Contains(DataFormat.Text)
+ && !e.DataTransfer.Contains(DataFormat.File)
+ && !e.DataTransfer.Contains(_customFormat))
e.DragEffects = DragDropEffects.None;
}
@@ -114,13 +119,13 @@ namespace ControlCatalog.Pages
e.DragEffects = e.DragEffects & (DragDropEffects.Copy);
}
- if (e.Data.Contains(DataFormats.Text))
+ if (e.DataTransfer.Contains(DataFormat.Text))
{
- _dropState.Text = e.Data.GetText();
+ _dropState.Text = e.DataTransfer.TryGetText();
}
- else if (e.Data.Contains(DataFormats.Files))
+ else if (e.DataTransfer.Contains(DataFormat.File))
{
- var files = e.Data.GetFiles() ?? Array.Empty();
+ var files = e.DataTransfer.TryGetFiles() ?? [];
var contentStr = "";
foreach (var item in files)
@@ -143,16 +148,9 @@ namespace ControlCatalog.Pages
_dropState.Text = contentStr;
}
-#pragma warning disable CS0618 // Type or member is obsolete
- else if (e.Data.Contains(DataFormats.FileNames))
- {
- var files = e.Data.GetFileNames();
- _dropState.Text = string.Join(Environment.NewLine, files ?? Array.Empty());
- }
-#pragma warning restore CS0618 // Type or member is obsolete
- else if (e.Data.Contains(CustomFormat))
+ else if (e.DataTransfer.Contains(_customFormat))
{
- _dropState.Text = "Custom: " + e.Data.Get(CustomFormat);
+ _dropState.Text = "Custom: " + e.DataTransfer.TryGetValue(_customFormat);
}
}
diff --git a/src/Android/Avalonia.Android/Platform/AndroidDataFormatHelper.cs b/src/Android/Avalonia.Android/Platform/AndroidDataFormatHelper.cs
new file mode 100644
index 0000000000..686234aaef
--- /dev/null
+++ b/src/Android/Avalonia.Android/Platform/AndroidDataFormatHelper.cs
@@ -0,0 +1,36 @@
+using System;
+using Android.Content;
+using Avalonia.Input;
+
+namespace Avalonia.Android.Platform;
+
+internal static class AndroidDataFormatHelper
+{
+ private const string AppPrefix = "application/avn-fmt.";
+
+ public static DataFormat MimeTypeToDataFormat(string mimeType)
+ {
+ if (mimeType == ClipDescription.MimetypeTextPlain)
+ return DataFormat.Text;
+
+ if (mimeType == ClipDescription.MimetypeTextUrilist)
+ return DataFormat.File;
+
+ if (mimeType.StartsWith("text/", StringComparison.OrdinalIgnoreCase))
+ return DataFormat.FromSystemName(mimeType, AppPrefix);
+
+ return DataFormat.FromSystemName(mimeType, AppPrefix);
+ }
+
+ public static string DataFormatToMimeType(DataFormat format)
+ {
+ if (DataFormat.Text.Equals(format))
+ return ClipDescription.MimetypeTextPlain;
+
+ if (DataFormat.File.Equals(format))
+ return ClipDescription.MimetypeTextUrilist;
+
+ return format.ToSystemName(AppPrefix);
+ }
+
+}
diff --git a/src/Android/Avalonia.Android/Platform/ClipDataItemToDataTransferItemWrapper.cs b/src/Android/Avalonia.Android/Platform/ClipDataItemToDataTransferItemWrapper.cs
new file mode 100644
index 0000000000..479e5e2001
--- /dev/null
+++ b/src/Android/Avalonia.Android/Platform/ClipDataItemToDataTransferItemWrapper.cs
@@ -0,0 +1,58 @@
+using System;
+using Android.App;
+using Android.Content;
+using Avalonia.Android.Platform.Storage;
+using Avalonia.Input;
+using Avalonia.Input.Platform;
+
+namespace Avalonia.Android.Platform;
+
+///
+/// Wraps a into a .
+///
+/// The clip data item.
+/// The data transfer owning this item.
+internal sealed class ClipDataItemToDataTransferItemWrapper(ClipData.Item item, ClipDataToDataTransferWrapper owner)
+ : PlatformDataTransferItem
+{
+ private readonly ClipData.Item _item = item;
+ private readonly ClipDataToDataTransferWrapper _owner = owner;
+
+ protected override DataFormat[] ProvideFormats()
+ => _owner.Formats; // There's no "format per item", assume each item handle all formats
+
+ protected override object? TryGetRawCore(DataFormat format)
+ {
+ if (DataFormat.Text.Equals(format))
+ return _item.CoerceToText(_owner.Context);
+
+ if (DataFormat.File.Equals(format))
+ {
+ return _item.Uri is { Scheme: "file" or "content" } fileUri && _owner.Context is Activity activity ?
+ AndroidStorageItem.CreateItem(activity, fileUri) :
+ null;
+ }
+
+ if (format is DataFormat)
+ return TryGetAsString();
+
+ return null;
+ }
+
+ private string? TryGetAsString()
+ {
+ if (_item.Text is { } text)
+ return text;
+
+ if (_item.HtmlText is { } htmlText)
+ return htmlText;
+
+ if (_item.Uri is { } uri)
+ return uri.ToString();
+
+ if (_item.Intent is { } intent)
+ return intent.ToUri(IntentUriType.Scheme);
+
+ return null;
+ }
+}
diff --git a/src/Android/Avalonia.Android/Platform/ClipDataToDataTransferWrapper.cs b/src/Android/Avalonia.Android/Platform/ClipDataToDataTransferWrapper.cs
new file mode 100644
index 0000000000..8bd9079142
--- /dev/null
+++ b/src/Android/Avalonia.Android/Platform/ClipDataToDataTransferWrapper.cs
@@ -0,0 +1,46 @@
+using Android.Content;
+using Avalonia.Input;
+using Avalonia.Input.Platform;
+
+namespace Avalonia.Android.Platform;
+
+///
+/// Wraps a into a .
+///
+/// The clip data.
+/// The application context.
+internal sealed class ClipDataToDataTransferWrapper(ClipData clipData, Context? context)
+ : PlatformDataTransfer
+{
+ private readonly ClipData _clipData = clipData;
+
+ public Context? Context { get; } = context;
+
+ protected override DataFormat[] ProvideFormats()
+ {
+ if (_clipData.Description is not { MimeTypeCount: > 0 and var count } clipDescription)
+ return [];
+
+ var formats = new DataFormat[count];
+
+ for (var i = 0; i < count; ++i)
+ formats[i] = AndroidDataFormatHelper.MimeTypeToDataFormat(clipDescription.GetMimeType(i)!);
+
+ return formats;
+ }
+
+ protected override PlatformDataTransferItem[] ProvideItems()
+ {
+ var count = _clipData.ItemCount;
+ var items = new PlatformDataTransferItem[count];
+
+ for (var i = 0; i < count; ++i)
+ items[i] = new ClipDataItemToDataTransferItemWrapper(_clipData.GetItemAt(i)!, this);
+
+ return items;
+ }
+
+ public override void Dispose()
+ {
+ }
+}
diff --git a/src/Android/Avalonia.Android/Platform/ClipboardImpl.cs b/src/Android/Avalonia.Android/Platform/ClipboardImpl.cs
index 7012ad1878..4dc7790209 100644
--- a/src/Android/Avalonia.Android/Platform/ClipboardImpl.cs
+++ b/src/Android/Avalonia.Android/Platform/ClipboardImpl.cs
@@ -1,65 +1,145 @@
using System;
+using System.Collections.Generic;
+using System.Linq;
using System.Threading.Tasks;
using Android.Content;
using Avalonia.Input;
using Avalonia.Input.Platform;
+using Avalonia.Logging;
+using AndroidUri = Android.Net.Uri;
namespace Avalonia.Android.Platform
{
- internal class ClipboardImpl : IClipboard
+ internal sealed class ClipboardImpl(ClipboardManager? clipboardManager, Context? context)
+ : IClipboardImpl
{
- private readonly ClipboardManager? _clipboardManager;
+ private readonly ClipboardManager? _clipboardManager = clipboardManager;
+ private readonly Context? _context = context;
- internal ClipboardImpl(ClipboardManager? value)
+ public Task TryGetDataAsync()
{
- _clipboardManager = value;
+ try
+ {
+ return Task.FromResult(TryGetData());
+ }
+ catch (Exception ex)
+ {
+ return Task.FromException(ex);
+ }
}
- public Task GetTextAsync()
+ private ClipDataToDataTransferWrapper? TryGetData()
+ => _clipboardManager?.PrimaryClip is { } clipData ?
+ new ClipDataToDataTransferWrapper(clipData, _context) :
+ null;
+
+ public async Task SetDataAsync(IAsyncDataTransfer dataTransfer)
{
- if (_clipboardManager?.HasPrimaryClip == true)
+ if (_clipboardManager is null)
+ return;
+
+ var mimeTypes = dataTransfer.Formats
+ .Select(AndroidDataFormatHelper.DataFormatToMimeType)
+ .ToArray();
+
+ ClipData.Item? firstItem = null;
+ List? additionalItems = null;
+
+ foreach (var dataTransferItem in dataTransfer.Items)
{
- return Task.FromResult(_clipboardManager.PrimaryClip?.GetItemAt(0)?.Text);
+ if (await TryCreateDataItemAsync(dataTransferItem) is not { } clipDataItem)
+ continue;
+
+ if (firstItem is null)
+ firstItem = clipDataItem;
+ else
+ (additionalItems ??= new()).Add(clipDataItem);
}
- return Task.FromResult(null);
+ if (firstItem is null)
+ {
+ Clear();
+ return;
+ }
+
+ var clipData = new ClipData((string?)null, mimeTypes, firstItem);
+
+ if (additionalItems is not null)
+ {
+ foreach (var additionalItem in additionalItems)
+ clipData.AddItem(additionalItem);
+ }
+
+ _clipboardManager.PrimaryClip = clipData;
}
- public Task SetTextAsync(string? text)
+ private async Task TryCreateDataItemAsync(IAsyncDataTransferItem item)
{
- if(_clipboardManager == null)
+ var hasFormats = false;
+
+ // Create the item from the first format returning a supported value.
+ foreach (var dataFormat in item.Formats)
{
- return Task.CompletedTask;
+ hasFormats = true;
+
+ if (DataFormat.Text.Equals(dataFormat))
+ {
+ var text = await item.TryGetValueAsync(DataFormat.Text);
+ return new ClipData.Item(text, string.Empty);
+ }
+
+ if (DataFormat.File.Equals(dataFormat))
+ {
+ var storageItem = await item.TryGetValueAsync(DataFormat.File);
+ if (storageItem is null)
+ continue;
+
+ return new ClipData.Item(AndroidUri.Parse(storageItem.Path.OriginalString));
+ }
+
+ if (dataFormat is DataFormat stringFormat)
+ {
+ var stringValue = await item.TryGetValueAsync(stringFormat);
+ if (stringValue is null)
+ continue;
+
+ return new ClipData.Item(stringValue);
+ }
}
- var clip = ClipData.NewPlainText("text", text);
- _clipboardManager.PrimaryClip = clip;
+ if (hasFormats)
+ {
+ Logger.TryGet(LogEventLevel.Warning, LogArea.AndroidPlatform)?.Log(
+ this,
+ "No compatible value found for data transfer item with formats {Formats}",
+ string.Join(", ", item.Formats));
+ }
- return Task.CompletedTask;
+ return null;
}
public Task ClearAsync()
{
- if (_clipboardManager == null)
+ try
{
+ Clear();
return Task.CompletedTask;
}
-
- _clipboardManager.PrimaryClip = null;
-
- return Task.CompletedTask;
+ catch (Exception ex)
+ {
+ return Task.FromException(ex);
+ }
}
- public Task SetDataObjectAsync(IDataObject data) => throw new PlatformNotSupportedException();
-
- public Task GetFormatsAsync() => throw new PlatformNotSupportedException();
-
- public Task GetDataAsync(string format) => throw new PlatformNotSupportedException();
-
- public Task TryGetInProcessDataObjectAsync() => Task.FromResult(null);
+ private void Clear()
+ {
+ if (_clipboardManager is null)
+ return;
- ///
- public Task FlushAsync() =>
- Task.CompletedTask;
+ if (OperatingSystem.IsAndroidVersionAtLeast(28))
+ _clipboardManager.ClearPrimaryClip();
+ else
+ _clipboardManager.PrimaryClip = ClipData.NewPlainText(null, string.Empty);
+ }
}
}
diff --git a/src/Android/Avalonia.Android/Platform/SkiaPlatform/TopLevelImpl.cs b/src/Android/Avalonia.Android/Platform/SkiaPlatform/TopLevelImpl.cs
index ec2b31f5bf..0a0de9dae6 100644
--- a/src/Android/Avalonia.Android/Platform/SkiaPlatform/TopLevelImpl.cs
+++ b/src/Android/Avalonia.Android/Platform/SkiaPlatform/TopLevelImpl.cs
@@ -40,7 +40,7 @@ namespace Avalonia.Android.Platform.SkiaPlatform
private readonly IStorageProvider? _storageProvider;
private readonly AndroidSystemNavigationManagerImpl _systemNavigationManager;
private readonly AndroidInsetsManager? _insetsManager;
- private readonly ClipboardImpl _clipboard;
+ private readonly Clipboard _clipboard;
private readonly AndroidLauncher? _launcher;
private readonly AndroidScreens? _screens;
private ViewImpl _view;
@@ -48,23 +48,25 @@ namespace Avalonia.Android.Platform.SkiaPlatform
public TopLevelImpl(AvaloniaView avaloniaView, bool placeOnTop = false)
{
- if (avaloniaView.Context is null)
+ if (avaloniaView.Context is not { } context)
{
throw new ArgumentException("AvaloniaView.Context must not be null");
}
- _view = new ViewImpl(avaloniaView.Context, this, placeOnTop);
+ _view = new ViewImpl(context, this, placeOnTop);
_textInputMethod = new AndroidInputMethod(avaloniaView);
_keyboardHelper = new AndroidKeyboardEventsHelper(this);
_pointerHelper = new AndroidMotionEventsHelper(this);
_gl = new EglGlPlatformSurface(this);
_framebuffer = new FramebufferManager(this);
- _clipboard = new ClipboardImpl(avaloniaView.Context.GetSystemService(Context.ClipboardService).JavaCast());
- _screens = new AndroidScreens(avaloniaView.Context);
+ _clipboard = new Clipboard(new ClipboardImpl(
+ context.GetSystemService(Context.ClipboardService).JavaCast(),
+ context));
+ _screens = new AndroidScreens(context);
RenderScaling = _view.Scaling;
- if (avaloniaView.Context is Activity mainActivity)
+ if (context is Activity mainActivity)
{
_insetsManager = new AndroidInsetsManager(mainActivity, this);
_storageProvider = new AndroidStorageProvider(mainActivity);
@@ -74,7 +76,7 @@ namespace Avalonia.Android.Platform.SkiaPlatform
_nativeControlHost = new AndroidNativeControlHostImpl(avaloniaView);
_transparencyLevel = WindowTransparencyLevel.None;
- _systemNavigationManager = new AndroidSystemNavigationManagerImpl(avaloniaView.Context as IActivityNavigationService);
+ _systemNavigationManager = new AndroidSystemNavigationManagerImpl(context as IActivityNavigationService);
Surfaces = new object[] { _gl, _framebuffer, _view };
Handle = new AndroidViewControlHandle(_view);
diff --git a/src/Avalonia.Base/Avalonia.Base.csproj b/src/Avalonia.Base/Avalonia.Base.csproj
index 3e89984a38..485a825017 100644
--- a/src/Avalonia.Base/Avalonia.Base.csproj
+++ b/src/Avalonia.Base/Avalonia.Base.csproj
@@ -17,9 +17,11 @@
-
-
+
+
+
+
diff --git a/src/Avalonia.Base/Input/AsyncDataTransferExtensions.cs b/src/Avalonia.Base/Input/AsyncDataTransferExtensions.cs
new file mode 100644
index 0000000000..3e62a295d3
--- /dev/null
+++ b/src/Avalonia.Base/Input/AsyncDataTransferExtensions.cs
@@ -0,0 +1,139 @@
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using Avalonia.Logging;
+using Avalonia.Platform.Storage;
+
+namespace Avalonia.Input;
+
+// Keep AsyncDataTransferExtensions.TryGetXxxAsync methods in sync with DataTransferExtensions.TryGetXxx ones.
+
+///
+/// Contains extension methods for .
+///
+public static class AsyncDataTransferExtensions
+{
+ internal static IDataTransfer ToSynchronous(this IAsyncDataTransfer asyncDataTransfer, string logArea)
+ {
+ if (asyncDataTransfer is IDataTransfer dataTransfer)
+ return dataTransfer;
+
+ Logger.TryGet(LogEventLevel.Warning, logArea)?.Log(
+ null,
+ $"Using a synchronous wrapper for {nameof(IAsyncDataTransferItem)} {{Type}}. Consider implementing {nameof(IDataTransfer)} instead.",
+ asyncDataTransfer.GetType());
+
+ return new AsyncToSyncDataTransfer(asyncDataTransfer);
+ }
+
+ ///
+ /// Gets whether a supports a specific format.
+ ///
+ /// The instance.
+ /// The format to check.
+ /// true if is supported, false otherwise.
+ public static bool Contains(this IAsyncDataTransfer dataTransfer, DataFormat format)
+ {
+ var formats = dataTransfer.Formats;
+ var count = formats.Count;
+
+ for (var i = 0; i < count; ++i)
+ {
+ if (format == formats[i])
+ return true;
+ }
+
+ return false;
+ }
+
+ ///
+ /// Gets the list of contained in this object, filtered by a given format.
+ ///
+ ///
+ ///
+ /// Some platforms (such as Windows and X11) may only support a single data item for all formats
+ /// except .
+ ///
+ /// Items returned by this property must stay valid until the is disposed.
+ ///
+ public static IEnumerable GetItems(this IAsyncDataTransfer dataTransfer, DataFormat format)
+ {
+ var items = dataTransfer.Items;
+ var count = items.Count;
+
+ for (var i = 0; i < count; ++i)
+ {
+ var item = items[i];
+ if (item.Contains(format))
+ yield return item;
+ }
+ }
+
+ ///
+ /// Tries to get a value for a given format from a .
+ ///
+ /// The instance.
+ /// The format to retrieve.
+ /// A value for , or null if the format is not supported.
+ ///
+ /// If the contains several items supporting ,
+ /// the first matching one will be returned.
+ ///
+ public static Task TryGetValueAsync(this IAsyncDataTransfer dataTransfer, DataFormat format)
+ where T : class
+ => dataTransfer.GetItems(format).FirstOrDefault() is { } item ?
+ item.TryGetValueAsync(format) :
+ Task.FromResult(null);
+
+ ///
+ /// Tries to get multiple values for a given format from a .
+ ///
+ /// The instance.
+ /// The format to retrieve.
+ /// A list of values for , or null if the format is not supported.
+ public static async Task TryGetValuesAsync(this IAsyncDataTransfer dataTransfer, DataFormat format)
+ where T : class
+ {
+ List? results = null;
+
+ foreach (var item in dataTransfer.GetItems(format))
+ {
+ // No ConfigureAwait(false) here: we want TryGetAsync() for next items to be called on the initial thread.
+ var result = await item.TryGetValueAsync(format);
+ if (result is null)
+ continue;
+
+ results ??= [];
+ results.Add(result);
+ }
+
+ return results?.ToArray();
+ }
+
+ ///
+ /// Returns a text, if available, from a instance.
+ ///
+ /// The data transfer instance.
+ /// A string, or null if the format isn't available.
+ /// .
+ public static Task TryGetTextAsync(this IAsyncDataTransfer dataTransfer)
+ => dataTransfer.TryGetValueAsync(DataFormat.Text);
+
+ ///
+ /// Returns a file, if available, from a instance.
+ ///
+ /// The data transfer instance.
+ /// An (file or folder), or null if the format isn't available.
+ /// .
+ public static Task TryGetFileAsync(this IAsyncDataTransfer dataTransfer)
+ => dataTransfer.TryGetValueAsync(DataFormat.File);
+
+ ///
+ /// Returns a list of files, if available, from a instance.
+ ///
+ /// The data transfer instance.
+ /// An array of (files or folders), or null if the format isn't available.
+ /// .
+ public static Task TryGetFilesAsync(this IAsyncDataTransfer dataTransfer)
+ => dataTransfer.TryGetValuesAsync(DataFormat.File);
+}
diff --git a/src/Avalonia.Base/Input/AsyncDataTransferItemExtensions.cs b/src/Avalonia.Base/Input/AsyncDataTransferItemExtensions.cs
new file mode 100644
index 0000000000..dfe2b7c9cf
--- /dev/null
+++ b/src/Avalonia.Base/Input/AsyncDataTransferItemExtensions.cs
@@ -0,0 +1,58 @@
+using System.Threading.Tasks;
+using Avalonia.Platform.Storage;
+
+namespace Avalonia.Input;
+
+///
+/// Contains extension methods for .
+///
+public static class AsyncDataTransferItemExtensions
+{
+ ///
+ /// Gets whether a supports a specific format.
+ ///
+ /// The instance.
+ /// The format to check.
+ /// true if is supported, false otherwise.
+ public static bool Contains(this IAsyncDataTransferItem dataTransferItem, DataFormat format)
+ {
+ var formats = dataTransferItem.Formats;
+ var count = formats.Count;
+
+ for (var i = 0; i < count; ++i)
+ {
+ if (format == formats[i])
+ return true;
+ }
+
+ return false;
+ }
+
+ ///
+ /// Tries to get a value for a given format from a .
+ ///
+ /// The instance.
+ /// The format to retrieve.
+ /// A value for , or null if the format is not supported.
+ public static async Task TryGetValueAsync(this IAsyncDataTransferItem dataTransferItem, DataFormat format)
+ where T : class
+ => await dataTransferItem.TryGetRawAsync(format).ConfigureAwait(false) as T;
+
+ ///
+ /// Returns a text, if available, from a instance.
+ ///
+ /// The data transfer instance.
+ /// A string, or null if the format isn't available.
+ /// .
+ public static Task TryGetTextAsync(this IAsyncDataTransferItem dataTransferItem)
+ => dataTransferItem.TryGetValueAsync(DataFormat.Text);
+
+ ///
+ /// Returns a file, if available, from a instance.
+ ///
+ /// The data transfer instance.
+ /// An (file or folder), or null if the format isn't available.
+ /// .
+ public static Task TryGetFileAsync(this IAsyncDataTransferItem dataTransferItem)
+ => dataTransferItem.TryGetValueAsync(DataFormat.File);
+}
diff --git a/src/Avalonia.Base/Input/AsyncToSyncDataTransfer.cs b/src/Avalonia.Base/Input/AsyncToSyncDataTransfer.cs
new file mode 100644
index 0000000000..1fc975adc7
--- /dev/null
+++ b/src/Avalonia.Base/Input/AsyncToSyncDataTransfer.cs
@@ -0,0 +1,45 @@
+using System.Collections.Generic;
+
+namespace Avalonia.Input;
+
+///
+/// Wraps a into a .
+///
+/// The async object to wrap.
+/// Using this type should be a last resort!
+internal sealed class AsyncToSyncDataTransfer(IAsyncDataTransfer asyncDataTransfer)
+ : IDataTransfer, IAsyncDataTransfer
+{
+ private readonly IAsyncDataTransfer _asyncDataTransfer = asyncDataTransfer;
+ private AsyncToSyncDataTransferItem[]? _items;
+
+ public IReadOnlyList Formats
+ => _asyncDataTransfer.Formats;
+
+ public IReadOnlyList Items
+ => _items ??= ProvideItems();
+
+ IReadOnlyList IDataTransfer.Items
+ => Items;
+
+ IReadOnlyList IAsyncDataTransfer.Items
+ => _asyncDataTransfer.Items;
+
+ private AsyncToSyncDataTransferItem[] ProvideItems()
+ {
+ var asyncItems = _asyncDataTransfer.Items;
+ var count = asyncItems.Count;
+ var syncItems = new AsyncToSyncDataTransferItem[count];
+
+ for (var i = 0; i < count; ++i)
+ {
+ var asyncItem = asyncItems[i];
+ syncItems[i] = new AsyncToSyncDataTransferItem(asyncItem);
+ }
+
+ return syncItems;
+ }
+
+ public void Dispose()
+ => _asyncDataTransfer.Dispose();
+}
diff --git a/src/Avalonia.Base/Input/AsyncToSyncDataTransferItem.cs b/src/Avalonia.Base/Input/AsyncToSyncDataTransferItem.cs
new file mode 100644
index 0000000000..c7cc2579c6
--- /dev/null
+++ b/src/Avalonia.Base/Input/AsyncToSyncDataTransferItem.cs
@@ -0,0 +1,24 @@
+using System.Collections.Generic;
+using System.Threading.Tasks;
+
+namespace Avalonia.Input;
+
+///
+/// Wraps a into a .
+///
+/// The async item to wrap.
+/// Using this type should be a last resort!
+internal sealed class AsyncToSyncDataTransferItem(IAsyncDataTransferItem asyncDataTransferItem)
+ : IDataTransferItem, IAsyncDataTransferItem
+{
+ private readonly IAsyncDataTransferItem _asyncDataTransferItem = asyncDataTransferItem;
+
+ public IReadOnlyList Formats
+ => _asyncDataTransferItem.Formats;
+
+ public object? TryGetRaw(DataFormat format)
+ => _asyncDataTransferItem.TryGetRawAsync(format).GetAwaiter().GetResult();
+
+ public Task TryGetRawAsync(DataFormat format)
+ => _asyncDataTransferItem.TryGetRawAsync(format);
+}
diff --git a/src/Avalonia.Base/Input/DataFormat.cs b/src/Avalonia.Base/Input/DataFormat.cs
new file mode 100644
index 0000000000..1ec7aa4f2e
--- /dev/null
+++ b/src/Avalonia.Base/Input/DataFormat.cs
@@ -0,0 +1,227 @@
+using System;
+using Avalonia.Metadata;
+using Avalonia.Platform.Storage;
+using Avalonia.Utilities;
+
+namespace Avalonia.Input;
+
+///
+/// Represents a format usable with the clipboard and drag-and-drop.
+///
+public abstract class DataFormat : IEquatable
+{
+ private protected DataFormat(DataFormatKind kind, string identifier)
+ {
+ Kind = kind;
+ Identifier = identifier;
+ }
+
+ ///
+ /// Gets the kind of the data format.
+ ///
+ public DataFormatKind Kind { get; }
+
+ ///
+ /// Gets the identifier of the data format.
+ ///
+ public string Identifier { get; }
+
+ ///
+ /// Gets a data format representing plain text.
+ /// Its data type is .
+ ///
+ public static DataFormat Text { get; } = CreateUniversalFormat("Text");
+
+ ///
+ /// Gets a data format representing a single file.
+ /// Its data type is .
+ ///
+ public static DataFormat File { get; } = CreateUniversalFormat("File");
+
+ ///
+ /// Creates a name for this format, usable by the underlying platform.
+ ///
+ /// The system prefix used to recognize the name as an application format.
+ /// A system name for the format.
+ ///
+ /// This method can only be called if is
+ /// or .
+ ///
+ public string ToSystemName(string applicationPrefix)
+ {
+ ThrowHelper.ThrowIfNull(applicationPrefix);
+
+ return Kind switch
+ {
+ DataFormatKind.Application => applicationPrefix + Identifier,
+ DataFormatKind.Platform => Identifier,
+ _ => throw new InvalidOperationException($"Cannot get system name for universal format {Identifier}")
+ };
+ }
+
+ ///
+ public bool Equals(DataFormat? other)
+ {
+ if (other is null)
+ return false;
+ if (ReferenceEquals(this, other))
+ return true;
+ return Kind == other.Kind && Identifier == other.Identifier;
+ }
+
+ ///
+ public override bool Equals(object? obj)
+ => Equals(obj as DataFormat);
+
+ ///
+ public override int GetHashCode()
+ => ((int)Kind * 397) ^ Identifier.GetHashCode();
+
+ ///
+ /// Compares two instances of for equality.
+ ///
+ /// The first instance.
+ /// The second instance.
+ /// true if the two instances are equal; otherwise false.
+ public static bool operator ==(DataFormat? left, DataFormat? right)
+ => Equals(left, right);
+
+ ///
+ /// Compares two instances of for inequality.
+ ///
+ /// The first instance.
+ /// The second instance.
+ /// true if the two instances are not equal; otherwise false.
+ public static bool operator !=(DataFormat? left, DataFormat? right)
+ => !Equals(left, right);
+
+ private static DataFormat CreateUniversalFormat(string identifier) where T : class
+ => new(DataFormatKind.Universal, identifier);
+
+ ///
+ /// Creates a new format specific to the application that returns an array of .
+ ///
+ ///
+ ///
+ /// The format identifier. To avoid conflicts with system identifiers, this value isn't passed to the underlying
+ /// platform directly. However, two different applications using the same identifier
+ /// with or
+ /// are able to share data using this format.
+ ///
+ /// Only ASCII letters (A-Z, a-z), digits (0-9), the dot (.) and the hyphen (-) are accepted.
+ ///
+ /// A new .
+ public static DataFormat CreateBytesApplicationFormat(string identifier)
+ => CreateApplicationFormat(identifier);
+
+ ///
+ /// Creates a new format specific to the application that returns a .
+ ///
+ ///
+ ///
+ /// The format identifier. To avoid conflicts with system identifiers, this value isn't passed to the underlying
+ /// platform directly. However, two different applications using the same identifier
+ /// with or
+ /// are able to share data using this format.
+ ///
+ /// Only ASCII letters (A-Z, a-z), digits (0-9), the dot (.) and the hyphen (-) are accepted.
+ ///
+ /// A new .
+ public static DataFormat CreateStringApplicationFormat(string identifier)
+ => CreateApplicationFormat(identifier);
+
+ private static DataFormat CreateApplicationFormat(string identifier)
+ where T : class
+ {
+ if (!IsValidApplicationFormatIdentifier(identifier))
+ throw new ArgumentException("Invalid application identifier", nameof(identifier));
+
+ return new(DataFormatKind.Application, identifier);
+ }
+
+ ///
+ /// Creates a new format for the current platform that returns an array of .
+ ///
+ ///
+ /// The format identifier. This value is not validated and is passed AS IS to the underlying platform.
+ /// Most systems use mime types, but macOS requires Uniform Type Identifiers (UTI).
+ ///
+ /// A new .
+ public static DataFormat CreateBytesPlatformFormat(string identifier)
+ => CreatePlatformFormat(identifier);
+
+ ///
+ /// Creates a new format for the current platform that returns a .
+ ///
+ ///
+ /// The format identifier. This value is not validated and is passed AS IS to the underlying platform.
+ /// Most systems use mime types, but macOS requires Uniform Type Identifiers (UTI).
+ ///
+ /// A new .
+ public static DataFormat CreateStringPlatformFormat(string identifier)
+ => CreatePlatformFormat(identifier);
+
+ private static DataFormat CreatePlatformFormat(string identifier)
+ where T : class
+ {
+ ThrowHelper.ThrowIfNullOrEmpty(identifier);
+
+ return new(DataFormatKind.Platform, identifier);
+ }
+
+ ///
+ /// Creates a from a name coming from the underlying platform.
+ ///
+ /// The name.
+ /// The system prefix used to recognize the name as an application format.
+ /// A corresponding to .
+ [PrivateApi]
+ public static DataFormat FromSystemName(string systemName, string applicationPrefix)
+ where T : class
+ {
+ ThrowHelper.ThrowIfNull(systemName);
+ ThrowHelper.ThrowIfNull(applicationPrefix);
+
+ if (systemName.StartsWith(applicationPrefix, StringComparison.OrdinalIgnoreCase))
+ {
+ var identifier = systemName.Substring(applicationPrefix.Length);
+ if (IsValidApplicationFormatIdentifier(identifier))
+ return new(DataFormatKind.Application, identifier);
+ }
+
+ return new(DataFormatKind.Platform, systemName);
+ }
+
+ private static bool IsValidApplicationFormatIdentifier(string identifier)
+ {
+ if (string.IsNullOrEmpty(identifier))
+ return false;
+
+ foreach (var c in identifier)
+ {
+ if (!IsValidChar(c))
+ return false;
+ }
+
+ return true;
+
+ static bool IsValidChar(char c)
+ => IsAsciiLetterOrDigit(c) || c == '.' || c == '-';
+
+ static bool IsAsciiLetterOrDigit(char c)
+ {
+#if NET8_0_OR_GREATER
+ return char.IsAsciiLetterOrDigit(c);
+#else
+ return c is
+ (>= '0' and <= '9') or
+ (>= 'A' and <= 'Z') or
+ (>= 'a' and <= 'z');
+#endif
+ }
+ }
+
+ ///
+ public override string ToString()
+ => $"{Kind}: {Identifier}";
+}
diff --git a/src/Avalonia.Base/Input/DataFormatKind.cs b/src/Avalonia.Base/Input/DataFormatKind.cs
new file mode 100644
index 0000000000..17f778e189
--- /dev/null
+++ b/src/Avalonia.Base/Input/DataFormatKind.cs
@@ -0,0 +1,46 @@
+namespace Avalonia.Input;
+
+///
+/// Represents the kind of a .
+///
+public enum DataFormatKind
+{
+ ///
+ ///
+ /// The data format is specific to the application.
+ /// The exact format name used internally by Avalonia will vary depending on the platform.
+ ///
+ ///
+ /// Such a format is created using
+ /// or .
+ ///
+ ///
+ ///
+ ///
+ Application,
+
+ ///
+ ///
+ /// The data format is specific to the current platform.
+ /// Any other application using the same identifier will be able to access it.
+ ///
+ ///
+ /// Such a format is created using
+ /// or .
+ ///
+ ///
+ ///
+ ///
+ Platform,
+
+ ///
+ ///
+ /// The data format is cross-platform and supported directly by Avalonia.
+ /// Such formats include and .
+ ///
+ ///
+ /// It is not possible to create such a format directly.
+ ///
+ ///
+ Universal
+}
diff --git a/src/Avalonia.Base/Input/DataFormatOfT.cs b/src/Avalonia.Base/Input/DataFormatOfT.cs
new file mode 100644
index 0000000000..2036f49fb0
--- /dev/null
+++ b/src/Avalonia.Base/Input/DataFormatOfT.cs
@@ -0,0 +1,24 @@
+using System.Diagnostics.CodeAnalysis;
+
+namespace Avalonia.Input;
+
+///
+/// Represents a format usable with the clipboard and drag-and-drop, with a data type.
+///
+/// The data type.
+///
+/// This class cannot be instantiated directly.
+/// Use universal formats such as and ,
+/// or create custom formats using ,
+/// ,
+/// or .
+///
+[SuppressMessage("ReSharper", "UnusedTypeParameter", Justification = "Used to resolve typed overloads.")]
+public sealed class DataFormat : DataFormat
+ where T : class
+{
+ internal DataFormat(DataFormatKind kind, string identifier)
+ : base(kind, identifier)
+ {
+ }
+}
diff --git a/src/Avalonia.Base/Input/DataFormats.cs b/src/Avalonia.Base/Input/DataFormats.cs
index 8050f1b721..2fe818f20d 100644
--- a/src/Avalonia.Base/Input/DataFormats.cs
+++ b/src/Avalonia.Base/Input/DataFormats.cs
@@ -1,6 +1,6 @@
using System;
using System.ComponentModel;
-using Avalonia.Metadata;
+using Avalonia.Input.Platform;
namespace Avalonia.Input
{
@@ -9,11 +9,13 @@ namespace Avalonia.Input
///
/// Dataformat for plaintext
///
+ [Obsolete($"Use {nameof(DataFormat)}.{nameof(DataFormat.Text)} instead.")]
public static readonly string Text = nameof(Text);
///
/// Dataformat for one or more files.
///
+ [Obsolete($"Use {nameof(DataFormat)}.{nameof(DataFormat.File)} instead.")]
public static readonly string Files = nameof(Files);
///
@@ -22,7 +24,33 @@ namespace Avalonia.Input
///
/// This data format is supported only on desktop platforms.
///
- [Unstable("Use DataFormats.Files, this format is supported only on desktop platforms. And it will be removed in 12.0."), EditorBrowsable(EditorBrowsableState.Never)]
+ [Obsolete($"Use {nameof(DataFormat)}.{nameof(DataFormat.File)} instead."), EditorBrowsable(EditorBrowsableState.Never)]
public static readonly string FileNames = nameof(FileNames);
+
+#pragma warning disable CS0618 // Type or member is obsolete
+
+ internal static DataFormat ToDataFormat(string format)
+ {
+ if (format == Text)
+ return DataFormat.Text;
+
+ if (format == Files || format == FileNames)
+ return DataFormat.File;
+
+ return DataFormat.CreateBytesPlatformFormat(format);
+ }
+
+ internal static string ToString(DataFormat format)
+ {
+ if (DataFormat.Text.Equals(format))
+ return Text;
+
+ if (DataFormat.File.Equals(format))
+ return Files;
+
+ return format.Identifier;
+ }
+
+#pragma warning restore CS0618 // Type or member is obsolete
}
}
diff --git a/src/Avalonia.Base/Input/DataObject.cs b/src/Avalonia.Base/Input/DataObject.cs
index 93a6baa03c..dc9e2a29af 100644
--- a/src/Avalonia.Base/Input/DataObject.cs
+++ b/src/Avalonia.Base/Input/DataObject.cs
@@ -1,10 +1,12 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
namespace Avalonia.Input
{
///
/// Specific and mutable implementation of the IDataObject interface.
///
+ [Obsolete($"Use {nameof(DataTransfer)} instead")]
public class DataObject : IDataObject
{
private readonly Dictionary _items = new();
diff --git a/src/Avalonia.Base/Input/DataObjectExtensions.cs b/src/Avalonia.Base/Input/DataObjectExtensions.cs
index d2e525cd68..f361485404 100644
--- a/src/Avalonia.Base/Input/DataObjectExtensions.cs
+++ b/src/Avalonia.Base/Input/DataObjectExtensions.cs
@@ -3,8 +3,11 @@ using System.ComponentModel;
using System.Linq;
using Avalonia.Platform.Storage;
+#pragma warning disable CS0618 // Type or member is obsolete
+
namespace Avalonia.Input
{
+ // TODO12: remove
public static class DataObjectExtensions
{
///
diff --git a/src/Avalonia.Base/Input/DataTransfer.cs b/src/Avalonia.Base/Input/DataTransfer.cs
new file mode 100644
index 0000000000..7fd2fd1ec4
--- /dev/null
+++ b/src/Avalonia.Base/Input/DataTransfer.cs
@@ -0,0 +1,59 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using Avalonia.Utilities;
+
+namespace Avalonia.Input;
+
+///
+/// A mutable implementation of and .
+///
+///
+/// While it also implements , this class always returns data synchronously.
+/// For advanced usages, consider implementing directly.
+///
+public sealed class DataTransfer : IDataTransfer, IAsyncDataTransfer
+{
+ private readonly List _items = [];
+ private DataFormat[]? _formats;
+
+ ///
+ public IReadOnlyList Formats
+ {
+ get
+ {
+ return _formats ??= GetFormatsCore();
+
+ DataFormat[] GetFormatsCore()
+ => Items.SelectMany(item => item.Formats).Distinct().ToArray();
+ }
+ }
+
+ ///
+ /// Gets a list of contained in this object.
+ ///
+ public IReadOnlyList Items
+ => _items;
+
+ IReadOnlyList IDataTransfer.Items
+ => Items;
+
+ IReadOnlyList IAsyncDataTransfer.Items
+ => Items;
+
+ ///
+ /// Adds an existing to this object.
+ ///
+ /// The item to add.
+ public void Add(DataTransferItem item)
+ {
+ ThrowHelper.ThrowIfNull(item);
+
+ _formats = null;
+ _items.Add(item);
+ }
+
+ void IDisposable.Dispose()
+ {
+ }
+}
diff --git a/src/Avalonia.Base/Input/DataTransferExtensions.cs b/src/Avalonia.Base/Input/DataTransferExtensions.cs
new file mode 100644
index 0000000000..c50971f061
--- /dev/null
+++ b/src/Avalonia.Base/Input/DataTransferExtensions.cs
@@ -0,0 +1,130 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using Avalonia.Input.Platform;
+using Avalonia.Platform.Storage;
+
+namespace Avalonia.Input;
+
+// Keep DataTransferExtensions.TryGetXxx methods in sync with AsyncDataTransferExtensions.TryGetXxxAsync ones.
+
+///
+/// Contains extension methods for .
+///
+public static class DataTransferExtensions
+{
+ [Obsolete]
+ internal static IDataObject ToLegacyDataObject(this IDataTransfer dataTransfer)
+ => (dataTransfer as DataObjectToDataTransferWrapper)?.DataObject
+ ?? new DataTransferToDataObjectWrapper(dataTransfer);
+
+ ///
+ /// Gets whether a supports a specific format.
+ ///
+ /// The instance.
+ /// The format to check.
+ /// true if is supported, false otherwise.
+ public static bool Contains(this IDataTransfer dataTransfer, DataFormat format)
+ {
+ var formats = dataTransfer.Formats;
+ var count = formats.Count;
+
+ for (var i = 0; i < count; ++i)
+ {
+ if (format == formats[i])
+ return true;
+ }
+
+ return false;
+ }
+
+ ///
+ /// Gets the list of contained in this object, filtered by a given format.
+ ///
+ ///
+ ///
+ /// Some platforms (such as Windows and X11) may only support a single data item for all formats
+ /// except .
+ ///
+ /// Items returned by this property must stay valid until the is disposed.
+ ///
+ public static IEnumerable GetItems(this IDataTransfer dataTransfer, DataFormat format)
+ {
+ var items = dataTransfer.Items;
+ var count = items.Count;
+
+ for (var i = 0; i < count; ++i)
+ {
+ var item = items[i];
+ if (item.Contains(format))
+ yield return item;
+ }
+ }
+
+ ///
+ /// Tries to get a value for a given format from a .
+ ///
+ /// The instance.
+ /// The format to retrieve.
+ /// A value for , or null if the format is not supported.
+ ///
+ /// If the contains several items supporting ,
+ /// the first matching one will be returned.
+ ///
+ public static T? TryGetValue(this IDataTransfer dataTransfer, DataFormat format)
+ where T : class
+ => dataTransfer.GetItems(format).FirstOrDefault() is { } item ?
+ item.TryGetValue(format) :
+ null;
+
+ ///
+ /// Tries to get multiple values for a given format from a .
+ ///
+ /// The instance.
+ /// The format to retrieve.
+ /// A list of values for , or null if the format is not supported.
+ public static T[]? TryGetValues(this IDataTransfer dataTransfer, DataFormat format)
+ where T : class
+ {
+ List? results = null;
+
+ foreach (var item in dataTransfer.GetItems(format))
+ {
+ var result = item.TryGetValue(format);
+ if (result is null)
+ continue;
+
+ results ??= [];
+ results.Add(result);
+ }
+
+ return results?.ToArray();
+ }
+
+ ///
+ /// Returns a text, if available, from a instance.
+ ///
+ /// The data transfer instance.
+ /// A string, or null if the format isn't available.
+ /// .
+ public static string? TryGetText(this IDataTransfer dataTransfer)
+ => dataTransfer.TryGetValue(DataFormat.Text);
+
+ ///
+ /// Returns a file, if available, from a instance.
+ ///
+ /// The data transfer instance.
+ /// An (file or folder), or null if the format isn't available.
+ /// .
+ public static IStorageItem? TryGetFile(this IDataTransfer dataTransfer)
+ => dataTransfer.TryGetValue(DataFormat.File);
+
+ ///
+ /// Returns a list of files, if available, from a instance.
+ ///
+ /// The data transfer instance.
+ /// An array of (files or folders), or null if the format isn't available.
+ /// .
+ public static IStorageItem[]? TryGetFiles(this IDataTransfer dataTransfer)
+ => dataTransfer.TryGetValues(DataFormat.File);
+}
diff --git a/src/Avalonia.Base/Input/DataTransferItem.cs b/src/Avalonia.Base/Input/DataTransferItem.cs
new file mode 100644
index 0000000000..17a714efd4
--- /dev/null
+++ b/src/Avalonia.Base/Input/DataTransferItem.cs
@@ -0,0 +1,222 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+using Avalonia.Platform.Storage;
+using Avalonia.Utilities;
+
+namespace Avalonia.Input;
+
+///
+/// A mutable implementation of and .
+/// This class also provides several static methods to easily create a for common usages.
+///
+///
+/// While it also implements , this class always returns data synchronously.
+/// For advanced usages, consider implementing directly.
+///
+public sealed class DataTransferItem : IDataTransferItem, IAsyncDataTransferItem
+{
+ private Dictionary? _accessorByFormat; // used for 2+ formats
+ private KeyValuePair? _singleItem; // used for the common single format case
+ private DataFormat[]? _formats;
+
+ ///
+ public IReadOnlyList Formats
+ {
+ get
+ {
+ return _formats ??= ComputeFormats();
+
+ DataFormat[] ComputeFormats()
+ {
+ if (_accessorByFormat is not null)
+ return _accessorByFormat.Keys.ToArray();
+ if (_singleItem is { } singleItem)
+ return [singleItem.Key];
+ return [];
+ }
+ }
+ }
+
+ ///
+ public object? TryGetRaw(DataFormat format)
+ => FindAccessor(format)?.GetValue();
+
+ Task IAsyncDataTransferItem.TryGetRawAsync(DataFormat format)
+ {
+ try
+ {
+ return Task.FromResult(TryGetRaw(format));
+ }
+ catch (Exception ex)
+ {
+ return Task.FromException(ex);
+ }
+ }
+
+ private DataAccessor? FindAccessor(DataFormat format)
+ {
+ if (_accessorByFormat is not null)
+ return _accessorByFormat.TryGetValue(format, out var accessor) ? accessor : null;
+
+ if (_singleItem is { } singleItem)
+ return singleItem.Value;
+
+ return null;
+ }
+
+ ///
+ /// Sets the value for a given format.
+ ///
+ /// The format.
+ ///
+ /// The value corresponding to .
+ /// If null, the format won't be part of the .
+ ///
+ public void Set(DataFormat format, T? value)
+ where T : class
+ {
+ ThrowHelper.ThrowIfNull(format);
+
+ if (value is null)
+ RemoveCore(format);
+ else
+ SetCore(format, new DataAccessor(static state => state, value));
+ }
+
+ ///
+ /// Sets a value created on demand for a given format.
+ ///
+ /// The value type.
+ /// The format.
+ /// A function returning the value corresponding to .
+ public void Set(DataFormat format, Func getValue)
+ where T : class
+ {
+ ThrowHelper.ThrowIfNull(format);
+ ThrowHelper.ThrowIfNull(getValue);
+
+ SetCore(format, new DataAccessor(static state => ((Func)state)(), getValue));
+ }
+
+ private void SetCore(DataFormat format, DataAccessor accessor)
+ {
+ if (_accessorByFormat is not null)
+ _accessorByFormat[format] = accessor;
+ else if (_singleItem is { } singleItem && !singleItem.Key.Equals(format))
+ {
+ _accessorByFormat = new()
+ {
+ [singleItem.Key] = singleItem.Value,
+ [format] = accessor
+ };
+ _singleItem = null;
+ }
+ else
+ _singleItem = new(format, accessor);
+
+ _formats = null;
+ }
+
+ private void RemoveCore(DataFormat format)
+ {
+ bool removed;
+
+ if (_accessorByFormat is not null)
+ removed = _accessorByFormat.Remove(format);
+ else if (_singleItem is { } singleItem && singleItem.Key.Equals(format))
+ {
+ _singleItem = null;
+ removed = true;
+ }
+ else
+ removed = false;
+
+ if (removed)
+ _formats = null;
+ }
+
+
+ ///
+ /// Sets the value for the format.
+ ///
+ ///
+ /// The value corresponding to the format.
+ /// If null, the format won't be part of the .
+ ///
+ public void SetText(string? value)
+ => Set(DataFormat.Text, value);
+
+ ///
+ /// Sets the value for the format.
+ ///
+ ///
+ /// The value corresponding to the format.
+ /// If null, the format won't be part of the .
+ ///
+ public void SetFile(IStorageItem? value)
+ => Set(DataFormat.File, value);
+
+ ///
+ /// Creates a new for a single format with a given value.
+ ///
+ /// The value type.
+ /// The format.
+ ///
+ /// The value corresponding to .
+ /// If null, the format won't be part of the .
+ ///
+ /// A instance.
+ public static DataTransferItem Create(DataFormat format, T? value)
+ where T : class
+ {
+ var item = new DataTransferItem();
+ item.Set(format, value);
+ return item;
+ }
+
+ ///
+ /// Creates a new for a single format with a given value created on demand.
+ ///
+ /// The value type.
+ /// The format.
+ /// A function returning the value corresponding to .
+ /// A instance.
+ public static DataTransferItem Create(DataFormat format, Func getValue)
+ where T : class
+ {
+ var item = new DataTransferItem();
+ item.Set(format, getValue);
+ return item;
+ }
+
+ ///
+ /// Creates a new with as a single format.
+ ///
+ ///
+ /// The value corresponding to the format.
+ /// If null, the format won't be part of the .
+ ///
+ /// A instance.
+ public static DataTransferItem CreateText(string? value)
+ => Create(DataFormat.Text, value);
+
+ ///
+ /// Creates a new with as a single format.
+ ///
+ ///
+ /// The value corresponding to the format.
+ /// If null, the format won't be part of the .
+ ///
+ /// A instance.
+ public static DataTransferItem CreateFile(IStorageItem? value)
+ => Create(DataFormat.File, value);
+
+ private readonly struct DataAccessor(Func getValue, object state)
+ {
+ public object? GetValue()
+ => getValue(state);
+ }
+}
+
diff --git a/src/Avalonia.Base/Input/DataTransferItemExtensions.cs b/src/Avalonia.Base/Input/DataTransferItemExtensions.cs
new file mode 100644
index 0000000000..70ffc0d5cb
--- /dev/null
+++ b/src/Avalonia.Base/Input/DataTransferItemExtensions.cs
@@ -0,0 +1,57 @@
+using Avalonia.Platform.Storage;
+
+namespace Avalonia.Input;
+
+///
+/// Contains extension methods for .
+///
+public static class DataTransferItemExtensions
+{
+ ///
+ /// Gets whether a supports a specific format.
+ ///
+ /// The instance.
+ /// The format to check.
+ /// true if is supported, false otherwise.
+ public static bool Contains(this IDataTransferItem dataTransferItem, DataFormat format)
+ {
+ var formats = dataTransferItem.Formats;
+ var count = formats.Count;
+
+ for (var i = 0; i < count; ++i)
+ {
+ if (format == formats[i])
+ return true;
+ }
+
+ return false;
+ }
+
+ ///
+ /// Tries to get a value for a given format from a .
+ ///
+ /// The instance.
+ /// The format to retrieve.
+ /// A value for , or null if the format is not supported.
+ public static T? TryGetValue(this IDataTransferItem dataTransferItem, DataFormat format)
+ where T : class
+ => dataTransferItem.TryGetRaw(format) as T;
+
+ ///
+ /// Returns a text, if available, from a instance.
+ ///
+ /// The data transfer instance.
+ /// A string, or null if the format isn't available.
+ /// .
+ public static string? TryGetText(this IDataTransferItem dataTransferItem)
+ => dataTransferItem.TryGetValue(DataFormat.Text);
+
+ ///
+ /// Returns a file, if available, from a instance.
+ ///
+ /// The data transfer instance.
+ /// An (file or folder), or null if the format isn't available.
+ /// .
+ public static IStorageItem? TryGetFile(this IDataTransferItem dataTransferItem)
+ => dataTransferItem.TryGetValue(DataFormat.File);
+}
diff --git a/src/Avalonia.Base/Input/DragDrop.cs b/src/Avalonia.Base/Input/DragDrop.cs
index 0bb4450e66..551f436854 100644
--- a/src/Avalonia.Base/Input/DragDrop.cs
+++ b/src/Avalonia.Base/Input/DragDrop.cs
@@ -126,10 +126,28 @@ namespace Avalonia.Input
/// Starts a dragging operation with the given and returns the applied drop effect from the target.
///
///
+ [Obsolete($"Use {nameof(DoDragDropAsync)} instead.")]
public static Task DoDragDrop(PointerEventArgs triggerEvent, IDataObject data, DragDropEffects allowedEffects)
{
- var src = AvaloniaLocator.Current.GetService();
- return src?.DoDragDrop(triggerEvent, data, allowedEffects) ?? Task.FromResult(DragDropEffects.None);
+ return DoDragDropAsync(triggerEvent, new DataObjectToDataTransferWrapper(data), allowedEffects);
+ }
+
+ ///
+ /// Starts a dragging operation with the given and returns the applied drop effect from the target.
+ ///
+ ///
+ public static Task DoDragDropAsync(
+ PointerEventArgs triggerEvent,
+ IDataTransfer dataTransfer,
+ DragDropEffects allowedEffects)
+ {
+ if (AvaloniaLocator.Current.GetService() is not { } dragSource)
+ {
+ dataTransfer.Dispose();
+ return Task.FromResult(DragDropEffects.None);
+ }
+
+ return dragSource.DoDragDropAsync(triggerEvent, dataTransfer, allowedEffects);
}
}
}
diff --git a/src/Avalonia.Base/Input/DragDropDevice.cs b/src/Avalonia.Base/Input/DragDropDevice.cs
index 5ad20111fc..8f3b542e8d 100644
--- a/src/Avalonia.Base/Input/DragDropDevice.cs
+++ b/src/Avalonia.Base/Input/DragDropDevice.cs
@@ -1,6 +1,7 @@
using Avalonia.Interactivity;
using Avalonia.VisualTree;
using System.Linq;
+using Avalonia.Input.Platform;
using Avalonia.Input.Raw;
using Avalonia.Metadata;
@@ -21,8 +22,15 @@ namespace Avalonia.Input
return target;
return null;
}
-
- private static DragDropEffects RaiseDragEvent(Interactive? target, IInputRoot inputRoot, Point point, RoutedEvent routedEvent, DragDropEffects operation, IDataObject data, KeyModifiers modifiers)
+
+ private static DragDropEffects RaiseDragEvent(
+ Interactive? target,
+ IInputRoot inputRoot,
+ Point point,
+ RoutedEvent routedEvent,
+ DragDropEffects operation,
+ IDataTransfer dataTransfer,
+ KeyModifiers modifiers)
{
if (target == null)
return DragDropEffects.None;
@@ -32,7 +40,7 @@ namespace Avalonia.Input
if (!p.HasValue)
return DragDropEffects.None;
- var args = new DragEventArgs(routedEvent, data, target, p.Value, modifiers)
+ var args = new DragEventArgs(routedEvent, dataTransfer, target, p.Value, modifiers)
{
RoutedEvent = routedEvent,
DragEffects = operation
@@ -41,13 +49,13 @@ namespace Avalonia.Input
return args.DragEffects;
}
- private DragDropEffects DragEnter(IInputRoot inputRoot, Point point, IDataObject data, DragDropEffects effects, KeyModifiers modifiers)
+ private DragDropEffects DragEnter(IInputRoot inputRoot, Point point, IDataTransfer data, DragDropEffects effects, KeyModifiers modifiers)
{
_lastTarget = GetTarget(inputRoot, point);
return RaiseDragEvent(_lastTarget, inputRoot, point, DragDrop.DragEnterEvent, effects, data, modifiers);
}
- private DragDropEffects DragOver(IInputRoot inputRoot, Point point, IDataObject data, DragDropEffects effects, KeyModifiers modifiers)
+ private DragDropEffects DragOver(IInputRoot inputRoot, Point point, IDataTransfer data, DragDropEffects effects, KeyModifiers modifiers)
{
var target = GetTarget(inputRoot, point);
@@ -66,7 +74,7 @@ namespace Avalonia.Input
}
}
- private void DragLeave(IInputRoot inputRoot, Point point, IDataObject data, DragDropEffects effects, KeyModifiers modifiers)
+ private void DragLeave(IInputRoot inputRoot, Point point, IDataTransfer data, DragDropEffects effects, KeyModifiers modifiers)
{
if (_lastTarget == null)
return;
@@ -80,7 +88,7 @@ namespace Avalonia.Input
}
}
- private DragDropEffects Drop(IInputRoot inputRoot, Point point, IDataObject data, DragDropEffects effects, KeyModifiers modifiers)
+ private DragDropEffects Drop(IInputRoot inputRoot, Point point, IDataTransfer data, DragDropEffects effects, KeyModifiers modifiers)
{
try
{
@@ -103,16 +111,16 @@ namespace Avalonia.Input
switch (e.Type)
{
case RawDragEventType.DragEnter:
- e.Effects = DragEnter(e.Root, e.Location, e.Data, e.Effects, e.KeyModifiers);
+ e.Effects = DragEnter(e.Root, e.Location, e.DataTransfer, e.Effects, e.KeyModifiers);
break;
case RawDragEventType.DragOver:
- e.Effects = DragOver(e.Root, e.Location, e.Data, e.Effects, e.KeyModifiers);
+ e.Effects = DragOver(e.Root, e.Location, e.DataTransfer, e.Effects, e.KeyModifiers);
break;
case RawDragEventType.DragLeave:
- DragLeave(e.Root, e.Location, e.Data, e.Effects, e.KeyModifiers);
+ DragLeave(e.Root, e.Location, e.DataTransfer, e.Effects, e.KeyModifiers);
break;
case RawDragEventType.Drop:
- e.Effects = Drop(e.Root, e.Location, e.Data, e.Effects, e.KeyModifiers);
+ e.Effects = Drop(e.Root, e.Location, e.DataTransfer, e.Effects, e.KeyModifiers);
break;
}
}
diff --git a/src/Avalonia.Base/Input/DragEventArgs.cs b/src/Avalonia.Base/Input/DragEventArgs.cs
index 26ec98361b..cf86f22c2b 100644
--- a/src/Avalonia.Base/Input/DragEventArgs.cs
+++ b/src/Avalonia.Base/Input/DragEventArgs.cs
@@ -1,4 +1,5 @@
using System;
+using Avalonia.Input.Platform;
using Avalonia.Interactivity;
using Avalonia.Metadata;
@@ -8,10 +9,15 @@ namespace Avalonia.Input
{
private readonly Interactive _target;
private readonly Point _targetLocation;
+ [Obsolete] private IDataObject? _legacyDataObject;
public DragDropEffects DragEffects { get; set; }
- public IDataObject Data { get; }
+ public IDataTransfer DataTransfer { get; }
+
+ [Obsolete($"Use {nameof(DataTransfer)} instead.")]
+ public IDataObject Data
+ => _legacyDataObject ??= DataTransfer.ToLegacyDataObject();
public KeyModifiers KeyModifiers { get; }
@@ -25,11 +31,27 @@ namespace Avalonia.Input
return _target.TranslatePoint(_targetLocation, relativeTo) ?? new Point(0, 0);
}
+ [Obsolete($"Use the constructor accepting a {nameof(IDataTransfer)} instance instead.")]
+ public DragEventArgs(
+ RoutedEvent routedEvent,
+ IDataObject data,
+ Interactive target,
+ Point targetLocation,
+ KeyModifiers keyModifiers)
+ : this(routedEvent, new DataObjectToDataTransferWrapper(data), target, targetLocation, keyModifiers)
+ {
+ }
+
[Unstable("This constructor might be removed in 12.0. For unit testing, consider using DragDrop.DoDragDrop or IHeadlessWindow.DragDrop.")]
- public DragEventArgs(RoutedEvent routedEvent, IDataObject data, Interactive target, Point targetLocation, KeyModifiers keyModifiers)
+ public DragEventArgs(
+ RoutedEvent routedEvent,
+ IDataTransfer dataTransfer,
+ Interactive target,
+ Point targetLocation,
+ KeyModifiers keyModifiers)
: base(routedEvent)
{
- Data = data;
+ DataTransfer = dataTransfer;
_target = target;
_targetLocation = targetLocation;
KeyModifiers = keyModifiers;
diff --git a/src/Avalonia.Base/Input/IAsyncDataTransfer.cs b/src/Avalonia.Base/Input/IAsyncDataTransfer.cs
new file mode 100644
index 0000000000..effc584711
--- /dev/null
+++ b/src/Avalonia.Base/Input/IAsyncDataTransfer.cs
@@ -0,0 +1,47 @@
+using System;
+using System.Collections.Generic;
+using Avalonia.Input.Platform;
+
+namespace Avalonia.Input;
+
+///
+/// Represents an object providing a list of usable by the clipboard.
+///
+///
+///
+///
+/// -
+/// When an implementation of this interface is put into the clipboard using ,
+/// it must NOT be disposed by the caller. The system will dispose of it automatically when it becomes unused.
+///
+/// -
+/// When an implementation of this interface is returned from the clipboard via ,
+/// it MUST be disposed the caller.
+///
+/// -
+/// This interface is mostly used during clipboard operations. However, several platforms only support synchronous
+/// clipboard manipulation and will try to use if the underlying type also implements it.
+/// For this reason, custom implementations should ideally implement both and
+/// .
+///
+///
+///
+public interface IAsyncDataTransfer : IDisposable
+{
+ ///
+ /// Gets the formats supported by a .
+ ///
+ IReadOnlyList Formats { get; }
+
+ ///
+ /// Gets a list of contained in this object.
+ ///
+ ///
+ ///
+ /// Some platforms (such as Windows and X11) may only support a single data item for all formats
+ /// except .
+ ///
+ /// Items returned by this property must stay valid until the is disposed.
+ ///
+ IReadOnlyList Items { get; }
+}
diff --git a/src/Avalonia.Base/Input/IAsyncDataTransferItem.cs b/src/Avalonia.Base/Input/IAsyncDataTransferItem.cs
new file mode 100644
index 0000000000..8ed053ac35
--- /dev/null
+++ b/src/Avalonia.Base/Input/IAsyncDataTransferItem.cs
@@ -0,0 +1,35 @@
+using System.Collections.Generic;
+using System.Threading.Tasks;
+
+namespace Avalonia.Input;
+
+///
+/// Represent an item inside a .
+/// An item may support several formats and can return the value of a given format on demand.
+///
+///
+public interface IAsyncDataTransferItem
+{
+ ///
+ /// Gets the formats supported by this item.
+ ///
+ IReadOnlyList Formats { get; }
+
+ ///
+ /// Tries to get a value for a given format.
+ ///
+ /// The format to retrieve.
+ /// A value for , or null if the format is not supported.
+ ///
+ ///
+ /// Implementations of this method are expected to return a value matching the exact type
+ /// of the generic argument of the underlying .
+ ///
+ ///
+ /// To retrieve a typed value, use .
+ ///
+ ///
+ ///
+ ///
+ Task TryGetRawAsync(DataFormat format);
+}
diff --git a/src/Avalonia.Base/Input/IDataObject.cs b/src/Avalonia.Base/Input/IDataObject.cs
index 6ccd0a8499..560ffc0c02 100644
--- a/src/Avalonia.Base/Input/IDataObject.cs
+++ b/src/Avalonia.Base/Input/IDataObject.cs
@@ -1,12 +1,12 @@
-using System.Collections.Generic;
-using System.Linq;
-using Avalonia.Platform.Storage;
+using System;
+using System.Collections.Generic;
namespace Avalonia.Input
{
///
/// Interface to access information about the data of a drag-and-drop operation.
///
+ [Obsolete($"Use {nameof(IDataTransfer)} or {nameof(IAsyncDataTransfer)} instead")]
public interface IDataObject
{
///
diff --git a/src/Avalonia.Base/Input/IDataTransfer.cs b/src/Avalonia.Base/Input/IDataTransfer.cs
new file mode 100644
index 0000000000..81f33fb0ad
--- /dev/null
+++ b/src/Avalonia.Base/Input/IDataTransfer.cs
@@ -0,0 +1,32 @@
+using System;
+using System.Collections.Generic;
+
+namespace Avalonia.Input;
+
+///
+/// Represents an object providing a list of usableduring a drag and drop operation.
+///
+///
+///
+/// When an implementation of this interface is used as a drag source using ,
+/// it must NOT be disposed by the caller. The system will dispose of it automatically when the drag operation completes.
+///
+public interface IDataTransfer : IDisposable
+{
+ ///
+ /// Gets the formats supported by a .
+ ///
+ IReadOnlyList Formats { get; }
+
+ ///
+ /// Gets a list of contained in this object.
+ ///
+ ///
+ ///
+ /// Some platforms (such as Windows and X11) may only support a single data item for all formats
+ /// except .
+ ///
+ /// Items returned by this property must stay valid until the is disposed.
+ ///
+ IReadOnlyList Items { get; }
+}
diff --git a/src/Avalonia.Base/Input/IDataTransferItem.cs b/src/Avalonia.Base/Input/IDataTransferItem.cs
new file mode 100644
index 0000000000..8ecc3e4016
--- /dev/null
+++ b/src/Avalonia.Base/Input/IDataTransferItem.cs
@@ -0,0 +1,34 @@
+using System.Collections.Generic;
+
+namespace Avalonia.Input;
+
+///
+/// Represent an item inside a .
+/// An item may support several formats and can return the value of a given format on demand.
+///
+///
+public interface IDataTransferItem
+{
+ ///
+ /// Gets the formats supported by this item.
+ ///
+ IReadOnlyList Formats { get; }
+
+ ///
+ /// Tries to get a value for a given format.
+ ///
+ /// The format to retrieve.
+ /// A value for , or null if the format is not supported.
+ ///
+ ///
+ /// Implementations of this method are expected to return a value matching the exact type
+ /// of the generic argument of the underlying .
+ ///
+ ///
+ /// To retrieve a typed value, use .
+ ///
+ ///
+ ///
+ ///
+ object? TryGetRaw(DataFormat format);
+}
diff --git a/src/Avalonia.Base/Input/Platform/BinaryFormatterHelper.cs b/src/Avalonia.Base/Input/Platform/BinaryFormatterHelper.cs
new file mode 100644
index 0000000000..6e38a8afac
--- /dev/null
+++ b/src/Avalonia.Base/Input/Platform/BinaryFormatterHelper.cs
@@ -0,0 +1,72 @@
+using System;
+using System.Diagnostics.CodeAnalysis;
+using System.IO;
+using System.Runtime.Serialization.Formatters.Binary;
+using Avalonia.Compatibility;
+using Avalonia.Logging;
+
+namespace Avalonia.Input.Platform;
+
+// TODO12: remove
+[Obsolete("Remove in v12")]
+internal static class BinaryFormatterHelper
+{
+ // Compatibility with WinForms + WPF...
+ private static ReadOnlySpan SerializedObjectGuid
+ => [
+ // FD9EA796-3B13-4370-A679-56106BB288FB
+ 0x96, 0xa7, 0x9e, 0xfd,
+ 0x13, 0x3b,
+ 0x70, 0x43,
+ 0xa6, 0x79, 0x56, 0x10, 0x6b, 0xb2, 0x88, 0xfb
+ ];
+
+ [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "We still use BinaryFormatter for WinForms drag and drop compatibility")]
+ [UnconditionalSuppressMessage("Trimming", "IL3050", Justification = "We still use BinaryFormatter for WinForms drag and drop compatibility")]
+ public static byte[]? TrySerializeUsingBinaryFormatter(object data, DataFormat dataFormat)
+ {
+ if (!OperatingSystemEx.IsWindows())
+ return null;
+
+ Logger.TryGet(LogEventLevel.Warning, LogArea.Win32Platform)?.Log(
+ null,
+ "Using BinaryFormatter to serialize data format {Format}. This won't be supported in Avalonia v12. Prefer passing a byte[] or Stream instead.",
+ dataFormat);
+
+ var stream = new MemoryStream();
+ var serializedGuid = SerializedObjectGuid;
+
+#if NET6_0_OR_GREATER
+ stream.Write(serializedGuid);
+#else
+ stream.Write(serializedGuid.ToArray(), 0, serializedGuid.Length);
+#endif
+
+#pragma warning disable SYSLIB0011 // Type or member is obsolete
+ new BinaryFormatter().Serialize(stream, data);
+#pragma warning restore SYSLIB0011 // Type or member is obsolete
+
+ return stream.GetBuffer();
+ }
+
+ [UnconditionalSuppressMessage("Trimming", "IL2026", Justification = "We still use BinaryFormatter for WinForms drag and drop compatibility")]
+ [UnconditionalSuppressMessage("Trimming", "IL3050", Justification = "We still use BinaryFormatter for WinForms drag and drop compatibility")]
+ public static object? TryDeserializeUsingBinaryFormatter(byte[]? bytes)
+ {
+ var serializedObjectGuid = SerializedObjectGuid;
+
+ // Our Win32 backend used to automatically serialize/deserialize objects using the BinaryFormatter.
+ // Only keep that behavior for compatibility with IDataObject.
+ if (OperatingSystemEx.IsWindows() && bytes is not null && bytes.AsSpan().StartsWith(serializedObjectGuid))
+ {
+ using var stream = new MemoryStream(bytes);
+ stream.Position = serializedObjectGuid.Length;
+
+#pragma warning disable SYSLIB0011 // Type or member is obsolete
+ return new BinaryFormatter().Deserialize(stream);
+#pragma warning restore SYSLIB0011 // Type or member is obsolete
+ }
+
+ return null;
+ }
+}
diff --git a/src/Avalonia.Base/Input/Platform/Clipboard.cs b/src/Avalonia.Base/Input/Platform/Clipboard.cs
new file mode 100644
index 0000000000..6810851775
--- /dev/null
+++ b/src/Avalonia.Base/Input/Platform/Clipboard.cs
@@ -0,0 +1,103 @@
+using System;
+using System.IO;
+using System.Linq;
+using System.Threading.Tasks;
+using Avalonia.Compatibility;
+using Avalonia.Platform.Storage;
+
+namespace Avalonia.Input.Platform;
+
+///
+/// Implementation of
+///
+internal sealed class Clipboard(IClipboardImpl clipboardImpl) : IClipboard
+{
+ private readonly IClipboardImpl _clipboardImpl = clipboardImpl;
+ private IAsyncDataTransfer? _lastDataTransfer;
+
+ Task IClipboard.GetTextAsync()
+ => this.TryGetTextAsync();
+
+ Task IClipboard.SetTextAsync(string? text)
+ => this.SetValueAsync(DataFormat.Text, text);
+
+ public Task ClearAsync()
+ {
+ _lastDataTransfer?.Dispose();
+ _lastDataTransfer = null;
+
+ return _clipboardImpl.ClearAsync();
+ }
+
+ [Obsolete($"Use {nameof(SetDataAsync)} instead.")]
+ Task IClipboard.SetDataObjectAsync(IDataObject data)
+ => SetDataAsync(new DataObjectToDataTransferWrapper(data));
+
+ public Task SetDataAsync(IAsyncDataTransfer? dataTransfer)
+ {
+ if (dataTransfer is null)
+ return ClearAsync();
+
+ if (_clipboardImpl is IOwnedClipboardImpl)
+ _lastDataTransfer = dataTransfer;
+
+ return _clipboardImpl.SetDataAsync(dataTransfer);
+ }
+
+ public Task FlushAsync()
+ => _clipboardImpl is IFlushableClipboardImpl flushable ? flushable.FlushAsync() : Task.CompletedTask;
+
+ async Task IClipboard.GetFormatsAsync()
+ {
+ var dataTransfer = await TryGetDataAsync();
+ return dataTransfer is null ? [] : dataTransfer.Formats.Select(DataFormats.ToString).ToArray();
+ }
+
+ [Obsolete($"Use {nameof(TryGetDataAsync)} instead.")]
+ async Task IClipboard.GetDataAsync(string format)
+ {
+ // No ConfigureAwait(false) here: we want TryGetXxxAsync() below to be called on the initial thread.
+ using var dataTransfer = await TryGetDataAsync();
+ if (dataTransfer is null)
+ return null;
+
+ if (format == DataFormats.Text)
+ return await dataTransfer.TryGetTextAsync().ConfigureAwait(false);
+
+ if (format == DataFormats.Files)
+ return await dataTransfer.TryGetFilesAsync().ConfigureAwait(false);
+
+ if (format == DataFormats.FileNames)
+ {
+ return (await dataTransfer.TryGetFilesAsync().ConfigureAwait(false))
+ ?.Select(file => file.TryGetLocalPath())
+ .Where(path => path is not null)
+ .ToArray();
+ }
+
+ var typedFormat = DataFormat.CreateBytesPlatformFormat(format);
+ var bytes = await dataTransfer.TryGetValueAsync(typedFormat).ConfigureAwait(false);
+ return BinaryFormatterHelper.TryDeserializeUsingBinaryFormatter(bytes) ?? bytes;
+ }
+
+ public Task TryGetDataAsync()
+ => _clipboardImpl.TryGetDataAsync();
+
+ [Obsolete($"Use {nameof(TryGetInProcessDataAsync)} instead.")]
+ async Task IClipboard.TryGetInProcessDataObjectAsync()
+ {
+ var dataTransfer = await TryGetInProcessDataAsync().ConfigureAwait(false);
+ return (dataTransfer as DataObjectToDataTransferWrapper)?.DataObject;
+ }
+
+ public async Task TryGetInProcessDataAsync()
+ {
+ if (_lastDataTransfer is null || _clipboardImpl is not IOwnedClipboardImpl ownedClipboardImpl)
+ return null;
+
+ if (!await ownedClipboardImpl.IsCurrentOwnerAsync())
+ _lastDataTransfer = null;
+
+ return _lastDataTransfer;
+ }
+}
diff --git a/src/Avalonia.Base/Input/Platform/ClipboardExtensions.cs b/src/Avalonia.Base/Input/Platform/ClipboardExtensions.cs
new file mode 100644
index 0000000000..d0d5925e53
--- /dev/null
+++ b/src/Avalonia.Base/Input/Platform/ClipboardExtensions.cs
@@ -0,0 +1,189 @@
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using Avalonia.Platform.Storage;
+
+namespace Avalonia.Input.Platform;
+
+///
+/// Contains extension methods related to .
+///
+public static class ClipboardExtensions
+{
+ ///
+ /// Gets a list containing the formats currently available from the clipboard.
+ ///
+ /// A list of formats. It can be empty if the clipboard is empty.
+ public static async Task> GetDataFormatsAsync(this IClipboard clipboard)
+ {
+ using var dataTransfer = await clipboard.TryGetDataAsync();
+ return dataTransfer is null ? [] : dataTransfer.Formats;
+ }
+
+ ///
+ /// Tries to get a value for a given format from the clipboard.
+ ///
+ /// The instance.
+ /// The format to retrieve.
+ /// A value for , or null if the format is not supported.
+ ///
+ /// If the contains several items supporting ,
+ /// the first matching one will be returned.
+ ///
+ public static async Task TryGetValueAsync(this IClipboard clipboard, DataFormat format)
+ where T : class
+ {
+ // No ConfigureAwait(false) here: we want TryGetValueAsync() below to be called on the initial thread.
+ using var dataTransfer = await clipboard.TryGetDataAsync();
+ if (dataTransfer is null)
+ return null;
+
+ // However, ConfigureAwait(false) is fine here: we're not doing anything after.
+ return await dataTransfer.TryGetValueAsync(format).ConfigureAwait(false);
+ }
+
+ ///
+ /// Tries to get multiple values for a given format from the clipboard.
+ ///
+ /// The instance.
+ /// The format to retrieve.
+ /// A list of values for , or null if the format is not supported.
+ public static async Task TryGetValuesAsync(this IClipboard clipboard, DataFormat format)
+ where T : class
+ {
+ // No ConfigureAwait(false) here: we want TryGetValuesAsync() below to be called on the initial thread.
+ using var dataTransfer = await clipboard.TryGetDataAsync();
+ if (dataTransfer is null)
+ return null;
+
+ // However, ConfigureAwait(false) is fine here: we're not doing anything after.
+ return await dataTransfer.TryGetValuesAsync(format).ConfigureAwait(false);
+ }
+
+ ///
+ /// Places a single value on the clipboard in the specified format.
+ ///
+ /// The clipboard instance.
+ /// The data format.
+ /// The value to place on the clipboard.
+ ///
+ /// By calling this method, the clipboard will get cleared of any possible previous data.
+ ///
+ /// If is null, nothing will get placed on the clipboard and this method
+ /// will be equivalent to .
+ ///
+ ///
+ public static Task SetValueAsync(this IClipboard clipboard, DataFormat format, T? value)
+ where T : class
+ {
+ if (value is null)
+ return clipboard.ClearAsync();
+
+ var dataTransfer = new DataTransfer();
+ dataTransfer.Add(DataTransferItem.Create(format, value));
+ return clipboard.SetDataAsync(dataTransfer);
+ }
+
+ ///
+ /// Places multiple values on the clipboard in the specified format.
+ ///
+ /// The clipboard instance.
+ /// The data format.
+ /// The values to place on the clipboard.
+ ///
+ /// By calling this method, the clipboard will get cleared of any possible previous data.
+ ///
+ /// If is null or empty, nothing will get placed on the clipboard and this method
+ /// will be equivalent to .
+ ///
+ ///
+ public static Task SetValuesAsync(this IClipboard clipboard, DataFormat format, IEnumerable? values)
+ where T : class
+ {
+ if (values is null)
+ return clipboard.ClearAsync();
+
+ var dataTransfer = new DataTransfer();
+
+ foreach (var value in values)
+ dataTransfer.Add(DataTransferItem.Create(format, value));
+
+ return dataTransfer.Items.Count == 0
+ ? clipboard.ClearAsync()
+ : clipboard.SetDataAsync(dataTransfer);
+ }
+
+ ///
+ /// Returns a text, if available, from the clipboard.
+ ///
+ /// The clipboard instance.
+ /// A string, or null if the format isn't available.
+ ///
+ public static Task TryGetTextAsync(this IClipboard clipboard)
+ => clipboard.TryGetValueAsync(DataFormat.Text);
+
+ ///
+ /// Returns a file, if available, from the clipboard.
+ ///
+ /// The clipboard instance.
+ /// An (file or folder), or null if the format isn't available.
+ /// .
+ public static Task TryGetFileAsync(this IClipboard clipboard)
+ => clipboard.TryGetValueAsync(DataFormat.File);
+
+ ///
+ /// Returns a list of files, if available, from the clipboard.
+ ///
+ /// The data transfer instance.
+ /// An array of (files or folders), or null if the format isn't available.
+ /// .
+ public static Task TryGetFilesAsync(this IClipboard clipboard)
+ => clipboard.TryGetValuesAsync(DataFormat.File);
+
+ ///
+ /// Places a text on the clipboard.
+ ///
+ /// The clipboard instance.
+ /// The value to place on the clipboard.
+ ///
+ /// By calling this method, the clipboard will get cleared of any possible previous data.
+ ///
+ /// If is null, nothing will get placed on the clipboard and this method
+ /// will be equivalent to .
+ ///
+ ///
+ ///
+ public static Task SetTextAsync(this IClipboard clipboard, string? text)
+ => clipboard.SetValueAsync(DataFormat.Text, text);
+
+ ///
+ /// Places a file on the clipboard.
+ ///
+ /// The clipboard instance.
+ /// The file to place on the clipboard.
+ ///
+ /// By calling this method, the clipboard will get cleared of any possible previous data.
+ ///
+ /// If is null, nothing will get placed on the clipboard and this method
+ /// will be equivalent to .
+ ///
+ ///
+ ///
+ public static Task SetFileAsync(this IClipboard clipboard, IStorageItem? file)
+ => clipboard.SetValueAsync(DataFormat.File, file);
+
+ ///
+ /// Places a list of files on the clipboard.
+ ///
+ /// The clipboard instance.
+ /// The files to place on the clipboard.
+ ///
+ /// By calling this method, the clipboard will get cleared of any possible previous data.
+ ///
+ /// If is null or empty, nothing will get placed on the clipboard and this method
+ /// will be equivalent to .
+ ///
+ ///
+ ///
+ public static Task SetFilesAsync(this IClipboard clipboard, IEnumerable? files)
+ => clipboard.SetValuesAsync(DataFormat.File, files);
+}
diff --git a/src/Avalonia.Base/Input/Platform/DataObjectToDataTransferItemWrapper.cs b/src/Avalonia.Base/Input/Platform/DataObjectToDataTransferItemWrapper.cs
new file mode 100644
index 0000000000..656fbce996
--- /dev/null
+++ b/src/Avalonia.Base/Input/Platform/DataObjectToDataTransferItemWrapper.cs
@@ -0,0 +1,79 @@
+using System;
+using System.Diagnostics;
+using System.Diagnostics.CodeAnalysis;
+using System.IO;
+using System.Runtime.Serialization.Formatters.Binary;
+using System.Text;
+using Avalonia.Compatibility;
+using Avalonia.Logging;
+
+namespace Avalonia.Input.Platform;
+
+///
+/// Wraps a legacy into a .
+///
+[Obsolete]
+internal sealed class DataObjectToDataTransferItemWrapper(
+ IDataObject dataObject,
+ DataFormat[] formats,
+ string[] formatStrings)
+ : PlatformDataTransferItem
+{
+ private readonly IDataObject _dataObject = dataObject;
+ private readonly DataFormat[] _formats = formats;
+ private readonly string[] _formatStrings = formatStrings;
+
+ protected override DataFormat[] ProvideFormats()
+ => _formats;
+
+ protected override object? TryGetRawCore(DataFormat format)
+ {
+ var index = Array.IndexOf(Formats, format);
+ if (index < 0)
+ return null;
+
+ // We should never have DataFormat.File here, it's been handled by DataObjectToDataTransferWrapper.
+ Debug.Assert(!DataFormat.File.Equals(format));
+
+ var formatString = _formatStrings[index];
+ var data = _dataObject.Get(formatString);
+
+ if (DataFormat.Text.Equals(format))
+ return Convert.ToString(data) ?? string.Empty;
+
+ if (format is DataFormat)
+ return Convert.ToString(data);
+
+ if (format is DataFormat)
+ return ConvertLegacyDataToBytes(format, data);
+
+ return null;
+ }
+
+ private static byte[]? ConvertLegacyDataToBytes(DataFormat format, object? data)
+ {
+ switch (data)
+ {
+ case null:
+ return null;
+
+ case byte[] bytes:
+ return bytes;
+
+ case string str:
+ return OperatingSystemEx.IsWindows() || OperatingSystemEx.IsMacOS() || OperatingSystemEx.IsIOS() ?
+ Encoding.Unicode.GetBytes(str) :
+ Encoding.UTF8.GetBytes(str);
+
+ case Stream stream:
+ var length = (int)(stream.Length - stream.Position);
+ var buffer = new byte[length];
+
+ stream.ReadExactly(buffer, 0, length);
+ return buffer;
+
+ default:
+ return BinaryFormatterHelper.TrySerializeUsingBinaryFormatter(data, format);
+ }
+ }
+}
diff --git a/src/Avalonia.Base/Input/Platform/DataObjectToDataTransferWrapper.cs b/src/Avalonia.Base/Input/Platform/DataObjectToDataTransferWrapper.cs
new file mode 100644
index 0000000000..8460268ec6
--- /dev/null
+++ b/src/Avalonia.Base/Input/Platform/DataObjectToDataTransferWrapper.cs
@@ -0,0 +1,84 @@
+using System;
+using System.Collections.Generic;
+using System.Diagnostics;
+using System.Diagnostics.CodeAnalysis;
+using System.Linq;
+using Avalonia.Platform.Storage;
+using Avalonia.Platform.Storage.FileIO;
+
+namespace Avalonia.Input.Platform;
+
+#pragma warning disable CS0618 // Type or member is obsolete: usages of IDataObject and DataFormats
+
+// TODO12: remove
+///
+/// Wraps a legacy into a .
+///
+[Obsolete]
+internal sealed class DataObjectToDataTransferWrapper(IDataObject dataObject)
+ : PlatformDataTransfer
+{
+ public IDataObject DataObject { get; } = dataObject;
+
+ protected override DataFormat[] ProvideFormats()
+ => DataObject.GetDataFormats().Select(DataFormats.ToDataFormat).Distinct().ToArray();
+
+ protected override PlatformDataTransferItem[] ProvideItems()
+ {
+ var items = new List();
+ var nonFileFormats = new List();
+ var nonFileFormatStrings = new List();
+
+ foreach (var formatString in DataObject.GetDataFormats())
+ {
+ var format = DataFormats.ToDataFormat(formatString);
+
+ if (formatString == DataFormats.Files)
+ {
+ // This is not ideal as we're reading the filenames ahead of time to generate the appropriate items.
+ // We don't really care about that for this legacy wrapper.
+ if (DataObject.Get(formatString) is IEnumerable storageItems)
+ {
+ foreach (var storageItem in storageItems)
+ items.Add(PlatformDataTransferItem.Create(DataFormat.File, storageItem));
+ }
+ }
+ else if (formatString == DataFormats.FileNames)
+ {
+ if (DataObject.Get(formatString) is IEnumerable fileNames)
+ {
+ foreach (var fileName in fileNames)
+ {
+ if (StorageProviderHelpers.TryCreateBclStorageItem(fileName) is { } storageItem)
+ items.Add(PlatformDataTransferItem.Create(DataFormat.File, storageItem));
+ }
+ }
+ }
+ else
+ {
+ nonFileFormats.Add(format);
+ nonFileFormatStrings.Add(formatString);
+ }
+ }
+
+ if (nonFileFormats.Count > 0)
+ {
+ Debug.Assert(nonFileFormats.Count == nonFileFormatStrings.Count);
+
+ // Single item containing all formats except for DataFormat.File.
+ items.Add(new DataObjectToDataTransferItemWrapper(
+ DataObject,
+ nonFileFormats.ToArray(),
+ nonFileFormatStrings.ToArray()));
+ }
+
+ return items.ToArray();
+ }
+
+ [SuppressMessage(
+ "ReSharper",
+ "SuspiciousTypeConversion.Global",
+ Justification = "IDisposable may be implemented externally by the IDataObject instance.")]
+ public override void Dispose()
+ => (DataObject as IDisposable)?.Dispose();
+}
diff --git a/src/Avalonia.Base/Input/Platform/DataTransferToDataObjectWrapper.cs b/src/Avalonia.Base/Input/Platform/DataTransferToDataObjectWrapper.cs
new file mode 100644
index 0000000000..f1d6040efa
--- /dev/null
+++ b/src/Avalonia.Base/Input/Platform/DataTransferToDataObjectWrapper.cs
@@ -0,0 +1,44 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using Avalonia.Platform.Storage;
+
+namespace Avalonia.Input.Platform;
+
+///
+/// Wraps a into a legacy .
+///
+[Obsolete]
+internal sealed class DataTransferToDataObjectWrapper(IDataTransfer dataTransfer) : IDataObject
+{
+ public IDataTransfer DataTransfer { get; } = dataTransfer;
+
+ public IEnumerable GetDataFormats()
+ => DataTransfer.Formats.Select(DataFormats.ToString);
+
+ public bool Contains(string dataFormat)
+ => DataTransfer.Contains(DataFormats.ToDataFormat(dataFormat));
+
+ public object? Get(string dataFormat)
+ {
+ if (dataFormat == DataFormats.Text)
+ return DataTransfer.TryGetText();
+
+ if (dataFormat == DataFormats.Files)
+ return DataTransfer.TryGetFiles();
+
+ if (dataFormat == DataFormats.FileNames)
+ {
+ return DataTransfer
+ .TryGetFiles()
+ ?.Select(file => file.TryGetLocalPath())
+ .Where(path => path is not null)
+ .ToArray();
+ }
+
+ var typedFormat = DataFormat.CreateBytesPlatformFormat(dataFormat);
+ var bytes = DataTransfer.TryGetValue(typedFormat);
+ return BinaryFormatterHelper.TryDeserializeUsingBinaryFormatter(bytes) ?? bytes;
+ }
+
+}
diff --git a/src/Avalonia.Base/Input/Platform/IClipboard.cs b/src/Avalonia.Base/Input/Platform/IClipboard.cs
index 55516b2250..b75e1b5a40 100644
--- a/src/Avalonia.Base/Input/Platform/IClipboard.cs
+++ b/src/Avalonia.Base/Input/Platform/IClipboard.cs
@@ -1,26 +1,39 @@
+using System;
using System.Threading.Tasks;
using Avalonia.Metadata;
namespace Avalonia.Input.Platform
{
+ ///
+ /// Represents the system clipboard.
+ ///
[NotClientImplementable]
public interface IClipboard
{
+ // TODO12: remove, ClipboardExtensions.TryGetTextAsync exists
///
- /// Returns a string containing the text data on the Clipboard.
+ /// Returns a string containing the text data on the clipboard.
///
- /// A string containing text data in the specified data format, or an empty string if no corresponding text data is available.
+ /// A string containing text data, or null if no corresponding text data is available.
+ [Obsolete($"Use {nameof(ClipboardExtensions)}.{nameof(ClipboardExtensions.TryGetTextAsync)} instead")]
Task GetTextAsync();
+ // TODO12: remove, ClipboardExtensions.SetTextAsync exists
///
- /// Stores text data on the Clipboard. The text data to store is specified as a string.
+ /// Places a text on the clipboard.
///
- /// A string that contains the UnicodeText data to store on the Clipboard.
- /// is null.
+ /// The text value to set.
+ ///
+ /// By calling this method, the clipboard will get cleared of any possible previous data.
+ ///
+ /// If is null or empty, nothing will get placed on the clipboard and this method
+ /// will be equivalent to .
+ ///
+ ///
Task SetTextAsync(string? text);
///
- /// Clears any data from the system Clipboard.
+ /// Clears any data from the system clipboard.
///
Task ClearAsync();
@@ -29,18 +42,37 @@ namespace Avalonia.Input.Platform
///
/// A data object (an object that implements ) to place on the system Clipboard.
/// is null.
+ [Obsolete($"Use {nameof(SetDataAsync)} instead.")]
Task SetDataObjectAsync(IDataObject data);
+ ///
+ /// Places a data object on the clipboard.
+ /// The data object is responsible for providing supported formats and data upon request.
+ ///
+ /// The data object to set on the clipboard.
+ ///
+ ///
+ /// If is null, nothing will get placed on the clipboard and this method
+ /// will be equivalent to .
+ ///
+ ///
+ /// The must NOT be disposed by the caller after this call.
+ /// The clipboard will dispose of it automatically when it becomes unused.
+ ///
+ ///
+ Task SetDataAsync(IAsyncDataTransfer? dataTransfer);
+
///
/// Permanently adds the data that is on the Clipboard so that it is available after the data's original application closes.
///
///
- /// This method works only on Windows platform, on other platforms it does nothing.
+ /// This method is only supported on the Windows platform. This method will do nothing on other platforms.
Task FlushAsync();
///
/// Get list of available Clipboard format.
///
+ [Obsolete($"Use {nameof(ClipboardExtensions.GetDataFormatsAsync)} instead.")]
Task GetFormatsAsync();
///
@@ -48,15 +80,44 @@ namespace Avalonia.Input.Platform
///
/// A string that specifies the format of the data to retrieve. For a set of predefined data formats, see the class.
///
+ [Obsolete($"Use {nameof(TryGetDataAsync)} instead.")]
Task GetDataAsync(string format);
-
+
+ ///
+ /// Retrieves data from the clipboard.
+ ///
+ ///
+ /// The returned MUST be disposed by the caller.
+ ///
+ /// Avoid storing the returned instance for a long time:
+ /// use it, then dispose it as soon as possible.
+ ///
+ ///
+ Task TryGetDataAsync();
+
///
- /// If clipboard contains the IDataObject that was set by a previous call to ,
+ /// If clipboard contains the IDataObject that was set by a previous call to ,
/// return said IDataObject instance. Otherwise, return null.
/// Note that not every platform supports that method, on unsupported platforms this method will always return
/// null
///
///
+ [Obsolete($"Use {nameof(TryGetInProcessDataAsync)} instead.")]
Task TryGetInProcessDataObjectAsync();
+
+ ///
+ /// Retrieves the exact instance of a previously placed on the clipboard
+ /// by , if any.
+ ///
+ /// The data transfer object if present, null otherwise.
+ ///
+ /// This method cannot be used to retrieve a set by another process.
+ /// This method is only supported on Windows, macOS and X11 platforms. Other platforms will always return null.
+ ///
+ /// Contrary to , the returned must NOT be disposed
+ /// by the caller since it's still owned by the clipboard.
+ ///
+ ///
+ Task TryGetInProcessDataAsync();
}
}
diff --git a/src/Avalonia.Base/Input/Platform/IClipboardImpl.cs b/src/Avalonia.Base/Input/Platform/IClipboardImpl.cs
new file mode 100644
index 0000000000..8adbd26afc
--- /dev/null
+++ b/src/Avalonia.Base/Input/Platform/IClipboardImpl.cs
@@ -0,0 +1,20 @@
+using System.Threading.Tasks;
+using Avalonia.Metadata;
+
+namespace Avalonia.Input.Platform;
+
+///
+/// Represents a platform-specific implementation of the clipboard.
+///
+[PrivateApi]
+public interface IClipboardImpl
+{
+ ///
+ Task TryGetDataAsync();
+
+ ///
+ Task SetDataAsync(IAsyncDataTransfer dataTransfer);
+
+ ///
+ Task ClearAsync();
+}
diff --git a/src/Avalonia.Base/Input/Platform/IFlushableClipboardImpl.cs b/src/Avalonia.Base/Input/Platform/IFlushableClipboardImpl.cs
new file mode 100644
index 0000000000..1c7f55c874
--- /dev/null
+++ b/src/Avalonia.Base/Input/Platform/IFlushableClipboardImpl.cs
@@ -0,0 +1,14 @@
+using System.Threading.Tasks;
+using Avalonia.Metadata;
+
+namespace Avalonia.Input.Platform;
+
+///
+/// Represents a platform-specific implementation of the clipboard that can be flushed.
+///
+[PrivateApi]
+public interface IFlushableClipboardImpl : IClipboardImpl
+{
+ ///
+ Task FlushAsync();
+}
diff --git a/src/Avalonia.Base/Input/Platform/IOwnedClipboardImpl.cs b/src/Avalonia.Base/Input/Platform/IOwnedClipboardImpl.cs
new file mode 100644
index 0000000000..e9ad7748cb
--- /dev/null
+++ b/src/Avalonia.Base/Input/Platform/IOwnedClipboardImpl.cs
@@ -0,0 +1,16 @@
+using System.Threading.Tasks;
+using Avalonia.Metadata;
+
+namespace Avalonia.Input.Platform;
+
+///
+/// Represents a platform-specific implementation of the clipboard that keeps track of its current owner.
+///
+[PrivateApi]
+public interface IOwnedClipboardImpl : IClipboardImpl
+{
+ ///
+ /// Gets whether the current instance still owns the system clipboard.
+ ///
+ Task IsCurrentOwnerAsync();
+}
diff --git a/src/Avalonia.Base/Input/Platform/IPlatformDragSource.cs b/src/Avalonia.Base/Input/Platform/IPlatformDragSource.cs
index 8d1b93087e..44881bcee1 100644
--- a/src/Avalonia.Base/Input/Platform/IPlatformDragSource.cs
+++ b/src/Avalonia.Base/Input/Platform/IPlatformDragSource.cs
@@ -1,11 +1,21 @@
-using System.Threading.Tasks;
+using System;
+using System.Threading.Tasks;
using Avalonia.Metadata;
namespace Avalonia.Input.Platform
{
- [Unstable]
+ [NotClientImplementable]
public interface IPlatformDragSource
{
- Task DoDragDrop(PointerEventArgs triggerEvent, IDataObject data, DragDropEffects allowedEffects);
+ [Obsolete($"Use {nameof(DoDragDropAsync)} instead.")]
+ Task DoDragDrop(
+ PointerEventArgs triggerEvent,
+ IDataObject data,
+ DragDropEffects allowedEffects);
+
+ Task DoDragDropAsync(
+ PointerEventArgs triggerEvent,
+ IDataTransfer dataTransfer,
+ DragDropEffects allowedEffects);
}
}
diff --git a/src/Avalonia.Base/Input/Platform/PlatformAsyncDataTransfer.cs b/src/Avalonia.Base/Input/Platform/PlatformAsyncDataTransfer.cs
new file mode 100644
index 0000000000..36ed90002c
--- /dev/null
+++ b/src/Avalonia.Base/Input/Platform/PlatformAsyncDataTransfer.cs
@@ -0,0 +1,37 @@
+using System.Collections.Generic;
+
+namespace Avalonia.Input.Platform;
+
+///
+/// Abstract implementation of used by platform implementations.
+///
+/// Use this class when the platform can only provide the underlying data asynchronously.
+internal abstract class PlatformAsyncDataTransfer : IAsyncDataTransfer
+{
+ private DataFormat[]? _formats;
+ private IAsyncDataTransferItem[]? _items;
+
+ public DataFormat[] Formats
+ => _formats ??= ProvideFormats();
+
+ IReadOnlyList IAsyncDataTransfer.Formats
+ => Formats;
+
+ protected bool AreFormatsInitialized
+ => _formats is not null;
+
+ public IAsyncDataTransferItem[] Items
+ => _items ??= ProvideItems();
+
+ IReadOnlyList IAsyncDataTransfer.Items
+ => Items;
+
+ protected bool AreItemsInitialized
+ => _items is not null;
+
+ protected abstract DataFormat[] ProvideFormats();
+
+ protected abstract IAsyncDataTransferItem[] ProvideItems();
+
+ public abstract void Dispose();
+}
diff --git a/src/Avalonia.Base/Input/Platform/PlatformAsyncDataTransferItem.cs b/src/Avalonia.Base/Input/Platform/PlatformAsyncDataTransferItem.cs
new file mode 100644
index 0000000000..1944214fca
--- /dev/null
+++ b/src/Avalonia.Base/Input/Platform/PlatformAsyncDataTransferItem.cs
@@ -0,0 +1,30 @@
+using System;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+
+namespace Avalonia.Input.Platform;
+
+///
+/// Abstract implementation of used by platform implementations.
+///
+/// Use this class when the platform can only provide the underlying data asynchronously.
+internal abstract class PlatformAsyncDataTransferItem : IAsyncDataTransferItem
+{
+ private DataFormat[]? _formats;
+
+ public DataFormat[] Formats
+ => _formats ??= ProvideFormats();
+
+ IReadOnlyList IAsyncDataTransferItem.Formats
+ => Formats;
+
+ protected abstract DataFormat[] ProvideFormats();
+
+ public bool Contains(DataFormat format)
+ => Array.IndexOf(Formats, format) >= 0;
+
+ public Task TryGetRawAsync(DataFormat format)
+ => Contains(format) ? TryGetRawCoreAsync(format) : Task.FromResult(null);
+
+ protected abstract Task TryGetRawCoreAsync(DataFormat format);
+}
diff --git a/src/Avalonia.Base/Input/Platform/PlatformDataTransfer.cs b/src/Avalonia.Base/Input/Platform/PlatformDataTransfer.cs
new file mode 100644
index 0000000000..6d6e1cb72a
--- /dev/null
+++ b/src/Avalonia.Base/Input/Platform/PlatformDataTransfer.cs
@@ -0,0 +1,43 @@
+using System.Collections.Generic;
+
+namespace Avalonia.Input.Platform;
+
+///
+/// Abstract implementation of used by platform implementations.
+///
+/// Use this class when the platform can only provide the underlying data asynchronously.
+internal abstract class PlatformDataTransfer : IDataTransfer, IAsyncDataTransfer
+{
+ private DataFormat[]? _formats;
+ private PlatformDataTransferItem[]? _items;
+
+ public DataFormat[] Formats
+ => _formats ??= ProvideFormats();
+
+ IReadOnlyList IDataTransfer.Formats
+ => Formats;
+
+ IReadOnlyList IAsyncDataTransfer.Formats
+ => Formats;
+
+ protected bool AreFormatsInitialized
+ => _formats is not null;
+
+ public PlatformDataTransferItem[] Items
+ => _items ??= ProvideItems();
+
+ IReadOnlyList IDataTransfer.Items
+ => Items;
+
+ IReadOnlyList IAsyncDataTransfer.Items
+ => Items;
+
+ protected bool AreItemsInitialized
+ => _items is not null;
+
+ protected abstract DataFormat[] ProvideFormats();
+
+ protected abstract PlatformDataTransferItem[] ProvideItems();
+
+ public abstract void Dispose();
+}
diff --git a/src/Avalonia.Base/Input/Platform/PlatformDataTransferItem.cs b/src/Avalonia.Base/Input/Platform/PlatformDataTransferItem.cs
new file mode 100644
index 0000000000..da653985ba
--- /dev/null
+++ b/src/Avalonia.Base/Input/Platform/PlatformDataTransferItem.cs
@@ -0,0 +1,63 @@
+using System;
+using System.Collections.Generic;
+using System.Threading.Tasks;
+
+namespace Avalonia.Input.Platform;
+
+///
+/// Abstract implementation of used by platform implementations.
+///
+/// Use this class when the platform can only provide the underlying data synchronously.
+internal abstract class PlatformDataTransferItem : IDataTransferItem, IAsyncDataTransferItem
+{
+ private DataFormat[]? _formats;
+
+ public DataFormat[] Formats
+ => _formats ??= ProvideFormats();
+
+ IReadOnlyList IDataTransferItem.Formats
+ => Formats;
+
+ IReadOnlyList IAsyncDataTransferItem.Formats
+ => Formats;
+
+ protected abstract DataFormat[] ProvideFormats();
+
+ public bool Contains(DataFormat format)
+ => Array.IndexOf(Formats, format) >= 0;
+
+ public object? TryGetRaw(DataFormat format)
+ => Contains(format) ? TryGetRawCore(format) : Task.FromResult(null);
+
+ public Task TryGetRawAsync(DataFormat format)
+ {
+ if (!Contains(format))
+ return Task.FromResult(null);
+
+ try
+ {
+ return Task.FromResult(TryGetRawCore(format));
+ }
+ catch (Exception ex)
+ {
+ return Task.FromException(ex);
+ }
+ }
+
+ protected abstract object? TryGetRawCore(DataFormat format);
+
+ public static PlatformDataTransferItem Create(DataFormat format, T value) where T : class
+ => new SingleFormatItem(format, value);
+
+ private sealed class SingleFormatItem(DataFormat format, object value) : PlatformDataTransferItem
+ {
+ private readonly DataFormat _format = format;
+ private readonly object _value = value;
+
+ protected override DataFormat[] ProvideFormats()
+ => [_format];
+
+ protected override object? TryGetRawCore(DataFormat format)
+ => _format.Equals(format) ? _value : null;
+ }
+}
diff --git a/src/Avalonia.Base/Input/Raw/RawDragEvent.cs b/src/Avalonia.Base/Input/Raw/RawDragEvent.cs
index 8ade3d8af5..5f7c5e3e04 100644
--- a/src/Avalonia.Base/Input/Raw/RawDragEvent.cs
+++ b/src/Avalonia.Base/Input/Raw/RawDragEvent.cs
@@ -1,4 +1,5 @@
using System;
+using Avalonia.Input.Platform;
using Avalonia.Metadata;
namespace Avalonia.Input.Raw
@@ -6,19 +7,47 @@ namespace Avalonia.Input.Raw
[PrivateApi]
public class RawDragEvent : RawInputEventArgs
{
+ [Obsolete] private IDataObject? _legacyDataObject;
+
public Point Location { get; set; }
- public IDataObject Data { get; }
+
+ public IDataTransfer DataTransfer { get; }
+
+ [Obsolete($"Use {nameof(DataTransfer)} instead.")]
+ public IDataObject Data
+ => _legacyDataObject ??= DataTransfer.ToLegacyDataObject();
+
public DragDropEffects Effects { get; set; }
+
public RawDragEventType Type { get; }
+
public KeyModifiers KeyModifiers { get; }
- public RawDragEvent(IDragDropDevice inputDevice, RawDragEventType type,
- IInputRoot root, Point location, IDataObject data, DragDropEffects effects, RawInputModifiers modifiers)
- :base(inputDevice, 0, root)
+ [Obsolete($"Use the constructor accepting a {nameof(IDataTransfer)} instance instead.")]
+ public RawDragEvent(IDragDropDevice inputDevice,
+ RawDragEventType type,
+ IInputRoot root,
+ Point location,
+ IDataObject data,
+ DragDropEffects effects,
+ RawInputModifiers modifiers)
+ : this(inputDevice, type, root, location, new DataObjectToDataTransferWrapper(data), effects, modifiers)
+ {
+ }
+
+ public RawDragEvent(
+ IDragDropDevice inputDevice,
+ RawDragEventType type,
+ IInputRoot root,
+ Point location,
+ IDataTransfer dataTransfer,
+ DragDropEffects effects,
+ RawInputModifiers modifiers)
+ : base(inputDevice, 0, root)
{
Type = type;
Location = location;
- Data = data;
+ DataTransfer = dataTransfer;
Effects = effects;
KeyModifiers = modifiers.ToKeyModifiers();
}
diff --git a/src/Avalonia.Base/Platform/Storage/FileIO/StorageProviderHelpers.cs b/src/Avalonia.Base/Platform/Storage/FileIO/StorageProviderHelpers.cs
index 48cc79672b..814333cac6 100644
--- a/src/Avalonia.Base/Platform/Storage/FileIO/StorageProviderHelpers.cs
+++ b/src/Avalonia.Base/Platform/Storage/FileIO/StorageProviderHelpers.cs
@@ -8,7 +8,7 @@ namespace Avalonia.Platform.Storage.FileIO;
internal static class StorageProviderHelpers
{
- public static BclStorageItem? TryCreateBclStorageItem(string path)
+ public static BclStorageItem? TryCreateBclStorageItem(string? path)
{
if (!string.IsNullOrWhiteSpace(path))
{
diff --git a/src/Avalonia.Base/Utilities/ThrowHelper.cs b/src/Avalonia.Base/Utilities/ThrowHelper.cs
index e97ab754e5..94550db660 100644
--- a/src/Avalonia.Base/Utilities/ThrowHelper.cs
+++ b/src/Avalonia.Base/Utilities/ThrowHelper.cs
@@ -5,20 +5,42 @@ using System.Runtime.CompilerServices;
namespace Avalonia.Utilities;
///
-/// Helper method to help inlining methods that do a throw check.
-/// Equivalent of .NET6+ ArgumentNullException.ThrowIfNull() for netstandard2.0+
+/// Helper methods to help inlining methods that do a throw check.
///
-internal class ThrowHelper
+internal static class ThrowHelper
{
+ ///
+ /// Equivalent of .NET6+ ArgumentNullException.ThrowIfNull().
+ ///
[MethodImpl(MethodImplOptions.AggressiveInlining)]
- public static void ThrowIfNull([NotNull] object? argument, string paramName)
+ public static void ThrowIfNull([NotNull] object? argument, [CallerArgumentExpression(nameof(argument))] string? paramName = null)
{
if (argument is null)
{
ThrowArgumentNullException(paramName);
}
+
+ [DoesNotReturn]
+ static void ThrowArgumentNullException(string? paramName) => throw new ArgumentNullException(paramName);
+ }
+
+ ///
+ /// Equivalent of .NET8+ ArgumentException.ThrowIfNullOrEmpty().
+ ///
+ [MethodImpl(MethodImplOptions.AggressiveInlining)]
+ public static void ThrowIfNullOrEmpty([NotNull] string? argument, [CallerArgumentExpression(nameof(argument))] string? paramName = null)
+ {
+ if (string.IsNullOrEmpty(argument))
+ {
+ ThrowNullOrEmptyException(argument, paramName);
+ }
+
+ [DoesNotReturn]
+ static void ThrowNullOrEmptyException(string? argument, string? paramName)
+ {
+ ThrowIfNull(argument, paramName);
+ throw new ArgumentException("Empty string", paramName);
+ }
}
- [DoesNotReturn]
- private static void ThrowArgumentNullException(string paramName) => throw new ArgumentNullException(paramName);
}
diff --git a/src/Avalonia.Controls/MaskedTextBox.cs b/src/Avalonia.Controls/MaskedTextBox.cs
index a483f2758a..e134c5db19 100644
--- a/src/Avalonia.Controls/MaskedTextBox.cs
+++ b/src/Avalonia.Controls/MaskedTextBox.cs
@@ -4,6 +4,7 @@ using System.ComponentModel;
using System.Globalization;
using System.Linq;
using Avalonia.Input;
+using Avalonia.Input.Platform;
using Avalonia.Interactivity;
namespace Avalonia.Controls
@@ -216,7 +217,7 @@ namespace Avalonia.Controls
string? text = null;
try
{
- text = await clipboard.GetTextAsync();
+ text = await clipboard.TryGetTextAsync();
}
catch (TimeoutException)
{
diff --git a/src/Avalonia.Controls/Platform/InProcessDragSource.cs b/src/Avalonia.Controls/Platform/InProcessDragSource.cs
index aeedbe81ea..aa8694b6ac 100644
--- a/src/Avalonia.Controls/Platform/InProcessDragSource.cs
+++ b/src/Avalonia.Controls/Platform/InProcessDragSource.cs
@@ -1,4 +1,5 @@
-using System.Linq;
+using System;
+using System.Linq;
using Avalonia.Reactive;
using System.Threading.Tasks;
using Avalonia.Controls;
@@ -18,7 +19,7 @@ namespace Avalonia.Platform
private readonly LightweightSubject _result = new();
private DragDropEffects _allowedEffects;
- private IDataObject? _draggedData;
+ private IDataTransfer? _draggedData;
private TopLevel? _lastRoot;
private Point _lastPosition;
private StandardCursorType? _lastCursorType;
@@ -30,13 +31,23 @@ namespace Avalonia.Platform
_dragDrop = AvaloniaLocator.Current.GetRequiredService();
}
- public async Task DoDragDrop(PointerEventArgs triggerEvent, IDataObject data, DragDropEffects allowedEffects)
+ [Obsolete($"Use {nameof(DoDragDropAsync)} instead.")]
+ Task IPlatformDragSource.DoDragDrop(
+ PointerEventArgs triggerEvent,
+ IDataObject data,
+ DragDropEffects allowedEffects)
+ => DoDragDropAsync(triggerEvent, new DataObjectToDataTransferWrapper(data), allowedEffects);
+
+ public async Task DoDragDropAsync(
+ PointerEventArgs triggerEvent,
+ IDataTransfer dataTransfer,
+ DragDropEffects allowedEffects)
{
Dispatcher.UIThread.VerifyAccess();
triggerEvent.Pointer.Capture(null);
if (_draggedData == null)
{
- _draggedData = data;
+ _draggedData = dataTransfer;
_lastRoot = null;
_lastPosition = default;
_allowedEffects = allowedEffects;
diff --git a/src/Avalonia.Controls/TextBox.cs b/src/Avalonia.Controls/TextBox.cs
index 3927fe3833..cece9d8c7d 100644
--- a/src/Avalonia.Controls/TextBox.cs
+++ b/src/Avalonia.Controls/TextBox.cs
@@ -1259,7 +1259,7 @@ namespace Avalonia.Controls
{
try
{
- text = await clipboard.GetTextAsync();
+ text = await clipboard.TryGetTextAsync();
}
catch (TimeoutException)
{
diff --git a/src/Avalonia.DesignerSupport/Remote/Stubs.cs b/src/Avalonia.DesignerSupport/Remote/Stubs.cs
index e83c29c9af..15b916f7fa 100644
--- a/src/Avalonia.DesignerSupport/Remote/Stubs.cs
+++ b/src/Avalonia.DesignerSupport/Remote/Stubs.cs
@@ -1,11 +1,10 @@
+#nullable enable
+
using System;
using System.Collections.Generic;
using System.IO;
-using Avalonia.Reactive;
using System.Threading.Tasks;
-using Avalonia.Automation.Peers;
using Avalonia.Controls;
-using Avalonia.Controls.Platform;
using Avalonia.Controls.Primitives.PopupPositioning;
using Avalonia.Input;
using Avalonia.Input.Platform;
@@ -15,49 +14,48 @@ using Avalonia.Platform.Storage;
using Avalonia.Platform.Storage.FileIO;
using Avalonia.Rendering;
using Avalonia.Rendering.Composition;
-using Avalonia.Threading;
namespace Avalonia.DesignerSupport.Remote
{
class WindowStub : IWindowImpl, IPopupImpl
{
- public Action Deactivated { get; set; }
- public Action Activated { get; set; }
- public IPlatformHandle Handle { get; }
+ public Action? Deactivated { get; set; }
+ public Action? Activated { get; set; }
+ public IPlatformHandle? Handle { get; }
public Size MaxAutoSizeHint { get; }
public Size ClientSize { get; }
public Size? FrameSize => null;
public double RenderScaling { get; } = 1.0;
public double DesktopScaling => 1.0;
- public IEnumerable