diff options
Diffstat (limited to 'framework/source/inc/accelerators')
6 files changed, 0 insertions, 119 deletions
diff --git a/framework/source/inc/accelerators/acceleratorcache.hxx b/framework/source/inc/accelerators/acceleratorcache.hxx index 932cfcaf2dc5..a49cb1ca3393 100644 --- a/framework/source/inc/accelerators/acceleratorcache.hxx +++ b/framework/source/inc/accelerators/acceleratorcache.hxx @@ -27,13 +27,11 @@ #include <comphelper/sequenceasvector.hxx> - // definition namespace framework { - /** @short implements a cache for any accelerator configuration. @@ -50,14 +48,12 @@ class AcceleratorCache public: - /** TODO document me commands -> keys */ typedef ::comphelper::SequenceAsVector< css::awt::KeyEvent > TKeyList; typedef BaseHash< TKeyList > TCommand2Keys; - /** TODO document me keys -> commands */ @@ -66,40 +62,32 @@ class AcceleratorCache KeyEventHashCode , KeyEventEqualsFunc > TKey2Commands; - // member private: - /** map commands to keys in relation 1:n. First key is interpreted as preferred one! */ TCommand2Keys m_lCommand2Keys; - /** map keys to commands in relation 1:1. */ TKey2Commands m_lKey2Commands; - // interface public: - /** @short creates a new - but empty - cache instance. */ AcceleratorCache(); - /** @short make a copy of this cache. @descr Used for the copy-on-write feature. */ AcceleratorCache(const AcceleratorCache& rCopy); - /** @short does nothing real. */ virtual ~AcceleratorCache(); - /** @short write changes back to the original container. @param rCopy @@ -108,11 +96,9 @@ class AcceleratorCache */ virtual void takeOver(const AcceleratorCache& rCopy); - /** TODO document me */ AcceleratorCache& operator=(const AcceleratorCache& rCopy); - /** @short checks if the specified key exists. @param aKey @@ -124,11 +110,9 @@ class AcceleratorCache virtual sal_Bool hasKey(const css::awt::KeyEvent& aKey) const; virtual sal_Bool hasCommand(const OUString& sCommand) const; - /** TODO document me */ virtual TKeyList getAllKeys() const; - /** @short add a new or change an existing key-command pair of this container. @@ -141,7 +125,6 @@ class AcceleratorCache virtual void setKeyCommandPair(const css::awt::KeyEvent& aKey , const OUString& sCommand); - /** @short returns the list of keys, which are registered for this command. @@ -153,11 +136,9 @@ class AcceleratorCache */ virtual TKeyList getKeysByCommand(const OUString& sCommand) const; - /** TODO */ virtual OUString getCommandByKey(const css::awt::KeyEvent& aKey) const; - /** TODO */ virtual void removeKey(const css::awt::KeyEvent& aKey); virtual void removeCommand(const OUString& sCommand); diff --git a/framework/source/inc/accelerators/acceleratorconfiguration.hxx b/framework/source/inc/accelerators/acceleratorconfiguration.hxx index 27095364888b..8065456744f6 100644 --- a/framework/source/inc/accelerators/acceleratorconfiguration.hxx +++ b/framework/source/inc/accelerators/acceleratorconfiguration.hxx @@ -50,7 +50,6 @@ #include <cppuhelper/implbase4.hxx> #include <salhelper/singletonref.hxx> - // definition namespace framework @@ -64,7 +63,6 @@ const char CFG_ENTRY_MODULES[] = "Modules"; in combination with the salhelper::SingletonRef mechanism! */ typedef PresetHandler AcceleratorPresets; - /** implements a read/write access to the accelerator configuration. */ @@ -80,12 +78,10 @@ class XMLBasedAcceleratorConfiguration : public IStorageListener, 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 @@ -93,15 +89,12 @@ class XMLBasedAcceleratorConfiguration : public IStorageListener, 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: @@ -109,7 +102,6 @@ class XMLBasedAcceleratorConfiguration : public IStorageListener, XMLBasedAcceleratorConfiguration( const css::uno::Reference< css::uno::XComponentContext >& xContext); virtual ~XMLBasedAcceleratorConfiguration( ); - // uno interface! public: @@ -192,12 +184,10 @@ class XMLBasedAcceleratorConfiguration : public IStorageListener, // 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 @@ -208,12 +198,10 @@ class XMLBasedAcceleratorConfiguration : public IStorageListener, */ OUString impl_ts_getLocale() const; - // helper private: - /** @short load a configuration set, using the given stream. @param xStream @@ -221,7 +209,6 @@ class XMLBasedAcceleratorConfiguration : public IStorageListener, */ void impl_ts_load(const css::uno::Reference< css::io::XInputStream >& xStream); - /** @short save a configuration set, using the given stream. @param xStream @@ -229,7 +216,6 @@ class XMLBasedAcceleratorConfiguration : public IStorageListener, */ 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 @@ -257,7 +243,6 @@ class XMLBasedAcceleratorConfiguration : public IStorageListener, 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 @@ -293,7 +278,6 @@ class XCUBasedAcceleratorConfiguration : public ::cppu::WeakImplHelper4< protected: - /** the global uno service manager. Must be used to create own needed services. */ css::uno::Reference< css::uno::XComponentContext > m_xContext; @@ -309,7 +293,6 @@ class XCUBasedAcceleratorConfiguration : public ::cppu::WeakImplHelper4< ::salhelper::SingletonRef< KeyMapping > m_rKeyMapping; - // native interface! public: @@ -317,7 +300,6 @@ class XCUBasedAcceleratorConfiguration : public ::cppu::WeakImplHelper4< XCUBasedAcceleratorConfiguration( const css::uno::Reference< css::uno::XComponentContext >& xContext ); virtual ~XCUBasedAcceleratorConfiguration( ); - // uno interface! public: @@ -410,12 +392,10 @@ class XCUBasedAcceleratorConfiguration : public ::cppu::WeakImplHelper4< 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 @@ -426,7 +406,6 @@ class XCUBasedAcceleratorConfiguration : public ::cppu::WeakImplHelper4< */ OUString impl_ts_getLocale() const; - // helper private: diff --git a/framework/source/inc/accelerators/istoragelistener.hxx b/framework/source/inc/accelerators/istoragelistener.hxx index 154a1eb0caee..b6786dc6bc79 100644 --- a/framework/source/inc/accelerators/istoragelistener.hxx +++ b/framework/source/inc/accelerators/istoragelistener.hxx @@ -23,14 +23,11 @@ #include <general.h> #include <stdtypes.h> - - // definition namespace framework { - /** TODO document me */ @@ -38,7 +35,6 @@ class IStorageListener { public: - /** @short TODO */ virtual void changesOccurred(const OUString& sPath) = 0; diff --git a/framework/source/inc/accelerators/keymapping.hxx b/framework/source/inc/accelerators/keymapping.hxx index 0336934f4358..be7821e07738 100644 --- a/framework/source/inc/accelerators/keymapping.hxx +++ b/framework/source/inc/accelerators/keymapping.hxx @@ -30,7 +30,6 @@ namespace framework { - /** can be used to map key identifier to the corresponding key codes ... @@ -42,7 +41,6 @@ class KeyMapping private: - /** @short is used to map a key code to the right key identifier, which is used to make the xml file "human readable" @@ -53,33 +51,27 @@ class KeyMapping const char* Identifier; }; - /** @short hash structure to map identifier to key codes. */ typedef BaseHash< sal_Int16 > Identifier2CodeHash; - /** @short hash structure to map key codes to identifier. */ typedef ::boost::unordered_map< sal_Int16 , OUString , ShortHashCode , ::std::equal_to< sal_Int16 > > Code2IdentifierHash; - // member private: static KeyIdentifierInfo KeyIdentifierMap[]; - /** @short hash to map identifier to key codes. */ Identifier2CodeHash m_lIdentifierHash; - /** @short hash to map key codes to identifier. */ Code2IdentifierHash m_lCodeHash; - // interface public: @@ -87,7 +79,6 @@ class KeyMapping KeyMapping(); virtual ~KeyMapping(); - /** @short return a suitable key code for the specified key identifier. @@ -105,7 +96,6 @@ class KeyMapping virtual sal_uInt16 mapIdentifierToCode(const OUString& sIdentifier) throw(css::lang::IllegalArgumentException); - /** @short return a suitable key identifier for the specified key code. @@ -116,19 +106,16 @@ class KeyMapping */ virtual OUString mapCodeToIdentifier(sal_uInt16 nCode); - // helper private: - /** @short check if the given string describe a numeric value ... and convert it. @param sIdentifier the string value, which should be converted. - @param rCode contains the converted code, but is defined only if this method returns sal_True! diff --git a/framework/source/inc/accelerators/presethandler.hxx b/framework/source/inc/accelerators/presethandler.hxx index 86fa1cc13ace..d7cea6a7e097 100644 --- a/framework/source/inc/accelerators/presethandler.hxx +++ b/framework/source/inc/accelerators/presethandler.hxx @@ -52,7 +52,6 @@ namespace framework class PresetHandler { - public: static OUString PRESET_DEFAULT(); @@ -63,12 +62,10 @@ class PresetHandler static OUString RESOURCETYPE_ACCELERATOR(); static OUString RESOURCETYPE_STATUSBAR(); - // types public: - /** @short this handler can provide different types of configuration. @@ -84,7 +81,6 @@ class PresetHandler private: - /** @short because a concurrent access to the same storage from different implementations isnt supported, we have to share it with others. @@ -109,23 +105,19 @@ class PresetHandler virtual ~TSharedStorages() {}; }; - // member private: - /** @short can be used to create on needed uno resources. */ css::uno::Reference< css::uno::XComponentContext > m_xContext; - /** @short knows the type of provided configuration. @descr e.g. global, modules, ... */ EConfigType m_eConfigType; - /** @short specify the type of resource, which configuration sets must be provided here. @@ -133,7 +125,6 @@ class PresetHandler */ OUString m_sResourceType; - /** @short specify the application module for a module dependend configuration. @@ -143,19 +134,16 @@ class PresetHandler */ OUString m_sModule; - /** @short provides access to the: a) shared root storages b) shared "inbetween" storages of the share and user layer. */ ::salhelper::SingletonRef< TSharedStorages > m_aSharedStorages; - /** @short if we run in document mode, we cant use the global root storages! We have to use a special document storage explicitly. */ StorageHolder m_lDocumentStorages; - /** @short holds the folder storage of the share layer alive, where the current configuration set exists. @@ -168,12 +156,10 @@ class PresetHandler */ css::uno::Reference< css::embed::XStorage > m_xWorkingStorageShare; - /** @short global language-independent storage */ css::uno::Reference< css::embed::XStorage > m_xWorkingStorageNoLang; - /** @short holds the folder storage of the user layer alive, where the current configuration set exists. @@ -186,17 +172,14 @@ class PresetHandler */ css::uno::Reference< css::embed::XStorage > m_xWorkingStorageUser; - /** @short knows the names of all presets inside the current working storage of the share layer. */ OUStringList m_lPresets; - /** @short knows the names of all targets inside the current working storage of the user layer. */ OUStringList m_lTargets; - /** @short its the current office locale and will be used to handle localized presets. @@ -204,18 +187,15 @@ class PresetHandler localized handling inside this class! */ LanguageTag m_aLanguageTag; - /** @short knows the relative path from the root. */ OUString m_sRelPathShare; OUString m_sRelPathNoLang; OUString m_sRelPathUser; - // native interface public: - /** @short does nothing real. @descr Because this class should be useable in combination @@ -228,19 +208,15 @@ class PresetHandler */ PresetHandler(const css::uno::Reference< css::uno::XComponentContext >& xContext); - /** @short copy ctor */ PresetHandler(const PresetHandler& rCopy); - /** @short closes all open storages ... if user forgot that .-) */ virtual ~PresetHandler(); - /** @short free all currently cache(!) storages. */ void forgetCachedStorages(); - /** @short return access to the internally used and cached root storage. @descr These root storages are the base of all further opened @@ -258,7 +234,6 @@ class PresetHandler css::uno::Reference< css::embed::XStorage > getOrCreateRootStorageShare(); css::uno::Reference< css::embed::XStorage > getOrCreateRootStorageUser(); - /** @short provides access to the current working storages. @descr Working storages are the "lowest" storages, where the @@ -270,7 +245,6 @@ class PresetHandler css::uno::Reference< css::embed::XStorage > getWorkingStorageShare(); css::uno::Reference< css::embed::XStorage > getWorkingStorageUser(); - /** @short check if there is a parent storage well known for the specified child storage and return it. @@ -283,7 +257,6 @@ class PresetHandler css::uno::Reference< css::embed::XStorage > getParentStorageShare(const css::uno::Reference< css::embed::XStorage >& xChild); css::uno::Reference< css::embed::XStorage > getParentStorageUser (const css::uno::Reference< css::embed::XStorage >& xChild); - /** @short free all internal structures and let this handler work on a new type of configuration sets. @@ -324,7 +297,6 @@ class PresetHandler const css::uno::Reference< css::embed::XStorage >& xDocumentRoot , const LanguageTag& rLanguageTag = LanguageTag(LANGUAGE_USER_PRIV_NOTRANSLATE)); - /** @short try to copy the specified preset from the share layer to the user layer and establish it as the specified target. @@ -348,7 +320,6 @@ class PresetHandler void copyPresetToTarget(const OUString& sPreset, const OUString& sTarget); - /** @short open the specified preset as stream object and return it. @@ -366,7 +337,6 @@ class PresetHandler css::uno::Reference< css::io::XStream > openPreset(const OUString& sPreset, sal_Bool bUseNoLangGlobal = sal_False); - /** @short open the specified target as stream object and return it. @@ -388,7 +358,6 @@ class PresetHandler css::uno::Reference< css::io::XStream > openTarget(const OUString& sTarget , sal_Bool bCreateIfMissing); - /** @short do anything which is necessary to flush all changes back to disk. @@ -398,17 +367,14 @@ class PresetHandler */ void commitUserChanges(); - /** TODO */ void addStorageListener(IStorageListener* pListener); void removeStorageListener(IStorageListener* pListener); - // helper private: - /** @short open a config path ignoring errors (catching exceptions). @descr We catch only normal exceptions here - no runtime exceptions. @@ -428,7 +394,6 @@ class PresetHandler sal_Int32 eMode , sal_Bool bShare); - /** @short try to find the specified locale inside list of possible ones. @descr The lits of possible locale values was e.g. retrieved from the system @@ -455,7 +420,6 @@ class PresetHandler OUString& rLanguageTag , sal_Bool bAllowFallbacks ); - /** @short open a config path ignoring errors (catching exceptions). @descr We catch only normal exceptions here - no runtime exceptions. @@ -489,7 +453,6 @@ class PresetHandler OUString& rLanguageTag , sal_Bool bAllowFallback); - /** @short returns the names of all sub storages of specified storage. @param xFolder diff --git a/framework/source/inc/accelerators/storageholder.hxx b/framework/source/inc/accelerators/storageholder.hxx index 07c0b116c999..c0c4269dba66 100644 --- a/framework/source/inc/accelerators/storageholder.hxx +++ b/framework/source/inc/accelerators/storageholder.hxx @@ -26,12 +26,9 @@ #include <com/sun/star/embed/XStorage.hpp> - namespace framework { - - /** TODO document me */ @@ -64,7 +61,6 @@ class StorageHolder OUStringHash , ::std::equal_to< OUString > > TPath2StorageInfo; - // member private: mutable osl::Mutex m_mutex; @@ -75,95 +71,77 @@ class StorageHolder /** @short TODO */ TPath2StorageInfo m_lStorages; - // interface public: - /** @short TODO */ StorageHolder(); - /** @short TODO */ virtual ~StorageHolder(); - /** @short TODO */ virtual void forgetCachedStorages(); - /** @short TODO */ virtual void setRootStorage(const css::uno::Reference< css::embed::XStorage >& xRoot); - /** @short TODO */ virtual css::uno::Reference< css::embed::XStorage > getRootStorage() const; - /** @short TODO open or get! */ virtual css::uno::Reference< css::embed::XStorage > openPath(const OUString& sPath , sal_Int32 nOpenMode); - /** @short TODO */ virtual StorageHolder::TStorageList getAllPathStorages(const OUString& sPath); - /** @short TODO */ virtual void commitPath(const OUString& sPath); - /** @short TODO */ virtual void closePath(const OUString& sPath); - /** @short TODO */ virtual void notifyPath(const OUString& sPath); - /** @short TODO */ virtual void addStorageListener( IStorageListener* pListener, const OUString& sPath ); - /** @short TODO */ virtual void removeStorageListener( IStorageListener* pListener, const OUString& sPath ); - /** @short TODO */ virtual OUString getPathOfStorage(const css::uno::Reference< css::embed::XStorage >& xStorage); - /** @short TODO */ virtual css::uno::Reference< css::embed::XStorage > getParentStorage(const css::uno::Reference< css::embed::XStorage >& xChild); - /** @short TODO */ virtual css::uno::Reference< css::embed::XStorage > getParentStorage(const OUString& sChildPath); - /** @short TODO */ void operator=(const StorageHolder& rCopy); - /** @short opens a sub element of the specified base storage. @descr First this method try to open the requested sub element @@ -197,16 +175,13 @@ class StorageHolder sal_Int32 eOpenMode , sal_Bool bAllowFallback); - // helper private: - /** @short TODO */ static OUString impl_st_normPath(const OUString& sPath); - /** @short TODO */ static OUStringList impl_st_parsePath(const OUString& sPath); |