toolkit/components/urlformatter/nsIURLFormatter.idl@129ffea94266 (annotated)
toolkit/components/urlformatter/nsIURLFormatter.idl
Sat, 03 Jan 2015 20:18:00 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Sat, 03 Jan 2015 20:18:00 +0100
- branch
- TOR_BUG_3246
- changeset 7
- 129ffea94266
- permissions
- -rw-r--r--
Conditionally enable double key logic according to:
private browsing mode or privacy.thirdparty.isolate preference and
implement in GetCookieStringCommon and FindCookie where it counts...
With some reservations of how to convince FindCookie users to test
condition and pass a nullptr when disabling double key logic.
| michael@0 | 1 | /* This Source Code Form is subject to the terms of the Mozilla Public |
| michael@0 | 2 | * License, v. 2.0. If a copy of the MPL was not distributed with this |
| michael@0 | 3 | * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ |
| michael@0 | 4 | |
| michael@0 | 5 | /** |
| michael@0 | 6 | * nsIURLFormatter |
| michael@0 | 7 | * |
| michael@0 | 8 | * nsIURLFormatter exposes methods to substitute variables in URL formats. |
| michael@0 | 9 | * Variable names can contain 'A-Z' letters and '_' characters. |
| michael@0 | 10 | * |
| michael@0 | 11 | * Mozilla Applications linking to Mozilla websites are strongly encouraged to use |
| michael@0 | 12 | * URLs of the following format: |
| michael@0 | 13 | * |
| michael@0 | 14 | * http[s]://%SERVICE%.mozilla.[com|org]/%LOCALE%/ |
| michael@0 | 15 | */ |
| michael@0 | 16 | |
| michael@0 | 17 | #include "nsISupports.idl" |
| michael@0 | 18 | |
| michael@0 | 19 | [scriptable, uuid(4ab31d30-372d-11db-a98b-0800200c9a66)] |
| michael@0 | 20 | interface nsIURLFormatter: nsISupports |
| michael@0 | 21 | { |
| michael@0 | 22 | /** |
| michael@0 | 23 | * formatURL - Formats a string URL |
| michael@0 | 24 | * |
| michael@0 | 25 | * The set of known variables is predefined. |
| michael@0 | 26 | * If a variable is unknown, it is left unchanged and a non-fatal error is reported. |
| michael@0 | 27 | * |
| michael@0 | 28 | * @param aFormat string Unformatted URL. |
| michael@0 | 29 | * |
| michael@0 | 30 | * @return The formatted URL. |
| michael@0 | 31 | */ |
| michael@0 | 32 | AString formatURL(in AString aFormat); |
| michael@0 | 33 | |
| michael@0 | 34 | /** |
| michael@0 | 35 | * formatURLPref - Formats a string URL stored in a preference |
| michael@0 | 36 | * |
| michael@0 | 37 | * If the preference value cannot be retrieved, a fatal error is reported |
| michael@0 | 38 | * and the "about:blank" URL is returned. |
| michael@0 | 39 | * |
| michael@0 | 40 | * @param aPref string Preference name. |
| michael@0 | 41 | * |
| michael@0 | 42 | * @return The formatted URL returned by formatURL(), or "about:blank". |
| michael@0 | 43 | */ |
| michael@0 | 44 | AString formatURLPref(in AString aPref); |
| michael@0 | 45 | }; |
