nsIWebContentConverterService Interface Reference

import"nsIWebContentConverterRegistrar.idl";

Inheritance diagram for nsIWebContentConverterService:
[legend]
Collaboration diagram for nsIWebContentConverterService:
[legend]

Public Member Functions

void setAutoHandler (in AString contentType, in nsIWebContentHandlerInfo handler)
 
nsIWebContentHandlerInfo getAutoHandler (in AString contentType)
 
nsIWebContentHandlerInfo getWebContentHandlerByURI (in AString contentType, in AString uri)
 
void loadPreferredHandler (in nsIRequest request)
 
void removeProtocolHandler (in AString protocol, in AString uri)
 
void removeContentHandler (in AString contentType, in AString uri)
 
void getContentHandlers (in AString contentType, out unsigned long count, [retval, array, size_is(count)] out nsIWebContentHandlerInfo handlers)
 
void resetHandlersForType (in AString contentType)
 

Detailed Description

Definition at line 68 of file nsIWebContentConverterRegistrar.idl.

Member Function Documentation

nsIWebContentHandlerInfo nsIWebContentConverterService::getAutoHandler ( in AString  contentType)

Gets the auto handler specified for a particular content type

Parameters
contentTypeThe content type to look up an auto handler for.
Returns
The web service handler that will automatically handle all documents of the specified type. null if there is no automatic handler. (Handlers may be registered, just none of them specified as "automatic").
void nsIWebContentConverterService::getContentHandlers ( in AString  contentType,
out unsigned long  count,
[retval, array, size_is(count)] out nsIWebContentHandlerInfo  handlers 
)

Gets the list of content handlers for a particular type.

Parameters
contentTypeThe content type to get handlers for
Returns
An array of nsIWebContentHandlerInfo objects
nsIWebContentHandlerInfo nsIWebContentConverterService::getWebContentHandlerByURI ( in AString  contentType,
in AString  uri 
)

Gets a web handler for the specified service URI

Parameters
contentTypeThe content type of the service being located
uriThe service URI of the handler to locate.
Returns
A web service handler that uses the specified uri.
void nsIWebContentConverterService::loadPreferredHandler ( in nsIRequest  request)

Loads the preferred handler when content of a registered type is about to be loaded.

Parameters
requestThe nsIRequest for the load of the content
void nsIWebContentConverterService::removeContentHandler ( in AString  contentType,
in AString  uri 
)

Removes a registered content handler

Parameters
contentTypeThe content type to remove a service handler for
uriThe uri of the service handler to remove
void nsIWebContentConverterService::removeProtocolHandler ( in AString  protocol,
in AString  uri 
)

Removes a registered protocol handler

Parameters
protocolThe protocol scheme to remove a service handler for
uriThe uri of the service handler to remove
void nsIWebContentConverterService::resetHandlersForType ( in AString  contentType)

Resets the list of available content handlers to the default set from the distribution.

Parameters
contentTypeThe content type to reset handlers for
void nsIWebContentConverterService::setAutoHandler ( in AString  contentType,
in nsIWebContentHandlerInfo  handler 
)

Specifies the handler to be used to automatically handle all links of a certain content type from now on.

Parameters
contentTypeThe content type to automatically load with the specified handler
handlerA web service handler. If this is null, no automatic action is performed and the user must choose.
Exceptions
NS_ERROR_NOT_AVAILABLEif the service refered to by |handler| is not already registered.

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