formula/source/ui/inc/ModuleHelper.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: ModuleHelper.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 FORMULA_MODULE_HELPER_RPT_HXX_
  32 #define FORMULA_MODULE_HELPER_RPT_HXX_
  33
  34 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  35 #include <tools/resmgr.hxx>
  36 #include "formula/formuladllapi.h"
  37 //.........................................................................
  38 namespace formula
  39 {
  40 //.........................................................................
  41     //=========================================================================
  42     //= OModule
  43     //=========================================================================
  44     class OModuleImpl;
  45     class FORMULA_DLLPUBLIC OModule
  46     {
  47         friend class OModuleClient;
  48
  49     private:
  50         OModule();
  51             // not implemented. OModule is a static class
  52
  53     protected:
  54         static ::osl::Mutex     s_aMutex;               /// access safety
  55         static sal_Int32        s_nClients;             /// number of registered clients
  56         static OModuleImpl*     s_pImpl;                /// impl class. lives as long as at least one client for the module is registered
  57
  58     public:
  59         /// get the vcl res manager of the module
  60         static ResMgr*  getResManager();
  61     protected:
  62         /// register a client for the module
  63         static void     registerClient();
  64         /// revoke a client for the module
  65         static void     revokeClient();
  66
  67     private:
  68         /** ensure that the impl class exists
  69             @precond m_aMutex is guarded when this method gets called
  70         */
  71         static void ensureImpl();
  72     };
  73
  74     //=========================================================================
  75     //= OModuleClient
  76     //=========================================================================
  77     /** base class for objects which uses any global module-specific ressources
  78     */
  79     class FORMULA_DLLPUBLIC OModuleClient
  80     {
  81     public:
  82         OModuleClient()         { OModule::registerClient(); }
  83         ~OModuleClient()        { OModule::revokeClient(); }
  84     };
  85
  86     //=========================================================================
  87     //= ModuleRes
  88     //=========================================================================
  89     /** specialized ResId, using the ressource manager provided by the global module
  90     */
  91     class FORMULA_DLLPUBLIC ModuleRes : public ::ResId
  92     {
  93     public:
  94         ModuleRes(USHORT _nId) : ResId(_nId, *OModule::getResManager()) { }
  95     };
  96 //.........................................................................
  97 }       // namespace formula
  98 //.........................................................................
  99
 100 #endif // FORMULA_MODULE_HELPER_RPT_HXX_
 101
 102