reportdesign/inc/ModuleHelper.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef _RPTUI_MODULE_HELPER_RPT_HXX_
  21 #define _RPTUI_MODULE_HELPER_RPT_HXX_
  22
  23 #include "dllapi.h"
  24 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  25 #include <tools/resmgr.hxx>
  26
  27 //.........................................................................
  28 namespace rptui
  29 {
  30 //.........................................................................
  31     //=========================================================================
  32     //= OModule
  33     //=========================================================================
  34     class OModuleImpl;
  35     class REPORTDESIGN_DLLPUBLIC OModule
  36     {
  37         friend class OModuleClient;
  38
  39     private:
  40         OModule();
  41             // not implemented. OModule is a static class
  42
  43     protected:
  44         static sal_Int32    s_nClients;     /// number of registered clients
  45         static OModuleImpl* s_pImpl;        /// impl class. lives as long as at least one client for the module is registered
  46
  47     public:
  48         /// get the vcl res manager of the module
  49         static ResMgr*  getResManager();
  50     protected:
  51         /// register a client for the module
  52         static void registerClient();
  53         /// revoke a client for the module
  54         static void revokeClient();
  55
  56     private:
  57         /** ensure that the impl class exists
  58             @precond m_aMutex is guarded when this method gets called
  59         */
  60         static void ensureImpl();
  61     };
  62
  63     //=========================================================================
  64     //= OModuleClient
  65     //=========================================================================
  66     /** base class for objects which uses any global module-specific resources
  67     */
  68     class REPORTDESIGN_DLLPUBLIC OModuleClient
  69     {
  70     public:
  71         inline OModuleClient()      { OModule::registerClient(); }
  72         inline ~OModuleClient() { OModule::revokeClient(); }
  73     };
  74
  75     //=========================================================================
  76     //= ModuleRes
  77     //=========================================================================
  78     /** specialized ResId, using the resource manager provided by the global module
  79     */
  80     class REPORTDESIGN_DLLPUBLIC ModuleRes : public ::ResId
  81     {
  82     public:
  83         inline ModuleRes(sal_uInt16 _nId) : ResId(_nId, *OModule::getResManager()) { }
  84     };
  85 //.........................................................................
  86 }   // namespace rptui
  87 //.........................................................................
  88
  89 #endif // _RPTUI_MODULE_HELPER_RPT_HXX_
  90
  91
  92 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */