diff options
Diffstat (limited to 'dom/webidl/Clipboard.webidl')
-rw-r--r-- | dom/webidl/Clipboard.webidl | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/dom/webidl/Clipboard.webidl b/dom/webidl/Clipboard.webidl new file mode 100644 index 0000000000..46ef9e91e0 --- /dev/null +++ b/dom/webidl/Clipboard.webidl @@ -0,0 +1,67 @@ +/* -*- 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 { + [Throws] + constructor(record<DOMString, ClipboardItemData> 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"; +}; |