widget/nsIClipboardHelper.idl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   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 #include "nsISupports.idl"
   8 #include "nsIClipboard.idl"
   9
  10 %{ C++
  11 #include "nsString.h" // needed for AString -> nsAString, unfortunately
  12 %}
  13
  14 /**
  15  * helper service for common uses of nsIClipboard.
  16  */
  17
  18 [scriptable, uuid(438307fd-0c68-4d79-922a-f6cc9550cd02)]
  19 interface nsIClipboardHelper : nsISupports
  20 {
  21   /**
  22    * copy string to given clipboard
  23    *
  24    * @param aString, the string to copy to the clipboard
  25    * @param aClipboardID, the ID of the clipboard to copy to
  26    *        (eg. kSelectionClipboard -- see nsIClipboard.idl)
  27    */
  28   void copyStringToClipboard(in AString aString, in long aClipboardID);
  29
  30   /**
  31    * copy string to (default) clipboard
  32    *
  33    * @param aString, the string to copy to the clipboard
  34    */
  35   void copyString(in AString aString);
  36 };