Update ooo320-m1
[ooovba.git] / reportdesign / inc / ModuleHelper.hxx
blob79e790e0d14c79ae7b5800884b4a84e547ca4ea0
1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: ModuleHelper.hxx,v $
10 * $Revision: 1.3 $
12 * This file is part of OpenOffice.org.
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.
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).
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.
29 ************************************************************************/
31 #ifndef _RPTUI_MODULE_HELPER_RPT_HXX_
32 #define _RPTUI_MODULE_HELPER_RPT_HXX_
34 #include "dllapi.h"
35 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
36 #include <tools/resmgr.hxx>
38 //.........................................................................
39 namespace rptui
41 //.........................................................................
42 //=========================================================================
43 //= OModule
44 //=========================================================================
45 class OModuleImpl;
46 class REPORTDESIGN_DLLPUBLIC OModule
48 friend class OModuleClient;
50 private:
51 OModule();
52 // not implemented. OModule is a static class
54 protected:
55 static ::osl::Mutex s_aMutex; /// access safety
56 static sal_Int32 s_nClients; /// number of registered clients
57 static OModuleImpl* s_pImpl; /// impl class. lives as long as at least one client for the module is registered
59 public:
60 /// get the vcl res manager of the module
61 static ResMgr* getResManager();
62 protected:
63 /// register a client for the module
64 static void registerClient();
65 /// revoke a client for the module
66 static void revokeClient();
68 private:
69 /** ensure that the impl class exists
70 @precond m_aMutex is guarded when this method gets called
72 static void ensureImpl();
75 //=========================================================================
76 //= OModuleClient
77 //=========================================================================
78 /** base class for objects which uses any global module-specific ressources
80 class REPORTDESIGN_DLLPUBLIC OModuleClient
82 public:
83 inline OModuleClient() { OModule::registerClient(); }
84 inline ~OModuleClient() { OModule::revokeClient(); }
87 //=========================================================================
88 //= ModuleRes
89 //=========================================================================
90 /** specialized ResId, using the ressource manager provided by the global module
92 class REPORTDESIGN_DLLPUBLIC ModuleRes : public ::ResId
94 public:
95 inline ModuleRes(USHORT _nId) : ResId(_nId, *OModule::getResManager()) { }
97 //.........................................................................
98 } // namespace rptui
99 //.........................................................................
101 #endif // _RPTUI_MODULE_HELPER_RPT_HXX_