formula/source/ui/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_FORMULA_SOURCE_UI_INC_MODULEHELPER_HXX
  21 #define INCLUDED_FORMULA_SOURCE_UI_INC_MODULEHELPER_HXX
  22
  23 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  24 #include <tools/resmgr.hxx>
  25
  26 namespace formula
  27 {
  28
  29
  30     //= OModule
  31
  32     class OModuleClient;
  33     class OModuleImpl;
  34     class OModule
  35     {
  36         friend class OModuleClient;
  37
  38     private:
  39         OModule() = delete; //TODO: get rid of this class
  40
  41     protected:
  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     protected:
  49         /// register a client for the module
  50         static void registerClient();
  51         /// revoke a client for the module
  52         static void revokeClient();
  53
  54     private:
  55         /** ensure that the impl class exists
  56             @precond m_aMutex is guarded when this method gets called
  57         */
  58         static void ensureImpl();
  59     };
  60
  61
  62     //= ModuleRes
  63
  64     /** specialized ResId, using the resource manager provided by the global module
  65     */
  66     class ModuleRes : public ::ResId
  67     {
  68     public:
  69         ModuleRes(sal_uInt16 _nId) : ResId(_nId, *OModule::getResManager()) { }
  70     };
  71
  72 }   // namespace formula
  73
  74
  75 #endif // INCLUDED_FORMULA_SOURCE_UI_INC_MODULEHELPER_HXX
  76
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */