1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
2 *
3 * ***** BEGIN LICENSE BLOCK *****
4 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
5 *
6 * The contents of this file are subject to the Mozilla Public License Version
7 * 1.1 (the "License"); you may not use this file except in compliance with
8 * the License. You may obtain a copy of the License at
9 * http://www.mozilla.org/MPL/
10 *
11 * Software distributed under the License is distributed on an "AS IS" basis,
12 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
13 * for the specific language governing rights and limitations under the
14 * License.
15 *
16 * The Original Code is the Mozilla browser.
17 *
18 * The Initial Developer of the Original Code is
19 * Netscape Communications Corp.
20 * Portions created by the Initial Developer are Copyright (C) 2001
21 * the Initial Developer. All Rights Reserved.
22 *
23 * Contributor(s):
24 *
25 * Alternatively, the contents of this file may be used under the terms of
26 * either the GNU General Public License Version 2 or later (the "GPL"), or
27 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
28 * in which case the provisions of the GPL or the LGPL are applicable instead
29 * of those above. If you wish to allow use of your version of this file only
30 * under the terms of either the GPL or the LGPL, and not to allow others to
31 * use your version of this file under the terms of the MPL, indicate your
32 * decision by deleting the provisions above and replace them with the notice
33 * and other provisions required by the GPL or the LGPL. If you do not delete
34 * the provisions above, a recipient may use your version of this file under
35 * the terms of any one of the MPL, the GPL or the LGPL.
36 *
37 * ***** END LICENSE BLOCK ***** */
38
39 #include "nsISupports.idl"
40 #include "nsIClipboard.idl"
41
42 %{ C++
43 #include "nsString.h" // needed for AString -> nsAString, unfortunately
44 %}
45
46 /**
47 * helper service for common uses of nsIClipboard.
48 */
49
50 [scriptable, uuid(44073a98-1dd2-11b2-8600-d0ae854dbe93)]
51 interface nsIClipboardHelper : nsISupports
52 {
53
54 /**
55 * copy string to given clipboard
56 *
57 * @param aString, the string to copy to the clipboard
58 * @param aClipboardID, the ID of the clipboard to copy to
59 * (eg. kSelectionClipboard -- see nsIClipboard.idl)
60 */
61 void copyStringToClipboard(in AString aString, in long aClipboardID);
62
63 /**
64 * copy string to (default) clipboard
65 *
66 * @param aString, the string to copy to the clipboard
67 */
68 void copyString(in AString aString);
69
70 };