binfilter/inc/bf_svtools/syslocale.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: syslocale.hxx,v $
  10  * $Revision: 1.3 $
  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 #ifndef INCLUDED_SVTOOLS_SYSLOCALE_HXX
  32 #define INCLUDED_SVTOOLS_SYSLOCALE_HXX
  33
  34 #ifndef INCLUDED_SVTDLLAPI_H
  35 #include "bf_svtools/svtdllapi.h"
  36 #endif
  37
  38 #ifndef _UNOTOOLS_LOCALEDATAWRAPPER_HXX
  39 #include <unotools/localedatawrapper.hxx>
  40 #endif
  41 #ifndef _UNOTOOLS_CHARCLASS_HXX
  42 #include <unotools/charclass.hxx>
  43 #endif
  44 #ifndef _SAL_TYPES_H_
  45 #include <sal/types.h>
  46 #endif
  47
  48 namespace osl { class Mutex; }
  49
  50 class LocaleDataWrapper;
  51
  52 namespace binfilter
  53 {
  54
  55 class SvtSysLocale_Impl;
  56
  57 /**
  58     SvtSysLocale provides a refcounted single instance of an application wide
  59     <type>LocaleDataWrapper</type> and <type>CharClass</type> which always
  60     follow the locale as it is currently configured by the user. You may use
  61     it anywhere to access the locale data elements like decimal separator and
  62     simple date formatting and so on. Contructing and destructing a
  63     SvtSysLocale is not expensive as long as there is at least one instance
  64     left.
  65  */
  66 class  SvtSysLocale
  67 {
  68     friend class SvtSysLocale_Impl;     // access to mutex
  69
  70     static  SvtSysLocale_Impl*  pImpl;
  71     static  sal_Int32           nRefCount;
  72
  73     static  ::osl::Mutex&               GetMutex();
  74
  75 public:
  76                                         SvtSysLocale();
  77                                         ~SvtSysLocale();
  78
  79             const LocaleDataWrapper&    GetLocaleData() const;
  80             const CharClass&            GetCharClass() const;
  81
  82     /** It is safe to store the pointers locally and use them AS LONG AS THE
  83         INSTANCE OF SvtSysLocale LIVES!
  84         It is a faster access but be sure what you do!
  85      */
  86             const LocaleDataWrapper*    GetLocaleDataPtr() const;
  87             const CharClass*            GetCharClassPtr() const;
  88
  89 };
  90
  91 }
  92
  93 #endif  // INCLUDED_SVTOOLS_SYSLOCALE_HXX