/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** 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 Shell Service.
 *
 * The Initial Developer of the Original Code is mozilla.org.
 * Portions created by the Initial Developer are Copyright (C) 2004
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *  Ben Goodger <ben@mozilla.org> (Original Author)
 *
 * 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 "nsIShellService.idl"

[scriptable, uuid(eccda3b0-ea69-4066-8343-ddaf1f435b53)]
interface nsIWindowsShellService : nsIShellService
{
    /**
    * Restores system settings to what they were before Firefox 
    * modified them.
    *
    * @param aForAllUsers   Whether or not Firefox should restore
    *                       settings for all users on a multi-user
    *                       system. 
    */
    void restoreFileSettings(in boolean aForAllUsers);

    /** 
     * The number of unread mail messages for the current user.
     * 
     * @return The number of unread (new) mail messages for the current user.
     */
    readonly attribute unsigned long unreadMailCount;

    /**
     * Valid starting keys for the Windows Registry.
     */
    const long HKCR = 0; // HKEY_CLASSES_ROOT
    const long HKCC = 1; // HKEY_CURRENT_CONFIG
    const long HKCU = 2; // HKEY_CURRENT_USER
    const long HKLM = 3; // HKEY_LOCAL_MACHINE
    const long HKU  = 4; // HKEY_USERS

    /** 
     * Retrieves a Windows Registry entry value.
     * 
     * @param aHKeyConstant The starting key, using the constants defined above.
     * @param aSubKeyName   The sub key to locate
     * @param aValueName    The value to locate in the sub key. The empty string
     *                      returns the default value of the sub key.
     * @return The value of the specified sub key/value, truncated to 4096 bytes.
     */
    string getRegistryEntry(in long aHKeyConstant, in string aSubKeyName, in string aValueName);
};

