Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsIFormatConverter Interface Reference

import "nsIFormatConverter.idl";

Inheritance diagram for nsIFormatConverter:
Inheritance graph
[legend]
Collaboration diagram for nsIFormatConverter:
Collaboration graph
[legend]

List of all members.

Public Member Functions

nsISupportsArray getInputDataFlavors ()
 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).
nsISupportsArray getOutputDataFlavors ()
 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).
boolean canConvert (in string aFromDataFlavor, in string aToDataFlavor)
 Determines whether a converion from one flavor to another is supported.
void convert (in string aFromDataFlavor, in nsISupports aFromData, in unsigned long aDataLen, in string aToDataFlavor, out nsISupports aToData, out unsigned long aDataToLen)
 Converts from one flavor to another.

Detailed Description

Definition at line 43 of file nsIFormatConverter.idl.


Member Function Documentation

boolean nsIFormatConverter::canConvert ( in string  aFromDataFlavor,
in string  aToDataFlavor 
)

Determines whether a converion from one flavor to another is supported.

Parameters:
aFromFormatConverterflavor to convert from
aFromFormatConverterflavor to convert to
void nsIFormatConverter::convert ( in string  aFromDataFlavor,
in nsISupports  aFromData,
in unsigned long  aDataLen,
in string  aToDataFlavor,
out nsISupports  aToData,
out unsigned long  aDataToLen 
)

Converts from one flavor to another.

Parameters:
aFromFormatConverterflavor to convert from
aFromFormatConverterflavor to convert to (destination own the memory)
Returns:
returns NS_OK if it was converted

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).

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).

Parameters:
aDataFlavorListfills list with supported flavors

The documentation for this interface was generated from the following file: