Files
libreoffice/framework/source/inc/accelerators/acceleratorconfiguration.hxx

453 lines
19 KiB
C++
Raw Normal View History

2010-10-27 13:11:31 +01:00
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
re-base on ALv2 code. Includes: Patches contributed by: Armin Le Grand. #118558# Correcting OLE attributes of LO3.4 at load time by loading as OOo3.3, details see task. http://svn.apache.org/viewvc?view=revision&revision=1195906 #118485# - Styles for OLEs are not saved. http://svn.apache.org/viewvc?view=revision&revision=1182166 #118898# Adapted ImpGraphic::ImplGetBitmap to correctly convert metafiles http://svn.apache.org/viewvc?view=revision&revision=1293316 #119337# Solves the wrong get/setPropertyValue calls in SvxShapeText (and thus in SvxOle2Shape) http://svn.apache.org/viewvc?view=revision&revision=1344156 Patches contributed by Mathias Bauer (and others) gnumake4 work variously http://svn.apache.org/viewvc?view=revision&revision=1394707 http://svn.apache.org/viewvc?view=revision&revision=1394326 cws mba34issues01: #i117717#: remove wrong assertion http://svn.apache.org/viewvc?view=revision&revision=1172349 Patch contributed by Herbert Duerr goodbye Registration and License dialogs, don't let the door hit you http://svn.apache.org/viewvc?view=revision&revision=1172613 help gcc 4.6.0 on 32bit ubuntu 11.10" http://svn.apache.org/viewvc?view=revision&revision=1245357 Do not add targets for junit tests when junit is disabled. Patch contributed by Andre Fischer http://svn.apache.org/viewvc?view=revision&revision=1241508 Revert "sb140: #i117082# avoid unncessary static class data members commit 21d97438e2944861e26e4984195f959a0cce1e41. remove obsolete FreeBSD visibility special case. retain consolidated BSD bridge code, remove OS/2 pieces.
2012-11-12 17:21:24 +00:00
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __FRAMEWORK_ACCELERATORS_ACCELERATORCONFIGURATION_HXX_
#define __FRAMEWORK_ACCELERATORS_ACCELERATORCONFIGURATION_HXX_
#include <accelerators/istoragelistener.hxx>
#include <accelerators/presethandler.hxx>
#include <accelerators/acceleratorcache.hxx>
#include <accelerators/keymapping.hxx>
#include <macros/xinterface.hxx>
#include <macros/xtypeprovider.hxx>
#include <threadhelp/threadhelpbase.hxx>
#include <general.h>
#include <stdtypes.h>
#include <com/sun/star/container/XNameAccess.hpp>
#include <com/sun/star/lang/XTypeProvider.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/ui/XAcceleratorConfiguration.hpp>
#include <com/sun/star/ui/XUIConfiguration.hpp>
#include <com/sun/star/ui/XUIConfigurationPersistence.hpp>
#include <com/sun/star/ui/XUIConfigurationStorage.hpp>
#include <com/sun/star/io/XStream.hpp>
#include <com/sun/star/io/XInputStream.hpp>
#include <com/sun/star/io/XOutputStream.hpp>
#include <com/sun/star/util/XChangesListener.hpp>
// TODO use XPresetHandler interface instead if available
#include <com/sun/star/form/XReset.hpp>
#include <cppuhelper/propshlp.hxx>
#include <cppuhelper/implbase2.hxx>
#include <cppuhelper/implbase4.hxx>
#include <salhelper/singletonref.hxx>
//__________________________________________
// definition
namespace framework
{
CWS-TOOLING: integrate CWS oj18 2009-08-21 15:08:49 +0200 oj r275263 : wrong check 2009-08-21 08:56:01 +0200 oj r275215 : missing not 2009-08-20 07:27:13 +0200 oj r275164 : use new method from global 2009-08-19 10:22:35 +0200 oj r275138 : call GetLocale instead of pLocale 2009-08-18 10:39:32 +0200 oj r275082 : missing header include 2009-08-18 10:09:44 +0200 oj r275081 : new methods at global 2009-08-18 10:09:00 +0200 oj r275080 : unused var 2009-08-18 08:59:04 +0200 oj r275078 : move files from classes to xml 2009-08-17 14:58:16 +0200 oj r275056 : CWS-TOOLING: rebase CWS oj18 to trunk@275001 (milestone: DEV300:m55) 2009-08-17 13:29:44 +0200 oj r275047 : compile error 2009-08-17 13:27:47 +0200 oj r275045 : compile error 2009-08-17 11:44:54 +0200 oj r275040 : add dep 2009-07-22 14:26:05 +0200 oj r274240 : move unused services into fwl 2009-07-22 14:25:35 +0200 oj r274239 : move unused services into fwl 2009-07-22 13:47:45 +0200 oj r274233 : remove some unused code 2009-07-22 09:06:20 +0200 oj r274219 : export dbtoolsclient dbcharsethelper for sc 2009-07-22 08:48:58 +0200 oj r274218 : create NumberFormatter on demand 2009-07-22 08:39:23 +0200 oj r274217 : change char to sal_Char 2009-07-22 07:33:34 +0200 oj r274214 : export dbtoolsclient dbcharsethelper for sc 2009-07-22 07:30:04 +0200 oj r274213 : late init of numberformatter and breakiterator 2009-07-22 07:28:55 +0200 oj r274212 : export dbtoolsclient dbcharsethelper for sc 2009-07-21 13:43:28 +0200 oj r274196 : check if quick start is enbaled 2009-07-21 13:40:09 +0200 oj r274195 : check config entry for UiEventsLogger 2009-07-21 13:37:40 +0200 oj r274194 : code refactoring, remove of duplicate code and some late inits and removale of not needed files 2009-07-21 13:35:38 +0200 oj r274193 : code refactoring, remove of duplicate code and some late inits and removale of not needed files 2009-07-21 13:33:41 +0200 oj r274192 : doc meta data will now be created on demand 2009-07-21 13:13:40 +0200 oj r274187 : load ldap functions on demand 2009-07-21 13:03:17 +0200 oj r274183 : late init of TransliterationImpl 2009-07-21 12:36:10 +0200 oj r274180 : late init of charClass
2009-09-08 04:57:32 +00:00
2012-03-24 14:00:06 +00:00
const char CFG_ENTRY_PRIMARY[] = "PrimaryKeys";
const char CFG_ENTRY_GLOBAL[] = "Global";
const char CFG_ENTRY_MODULES[] = "Modules";
/** "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 XMLBasedAcceleratorConfiguration : protected ThreadHelpBase, // attention! Must be the first base class to guarentee right initialize lock ...
public IStorageListener,
public ::cppu::WeakImplHelper2<
css::form::XReset, // TODO use XPresetHandler instead if available
css::ui::XAcceleratorConfiguration > // => css::ui::XUIConfigurationPersistence
// css::ui::XUIConfigurationStorage
// css::ui::XUIConfiguration
{
//______________________________________
// member
protected:
//---------------------------------------
/** the global uno service manager.
Must be used to create own needed services. */
css::uno::Reference< css::uno::XComponentContext > m_xContext;
//---------------------------------------
/** 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:
XMLBasedAcceleratorConfiguration( const css::uno::Reference< css::uno::XComponentContext >& xContext);
virtual ~XMLBasedAcceleratorConfiguration( );
//______________________________________
// uno interface!
public:
// XAcceleratorConfiguration
virtual css::uno::Sequence< css::awt::KeyEvent > SAL_CALL getAllKeyEvents()
throw(css::uno::RuntimeException);
virtual 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 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 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< OUString >& lCommandList)
throw(css::lang::IllegalArgumentException ,
css::uno::RuntimeException );
virtual void SAL_CALL removeCommandFromAllKeyEvents(const 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< css::ui::XUIConfigurationListener >& xListener)
throw(css::uno::RuntimeException);
virtual void SAL_CALL removeConfigurationListener(const css::uno::Reference< css::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 changesOccurred(const 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 OUString
The current office locale as BCP47 string.
*/
OUString 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 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 "sal_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);
};
class XCUBasedAcceleratorConfiguration : protected ThreadHelpBase, // attention! Must be the first base class to guarentee right initialize lock ...
public ::cppu::WeakImplHelper4<
css::util::XChangesListener,
css::lang::XComponent,
css::form::XReset, // TODO use XPresetHandler instead if available
css::ui::XAcceleratorConfiguration > // => css::ui::XUIConfigurationPersistence
// css::ui::XUIConfigurationStorage
// css::ui::XUIConfiguration
{
//______________________________________
// member
protected:
//---------------------------------------
/** the global uno service manager.
Must be used to create own needed services. */
css::uno::Reference< css::uno::XComponentContext > m_xContext;
css::uno::Reference< css::container::XNameAccess > m_xCfg;
AcceleratorCache m_aPrimaryReadCache;
AcceleratorCache m_aSecondaryReadCache;
AcceleratorCache* m_pPrimaryWriteCache;
AcceleratorCache* m_pSecondaryWriteCache;
OUString m_sGlobalOrModules;
OUString m_sModuleCFG;
::salhelper::SingletonRef< KeyMapping > m_rKeyMapping;
//______________________________________
// native interface!
public:
XCUBasedAcceleratorConfiguration( const css::uno::Reference< css::uno::XComponentContext >& xContext );
virtual ~XCUBasedAcceleratorConfiguration( );
//______________________________________
// uno interface!
public:
// XAcceleratorConfiguration
virtual css::uno::Sequence< css::awt::KeyEvent > SAL_CALL getAllKeyEvents()
throw(css::uno::RuntimeException);
virtual 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 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 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< OUString >& lCommandList)
throw(css::lang::IllegalArgumentException ,
css::uno::RuntimeException );
virtual void SAL_CALL removeCommandFromAllKeyEvents(const 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< css::ui::XUIConfigurationListener >& xListener)
throw(css::uno::RuntimeException);
virtual void SAL_CALL removeConfigurationListener(const css::uno::Reference< css::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);
// css.util.XChangesListener
virtual void SAL_CALL changesOccurred(const css::util::ChangesEvent& aEvent)
throw(css::uno::RuntimeException);
// css.lang.XEventListener
virtual void SAL_CALL disposing(const css::lang::EventObject& aEvent)
throw(css::uno::RuntimeException);
// XComponent
virtual void SAL_CALL dispose() throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL addEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& xListener ) throw (::com::sun::star::uno::RuntimeException);
virtual void SAL_CALL removeEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& aListener ) throw (::com::sun::star::uno::RuntimeException);
//______________________________________
// 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 OUString
The current office locale as BCP47 string.
*/
OUString impl_ts_getLocale() const;
//______________________________________
// helper
private:
void impl_ts_load(sal_Bool bPreferred, const css::uno::Reference< css::container::XNameAccess >& xCfg);
void impl_ts_save(sal_Bool bPreferred, const css::uno::Reference< css::container::XNameAccess >& xCfg);
void insertKeyToConfiguration(const css::awt::KeyEvent& aKeyEvent, const OUString& sCommand, const sal_Bool bPreferred);
void removeKeyFromConfiguration(const css::awt::KeyEvent& aKeyEvent, const sal_Bool bPreferred);
void reloadChanged(const OUString& sPrimarySecondary, const OUString& sGlobalModules, const OUString& sModule, const OUString& sKey);
AcceleratorCache& impl_getCFG(sal_Bool bPreferred, sal_Bool bWriteAccessRequested = sal_False);
};
} // namespace framework
#endif // __FRAMEWORK_ACCELERATORS_ACCELERATORCONFIGURATION_HXX_
2010-10-27 13:11:31 +01:00
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */