widget/xpwidgets/nsClipboardPrivacyHandler.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef nsClipboardPrivacyHandler_h__
   7 #define nsClipboardPrivacyHandler_h__
   8
   9 #include "nsIObserver.h"
  10 #include "nsWeakReference.h"
  11 #include "nsCOMPtr.h"
  12 #include "mozilla/Attributes.h"
  13
  14 class nsITransferable;
  15
  16 // nsClipboardPrivacyHandler makes sure that clipboard data copied during
  17 // the private browsing mode does not leak after exiting this mode.
  18 // In order to ensure this, callers should store an object of this class
  19 // for their lifetime, and call PrepareDataForClipboard in their
  20 // nsIClipboard::SetData implementation before starting to use the
  21 // nsITransferable object in any way.
  22
  23 class nsClipboardPrivacyHandler MOZ_FINAL : public nsIObserver,
  24                                             public nsSupportsWeakReference
  25 {
  26
  27 public:
  28
  29   // nsISupports
  30   NS_DECL_ISUPPORTS
  31
  32   // nsIObserver
  33   NS_DECL_NSIOBSERVER
  34
  35   nsresult Init();
  36   nsresult PrepareDataForClipboard(nsITransferable * aTransferable);
  37 };
  38
  39 nsresult NS_NewClipboardPrivacyHandler(nsClipboardPrivacyHandler ** aHandler);
  40
  41 #endif // nsClipboardPrivacyHandler_h__