[iOS DnD] Support DataTransfer.getData and DataTransfer.setData when dragging or...
[WebKit-https.git] / Source / WebCore / platform / ios / WebItemProviderPasteboard.h
1 /*
2  * Copyright (C) 2017 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #import <WebCore/AbstractPasteboard.h>
27
28 #if TARGET_OS_IPHONE && __IPHONE_OS_VERSION_MIN_REQUIRED >= 110000
29
30 @class UIItemProvider;
31 @protocol UIItemProviderWriting;
32
33 struct CGSize;
34
35 typedef NS_ENUM(NSInteger, WebPreferredPresentationStyle) {
36     WebPreferredPresentationStyleUnspecified,
37     WebPreferredPresentationStyleInline,
38     WebPreferredPresentationStyleAttachment
39 };
40
41 NS_ASSUME_NONNULL_BEGIN
42
43 /*! A WebItemProviderRegistrationInfo represents a single call to register something to an item provider.
44  @discussion Either the representing object exists and the type identifier and data are nil, or the
45  representing object is nil and the type identifier and data exist. The former represents a call to
46  register an entire UIItemProviderWriting-conformant object to the item provider, while the latter
47  represents a call to register only a data representation for the given type identifier.
48  */
49 WEBCORE_EXPORT @interface WebItemProviderRegistrationInfo : NSObject
50
51 @property (nonatomic, readonly, nullable, strong) id <UIItemProviderWriting> representingObject;
52 @property (nonatomic, readonly, nullable, strong) NSString *typeIdentifier;
53 @property (nonatomic, readonly, nullable, strong) NSData *data;
54
55 @end
56
57 /*! A WebItemProviderRegistrationInfoList represents a series of registration calls used to set up a
58  single item provider.
59  @discussion The order of items specified in the list (lowest indices first) is the order in which
60  objects or data are registered to the item provider, and therefore indicates the relative fidelity
61  of each item. Private UTI types, such as those vended through the injected editing bundle SPI, are
62  considered to be higher fidelity than the other default types.
63  */
64 WEBCORE_EXPORT @interface WebItemProviderRegistrationInfoList : NSObject
65
66 - (void)addRepresentingObject:(id <UIItemProviderWriting>)object;
67 - (void)addData:(NSData *)data forType:(NSString *)typeIdentifier;
68
69 @property (nonatomic) CGSize preferredPresentationSize;
70 @property (nonatomic, copy) NSString *suggestedName;
71 @property (nonatomic, readonly, nullable) UIItemProvider *itemProvider;
72
73 @property (nonatomic) WebPreferredPresentationStyle preferredPresentationStyle;
74
75 - (NSUInteger)numberOfItems;
76 - (nullable WebItemProviderRegistrationInfo *)itemAtIndex:(NSUInteger)index;
77 - (void)enumerateItems:(void(^)(WebItemProviderRegistrationInfo *item, NSUInteger index))block;
78
79 @end
80
81 typedef void (^WebItemProviderFileLoadBlock)(NSArray<NSURL *> *);
82
83 WEBCORE_EXPORT @interface WebItemProviderPasteboard : NSObject<AbstractPasteboard>
84
85 + (instancetype)sharedInstance;
86
87 @property (copy, nonatomic, nullable) NSArray<__kindof NSItemProvider *> *itemProviders;
88 @property (readonly, nonatomic) NSInteger numberOfItems;
89 @property (readonly, nonatomic) NSInteger changeCount;
90
91 // This will only be non-empty when an operation is being performed.
92 @property (readonly, nonatomic) NSArray<NSURL *> *droppedFileURLs;
93
94 @property (readonly, nonatomic) BOOL hasPendingOperation;
95 - (void)incrementPendingOperationCount;
96 - (void)decrementPendingOperationCount;
97
98 - (void)enumerateItemProvidersWithBlock:(void (^)(UIItemProvider *itemProvider, NSUInteger index, BOOL *stop))block;
99
100 // The given completion block is always dispatched on the main thread.
101 - (void)doAfterLoadingProvidedContentIntoFileURLs:(WebItemProviderFileLoadBlock)action;
102 - (void)doAfterLoadingProvidedContentIntoFileURLs:(WebItemProviderFileLoadBlock)action synchronousTimeout:(NSTimeInterval)synchronousTimeout;
103
104 @end
105
106 NS_ASSUME_NONNULL_END
107
108 #endif // TARGET_OS_IPHONE && __IPHONE_OS_VERSION_MIN_REQUIRED >= 110000