widget/nsIClipboardHelper.idl
author Birunthan Mohanathas <birunthan@mohanathas.com>
Thu, 21 May 2015 21:50:09 +0100
changeset 277578 9e89159cbe385d31bd3876515ffdcfff5544571b
parent 103390 108984fa0a891e621ffee7055af96bd47b850c94
child 474900 72c6733416e041bf2109fe1d1ebd38521a99dac9
permissions -rw-r--r--
Bug 1166840 - Remove document argument from nsIClipboardHelper.copyString{,ToClipboard}. r=ehsan

/* -*- 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/. */

#include "nsISupports.idl"
#include "nsIClipboard.idl"

%{ C++
#include "nsString.h" // needed for AString -> nsAString, unfortunately
%}

interface nsIDOMDocument;

/**
 * helper service for common uses of nsIClipboard.
 */

[scriptable, uuid(438307fd-0c68-4d79-922a-f6cc9550cd02)]
interface nsIClipboardHelper : nsISupports
{
  /**
   * copy string to given clipboard
   *
   * @param aString, the string to copy to the clipboard
   * @param aClipboardID, the ID of the clipboard to copy to
   *        (eg. kSelectionClipboard -- see nsIClipboard.idl)
   */
  void copyStringToClipboard(in AString aString, in long aClipboardID);

  /**
   * copy string to (default) clipboard
   *
   * @param aString, the string to copy to the clipboard
   */
  void copyString(in AString aString);
};