mirror of
https://github.com/classilla/tenfourfox.git
synced 2024-06-03 01:29:38 +00:00
47 lines
1.5 KiB
Plaintext
47 lines
1.5 KiB
Plaintext
/* -*- 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 "nsIProtocolHandler.idl"
|
|
|
|
/**
|
|
* Protocol handler superinterface for a protocol which performs substitutions
|
|
* from URIs of its scheme to URIs of another scheme.
|
|
*/
|
|
[scriptable, uuid(154c64fd-a69e-4105-89f8-bd7dfe621372)]
|
|
interface nsISubstitutingProtocolHandler : nsIProtocolHandler
|
|
{
|
|
/**
|
|
* Sets the substitution for the root key:
|
|
* resource://root/path ==> baseURI.resolve(path)
|
|
*
|
|
* A null baseURI removes the specified substitution.
|
|
*
|
|
* A root key should always be lowercase; however, this may not be
|
|
* enforced.
|
|
*/
|
|
void setSubstitution(in ACString root, in nsIURI baseURI);
|
|
|
|
/**
|
|
* Gets the substitution for the root key.
|
|
*
|
|
* @throws NS_ERROR_NOT_AVAILABLE if none exists.
|
|
*/
|
|
nsIURI getSubstitution(in ACString root);
|
|
|
|
/**
|
|
* Returns TRUE if the substitution exists and FALSE otherwise.
|
|
*/
|
|
boolean hasSubstitution(in ACString root);
|
|
|
|
/**
|
|
* Utility function to resolve a substituted URI. A resolved URI is not
|
|
* guaranteed to reference a resource that exists (ie. opening a channel to
|
|
* the resolved URI may fail).
|
|
*
|
|
* @throws NS_ERROR_NOT_AVAILABLE if resURI.host() is an unknown root key.
|
|
*/
|
|
AUTF8String resolveURI(in nsIURI resURI);
|
|
};
|