The Tor Browser: toolkit/components/urlformatter/nsIURLFormatter.idl@6474c204b198

Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.

     1 /* This Source Code Form is subject to the terms of the Mozilla Public

     2  * License, v. 2.0. If a copy of the MPL was not distributed with this

     3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

     5 /**

     6  * nsIURLFormatter

     7  *

     8  * nsIURLFormatter exposes methods to substitute variables in URL formats.

     9  * Variable names can contain 'A-Z' letters and '_' characters.

    10  *

    11  * Mozilla Applications linking to Mozilla websites are strongly encouraged to use

    12  * URLs of the following format:

    13  *

    14  *   http[s]://%SERVICE%.mozilla.[com|org]/%LOCALE%/

    15  */

    17 #include "nsISupports.idl"

    19 [scriptable, uuid(4ab31d30-372d-11db-a98b-0800200c9a66)]

    20 interface nsIURLFormatter: nsISupports

    21 {

    22   /**

    23    * formatURL - Formats a string URL

    24    *

    25    * The set of known variables is predefined.

    26    * If a variable is unknown, it is left unchanged and a non-fatal error is reported.

    27    *

    28    * @param aFormat string Unformatted URL.

    29    *

    30    * @return The formatted URL.

    31    */

    32   AString formatURL(in AString aFormat);

    34   /**

    35    * formatURLPref - Formats a string URL stored in a preference

    36    *

    37    * If the preference value cannot be retrieved, a fatal error is reported

    38    * and the "about:blank" URL is returned.

    39    *

    40    * @param aPref string Preference name.

    41    *

    42    * @return The formatted URL returned by formatURL(), or "about:blank".

    43    */

    44   AString formatURLPref(in AString aPref);

    45 };

The Tor Browser / file revision