1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef UI_BASE_CLIPBOARD_SCOPED_CLIPBOARD_WRITER_H_
#define UI_BASE_CLIPBOARD_SCOPED_CLIPBOARD_WRITER_H_
#include <string>
#include "base/component_export.h"
#include "base/macros.h"
#include "third_party/skia/include/core/SkBitmap.h"
#include "ui/base/clipboard/clipboard.h"
#include "ui/base/data_transfer_policy/data_transfer_endpoint.h"
namespace base {
class Pickle;
}
namespace ui {
// |ScopedClipboardWriter|:
// - is a wrapper for |Clipboard|.
// - simplifies writing data to the system clipboard.
// - handles packing data into a Clipboard::ObjectMap.
//
// Upon deletion, the class atomically writes all data to the clipboard,
// avoiding any potential race condition with other processes that are also
// writing to the system clipboard.
class COMPONENT_EXPORT(UI_BASE_CLIPBOARD) ScopedClipboardWriter {
public:
// Create an instance that is a simple wrapper around the clipboard of the
// given buffer with an optional parameter indicating the source of the data.
// TODO(crbug.com/1103193): change its references to use
// DataTransferEndpoint, if possible.
explicit ScopedClipboardWriter(
ClipboardBuffer buffer,
std::unique_ptr<DataTransferEndpoint> src = nullptr);
~ScopedClipboardWriter();
// Converts |text| to UTF-8 and adds it to the clipboard.
void WriteText(const std::u16string& text);
// Adds HTML to the clipboard. The url parameter is optional, but especially
// useful if the HTML fragment contains relative links.
void WriteHTML(const std::u16string& markup, const std::string& source_url);
// Adds SVG to the clipboard.
void WriteSvg(const std::u16string& text);
// Adds RTF to the clipboard.
void WriteRTF(const std::string& rtf_data);
// Adds text/uri-list filenames to the clipboard.
// Security Note: This function is expected to be called only by exo in
// Chrome OS. It should not be called by renderers or any other untrusted
// party since any paths written to the clipboard can be read by renderers.
void WriteFilenames(const std::string& uri_list);
// Adds a bookmark to the clipboard.
void WriteBookmark(const std::u16string& bookmark_title,
const std::string& url);
// Adds an html hyperlink (<a href>) to the clipboard. |anchor_text| and
// |url| will be escaped as needed.
void WriteHyperlink(const std::u16string& anchor_text,
const std::string& url);
// Used by WebKit to determine whether WebKit wrote the clipboard last
void WriteWebSmartPaste();
// Adds arbitrary pickled data to clipboard.
void WritePickledData(const base::Pickle& pickle,
const ClipboardFormatType& format);
// Data is written to the system clipboard in the same order as WriteData
// calls are received.
void WriteData(const std::u16string& format, mojo_base::BigBuffer data);
void WriteImage(const SkBitmap& bitmap);
// Mark the data to be written as confidential.
void MarkAsConfidential();
// Removes all objects that would be written to the clipboard.
void Reset();
private:
// We accumulate the data passed to the various targets in the |objects_|
// vector, and pass it to Clipboard::WritePortableRepresentations() during
// object destruction.
Clipboard::ObjectMap objects_;
std::vector<Clipboard::PlatformRepresentation> platform_representations_;
// The type is set at construction, and can be changed before committing.
const ClipboardBuffer buffer_;
SkBitmap bitmap_;
bool confidential_ = false;
// The source of the data written in ScopedClipboardWriter, nullptr means it's
// not set, or the source of the data can't be represented by
// DataTransferEndpoint.
std::unique_ptr<DataTransferEndpoint> data_src_;
DISALLOW_COPY_AND_ASSIGN(ScopedClipboardWriter);
};
} // namespace ui
#endif // UI_BASE_CLIPBOARD_SCOPED_CLIPBOARD_WRITER_H_
|
