mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-24 05:11:16 +00:00
69 lines
2.4 KiB
Plaintext
69 lines
2.4 KiB
Plaintext
/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* 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/.
|
|
*
|
|
* The origin of this IDL file is
|
|
* https://w3c.github.io/clipboard-apis/
|
|
*
|
|
* Copyright © 2018 W3C® (MIT, ERCIM, Keio), All Rights Reserved. W3C
|
|
* liability, trademark and document use rules apply.
|
|
*/
|
|
|
|
typedef sequence<ClipboardItem> ClipboardItems;
|
|
|
|
[SecureContext, Exposed=Window]
|
|
interface Clipboard : EventTarget {
|
|
[Pref="dom.events.asyncClipboard.clipboardItem", NewObject, NeedsSubjectPrincipal]
|
|
Promise<ClipboardItems> read();
|
|
[Func="Clipboard::ReadTextEnabled", NewObject, NeedsSubjectPrincipal]
|
|
Promise<DOMString> readText();
|
|
|
|
[Pref="dom.events.asyncClipboard.clipboardItem", NewObject, NeedsSubjectPrincipal]
|
|
Promise<undefined> write(ClipboardItems data);
|
|
|
|
[NewObject, NeedsSubjectPrincipal]
|
|
Promise<undefined> writeText(DOMString data);
|
|
};
|
|
|
|
partial interface Clipboard {
|
|
// @param allowed true, if the user allowed (e.g. clicked) the "Paste" menuitem.
|
|
// false, when the menupopup was dismissed.
|
|
[ChromeOnly]
|
|
undefined onUserReactedToPasteMenuPopup(boolean allowed);
|
|
};
|
|
|
|
typedef (DOMString or Blob) ClipboardItemDataType;
|
|
// typedef Promise<ClipboardItemDataType> ClipboardItemData;
|
|
// callback ClipboardItemDelayedCallback = ClipboardItemData ();
|
|
|
|
[SecureContext, Exposed=Window, Pref="dom.events.asyncClipboard.clipboardItem"]
|
|
interface ClipboardItem {
|
|
// Note: The spec uses Promise<ClipboardItemDataType>.
|
|
[Throws]
|
|
constructor(record<DOMString, ClipboardItemDataType> items,
|
|
optional ClipboardItemOptions options = {});
|
|
|
|
// static ClipboardItem createDelayed(
|
|
// record<DOMString, ClipboardItemDelayedCallback> items,
|
|
// optional ClipboardItemOptions options = {});
|
|
|
|
readonly attribute PresentationStyle presentationStyle;
|
|
// readonly attribute long long lastModified;
|
|
// readonly attribute boolean delayed;
|
|
|
|
// TODO: Use FrozenArray once available. (Bug 1236777)
|
|
// readonly attribute FrozenArray<DOMString> types;
|
|
[Frozen, Cached, Pure]
|
|
readonly attribute sequence<DOMString> types;
|
|
|
|
[NewObject]
|
|
Promise<Blob> getType(DOMString type);
|
|
};
|
|
|
|
enum PresentationStyle { "unspecified", "inline", "attachment" };
|
|
|
|
dictionary ClipboardItemOptions {
|
|
PresentationStyle presentationStyle = "unspecified";
|
|
};
|