The Tor Browser / file comparison
comparison: toolkit/components/urlformatter/nsIURLFormatter.idl
toolkit/components/urlformatter/nsIURLFormatter.idl
- branch
- TOR_BUG_9701
- changeset 15
- b8a032363ba2
equal
deleted
inserted
replaced
| -1:000000000000 | 0:660428ae9a85 |
|---|---|
| 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/. */ | |
| 4 | |
| 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 */ | |
| 16 | |
| 17 #include "nsISupports.idl" | |
| 18 | |
| 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); | |
| 33 | |
| 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 }; |
