dom/events/ClipboardItem.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_dom_ClipboardItem_h_
   8 #define mozilla_dom_ClipboardItem_h_
   9
  10 #include "mozilla/dom/Blob.h"
  11 #include "mozilla/dom/ClipboardBinding.h"
  12
  13 #include "nsWrapperCache.h"
  14
  15 namespace mozilla::dom {
  16
  17 struct ClipboardItemOptions;
  18 template <typename KeyType, typename ValueType>
  19 class Record;
  20 class Promise;
  21
  22 class ClipboardItem final : public nsWrapperCache {
  23  public:
  24   struct ItemEntry {
  25     nsString mType;
  26     OwningStringOrBlob mData;
  27   };
  28
  29   NS_INLINE_DECL_CYCLE_COLLECTING_NATIVE_REFCOUNTING(ClipboardItem)
  30   NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_NATIVE_CLASS(ClipboardItem)
  31
  32   ClipboardItem(nsISupports* aOwner, dom::PresentationStyle aPresentationStyle,
  33                 nsTArray<ItemEntry>&& aItems);
  34
  35   static already_AddRefed<ClipboardItem> Constructor(
  36       const GlobalObject& aGlobal,
  37       const Record<nsString, OwningStringOrBlob>& aItems,
  38       const ClipboardItemOptions& aOptions, ErrorResult& aRv);
  39
  40   dom::PresentationStyle PresentationStyle() const {
  41     return mPresentationStyle;
  42   };
  43   void GetTypes(nsTArray<nsString>& aTypes) const;
  44
  45   already_AddRefed<Promise> GetType(const nsAString& aType, ErrorResult& aRv);
  46
  47   nsISupports* GetParentObject() const { return mOwner; }
  48
  49   JSObject* WrapObject(JSContext* aCx,
  50                        JS::Handle<JSObject*> aGivenProto) override;
  51
  52   const nsTArray<ItemEntry>& Entries() const { return mItems; }
  53
  54  private:
  55   ~ClipboardItem() = default;
  56
  57   nsCOMPtr<nsISupports> mOwner;
  58   dom::PresentationStyle mPresentationStyle;
  59   nsTArray<ItemEntry> mItems;
  60 };
  61
  62 }  // namespace mozilla::dom
  63
  64 #endif  // mozilla_dom_ClipboardItem_h_