/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is Chrome Document Pack Interface.
 *
 * The Initial Developer of the Original Code is
 * Alexander J. Vincent <ajvincent@gmail.com>.
 * Portions created by the Initial Developer are Copyright (C) 2007
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"

interface xeIBaseURIMap;

[scriptable, uuid(36d5e9d6-8603-4e81-8fbf-16ee17de143c)]
interface xeIChromeDocumentPack : nsISupports
{
  // Note:  selectedLocale and selectedSkin may be settable in the future.
  /**
   * The currently selected locale for the document pack.
   */
  readonly attribute ACString selectedLocale;
  
  /**
   * The currently selected skin for the document pack.
   */
  readonly attribute ACString selectedSkin;
  
  const unsigned short PACKAGE_TYPE_CONTENT = 1;
  const unsigned short PACKAGE_TYPE_LOCALE  = 2;
  const unsigned short PACKAGE_TYPE_SKIN    = 3;
  
  /* A sub-package name is simply the localization or skin name for a locale
     or skin package.  For example, if I have an en-US localization and a
     fr-FR localization for chrome://verbosio/locale/, then you would call
     names = pack.getSubPackageNames("verbosio", PACKAGE_TYPE_LOCALE, count);
     The names array would then equal ["en-US", "fr-FR"] (if en-US came first
     in the manifest).
     
     Similarly, for a chrome://navigator/skin/ package with classic and modern
     skins, the call would be
     names = pack.getSubPackageNames("navigator", PACKAGE_TYPE_SKIN, count);
     The names array would then equal ["classic", "modern"] (if classic came
     first in the manifest).
   */
  
  /**
   * Get an array of chrome packages in the document pack.
   *
   * @return aCount Number of package names.
   * @return aArray Array of package names.
   */
  void getChromePackageNames(out unsigned long aCount,
                             [retval, array, size_is(aCount)]
                             out wstring aArray);
  
  /**
   * Get a list of all sub-package names for a chrome package.
   *
   * @param aPackageName The name of the package.
   * @param aPackageType The type of the package (content, locale, skin).
   * 
   * @return aCount Number of sub-package names.
   * @return aArray Array of sub-package names.
   *
   * @note:  This will return [null] for existing content packages, and []
   *         for non-existing content packages.
   */
  void getSubPackageNames(in ACString aPackageName,
                          in unsigned short aPackageType,
                          out unsigned long aCount,
                          [retval, array, size_is(aCount)]
                          out wstring aArray);

  /**
   * Get a base URI map for a given chrome package.
   *
   * @param aPackageName    The name of the package.
   * @param aPackageType    The type of the package (content, locale, skin).
   * @param aSubPackageName The name of the sub-package to retrieve.
   *
   * @return xeIBaseURIMap  The base URI map matching that chrome package.
   *
   * @note aSubPackageType must be null when aPackageType is for content.
   */
  xeIBaseURIMap getChromeBaseURI(in ACString aPackageName,
                                 in unsigned short aPackageType,
                                 in ACString aSubPackageName);
};
