mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-12-01 00:32:11 +00:00
c2e0e2cb11
Differential Revision: https://phabricator.services.mozilla.com/D97859
76 lines
2.6 KiB
C++
76 lines
2.6 KiB
C++
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#ifndef mozilla_dom_Clipboard_h_
|
|
#define mozilla_dom_Clipboard_h_
|
|
|
|
#include "nsString.h"
|
|
#include "mozilla/DOMEventTargetHelper.h"
|
|
#include "mozilla/Logging.h"
|
|
#include "mozilla/dom/DataTransfer.h"
|
|
|
|
namespace mozilla {
|
|
namespace dom {
|
|
|
|
enum ClipboardReadType {
|
|
eRead,
|
|
eReadText,
|
|
};
|
|
|
|
class Promise;
|
|
class ClipboardItem;
|
|
|
|
// https://www.w3.org/TR/clipboard-apis/#clipboard-interface
|
|
class Clipboard : public DOMEventTargetHelper {
|
|
public:
|
|
NS_DECL_ISUPPORTS_INHERITED
|
|
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(Clipboard, DOMEventTargetHelper)
|
|
|
|
IMPL_EVENT_HANDLER(message)
|
|
IMPL_EVENT_HANDLER(messageerror)
|
|
|
|
explicit Clipboard(nsPIDOMWindowInner* aWindow);
|
|
already_AddRefed<Promise> Read(nsIPrincipal& aSubjectPrincipal,
|
|
ErrorResult& aRv);
|
|
already_AddRefed<Promise> ReadText(nsIPrincipal& aSubjectPrincipal,
|
|
ErrorResult& aRv);
|
|
already_AddRefed<Promise> Write(
|
|
const Sequence<OwningNonNull<ClipboardItem>>& aData,
|
|
nsIPrincipal& aSubjectPrincipal, ErrorResult& aRv);
|
|
already_AddRefed<Promise> WriteText(const nsAString& aData,
|
|
nsIPrincipal& aSubjectPrincipal,
|
|
ErrorResult& aRv);
|
|
|
|
static LogModule* GetClipboardLog();
|
|
|
|
// Check if the Clipboard.readText API should be enabled for this context.
|
|
// This API is only enabled for Extension and System contexts, as there is no
|
|
// way to request the required permission for web content. If the clipboard
|
|
// API testing pref is enabled, ReadText is enabled for web content for
|
|
// testing purposes.
|
|
static bool ReadTextEnabled(JSContext* aCx, JSObject* aGlobal);
|
|
|
|
virtual JSObject* WrapObject(JSContext* aCx,
|
|
JS::Handle<JSObject*> aGivenProto) override;
|
|
|
|
private:
|
|
// Checks if dom.events.testing.asyncClipboard pref is enabled.
|
|
// The aforementioned pref allows automated tests to bypass the security
|
|
// checks when writing to
|
|
// or reading from the clipboard.
|
|
static bool IsTestingPrefEnabled();
|
|
|
|
already_AddRefed<Promise> ReadHelper(nsIPrincipal& aSubjectPrincipal,
|
|
ClipboardReadType aClipboardReadType,
|
|
ErrorResult& aRv);
|
|
|
|
~Clipboard();
|
|
};
|
|
|
|
} // namespace dom
|
|
} // namespace mozilla
|
|
#endif // mozilla_dom_Clipboard_h_
|