framework/source/inc/accelerators/moduleacceleratorconfiguration.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __FRAMEWORK_ACCELERATORS_MODULEACCELERATORCONFIGURATION_HXX_
  29 #define __FRAMEWORK_ACCELERATORS_MODULEACCELERATORCONFIGURATION_HXX_
  30
  31 //__________________________________________
  32 // own includes
  33
  34 #include <accelerators/acceleratorconfiguration.hxx>
  35 #include <accelerators/presethandler.hxx>
  36
  37 #ifndef __FRAMEWORK_MACROS_XINTERFACE_HXX_
  38 #include <macros/interface.hxx>
  39 #endif
  40 #include <macros/xtypeprovider.hxx>
  41 #include <macros/xserviceinfo.hxx>
  42
  43 //__________________________________________
  44 // interface includes
  45 #include <com/sun/star/lang/XInitialization.hpp>
  46
  47 //__________________________________________
  48 // other includes
  49
  50 //__________________________________________
  51 // definition
  52
  53 namespace framework
  54 {
  55
  56 //__________________________________________
  57 /**
  58     implements a read/write access to a module
  59     dependend accelerator configuration.
  60  */
  61 class ModuleAcceleratorConfiguration : public XCUBasedAcceleratorConfiguration
  62                                      , public css::lang::XServiceInfo
  63                                      , public css::lang::XInitialization
  64 {
  65     //______________________________________
  66     // member
  67
  68     private:
  69
  70         //----------------------------------
  71         /** identify the application module, where this accelerator
  72             configuration cache should work on. */
  73         ::rtl::OUString m_sModule;
  74         ::rtl::OUString m_sLocale;
  75
  76     //______________________________________
  77     // interface
  78
  79     public:
  80
  81         //----------------------------------
  82         /** initialize this instance and fill the internal cache.
  83
  84             @param  xSMGR
  85                     reference to an uno service manager, which is used internaly.
  86          */
  87         ModuleAcceleratorConfiguration(const css::uno::Reference< css::lang::XMultiServiceFactory > xSMGR);
  88
  89         //----------------------------------
  90         /** TODO */
  91         virtual ~ModuleAcceleratorConfiguration();
  92
  93         // XInterface, XTypeProvider, XServiceInfo
  94         FWK_DECLARE_XINTERFACE
  95         FWK_DECLARE_XTYPEPROVIDER
  96         DECLARE_XSERVICEINFO
  97
  98         // XInitialization
  99         virtual void SAL_CALL initialize(const css::uno::Sequence< css::uno::Any >& lArguments)
 100             throw(css::uno::Exception       ,
 101                   css::uno::RuntimeException);
 102
 103     //______________________________________
 104     // helper
 105
 106     private:
 107
 108         //----------------------------------
 109         /** read all data into the cache. */
 110         void impl_ts_fillCache();
 111 };
 112
 113 } // namespace framework
 114
 115 #endif // __FRAMEWORK_ACCELERATORS_MODULEACCELERATORCONFIGURATION_HXX_