connectivity/source/drivers/mozab/bootstrap/MNSProfileDirServiceProvider.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: MNSProfileDirServiceProvider.hxx,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31
  32 #include "mozilla_nsprofiledirserviceprovider.h"
  33
  34 // Forward Declarations
  35 class nsIAtom;
  36
  37 // --------------------------------------------------------------------------------------
  38 // nsProfileDirServiceProvider - The nsIDirectoryServiceProvider implementation used for
  39 // profile-relative file locations.
  40 // --------------------------------------------------------------------------------------
  41
  42 class nsProfileDirServiceProvider: public nsIDirectoryServiceProvider
  43 {
  44   NS_DECL_ISUPPORTS
  45   NS_DECL_NSIDIRECTORYSERVICEPROVIDER
  46
  47   friend nsresult NS_NewProfileDirServiceProvider( nsProfileDirServiceProvider**);
  48
  49 public:
  50
  51    virtual nsresult        SetProfileDir(nsIFile* aProfileDir);
  52    virtual nsresult         Register();
  53    virtual nsresult         Shutdown();
  54
  55 protected:
  56                            nsProfileDirServiceProvider();
  57    virtual                 ~nsProfileDirServiceProvider();
  58
  59   nsresult                 Initialize();
  60   nsresult                 EnsureProfileFileExists(nsIFile* profileDir);
  61   nsresult                 UndefineFileLocations();
  62
  63 protected:
  64
  65   // Atoms for file locations
  66   static nsIAtom*          sApp_PrefsDirectory50;
  67   static nsIAtom*          sApp_PreferencesFile50;
  68   static nsIAtom*          sApp_UserProfileDirectory50;
  69
  70   nsCOMPtr<nsIFile>        mProfileDir;
  71
  72 };
  73
  74
  75 // --------------------------------------------------------------------------------------
  76
  77 /**
  78  * Global method to create an instance of nsProfileDirServiceProvider
  79  *
  80  * @param aNotifyObservers    If true, will send out profile startup
  81  *                            notifications when the profile directory is set.
  82  *                            See nsIProfileChangeStatus.
  83  */
  84
  85 nsresult NS_NewProfileDirServiceProvider( nsProfileDirServiceProvider** aProvider);
  86