425 lines
18 KiB
C++
425 lines
18 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
|
|
/*
|
|
* 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 INCLUDED_FRAMEWORK_SOURCE_INC_ACCELERATORS_ACCELERATORCONFIGURATION_HXX
|
|
#define INCLUDED_FRAMEWORK_SOURCE_INC_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 <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
|
|
{
|
|
|
|
const char CFG_ENTRY_PRIMARY[] = "PrimaryKeys";
|
|
const char CFG_ENTRY_GLOBAL[] = "Global";
|
|
const char CFG_ENTRY_MODULES[] = "Modules";
|
|
|
|
/**
|
|
implements a read/write access to the accelerator configuration.
|
|
*/
|
|
class XMLBasedAcceleratorConfiguration : 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, std::exception) SAL_OVERRIDE;
|
|
|
|
virtual OUString SAL_CALL getCommandByKeyEvent(const css::awt::KeyEvent& aKeyEvent)
|
|
throw(css::container::NoSuchElementException,
|
|
css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
|
|
|
|
virtual void SAL_CALL setKeyEvent(const css::awt::KeyEvent& aKeyEvent,
|
|
const OUString& sCommand )
|
|
throw(css::lang::IllegalArgumentException,
|
|
css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
|
|
|
|
virtual void SAL_CALL removeKeyEvent(const css::awt::KeyEvent& aKeyEvent)
|
|
throw(css::container::NoSuchElementException,
|
|
css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
|
|
|
|
virtual css::uno::Sequence< css::awt::KeyEvent > SAL_CALL getKeyEventsByCommand(const OUString& sCommand)
|
|
throw(css::lang::IllegalArgumentException ,
|
|
css::container::NoSuchElementException,
|
|
css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
|
|
|
|
virtual css::uno::Sequence< css::uno::Any > SAL_CALL getPreferredKeyEventsForCommandList(const css::uno::Sequence< OUString >& lCommandList)
|
|
throw (css::lang::IllegalArgumentException, css::container::NoSuchElementException,
|
|
css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
virtual void SAL_CALL removeCommandFromAllKeyEvents(const OUString& sCommand)
|
|
throw(css::lang::IllegalArgumentException ,
|
|
css::container::NoSuchElementException,
|
|
css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
|
|
|
|
// XUIConfigurationPersistence
|
|
virtual void SAL_CALL reload()
|
|
throw(css::uno::Exception ,
|
|
css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
virtual void SAL_CALL store()
|
|
throw(css::uno::Exception ,
|
|
css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
virtual void SAL_CALL storeToStorage(const css::uno::Reference< css::embed::XStorage >& xStorage)
|
|
throw(css::uno::Exception ,
|
|
css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
virtual sal_Bool SAL_CALL isModified()
|
|
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
virtual sal_Bool SAL_CALL isReadOnly()
|
|
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
// XUIConfigurationStorage
|
|
virtual void SAL_CALL setStorage(const css::uno::Reference< css::embed::XStorage >& xStorage)
|
|
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
virtual sal_Bool SAL_CALL hasStorage()
|
|
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
// XUIConfiguration
|
|
virtual void SAL_CALL addConfigurationListener(const css::uno::Reference< css::ui::XUIConfigurationListener >& xListener)
|
|
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
virtual void SAL_CALL removeConfigurationListener(const css::uno::Reference< css::ui::XUIConfigurationListener >& xListener)
|
|
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
// XReset
|
|
// TODO use XPresetHandler instead if available
|
|
virtual void SAL_CALL reset()
|
|
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
virtual void SAL_CALL addResetListener(const css::uno::Reference< css::form::XResetListener >& xListener)
|
|
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
virtual void SAL_CALL removeResetListener(const css::uno::Reference< css::form::XResetListener >& xListener)
|
|
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
// IStorageListener
|
|
virtual void changesOccurred(const OUString& sPath) SAL_OVERRIDE;
|
|
|
|
// helper for derived classes
|
|
|
|
protected:
|
|
|
|
/** @short return the current office locale.
|
|
|
|
@descr We do 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 ,
|
|
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 internally. 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 wish 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(bool bWriteAccessRequested = false);
|
|
|
|
};
|
|
|
|
class XCUBasedAcceleratorConfiguration : 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, std::exception) SAL_OVERRIDE;
|
|
|
|
virtual OUString SAL_CALL getCommandByKeyEvent(const css::awt::KeyEvent& aKeyEvent)
|
|
throw(css::container::NoSuchElementException,
|
|
css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
|
|
|
|
virtual void SAL_CALL setKeyEvent(const css::awt::KeyEvent& aKeyEvent,
|
|
const OUString& sCommand )
|
|
throw (css::lang::IllegalArgumentException, css::container::NoSuchElementException,
|
|
css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
virtual void SAL_CALL removeKeyEvent(const css::awt::KeyEvent& aKeyEvent)
|
|
throw(css::container::NoSuchElementException,
|
|
css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
|
|
|
|
virtual css::uno::Sequence< css::awt::KeyEvent > SAL_CALL getKeyEventsByCommand(const OUString& sCommand)
|
|
throw(css::lang::IllegalArgumentException ,
|
|
css::container::NoSuchElementException,
|
|
css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
|
|
|
|
virtual css::uno::Sequence< css::uno::Any > SAL_CALL getPreferredKeyEventsForCommandList(const css::uno::Sequence< OUString >& lCommandList)
|
|
throw(css::lang::IllegalArgumentException, css::container::NoSuchElementException,
|
|
css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
virtual void SAL_CALL removeCommandFromAllKeyEvents(const OUString& sCommand)
|
|
throw(css::lang::IllegalArgumentException ,
|
|
css::container::NoSuchElementException,
|
|
css::uno::RuntimeException, std::exception ) SAL_OVERRIDE;
|
|
|
|
// XUIConfigurationPersistence
|
|
virtual void SAL_CALL reload()
|
|
throw(css::uno::Exception ,
|
|
css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
virtual void SAL_CALL store()
|
|
throw(css::uno::Exception ,
|
|
css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
virtual void SAL_CALL storeToStorage(const css::uno::Reference< css::embed::XStorage >& xStorage)
|
|
throw(css::uno::Exception ,
|
|
css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
virtual sal_Bool SAL_CALL isModified()
|
|
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
virtual sal_Bool SAL_CALL isReadOnly()
|
|
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
// XUIConfigurationStorage
|
|
virtual void SAL_CALL setStorage(const css::uno::Reference< css::embed::XStorage >& xStorage)
|
|
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
virtual sal_Bool SAL_CALL hasStorage()
|
|
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
// XUIConfiguration
|
|
virtual void SAL_CALL addConfigurationListener(const css::uno::Reference< css::ui::XUIConfigurationListener >& xListener)
|
|
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
virtual void SAL_CALL removeConfigurationListener(const css::uno::Reference< css::ui::XUIConfigurationListener >& xListener)
|
|
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
// XReset
|
|
// TODO use XPresetHandler instead if available
|
|
virtual void SAL_CALL reset()
|
|
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
virtual void SAL_CALL addResetListener(const css::uno::Reference< css::form::XResetListener >& xListener)
|
|
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
virtual void SAL_CALL removeResetListener(const css::uno::Reference< css::form::XResetListener >& xListener)
|
|
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
// css.util.XChangesListener
|
|
virtual void SAL_CALL changesOccurred(const css::util::ChangesEvent& aEvent)
|
|
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
// css.lang.XEventListener
|
|
virtual void SAL_CALL disposing(const css::lang::EventObject& aEvent)
|
|
throw(css::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
// XComponent
|
|
virtual void SAL_CALL dispose() throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
virtual void SAL_CALL addEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& xListener ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
virtual void SAL_CALL removeEventListener( const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XEventListener >& aListener ) throw (::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
|
|
|
|
// helper for derived classes
|
|
|
|
protected:
|
|
|
|
/** @short return the current office locale.
|
|
|
|
@descr We do 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(bool bPreferred, const css::uno::Reference< css::container::XNameAccess >& xCfg);
|
|
void impl_ts_save(bool bPreferred, const css::uno::Reference< css::container::XNameAccess >& xCfg);
|
|
|
|
void insertKeyToConfiguration(const css::awt::KeyEvent& aKeyEvent, const OUString& sCommand, const bool bPreferred);
|
|
void removeKeyFromConfiguration(const css::awt::KeyEvent& aKeyEvent, const bool bPreferred);
|
|
|
|
void reloadChanged(const OUString& sPrimarySecondary, const OUString& sGlobalModules, const OUString& sModule, const OUString& sKey);
|
|
AcceleratorCache& impl_getCFG(bool bPreferred, bool bWriteAccessRequested = false);
|
|
|
|
};
|
|
|
|
} // namespace framework
|
|
|
|
#endif // INCLUDED_FRAMEWORK_SOURCE_INC_ACCELERATORS_ACCELERATORCONFIGURATION_HXX
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|