intl/uconv/src/nsGREResProperties.h

   1 /* vim: set sts=2 sw=2 et cin: */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is gre/res property file loading code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Christian Biesinger <cbiesinger@web.de>.
  19  * Portions created by the Initial Developer are Copyright (C) 2005
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  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 #ifndef nsGREResProperties_h__
  39 #define nsGREResProperties_h__
  40
  41 #include "nsString.h"
  42 #include "nsIPersistentProperties2.h"
  43 #include "nsCOMPtr.h"
  44
  45 /**
  46  * This class loads a .properties file from the gre/res directory; the file
  47  * to load is specified as a constructor argument.
  48  */
  49 class nsGREResProperties {
  50 public:
  51   /**
  52    * @param aFile The file to load. Must be an ASCII string.
  53    */
  54   nsGREResProperties(const nsACString& aFile);
  55
  56   /**
  57    * Returns whether loading the file succeeded.
  58    */
  59   PRBool DidLoad() const;
  60   nsresult Get(const nsAString& aKey, nsAString& value);
  61
  62 private:
  63   nsCOMPtr<nsIPersistentProperties> mProps;
  64 };
  65
  66 #endif // nsGREResProperties_h__