dbaccess/source/ui/inc/moduledbu.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_DBACCESS_SOURCE_UI_INC_MODULEDBU_HXX
  21 #define INCLUDED_DBACCESS_SOURCE_UI_INC_MODULEDBU_HXX
  22
  23 #include <osl/mutex.hxx>
  24 #include <tools/resid.hxx>
  25
  26 class ResMgr;
  27
  28 namespace dbaui
  29 {
  30
  31 // OModule
  32 class OModuleImpl;
  33 class OModule
  34 {
  35     friend class OModuleClient;
  36
  37 private:
  38     OModule() = delete; //TODO: get rid of this class
  39
  40 protected:
  41     static ::osl::Mutex s_aMutex;       /// access safety
  42     static sal_Int32    s_nClients;     /// number of registered clients
  43     static OModuleImpl* s_pImpl;        /// impl class. lives as long as at least one client for the module is registered
  44
  45 public:
  46     /// get the vcl res manager of the module
  47     static ResMgr*  getResManager();
  48
  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 // OModuleClient
  63 /** base class for objects which uses any global module-specific resources
  64 */
  65 class OModuleClient
  66 {
  67 public:
  68     OModuleClient()     { OModule::registerClient(); }
  69     ~OModuleClient()    { OModule::revokeClient(); }
  70 };
  71
  72 // ModuleRes
  73 /** specialized ResId, using the resource manager provided by the global module
  74 */
  75 class ModuleRes : public ::ResId
  76 {
  77 public:
  78     ModuleRes(sal_uInt16 _nId) : ResId(_nId, *OModule::getResManager()) { }
  79 };
  80
  81 }   // namespace dbaui
  82
  83 #endif // INCLUDED_DBACCESS_SOURCE_UI_INC_MODULEDBU_HXX
  84
  85 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */