LibreOffice Module framework (master) 1
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
framework::XCUBasedAcceleratorConfiguration Class Reference

#include <acceleratorconfiguration.hxx>

Inheritance diagram for framework::XCUBasedAcceleratorConfiguration:
[legend]
Collaboration diagram for framework::XCUBasedAcceleratorConfiguration:
[legend]

Public Member Functions

 XCUBasedAcceleratorConfiguration (css::uno::Reference< css::uno::XComponentContext > xContext)
 
virtual ~XCUBasedAcceleratorConfiguration () override
 
virtual css::uno::Sequence< css::awt::KeyEvent > SAL_CALL getAllKeyEvents () override
 
virtual OUString SAL_CALL getCommandByKeyEvent (const css::awt::KeyEvent &aKeyEvent) override
 
virtual void SAL_CALL setKeyEvent (const css::awt::KeyEvent &aKeyEvent, const OUString &sCommand) override
 
virtual void SAL_CALL removeKeyEvent (const css::awt::KeyEvent &aKeyEvent) override
 
virtual css::uno::Sequence< css::awt::KeyEvent > SAL_CALL getKeyEventsByCommand (const OUString &sCommand) override
 
virtual css::uno::Sequence< css::uno::Any > SAL_CALL getPreferredKeyEventsForCommandList (const css::uno::Sequence< OUString > &lCommandList) override
 
virtual void SAL_CALL removeCommandFromAllKeyEvents (const OUString &sCommand) override
 
virtual void SAL_CALL reload () override
 
virtual void SAL_CALL store () override
 
virtual void SAL_CALL storeToStorage (const css::uno::Reference< css::embed::XStorage > &xStorage) override
 
virtual sal_Bool SAL_CALL isModified () override
 
virtual sal_Bool SAL_CALL isReadOnly () override
 
virtual void SAL_CALL setStorage (const css::uno::Reference< css::embed::XStorage > &xStorage) override
 
virtual sal_Bool SAL_CALL hasStorage () override
 
virtual void SAL_CALL addConfigurationListener (const css::uno::Reference< css::ui::XUIConfigurationListener > &xListener) override
 
virtual void SAL_CALL removeConfigurationListener (const css::uno::Reference< css::ui::XUIConfigurationListener > &xListener) override
 
virtual void SAL_CALL reset () override
 
virtual void SAL_CALL addResetListener (const css::uno::Reference< css::form::XResetListener > &xListener) override
 
virtual void SAL_CALL removeResetListener (const css::uno::Reference< css::form::XResetListener > &xListener) override
 
virtual void SAL_CALL changesOccurred (const css::util::ChangesEvent &aEvent) override
 
virtual void SAL_CALL disposing (const css::lang::EventObject &aEvent) override
 

Protected Member Functions

OUString impl_ts_getLocale () const
 return the current office locale. More...
 

Protected Attributes

css::uno::Reference< css::uno::XComponentContext > m_xContext
 the global uno service manager. More...
 
css::uno::Reference< css::container::XNameAccess > m_xCfg
 
AcceleratorCache m_aPrimaryReadCache
 
AcceleratorCache m_aSecondaryReadCache
 
std::unique_ptr< AcceleratorCache > m_pPrimaryWriteCache
 
std::unique_ptr< AcceleratorCache > m_pSecondaryWriteCache
 
OUString m_sGlobalOrModules
 
OUString m_sModuleCFG
 

Private Member Functions

void impl_ts_load (bool bPreferred, const css::uno::Reference< css::container::XNameAccess > &xCfg)
 
void impl_ts_save (bool bPreferred)
 
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, std::u16string_view sGlobalModules, const OUString &sModule, const OUString &sKey)
 
AcceleratorCache & impl_getCFG (bool bPreferred, bool bWriteAccessRequested=false)
 

Detailed Description

Definition at line 194 of file acceleratorconfiguration.hxx.

Constructor & Destructor Documentation

◆ XCUBasedAcceleratorConfiguration()

framework::XCUBasedAcceleratorConfiguration::XCUBasedAcceleratorConfiguration ( css::uno::Reference< css::uno::XComponentContext >  xContext)

Definition at line 482 of file acceleratorconfiguration.cxx.

References m_xCfg, m_xContext, and comphelper::ConfigurationHelper::openConfig().

◆ ~XCUBasedAcceleratorConfiguration()

framework::XCUBasedAcceleratorConfiguration::~XCUBasedAcceleratorConfiguration ( )
overridevirtual

Definition at line 490 of file acceleratorconfiguration.cxx.

Member Function Documentation

◆ addConfigurationListener()

void SAL_CALL framework::XCUBasedAcceleratorConfiguration::addConfigurationListener ( const css::uno::Reference< css::ui::XUIConfigurationListener > &  xListener)
overridevirtual

Definition at line 859 of file acceleratorconfiguration.cxx.

References SAL_INFO.

◆ addResetListener()

void SAL_CALL framework::XCUBasedAcceleratorConfiguration::addResetListener ( const css::uno::Reference< css::form::XResetListener > &  xListener)
overridevirtual

Definition at line 889 of file acceleratorconfiguration.cxx.

References SAL_INFO.

◆ changesOccurred()

void SAL_CALL framework::XCUBasedAcceleratorConfiguration::changesOccurred ( const css::util::ChangesEvent &  aEvent)
overridevirtual

Definition at line 899 of file acceleratorconfiguration.cxx.

References aEvent, framework::CFG_ENTRY_GLOBAL, framework::CFG_ENTRY_MODULES, i, reloadChanged(), and SAL_INFO.

◆ disposing()

void SAL_CALL framework::XCUBasedAcceleratorConfiguration::disposing ( const css::lang::EventObject &  aEvent)
overridevirtual

Definition at line 947 of file acceleratorconfiguration.cxx.

◆ getAllKeyEvents()

css::uno::Sequence< css::awt::KeyEvent > SAL_CALL framework::XCUBasedAcceleratorConfiguration::getAllKeyEvents ( )
overridevirtual

Definition at line 494 of file acceleratorconfiguration.cxx.

References comphelper::containerToSequence(), framework::AcceleratorCache::getAllKeys(), and impl_getCFG().

◆ getCommandByKeyEvent()

OUString SAL_CALL framework::XCUBasedAcceleratorConfiguration::getCommandByKeyEvent ( const css::awt::KeyEvent &  aKeyEvent)
overridevirtual

Definition at line 508 of file acceleratorconfiguration.cxx.

References framework::AcceleratorCache::getCommandByKey(), framework::AcceleratorCache::hasKey(), and impl_getCFG().

◆ getKeyEventsByCommand()

css::uno::Sequence< css::awt::KeyEvent > SAL_CALL framework::XCUBasedAcceleratorConfiguration::getKeyEventsByCommand ( const OUString &  sCommand)
overridevirtual

Definition at line 642 of file acceleratorconfiguration.cxx.

References comphelper::containerToSequence(), framework::AcceleratorCache::getKeysByCommand(), framework::AcceleratorCache::hasCommand(), and impl_getCFG().

◆ getPreferredKeyEventsForCommandList()

css::uno::Sequence< css::uno::Any > SAL_CALL framework::XCUBasedAcceleratorConfiguration::getPreferredKeyEventsForCommandList ( const css::uno::Sequence< OUString > &  lCommandList)
overridevirtual

Definition at line 675 of file acceleratorconfiguration.cxx.

References framework::AcceleratorCache::getKeysByCommand(), framework::AcceleratorCache::hasCommand(), i, impl_getCFG(), and framework::lcl_getPreferredKey().

◆ hasStorage()

sal_Bool SAL_CALL framework::XCUBasedAcceleratorConfiguration::hasStorage ( )
overridevirtual

Definition at line 853 of file acceleratorconfiguration.cxx.

References SAL_INFO.

◆ impl_getCFG()

AcceleratorCache & framework::XCUBasedAcceleratorConfiguration::impl_getCFG ( bool  bPreferred,
bool  bWriteAccessRequested = false 
)
private

Definition at line 1275 of file acceleratorconfiguration.cxx.

References m_aPrimaryReadCache, m_aSecondaryReadCache, m_pPrimaryWriteCache, and m_pSecondaryWriteCache.

Referenced by getAllKeyEvents(), getCommandByKeyEvent(), getKeyEventsByCommand(), getPreferredKeyEventsForCommandList(), removeCommandFromAllKeyEvents(), removeKeyEvent(), setKeyEvent(), and store().

◆ impl_ts_getLocale()

OUString framework::XCUBasedAcceleratorConfiguration::impl_ts_getLocale ( ) const
protected

return the current office locale.

@descr We do not cache this value, because we are not listen for changes on the configuration layer ...

Returns
OUString The current office locale as BCP47 string.

Definition at line 1314 of file acceleratorconfiguration.cxx.

Referenced by impl_ts_load(), insertKeyToConfiguration(), and reloadChanged().

◆ impl_ts_load()

void framework::XCUBasedAcceleratorConfiguration::impl_ts_load ( bool  bPreferred,
const css::uno::Reference< css::container::XNameAccess > &  xCfg 
)
private

Definition at line 951 of file acceleratorconfiguration.cxx.

References framework::CFG_ENTRY_GLOBAL, framework::CFG_ENTRY_MODULES, framework::CFG_PROP_COMMAND, framework::KeyMapping::get(), o3tl::getToken(), framework::AcceleratorCache::hasKey(), i, impl_ts_getLocale(), m_aPrimaryReadCache, m_aSecondaryReadCache, m_sGlobalOrModules, m_sModuleCFG, framework::KeyMapping::mapIdentifierToCode(), nIndex, nToken, framework::AcceleratorCache::setKeyCommandPair(), and u.

Referenced by reload().

◆ impl_ts_save()

void framework::XCUBasedAcceleratorConfiguration::impl_ts_save ( bool  bPreferred)
private

Definition at line 1059 of file acceleratorconfiguration.cxx.

References comphelper::ConfigurationHelper::flush(), framework::AcceleratorCache::getAllKeys(), framework::AcceleratorCache::getCommandByKey(), framework::AcceleratorCache::hasKey(), insertKeyToConfiguration(), m_aPrimaryReadCache, m_aSecondaryReadCache, m_pPrimaryWriteCache, m_pSecondaryWriteCache, m_xCfg, and removeKeyFromConfiguration().

Referenced by store().

◆ insertKeyToConfiguration()

void framework::XCUBasedAcceleratorConfiguration::insertKeyToConfiguration ( const css::awt::KeyEvent &  aKeyEvent,
const OUString &  sCommand,
const bool  bPreferred 
)
private

Definition at line 1136 of file acceleratorconfiguration.cxx.

References framework::CFG_ENTRY_GLOBAL, framework::CFG_ENTRY_MODULES, framework::CFG_ENTRY_PRIMARY, framework::CFG_ENTRY_SECONDARY, framework::CFG_PROP_COMMAND, impl_ts_getLocale(), framework::lcl_getKeyString(), m_sGlobalOrModules, m_sModuleCFG, and m_xCfg.

Referenced by impl_ts_save().

◆ isModified()

sal_Bool SAL_CALL framework::XCUBasedAcceleratorConfiguration::isModified ( )
overridevirtual

Definition at line 838 of file acceleratorconfiguration.cxx.

◆ isReadOnly()

sal_Bool SAL_CALL framework::XCUBasedAcceleratorConfiguration::isReadOnly ( )
overridevirtual

Definition at line 843 of file acceleratorconfiguration.cxx.

◆ reload()

void SAL_CALL framework::XCUBasedAcceleratorConfiguration::reload ( )
overridevirtual

Definition at line 736 of file acceleratorconfiguration.cxx.

References framework::CFG_ENTRY_PRIMARY, framework::CFG_ENTRY_SECONDARY, impl_ts_load(), m_aPrimaryReadCache, m_aSecondaryReadCache, m_pPrimaryWriteCache, m_pSecondaryWriteCache, m_xCfg, and SAL_INFO.

Referenced by reset().

◆ reloadChanged()

void framework::XCUBasedAcceleratorConfiguration::reloadChanged ( const OUString &  sPrimarySecondary,
std::u16string_view  sGlobalModules,
const OUString &  sModule,
const OUString &  sKey 
)
private

Definition at line 1207 of file acceleratorconfiguration.cxx.

References framework::CFG_ENTRY_GLOBAL, framework::CFG_ENTRY_MODULES, framework::CFG_ENTRY_PRIMARY, framework::CFG_ENTRY_SECONDARY, framework::CFG_PROP_COMMAND, framework::KeyMapping::get(), o3tl::getToken(), i, impl_ts_getLocale(), m_aPrimaryReadCache, m_aSecondaryReadCache, m_xCfg, framework::KeyMapping::mapIdentifierToCode(), nIndex, nToken, framework::AcceleratorCache::removeKey(), framework::AcceleratorCache::setKeyCommandPair(), and u.

Referenced by changesOccurred().

◆ removeCommandFromAllKeyEvents()

void SAL_CALL framework::XCUBasedAcceleratorConfiguration::removeCommandFromAllKeyEvents ( const OUString &  sCommand)
overridevirtual

Definition at line 712 of file acceleratorconfiguration.cxx.

References framework::AcceleratorCache::hasCommand(), impl_getCFG(), and framework::AcceleratorCache::removeCommand().

◆ removeConfigurationListener()

void SAL_CALL framework::XCUBasedAcceleratorConfiguration::removeConfigurationListener ( const css::uno::Reference< css::ui::XUIConfigurationListener > &  xListener)
overridevirtual

Definition at line 864 of file acceleratorconfiguration.cxx.

References SAL_INFO.

◆ removeKeyEvent()

void SAL_CALL framework::XCUBasedAcceleratorConfiguration::removeKeyEvent ( const css::awt::KeyEvent &  aKeyEvent)
overridevirtual

Definition at line 606 of file acceleratorconfiguration.cxx.

References framework::AcceleratorCache::getCommandByKey(), framework::AcceleratorCache::getKeysByCommand(), framework::AcceleratorCache::hasCommand(), framework::AcceleratorCache::hasKey(), impl_getCFG(), framework::AcceleratorCache::removeKey(), and framework::AcceleratorCache::setKeyCommandPair().

◆ removeKeyFromConfiguration()

void framework::XCUBasedAcceleratorConfiguration::removeKeyFromConfiguration ( const css::awt::KeyEvent &  aKeyEvent,
const bool  bPreferred 
)
private

Definition at line 1182 of file acceleratorconfiguration.cxx.

References framework::CFG_ENTRY_GLOBAL, framework::CFG_ENTRY_MODULES, framework::CFG_ENTRY_PRIMARY, framework::CFG_ENTRY_SECONDARY, framework::lcl_getKeyString(), m_sGlobalOrModules, m_sModuleCFG, and m_xCfg.

Referenced by impl_ts_save().

◆ removeResetListener()

void SAL_CALL framework::XCUBasedAcceleratorConfiguration::removeResetListener ( const css::uno::Reference< css::form::XResetListener > &  xListener)
overridevirtual

Definition at line 894 of file acceleratorconfiguration.cxx.

References SAL_INFO.

◆ reset()

void SAL_CALL framework::XCUBasedAcceleratorConfiguration::reset ( )
overridevirtual

Definition at line 869 of file acceleratorconfiguration.cxx.

References framework::CFG_ENTRY_GLOBAL, framework::CFG_ENTRY_MODULES, m_xCfg, m_xContext, comphelper::ConfigurationHelper::openConfig(), and reload().

◆ setKeyEvent()

void SAL_CALL framework::XCUBasedAcceleratorConfiguration::setKeyEvent ( const css::awt::KeyEvent &  aKeyEvent,
const OUString &  sCommand 
)
overridevirtual

Definition at line 526 of file acceleratorconfiguration.cxx.

References framework::AcceleratorCache::getCommandByKey(), framework::AcceleratorCache::getKeysByCommand(), framework::AcceleratorCache::hasCommand(), framework::AcceleratorCache::hasKey(), impl_getCFG(), framework::AcceleratorCache::removeKey(), SAL_INFO, and framework::AcceleratorCache::setKeyCommandPair().

◆ setStorage()

void SAL_CALL framework::XCUBasedAcceleratorConfiguration::setStorage ( const css::uno::Reference< css::embed::XStorage > &  xStorage)
overridevirtual

Definition at line 848 of file acceleratorconfiguration.cxx.

References SAL_INFO.

◆ store()

void SAL_CALL framework::XCUBasedAcceleratorConfiguration::store ( )
overridevirtual

Definition at line 758 of file acceleratorconfiguration.cxx.

References impl_getCFG(), impl_ts_save(), and SAL_INFO.

◆ storeToStorage()

void SAL_CALL framework::XCUBasedAcceleratorConfiguration::storeToStorage ( const css::uno::Reference< css::embed::XStorage > &  xStorage)
overridevirtual

Definition at line 777 of file acceleratorconfiguration.cxx.

References framework::AcceleratorConfigurationWriter::flush(), framework::AcceleratorCache::getAllKeys(), framework::AcceleratorCache::getCommandByKey(), m_aPrimaryReadCache, m_aSecondaryReadCache, m_pPrimaryWriteCache, m_pSecondaryWriteCache, m_xContext, framework::AcceleratorCache::setKeyCommandPair(), and xStream.

Member Data Documentation

◆ m_aPrimaryReadCache

AcceleratorCache framework::XCUBasedAcceleratorConfiguration::m_aPrimaryReadCache
protected

Definition at line 211 of file acceleratorconfiguration.hxx.

Referenced by impl_getCFG(), impl_ts_load(), impl_ts_save(), reload(), reloadChanged(), and storeToStorage().

◆ m_aSecondaryReadCache

AcceleratorCache framework::XCUBasedAcceleratorConfiguration::m_aSecondaryReadCache
protected

Definition at line 212 of file acceleratorconfiguration.hxx.

Referenced by impl_getCFG(), impl_ts_load(), impl_ts_save(), reload(), reloadChanged(), and storeToStorage().

◆ m_pPrimaryWriteCache

std::unique_ptr<AcceleratorCache> framework::XCUBasedAcceleratorConfiguration::m_pPrimaryWriteCache
protected

Definition at line 213 of file acceleratorconfiguration.hxx.

Referenced by impl_getCFG(), impl_ts_save(), reload(), and storeToStorage().

◆ m_pSecondaryWriteCache

std::unique_ptr<AcceleratorCache> framework::XCUBasedAcceleratorConfiguration::m_pSecondaryWriteCache
protected

Definition at line 214 of file acceleratorconfiguration.hxx.

Referenced by impl_getCFG(), impl_ts_save(), reload(), and storeToStorage().

◆ m_sGlobalOrModules

OUString framework::XCUBasedAcceleratorConfiguration::m_sGlobalOrModules
protected

Definition at line 216 of file acceleratorconfiguration.hxx.

Referenced by impl_ts_load(), insertKeyToConfiguration(), and removeKeyFromConfiguration().

◆ m_sModuleCFG

OUString framework::XCUBasedAcceleratorConfiguration::m_sModuleCFG
protected

Definition at line 217 of file acceleratorconfiguration.hxx.

Referenced by impl_ts_load(), insertKeyToConfiguration(), and removeKeyFromConfiguration().

◆ m_xCfg

css::uno::Reference< css::container::XNameAccess > framework::XCUBasedAcceleratorConfiguration::m_xCfg
protected

Definition at line 210 of file acceleratorconfiguration.hxx.

Referenced by impl_ts_save(), insertKeyToConfiguration(), reload(), reloadChanged(), removeKeyFromConfiguration(), reset(), and XCUBasedAcceleratorConfiguration().

◆ m_xContext

css::uno::Reference< css::uno::XComponentContext > framework::XCUBasedAcceleratorConfiguration::m_xContext
protected

the global uno service manager.

Must be used to create own needed services.

Definition at line 208 of file acceleratorconfiguration.hxx.

Referenced by reset(), storeToStorage(), and XCUBasedAcceleratorConfiguration().

The documentation for this class was generated from the following files:
Generated on Sun Jul 30 2023 04:33:46 for LibreOffice Module framework (master) by doxygen 1.9.3