1 /*
2  * Copyright (c) 2021 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef FOUNDATION_ACE_FRAMEWORKS_CORE_COMMON_CLIPBOARD_CLIPBOARD_H
17 #define FOUNDATION_ACE_FRAMEWORKS_CORE_COMMON_CLIPBOARD_CLIPBOARD_H
18 
19 #include "base/image/pixel_map.h"
20 #include "base/memory/ace_type.h"
21 #include "base/thread/task_executor.h"
22 #include "core/common/clipboard/paste_data.h"
23 #include "core/components/common/layout/constants.h"
24 
25 namespace OHOS::Ace {
26 
27 class Clipboard : public AceType {
28     DECLARE_ACE_TYPE(Clipboard, AceType);
29 
30 public:
31     ~Clipboard() override = default;
32 
33     virtual void SetData(
34         const std::string& data, CopyOptions copyOption = CopyOptions::InApp, bool isDragData = false) = 0;
35     virtual void GetData(const std::function<void(const std::string&)>& callback, bool syncMode = false) = 0;
36     virtual void SetPixelMapData(const RefPtr<PixelMap>& pixmap, CopyOptions copyOption = CopyOptions::InApp) = 0;
37     virtual void GetPixelMapData(
38         const std::function<void(const RefPtr<PixelMap>&)>& callback, bool syncMode = false) = 0;
39     virtual void HasData(const std::function<void(bool hasData)>& callback) = 0;
40     virtual void HasDataType(
41         const std::function<void(bool hasData)>& callback, const std::vector<std::string>& mimeTypes) = 0;
42     virtual void AddPixelMapRecord(const RefPtr<PasteDataMix>& pasteData, const RefPtr<PixelMap>& pixmap) = 0;
43     virtual void AddImageRecord(const RefPtr<PasteDataMix>& pasteData, const std::string& uri) = 0;
44     virtual void AddTextRecord(const RefPtr<PasteDataMix>& pasteData, const std::string& selectedStr) = 0;
45     virtual void AddSpanStringRecord(const RefPtr<PasteDataMix>& pasteData, std::vector<uint8_t>& data) = 0;
46     virtual void AddMultiTypeRecord(
47         const RefPtr<PasteDataMix>& pasteData, const RefPtr<MultiTypeRecordMix>& multiTypeRecord) = 0;
48     virtual void SetData(const RefPtr<PasteDataMix>& pasteData, CopyOptions copyOption = CopyOptions::Distributed) = 0;
49     virtual void GetData(const std::function<void(const std::string&, bool isLastRecord)>& textCallback,
50         const std::function<void(const RefPtr<PixelMap>&, bool isLastRecord)>& pixelMapCallback,
51         const std::function<void(const std::string&, bool isLastRecord)>& urlCallback, bool syncMode = false) = 0;
52     virtual RefPtr<PasteDataMix> CreatePasteDataMix() = 0;
53     virtual void Clear() = 0;
54     virtual void GetSpanStringData(
55         const std::function<void(std::vector<std::vector<uint8_t>>&, const std::string&, bool&)>& callback,
56         bool syncMode = false) = 0;
57 
58 protected:
Clipboard(const RefPtr<TaskExecutor> & taskExecutor)59     explicit Clipboard(const RefPtr<TaskExecutor>& taskExecutor) : taskExecutor_(taskExecutor) {}
60     RefPtr<TaskExecutor> taskExecutor_;
61 };
62 
63 } // namespace OHOS::Ace
64 
65 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_COMMON_CLIPBOARD_CLIPBOARD_H
66