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