mirror of
https://github.com/classilla/tenfourfox.git
synced 2024-06-08 20:29:36 +00:00
118 lines
4.1 KiB
Plaintext
118 lines
4.1 KiB
Plaintext
/* -*- Mode: C++; tab-width: 8; 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 "nsIMIMEInfo.idl"
|
|
#include "nsIWebContentHandlerRegistrar.idl"
|
|
|
|
interface nsIRequest;
|
|
|
|
[scriptable, uuid(eb361098-5158-4b21-8f98-50b445f1f0b2)]
|
|
interface nsIWebContentHandlerInfo : nsIHandlerApp
|
|
{
|
|
/**
|
|
* The content type handled by the handler
|
|
*/
|
|
readonly attribute AString contentType;
|
|
|
|
/**
|
|
* The uri of the handler, with an embedded %s where the URI of the loaded
|
|
* document will be encoded.
|
|
*/
|
|
readonly attribute AString uri;
|
|
|
|
/**
|
|
* Gets the service URL Spec, with the loading document URI encoded in it.
|
|
* @param uri
|
|
* The URI of the document being loaded
|
|
* @returns The URI of the service with the loading document URI encoded in
|
|
* it.
|
|
*/
|
|
AString getHandlerURI(in AString uri);
|
|
};
|
|
|
|
[scriptable, uuid(de7cc06e-e778-45cb-b7db-7a114e1e75b1)]
|
|
interface nsIWebContentConverterService : nsIWebContentHandlerRegistrar
|
|
{
|
|
/**
|
|
* Specifies the handler to be used to automatically handle all links of a
|
|
* certain content type from now on.
|
|
* @param contentType
|
|
* The content type to automatically load with the specified handler
|
|
* @param handler
|
|
* A web service handler. If this is null, no automatic action is
|
|
* performed and the user must choose.
|
|
* @throws NS_ERROR_NOT_AVAILABLE if the service refered to by |handler| is
|
|
* not already registered.
|
|
*/
|
|
void setAutoHandler(in AString contentType, in nsIWebContentHandlerInfo handler);
|
|
|
|
/**
|
|
* Gets the auto handler specified for a particular content type
|
|
* @param contentType
|
|
* The 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").
|
|
*/
|
|
nsIWebContentHandlerInfo getAutoHandler(in AString contentType);
|
|
|
|
/**
|
|
* Gets a web handler for the specified service URI
|
|
* @param contentType
|
|
* The content type of the service being located
|
|
* @param uri
|
|
* The service URI of the handler to locate.
|
|
* @returns A web service handler that uses the specified uri.
|
|
*/
|
|
nsIWebContentHandlerInfo getWebContentHandlerByURI(in AString contentType,
|
|
in AString uri);
|
|
|
|
/**
|
|
* Loads the preferred handler when content of a registered type is about
|
|
* to be loaded.
|
|
* @param request
|
|
* The nsIRequest for the load of the content
|
|
*/
|
|
void loadPreferredHandler(in nsIRequest request);
|
|
|
|
/**
|
|
* Removes a registered protocol handler
|
|
* @param protocol
|
|
* The protocol scheme to remove a service handler for
|
|
* @param uri
|
|
* The uri of the service handler to remove
|
|
*/
|
|
void removeProtocolHandler(in AString protocol, in AString uri);
|
|
|
|
/**
|
|
* Removes a registered content handler
|
|
* @param contentType
|
|
* The content type to remove a service handler for
|
|
* @param uri
|
|
* The uri of the service handler to remove
|
|
*/
|
|
void removeContentHandler(in AString contentType, in AString uri);
|
|
|
|
/**
|
|
* Gets the list of content handlers for a particular type.
|
|
* @param contentType
|
|
* The content type to get handlers for
|
|
* @returns An array of nsIWebContentHandlerInfo objects
|
|
*/
|
|
void getContentHandlers(in AString contentType,
|
|
[optional] out unsigned long count,
|
|
[retval,array,size_is(count)] out nsIWebContentHandlerInfo handlers);
|
|
|
|
/**
|
|
* Resets the list of available content handlers to the default set from
|
|
* the distribution.
|
|
* @param contentType
|
|
* The content type to reset handlers for
|
|
*/
|
|
void resetHandlersForType(in AString contentType);
|
|
};
|
|
|