widget/public/nsIFormatConverter.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39 #include "nsISupportsArray.idl"
  40
  41
  42 [scriptable, uuid(948A0023-E3A7-11d2-96CF-0060B0FB9956)]
  43 interface nsIFormatConverter : nsISupports
  44 {
  45   /**
  46     * Get the list of the "input" data flavors (mime types as nsISupportsCString),
  47     * in otherwords, the flavors that this converter can convert "from" (the
  48     * incoming data to the converter).
  49     */
  50   nsISupportsArray getInputDataFlavors ( ) ;
  51
  52   /**
  53     * Get the list of the "output" data flavors (mime types as nsISupportsCString),
  54     * in otherwords, the flavors that this converter can convert "to" (the
  55     * outgoing data to the converter).
  56     *
  57     * @param  aDataFlavorList fills list with supported flavors
  58     */
  59   nsISupportsArray getOutputDataFlavors ( ) ;
  60
  61   /**
  62     * Determines whether a converion from one flavor to another is supported
  63     *
  64     * @param  aFromFormatConverter flavor to convert from
  65     * @param  aFromFormatConverter flavor to convert to
  66     */
  67   boolean canConvert ( in string aFromDataFlavor, in string aToDataFlavor ) ;
  68
  69   /**
  70     * Converts from one flavor to another.
  71     *
  72     * @param  aFromFormatConverter flavor to convert from
  73     * @param  aFromFormatConverter flavor to convert to (destination own the memory)
  74     * @returns returns NS_OK if it was converted
  75     */
  76   void convert ( in string aFromDataFlavor, in nsISupports aFromData, in unsigned long aDataLen,
  77                    in string aToDataFlavor, out nsISupports aToData, out unsigned long aDataToLen ) ;
  78
  79 };
  80
  81
  82 %{ C++
  83
  84 %}