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 INCLUDED_REPORTDESIGN_INC_MODULEHELPER_HXX
  21 #define INCLUDED_REPORTDESIGN_INC_MODULEHELPER_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() = delete; //TODO: get rid of this class
  41
  42     protected:
  43         static sal_Int32    s_nClients;     /// number of registered clients
  44         static OModuleImpl* s_pImpl;        /// impl class. lives as long as at least one client for the module is registered
  45
  46     public:
  47         /// get the vcl res manager of the module
  48         static ResMgr*  getResManager();
  49     protected:
  50         /// register a client for the module
  51         static void registerClient();
  52         /// revoke a client for the module
  53         static void revokeClient();
  54
  55     private:
  56         /** ensure that the impl class exists
  57             @precond m_aMutex is guarded when this method gets called
  58         */
  59         static void ensureImpl();
  60     };
  61
  62
  63     //= OModuleClient
  64
  65     /** base class for objects which uses any global module-specific resources
  66     */
  67     class REPORTDESIGN_DLLPUBLIC OModuleClient
  68     {
  69     public:
  70         OModuleClient()      { OModule::registerClient(); }
  71         ~OModuleClient() { OModule::revokeClient(); }
  72     };
  73
  74
  75     //= ModuleRes
  76
  77     /** specialized ResId, using the resource manager provided by the global module
  78     */
  79     class REPORTDESIGN_DLLPUBLIC ModuleRes : public ::ResId
  80     {
  81     public:
  82         ModuleRes(sal_uInt16 _nId) : ResId(_nId, *OModule::getResManager()) { }
  83     };
  84
  85 }   // namespace rptui
  86
  87
  88 #endif // INCLUDED_REPORTDESIGN_INC_MODULEHELPER_HXX
  89
  90
  91 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */