widget/nsIFormatConverter.idl
author L10n Bumper Bot <release+l10nbumper@mozilla.com>
Tue, 19 Nov 2019 20:00:34 +0000
changeset 560108 674d9e106294d963caf9366d42138499d0f5b928
parent 534859 020c8c871c0d3b3920fe95935cfef06501976c0f
permissions -rw-r--r--
no bug - Bumping Firefox l10n changesets r=release a=l10n-bump DONTBUILD eo -> 908eda66ffda

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsISupports.idl"

[scriptable, uuid(948A0023-E3A7-11d2-96CF-0060B0FB9956)]
interface nsIFormatConverter : nsISupports
{
  /**
    * Get the list of the "input" data flavors (mime types as nsISupportsCString),
    * in otherwords, the flavors that this converter can convert "from" (the
    * incoming data to the converter).
    */
  Array<ACString> getInputDataFlavors ( ) ;

  /**
    * Get the list of the "output" data flavors (mime types as nsISupportsCString),
    * in otherwords, the flavors that this converter can convert "to" (the
    * outgoing data to the converter).
    *
    * @param  aDataFlavorList fills list with supported flavors
    */
  Array<ACString> getOutputDataFlavors ( ) ;

  /**
    * Determines whether a conversion from one flavor to another is supported
    *
    * @param  aFromFormatConverter flavor to convert from
    * @param  aFromFormatConverter flavor to convert to
    */
  boolean canConvert ( in string aFromDataFlavor, in string aToDataFlavor ) ;

  /**
    * Converts from one flavor to another.
    *
    * @param  aFromFormatConverter flavor to convert from
    * @param  aFromFormatConverter flavor to convert to (destination own the memory)
    * @returns returns NS_OK if it was converted
    */
  void convert ( in string aFromDataFlavor, in nsISupports aFromData,
                   in string aToDataFlavor, out nsISupports aToData ) ;

};


%{ C++

%}