widget/nsIFormatConverter.idl@b8a032363ba2 (annotated)
widget/nsIFormatConverter.idl
Thu, 22 Jan 2015 13:21:57 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Thu, 22 Jan 2015 13:21:57 +0100
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
- permissions
- -rw-r--r--
Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6
| michael@0 | 1 | /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ |
| michael@0 | 2 | /* This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 3 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 4 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 5 | |
| michael@0 | 6 | #include "nsISupports.idl" |
| michael@0 | 7 | #include "nsISupportsArray.idl" |
| michael@0 | 8 | |
| michael@0 | 9 | |
| michael@0 | 10 | [scriptable, uuid(948A0023-E3A7-11d2-96CF-0060B0FB9956)] |
| michael@0 | 11 | interface nsIFormatConverter : nsISupports |
| michael@0 | 12 | { |
| michael@0 | 13 | /** |
| michael@0 | 14 | * Get the list of the "input" data flavors (mime types as nsISupportsCString), |
| michael@0 | 15 | * in otherwords, the flavors that this converter can convert "from" (the |
| michael@0 | 16 | * incoming data to the converter). |
| michael@0 | 17 | */ |
| michael@0 | 18 | nsISupportsArray getInputDataFlavors ( ) ; |
| michael@0 | 19 | |
| michael@0 | 20 | /** |
| michael@0 | 21 | * Get the list of the "output" data flavors (mime types as nsISupportsCString), |
| michael@0 | 22 | * in otherwords, the flavors that this converter can convert "to" (the |
| michael@0 | 23 | * outgoing data to the converter). |
| michael@0 | 24 | * |
| michael@0 | 25 | * @param aDataFlavorList fills list with supported flavors |
| michael@0 | 26 | */ |
| michael@0 | 27 | nsISupportsArray getOutputDataFlavors ( ) ; |
| michael@0 | 28 | |
| michael@0 | 29 | /** |
| michael@0 | 30 | * Determines whether a conversion from one flavor to another is supported |
| michael@0 | 31 | * |
| michael@0 | 32 | * @param aFromFormatConverter flavor to convert from |
| michael@0 | 33 | * @param aFromFormatConverter flavor to convert to |
| michael@0 | 34 | */ |
| michael@0 | 35 | boolean canConvert ( in string aFromDataFlavor, in string aToDataFlavor ) ; |
| michael@0 | 36 | |
| michael@0 | 37 | /** |
| michael@0 | 38 | * Converts from one flavor to another. |
| michael@0 | 39 | * |
| michael@0 | 40 | * @param aFromFormatConverter flavor to convert from |
| michael@0 | 41 | * @param aFromFormatConverter flavor to convert to (destination own the memory) |
| michael@0 | 42 | * @returns returns NS_OK if it was converted |
| michael@0 | 43 | */ |
| michael@0 | 44 | void convert ( in string aFromDataFlavor, in nsISupports aFromData, in unsigned long aDataLen, |
| michael@0 | 45 | in string aToDataFlavor, out nsISupports aToData, out unsigned long aDataToLen ) ; |
| michael@0 | 46 | |
| michael@0 | 47 | }; |
| michael@0 | 48 | |
| michael@0 | 49 | |
| michael@0 | 50 | %{ C++ |
| michael@0 | 51 | |
| michael@0 | 52 | %} |
