зеркало из https://github.com/mozilla/gecko-dev.git
189 строки
7.3 KiB
Plaintext
189 строки
7.3 KiB
Plaintext
/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
*
|
|
* ***** BEGIN LICENSE BLOCK *****
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
*
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
* the License. You may obtain a copy of the License at
|
|
* http://www.mozilla.org/MPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
* for the specific language governing rights and limitations under the
|
|
* License.
|
|
*
|
|
* The Original Code is Mozilla Communicator.
|
|
*
|
|
* The Initial Developer of the Original Code is
|
|
* Netscape Communications Corp.
|
|
* Portions created by the Initial Developer are Copyright (C) 1999
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
* Mike Pinkerton
|
|
*
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
* the provisions above, a recipient may use your version of this file under
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
*
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
#include "nsISupports.idl"
|
|
#include "nsISupportsArray.idl"
|
|
#include "nsIFormatConverter.idl"
|
|
|
|
|
|
%{ C++
|
|
|
|
// these probably shouldn't live here, but in some central repository shared
|
|
// by the entire app.
|
|
#define kTextMime "text/plain"
|
|
#define kUnicodeMime "text/unicode"
|
|
#define kHTMLMime "text/html"
|
|
#define kAOLMailMime "AOLMAIL"
|
|
#define kPNGImageMime "image/png"
|
|
#define kJPEGImageMime "image/jpg"
|
|
#define kGIFImageMime "image/gif"
|
|
#define kFileMime "application/x-moz-file"
|
|
|
|
#define kURLMime "text/x-moz-url" // data contains url\ntitle
|
|
#define kURLDataMime "text/x-moz-url-data" // data contains url only
|
|
#define kURLDescriptionMime "text/x-moz-url-desc" // data contains description
|
|
#define kNativeImageMime "application/x-moz-nativeimage"
|
|
#define kNativeHTMLMime "application/x-moz-nativehtml"
|
|
|
|
// the source URL for a file promise
|
|
#define kFilePromiseURLMime "application/x-moz-file-promise-url"
|
|
// the destination filename for a file promise
|
|
#define kFilePromiseDestFilename "application/x-moz-file-promise-dest-filename"
|
|
// a dataless flavor used to interact with the OS during file drags
|
|
#define kFilePromiseMime "application/x-moz-file-promise"
|
|
// a synthetic flavor, put into the transferable once we know the destination directory of a file drag
|
|
#define kFilePromiseDirectoryMime "application/x-moz-file-promise-dir"
|
|
|
|
%}
|
|
|
|
|
|
/**
|
|
* nsIFlavorDataProvider allows a flavor to 'promise' data later,
|
|
* supplying the data lazily.
|
|
*
|
|
* To use it, call setTransferData, passing the flavor string,
|
|
* a nsIFlavorDataProvider QI'd to nsISupports, and a data size of 0.
|
|
*
|
|
* When someone calls getTransferData later, if the data size is
|
|
* stored as 0, the nsISupports will be QI'd to nsIFlavorDataProvider,
|
|
* and its getFlavorData called.
|
|
*
|
|
*/
|
|
interface nsITransferable;
|
|
|
|
[scriptable, uuid(7E225E5F-711C-11D7-9FAE-000393636592)]
|
|
interface nsIFlavorDataProvider : nsISupports
|
|
{
|
|
|
|
/**
|
|
* Retrieve the data from this data provider.
|
|
*
|
|
* @param aTransferable (in parameter) the transferable we're being called for.
|
|
* @param aFlavor (in parameter) the flavor of data to retrieve
|
|
* @param aData the data. Some variant of class in nsISupportsPrimitives.idl
|
|
* @param aDataLen the length of the data
|
|
*/
|
|
void getFlavorData(in nsITransferable aTransferable, in string aFlavor, out nsISupports aData, out unsigned long aDataLen);
|
|
};
|
|
|
|
|
|
[scriptable, uuid(8B5314BC-DB01-11d2-96CE-0060B0FB9956)]
|
|
interface nsITransferable : nsISupports
|
|
{
|
|
const long kFlavorHasDataProvider = 0;
|
|
|
|
/**
|
|
* Computes a list of flavors (mime types as nsISupportsCString) that the transferable
|
|
* can export, either through intrinsic knowledge or output data converters.
|
|
*
|
|
* @param aDataFlavorList fills list with supported flavors. This is a copy of
|
|
* the internal list, so it may be edited w/out affecting the transferable.
|
|
*/
|
|
nsISupportsArray flavorsTransferableCanExport ( ) ;
|
|
|
|
/**
|
|
* Given a flavor retrieve the data.
|
|
*
|
|
* @param aFlavor (in parameter) the flavor of data to retrieve
|
|
* @param aData the data. Some variant of class in nsISupportsPrimitives.idl
|
|
* @param aDataLen the length of the data
|
|
*/
|
|
void getTransferData ( in string aFlavor, out nsISupports aData, out unsigned long aDataLen ) ;
|
|
|
|
/**
|
|
* Returns the best flavor in the transferable, given those that have
|
|
* been added to it with |AddFlavor()|
|
|
*
|
|
* @param aFlavor (out parameter) the flavor of data that was retrieved
|
|
* @param aData the data. Some variant of class in nsISupportsPrimitives.idl
|
|
* @param aDataLen the length of the data
|
|
*/
|
|
void getAnyTransferData ( out string aFlavor, out nsISupports aData, out unsigned long aDataLen ) ;
|
|
|
|
/**
|
|
* Returns true if the data is large.
|
|
*/
|
|
boolean isLargeDataSet ( ) ;
|
|
|
|
|
|
///////////////////////////////
|
|
// Setter part of interface
|
|
///////////////////////////////
|
|
|
|
/**
|
|
* Computes a list of flavors (mime types as nsISupportsCString) that the transferable can
|
|
* accept into it, either through intrinsic knowledge or input data converters.
|
|
*
|
|
* @param outFlavorList fills list with supported flavors. This is a copy of
|
|
* the internal list, so it may be edited w/out affecting the transferable.
|
|
*/
|
|
nsISupportsArray flavorsTransferableCanImport ( ) ;
|
|
|
|
/**
|
|
* Sets the data in the transferable with the specified flavor. The transferable
|
|
* will maintain its own copy the data, so it is not necessary to do that beforehand.
|
|
*
|
|
* @param aFlavor the flavor of data that is being set
|
|
* @param aData the data, some variant of class in nsISupportsPrimitives.idl,
|
|
* or an nsIFlavorDataProvider (see above)
|
|
* @param aDataLen the length of the data, or 0 if passing a nsIFlavorDataProvider
|
|
*/
|
|
void setTransferData ( in string aFlavor, in nsISupports aData, in unsigned long aDataLen ) ;
|
|
|
|
/**
|
|
* Add the data flavor, indicating that this transferable
|
|
* can receive this type of flavor
|
|
*
|
|
* @param aDataFlavor a new data flavor to handle
|
|
*/
|
|
void addDataFlavor ( in string aDataFlavor ) ;
|
|
|
|
/**
|
|
* Removes the data flavor matching the given one (string compare) and the data
|
|
* that goes along with it.
|
|
*
|
|
* @param aDataFlavor a data flavor to remove
|
|
*/
|
|
void removeDataFlavor ( in string aDataFlavor ) ;
|
|
|
|
attribute nsIFormatConverter converter;
|
|
|
|
};
|
|
|