widget/nsIClipboardHelper.idl

Thu, 22 Jan 2015 13:21:57 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 22 Jan 2015 13:21:57 +0100
branch
TOR_BUG_9701
changeset 15
b8a032363ba2
permissions
-rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

michael@0 1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
michael@0 2 *
michael@0 3 * This Source Code Form is subject to the terms of the Mozilla Public
michael@0 4 * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0 5 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0 6
michael@0 7 #include "nsISupports.idl"
michael@0 8 #include "nsIClipboard.idl"
michael@0 9
michael@0 10 %{ C++
michael@0 11 #include "nsString.h" // needed for AString -> nsAString, unfortunately
michael@0 12 %}
michael@0 13
michael@0 14 interface nsIDOMDocument;
michael@0 15
michael@0 16 /**
michael@0 17 * helper service for common uses of nsIClipboard.
michael@0 18 */
michael@0 19
michael@0 20 [scriptable, uuid(c9d5a750-c3a8-11e1-9b21-0800200c9a66)]
michael@0 21 interface nsIClipboardHelper : nsISupports
michael@0 22 {
michael@0 23
michael@0 24 /**
michael@0 25 * copy string to given clipboard
michael@0 26 *
michael@0 27 * @param aString, the string to copy to the clipboard
michael@0 28 * @param aDoc, the source document for the string, if available
michael@0 29 * @param aClipboardID, the ID of the clipboard to copy to
michael@0 30 * (eg. kSelectionClipboard -- see nsIClipboard.idl)
michael@0 31 */
michael@0 32 void copyStringToClipboard(in AString aString, in long aClipboardID, [optional] in nsIDOMDocument aDoc);
michael@0 33
michael@0 34 /**
michael@0 35 * copy string to (default) clipboard
michael@0 36 *
michael@0 37 * @param aString, the string to copy to the clipboard
michael@0 38 * @param aDoc, the source document for the string, if available
michael@0 39 */
michael@0 40 void copyString(in AString aString, [optional] in nsIDOMDocument aDoc);
michael@0 41
michael@0 42 };

mercurial