michael@0: /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
michael@0:  *
michael@0:  * This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #include "nsISupports.idl"
michael@0: #include "nsIClipboard.idl"
michael@0: 
michael@0: %{ C++
michael@0: #include "nsString.h" // needed for AString -> nsAString, unfortunately
michael@0: %}
michael@0: 
michael@0: interface nsIDOMDocument;
michael@0: 
michael@0: /**
michael@0:  * helper service for common uses of nsIClipboard.
michael@0:  */
michael@0: 
michael@0: [scriptable, uuid(c9d5a750-c3a8-11e1-9b21-0800200c9a66)]
michael@0: interface nsIClipboardHelper : nsISupports
michael@0: {
michael@0: 
michael@0:   /**
michael@0:    * copy string to given clipboard
michael@0:    *
michael@0:    * @param aString, the string to copy to the clipboard
michael@0:    * @param aDoc, the source document for the string, if available
michael@0:    * @param aClipboardID, the ID of the clipboard to copy to
michael@0:    *        (eg. kSelectionClipboard -- see nsIClipboard.idl)
michael@0:    */
michael@0:   void copyStringToClipboard(in AString aString, in long aClipboardID, [optional] in nsIDOMDocument aDoc);
michael@0: 
michael@0:   /**
michael@0:    * copy string to (default) clipboard
michael@0:    *
michael@0:    * @param aString, the string to copy to the clipboard
michael@0:    * @param aDoc, the source document for the string, if available
michael@0:    */
michael@0:   void copyString(in AString aString, [optional] in nsIDOMDocument aDoc);
michael@0: 
michael@0: };