toolkit/components/urlformatter/public/nsIURLFormatter.idl

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is the URL Formatter Interface.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Dietrich Ayala <dietrich@mozilla.com>
  18  * Portions created by the Initial Developer are Copyright (C) 2006
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *   Dietrich Ayala <dietrich@mozilla.com>
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 /**
  39  * nsIURLFormatter
  40  *
  41  * nsIURLFormatter exposes methods to substitute variables in URL formats.
  42  *
  43  * Mozilla Applications linking to Mozilla websites are strongly encouraged to use
  44  * URLs of the following format:
  45  *
  46  *   http[s]://%LOCALE%.%SERVICE%.mozilla.[com|org]/%LOCALE%/
  47  */
  48
  49 #include "nsISupports.idl"
  50
  51 [scriptable, uuid(4ab31d30-372d-11db-a98b-0800200c9a66)]
  52 interface nsIURLFormatter: nsISupports
  53 {
  54   /**
  55    * formatURL - Formats a string URL
  56    *
  57    * @param aFormat string
  58    */
  59   AString formatURL(in AString aFormat);
  60
  61   /**
  62    * formatURLPref - Formats a string URL stored in a pref
  63    *
  64    * @param aFormat string
  65    */
  66   AString formatURLPref(in AString aPref);
  67 };