INTEGRATION: CWS keyconfig01 (1.1.2); FILE ADDED

2004/07/23 09:04:13 as 1.1.2.7: #i29863# support reset of user layer config
2004/07/20 09:48:47 as 1.1.2.6: #i29863# support load/save of acc cfg from/to documents, update all caches immediatly after changing one
2004/07/17 10:43:08 as 1.1.2.5: #i29863# close streams immediatly after using, patch res2xml tool, fix bugs inside read/write xml, establish preset handler
2004/07/14 06:58:43 as 1.1.2.4: #i29863# must change for ElementModes, correct exception declarations, some typos ...
2004/07/08 06:45:41 as 1.1.2.3: #i29863# support localized UI config, support new UI directory structure, adopt converter tool to support accelerators
2004/06/22 07:49:09 as 1.1.2.2: #i29863# first revision
2004/06/04 09:32:45 as 1.1.2.1: #i29863# first revision

1 files changed, 388 insertions, 0 deletions

diff --git a/framework/source/inc/accelerators/acceleratorconfiguration.hxx b/framework/source/inc/accelerators/acceleratorconfiguration.hxx
new file mode 100644
index 0000000000..923f9f55f9
--- /dev/null
+++ b/framework/source/inc/accelerators/acceleratorconfiguration.hxx
@@ -0,0 +1,388 @@
+/*************************************************************************
+ *
+ *  $RCSfile: acceleratorconfiguration.hxx,v $
+ *
+ *  $Revision: 1.2 $
+ *
+ *  last change: $Author: rt $ $Date: 2004-09-20 10:07:04 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 by Sun Microsystems, Inc.
+ *  901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ *  This library is free software; you can redistribute it and/or
+ *  modify it under the terms of the GNU Lesser General Public
+ *  License version 2.1, as published by the Free Software Foundation.
+ *
+ *  This library is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ *  Lesser General Public License for more details.
+ *
+ *  You should have received a copy of the GNU Lesser General Public
+ *  License along with this library; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ *  MA  02111-1307  USA
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (the "License"); You may not use this file
+ *  except in compliance with the License. You may obtain a copy of the
+ *  License at http://www.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#ifndef __FRAMEWORK_ACCELERATORS_ACCELERATORCONFIGURATION_HXX_
+#define __FRAMEWORK_ACCELERATORS_ACCELERATORCONFIGURATION_HXX_
+
+//__________________________________________
+// own includes
+
+#ifndef __FRAMEWORK_ACCELERATORS_ISTORAGELISTENER_HXX_
+#include <accelerators/istoragelistener.hxx>
+#endif
+
+#ifndef __FRAMEWORK_ACCELERATORS_PRESETHANDLER_HXX_
+#include <accelerators/presethandler.hxx>
+#endif
+
+#ifndef __FRAMEWORK_ACCELERATORS_ACCELERATORCACHE_HXX_
+#include <accelerators/acceleratorcache.hxx>
+#endif
+
+#ifndef __FRAMEWORK_MACROS_XINTERFACE_HXX_
+#include <macros/xinterface.hxx>
+#endif
+
+#ifndef __FRAMEWORK_MACROS_XTYPEPROVIDER_HXX_
+#include <macros/xtypeprovider.hxx>
+#endif
+
+#ifndef __FRAMEWORK_THREADHELP_THREADHELPBASE_HXX_
+#include <threadhelp/threadhelpbase.hxx>
+#endif
+
+#ifndef __FRAMEWORK_GENERAL_H_
+#include <general.h>
+#endif
+
+#ifndef __FRAMEWORK_STDTYPES_H_
+#include <stdtypes.h>
+#endif
+
+//__________________________________________
+// interface includes
+
+#ifndef _COM_SUN_STAR_LANG_XTYPEPROVIDER_HPP_
+#include <com/sun/star/lang/XTypeProvider.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_LANG_XMULTISERVICEFACTORY_HPP_
+#include <com/sun/star/lang/XMultiServiceFactory.hpp>
+#endif
+
+#ifndef _DRAFTS_COM_SUN_STAR_UI_XACCELERATORCONFIGURATION_HPP_
+#include <drafts/com/sun/star/ui/XAcceleratorConfiguration.hpp>
+#endif
+
+#ifndef _DRAFTS_COM_SUN_STAR_UI_XUICONFIGURATION_HPP_
+#include <drafts/com/sun/star/ui/XUIConfiguration.hpp>
+#endif
+
+#ifndef _DRAFTS_COM_SUN_STAR_UI_XUICONFIGURATIONPERSISTENCE_HPP_
+#include <drafts/com/sun/star/ui/XUIConfigurationPersistence.hpp>
+#endif
+
+#ifndef _DRAFTS_COM_SUN_STAR_UI_XUICONFIGURATIONSTORAGE_HDL_
+#include <drafts/com/sun/star/ui/XUIConfigurationStorage.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_IO_XSTREAM_HPP_
+#include <com/sun/star/io/XStream.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_IO_XINPUTSTREAM_HPP_
+#include <com/sun/star/io/XInputStream.hpp>
+#endif
+
+#ifndef _COM_SUN_STAR_IO_XOUTPUTSTREAM_HPP_
+#include <com/sun/star/io/XOutputStream.hpp>
+#endif
+
+// TODO use XPresetHandler interface instead if available
+#ifndef _COM_SUN_STAR_FORM_XRESET_HPP_
+#include <com/sun/star/form/XReset.hpp>
+#endif
+
+//__________________________________________
+// other includes
+
+#ifndef _CPPUHELPER_WEAK_HXX_
+#include <cppuhelper/weak.hxx>
+#endif
+
+#ifndef _COMPHELPER_LOCALE_HXX_
+#include <comphelper/locale.hxx>
+#endif
+
+//__________________________________________
+// definition
+
+namespace framework
+{
+
+/** "global" type to make accelerator presets unique, so they can be used
+    in combination with the salhelper::SingletonRef mechanism! */
+typedef PresetHandler AcceleratorPresets;    
+    
+//__________________________________________
+/**
+    implements a read/write access to the accelerator configuration.
+ */
+class AcceleratorConfiguration : protected ThreadHelpBase                       // attention! Must be the first base class to guarentee right initialize lock ...
+                               , public    IStorageListener
+                               , public    ::cppu::OWeakObject
+                               , public    css::lang::XTypeProvider
+                               , public    css::form::XReset                    // TODO use XPresetHandler instead if available
+                               , public    dcss::ui::XAcceleratorConfiguration  // => dcss::ui::XUIConfigurationPersistence
+                                                                                //    dcss::ui::XUIConfigurationStorage
+                                                                                //    dcss::ui::XUIConfiguration
+{
+    //______________________________________
+    // member
+
+    protected:
+
+        //---------------------------------------
+        /** the global uno service manager.
+            Must be used to create own needed services. */
+        css::uno::Reference< css::lang::XMultiServiceFactory > m_xSMGR;
+        
+        //---------------------------------------
+        /** used to:
+            i  ) copy configuration files from the share to the user layer
+            ii ) provide access to these config files
+            iii) cache all sub storages on the path from the top to the bottom(!)
+            iv ) provide commit for changes. */
+        PresetHandler m_aPresetHandler;
+        
+        //---------------------------------------
+        /** contains the cached configuration data */
+        AcceleratorCache m_aReadCache;
+        
+        //---------------------------------------
+        /** used to implement the copy on write pattern! */
+        AcceleratorCache* m_pWriteCache;
+        
+    //______________________________________
+    // native interface!
+
+    public:
+
+                 AcceleratorConfiguration( const css::uno::Reference< css::lang::XMultiServiceFactory > xSMGR );
+        virtual ~AcceleratorConfiguration(                                                                    );
+                    
+    //______________________________________
+    // uno interface!
+
+    public:
+    
+        // XInterface, XTypeProvider
+        DECLARE_XINTERFACE
+        DECLARE_XTYPEPROVIDER
+
+        // XAcceleratorConfiguration
+        virtual css::uno::Sequence< css::awt::KeyEvent > SAL_CALL getAllKeyEvents()
+            throw(css::uno::RuntimeException);
+            
+        virtual ::rtl::OUString SAL_CALL getCommandByKeyEvent(const css::awt::KeyEvent& aKeyEvent)
+            throw(css::container::NoSuchElementException,
+                  css::uno::RuntimeException            );
+                  
+        virtual void SAL_CALL setKeyEvent(const css::awt::KeyEvent& aKeyEvent,
+                                          const ::rtl::OUString&    sCommand )
+            throw(css::lang::IllegalArgumentException,
+                  css::uno::RuntimeException         );
+                  
+        virtual void SAL_CALL removeKeyEvent(const css::awt::KeyEvent& aKeyEvent)
+            throw(css::container::NoSuchElementException,
+                  css::uno::RuntimeException            );
+                  
+        virtual css::uno::Sequence< css::awt::KeyEvent > SAL_CALL getKeyEventsByCommand(const ::rtl::OUString& sCommand)
+            throw(css::lang::IllegalArgumentException   ,
+                  css::container::NoSuchElementException,
+                  css::uno::RuntimeException            );
+                  
+        virtual css::uno::Sequence< css::uno::Any > SAL_CALL getPreferredKeyEventsForCommandList(const css::uno::Sequence< ::rtl::OUString >& lCommandList)
+            throw(css::lang::IllegalArgumentException   ,
+                  css::uno::RuntimeException            );
+                  
+        virtual void SAL_CALL removeCommandFromAllKeyEvents(const ::rtl::OUString& sCommand)
+            throw(css::lang::IllegalArgumentException   ,
+                  css::container::NoSuchElementException,
+                  css::uno::RuntimeException            );
+
+        // XUIConfigurationPersistence
+        virtual void SAL_CALL reload()
+            throw(css::uno::Exception       ,
+                  css::uno::RuntimeException);
+                  
+        virtual void SAL_CALL store()
+            throw(css::uno::Exception       ,
+                  css::uno::RuntimeException);
+                  
+        virtual void SAL_CALL storeToStorage(const css::uno::Reference< css::embed::XStorage >& xStorage)
+            throw(css::uno::Exception       ,
+                  css::uno::RuntimeException);
+                  
+        virtual ::sal_Bool SAL_CALL isModified()
+            throw(css::uno::RuntimeException);
+            
+        virtual ::sal_Bool SAL_CALL isReadOnly()
+            throw(css::uno::RuntimeException);
+        
+        // XUIConfigurationStorage
+        virtual void SAL_CALL setStorage(const css::uno::Reference< css::embed::XStorage >& xStorage)
+            throw(css::uno::RuntimeException);
+            
+        virtual ::sal_Bool SAL_CALL hasStorage()
+            throw(css::uno::RuntimeException);
+        
+        // XUIConfiguration
+        virtual void SAL_CALL addConfigurationListener(const css::uno::Reference< dcss::ui::XUIConfigurationListener >& xListener)
+            throw(css::uno::RuntimeException);
+            
+        virtual void SAL_CALL removeConfigurationListener(const css::uno::Reference< dcss::ui::XUIConfigurationListener >& xListener)
+            throw(css::uno::RuntimeException);
+            
+        // XReset            
+        // TODO use XPresetHandler instead if available
+        virtual void SAL_CALL reset()
+            throw(css::uno::RuntimeException);
+            
+        virtual void SAL_CALL addResetListener(const css::uno::Reference< css::form::XResetListener >& xListener)
+            throw(css::uno::RuntimeException);
+            
+        virtual void SAL_CALL removeResetListener(const css::uno::Reference< css::form::XResetListener >& xListener)
+            throw(css::uno::RuntimeException);
+    
+        // IStorageListener
+        virtual void changesOccured(const ::rtl::OUString& sPath);
+
+    //______________________________________
+    // helper for derived classes
+
+    protected:
+    
+        //---------------------------------------
+        /** @short  return the current office locale.
+        
+            @descr  We does not cache this value, because we are not listen
+                    for changes on the configuration layer ...
+                    
+            @return ::comphelper::Locale
+                    The current office locale.                    
+         */
+        ::comphelper::Locale impl_ts_getLocale() const;
+        
+    //______________________________________
+    // helper
+
+    private:
+    
+        //---------------------------------------
+        /** @short  load a configuration set, using the given stream.
+        
+            @param  xStream
+                    provides the XML structure as stream.
+         */
+        void impl_ts_load(const css::uno::Reference< css::io::XInputStream >& xStream);
+        
+        //---------------------------------------
+        /** @short  save a configuration set, using the given stream.
+        
+            @param  xStream
+                    the XML structure can be written there.
+         */
+        void impl_ts_save(const css::uno::Reference< css::io::XOutputStream >& xStream);
+        
+        //---------------------------------------
+        /** @short  try to locate and open a sub storage.
+        
+            @descr  It search at the root storage for the specified
+                    sub storage. If it exists - it will be opened.
+                    By default this method tries to open the storage
+                    for reading. But the calli can request a writeable
+                    storage.
+                    
+            @param  xRooStorage
+                    used to locate the sub storage.
+
+            @param  sSubStorage
+                    relativ path of the sub storage.                    
+        
+            @param  bOutStream
+                    force open of the sub storage in
+                    write mode - instead of read mode, which
+                    is the default.
+                    
+            @return [XInterface]
+                    will be a css::io::XInpoutStream or a css::io::XOutputStream.
+                    Depends from the parameter bWriteable!                    
+         */
+        css::uno::Reference< css::uno::XInterface > impl_ts_openSubStorage(const css::uno::Reference< css::embed::XStorage >& xRootStorage,
+                                                                           const ::rtl::OUString&                             sSubStorage ,
+                                                                                 sal_Bool                                     bOutStream  );
+        
+        //---------------------------------------
+        /** @short  returns a reference to one of our internal cache members.
+        
+            @descr  We implement the copy-on-write pattern. Doing so
+                    we know two caches internaly. The second one is used
+                    only, if the container was changed.
+                    
+                    This method here returns access to one of these
+                    caches - depending on the change state of this
+                    configuration service.
+                    
+            @param  bWriteAccessRequested
+                    if the outside code whish to change the container
+                    it must call this method with "TRUE". So the internal
+                    cache can be prepared for that (means copy-on-write ...).                    
+                    
+            @return [AcceleratorCache]
+                    c++ reference(!) to one of our internal caches.                    
+         */
+        AcceleratorCache& impl_getCFG(sal_Bool bWriteAccessRequested = sal_False);
+};
+
+} // namespace framework
+
+#endif // __FRAMEWORK_ACCELERATORS_ACCELERATORCONFIGURATION_HXX_