nsClipboard.h - mozsearch

Enable keyboard shortcuts

/* -*- Mode: C++; 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/. */

#ifndef nsClipboard_h_

#define nsClipboard_h_

#include "nsBaseClipboard.h"

#include "nsCOMPtr.h"

#include "nsIClipboard.h"

#include "nsString.h"

#include "mozilla/Maybe.h"

#include "mozilla/StaticPtr.h"

#import <Cocoa/Cocoa.h>

class nsITransferable;

class nsClipboard : public nsBaseClipboard {

 public:

  nsClipboard();

  NS_DECL_ISUPPORTS_INHERITED

  // On macOS, cache the transferable of the current selection (chrome/content)

  // in the parent process. This is needed for the services menu which

  // requires synchronous access to the current selection.

  static mozilla::StaticRefPtr<nsITransferable> sSelectionCache;

  static int32_t sSelectionCacheChangeCount;

  // Helper methods, used also by nsDragService

  static NSDictionary* PasteboardDictFromTransferable(

      nsITransferable* aTransferable);

  // aPasteboardType is being retained and needs to be released by the caller.

  static bool IsStringType(const nsCString& aMIMEType,

                           NSString** aPasteboardType);

  static bool IsImageType(const nsACString& aMIMEType);

  static NSString* WrapHtmlForSystemPasteboard(NSString* aString);

  static nsresult TransferableFromPasteboard(nsITransferable* aTransferable,

                                             NSPasteboard* pboard);

 protected:

  // Implement the native clipboard behavior.

  NS_IMETHOD SetNativeClipboardData(nsITransferable* aTransferable,

                                    int32_t aWhichClipboard) override;

  NS_IMETHOD GetNativeClipboardData(nsITransferable* aTransferable,

                                    int32_t aWhichClipboard) override;

  nsresult EmptyNativeClipboardData(int32_t aWhichClipboard) override;

  mozilla::Result<int32_t, nsresult> GetNativeClipboardSequenceNumber(

      int32_t aWhichClipboard) override;

  mozilla::Result<bool, nsresult> HasNativeClipboardDataMatchingFlavors(

      const nsTArray<nsCString>& aFlavorList, int32_t aWhichClipboard) override;

  void ClearSelectionCache();

  void SetSelectionCache(nsITransferable* aTransferable);

 private:

  virtual ~nsClipboard();

  static mozilla::Maybe<uint32_t> FindIndexOfImageFlavor(

      const nsTArray<nsCString>& aMIMETypes);

};

#endif  // nsClipboard_h_