framework/source/inc/accelerators/globalacceleratorconfiguration.hxx

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