Back to index

lightning-sunbird  0.9+nobinonly
nsIClipboard.idl
Go to the documentation of this file.
00001 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
00002  *
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is Mozilla Communicator.
00017  *
00018  * The Initial Developer of the Original Code is
00019  * Netscape Communications Corp.
00020  * Portions created by the Initial Developer are Copyright (C) 1999
00021  * the Initial Developer. All Rights Reserved.
00022  *
00023  * Contributor(s):
00024  *   Mike Pinkerton
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either the GNU General Public License Version 2 or later (the "GPL"), or
00028  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 
00041 #include "nsISupports.idl"
00042 #include "nsISupportsArray.idl"
00043 #include "nsITransferable.idl"
00044 #include "nsIClipboardOwner.idl"
00045 
00046 
00047 [scriptable, uuid(8B5314BA-DB01-11d2-96CE-0060B0FB9956)]
00048 interface nsIClipboard : nsISupports
00049 {
00050     const long kSelectionClipboard = 0;
00051     const long kGlobalClipboard = 1;
00052     
00062     void setData ( in nsITransferable aTransferable, in nsIClipboardOwner anOwner, 
00063                     in long aWhichClipboard ) ;
00064 
00073     void getData ( in nsITransferable aTransferable, in long aWhichClipboard ) ;
00074 
00083     void emptyClipboard ( in long aWhichClipboard ) ;
00084 
00096     boolean hasDataMatchingFlavors ( in nsISupportsArray aFlavorList, in long aWhichClipboard )  ;
00097 
00105     boolean supportsSelectionClipboard ( ) ;
00106 };
00107 
00108 // Interface to a native image format such as the format stored on the clipboard
00109 [scriptable, uuid(DB21EB6C-AEBB-4d16-94EC-BCD8BBF513AE)]
00110 interface nsIClipboardImage : nsISupports
00111 {
00112   // the idl compiler complains if these two methods are scriptable. need to figure out why
00113   [noscript] void setNativeImage(in voidPtr aNativeImageData);
00114 
00115   // caller must later call releaseNativeImage to release their reference to the image. nsIClipboardImage
00116   // will keep its own reference until it is destroyed.
00117   [noscript] void getNativeImage(in voidPtr aNativeImageData); 
00118 
00119   // releaseNativeImage should only be called if you used getNativeImageData. You should pass in the same
00120   // object to both methods. (this routine exists so callers do not have to link in urlmon.lib just to release
00121   // the stgmedium object on windows).
00122   [noscript] void releaseNativeImage(in voidPtr aNativeImageData);
00123 };
00124 
00125 %{ C++
00126 
00127 %}