diff options
Diffstat (limited to 'framework/source/inc/accelerators/acceleratorcache.hxx')
| -rw-r--r-- | framework/source/inc/accelerators/acceleratorcache.hxx | 44 |
1 files changed, 22 insertions, 22 deletions
diff --git a/framework/source/inc/accelerators/acceleratorcache.hxx b/framework/source/inc/accelerators/acceleratorcache.hxx index 2462ce455f3d..23ec86df8a00 100644 --- a/framework/source/inc/accelerators/acceleratorcache.hxx +++ b/framework/source/inc/accelerators/acceleratorcache.hxx @@ -1,7 +1,7 @@ /************************************************************************* * * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. - * + * * Copyright 2000, 2010 Oracle and/or its affiliates. * * OpenOffice.org - a multi-platform office productivity suite @@ -55,11 +55,11 @@ namespace framework //__________________________________________ /** @short implements a cache for any accelerator configuration. - + @descr Its implemented threadsafe, supports copy-on-write pattern and a flush mechansim to support concurrent access to the same configuration. - + copy-on-write ... How? Do the following: */ class AcceleratorCache : public ThreadHelpBase // attention! Must be the first base class to guarentee right initialize lock ... @@ -68,14 +68,14 @@ class AcceleratorCache : public ThreadHelpBase // attention! Must be the first b // const, types public: - + //--------------------------------------- /** TODO document me commands -> keys */ typedef ::comphelper::SequenceAsVector< css::awt::KeyEvent > TKeyList; typedef BaseHash< TKeyList > TCommand2Keys; - + //--------------------------------------- /** TODO document me keys -> commands @@ -84,21 +84,21 @@ class AcceleratorCache : public ThreadHelpBase // attention! Must be the first b ::rtl::OUString , 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 @@ -107,20 +107,20 @@ class AcceleratorCache : public ThreadHelpBase // attention! Must be the first b //--------------------------------------- /** @short creates a new - but empty - cache instance. */ AcceleratorCache(); - + //--------------------------------------- /** @short make a copy of this cache. - @descr Used for the copy-on-write feature. + @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 the (changed!) copy, which should be written back to this original container. @@ -130,30 +130,30 @@ class AcceleratorCache : public ThreadHelpBase // attention! Must be the first b //--------------------------------------- /** TODO document me */ virtual AcceleratorCache& operator=(const AcceleratorCache& rCopy); - + //--------------------------------------- /** @short checks if the specified key exists. @param aKey the key, which should be checked. - + @return [bool] TRUE if the speicfied key exists inside this container. */ virtual sal_Bool hasKey(const css::awt::KeyEvent& aKey) const; virtual sal_Bool hasCommand(const ::rtl::OUString& sCommand) const; - + //--------------------------------------- /** TODO document me */ virtual TKeyList getAllKeys() const; - + //--------------------------------------- /** @short add a new or change an existing key-command pair of this container. - + @param aKey describe the key. - + @param sCommand describe the command. */ @@ -163,7 +163,7 @@ class AcceleratorCache : public ThreadHelpBase // attention! Must be the first b //--------------------------------------- /** @short returns the list of keys, which are registered for this command. - + @param sCommand describe the command. @@ -171,11 +171,11 @@ class AcceleratorCache : public ThreadHelpBase // attention! Must be the first b the list of registered keys. Can be empty! */ virtual TKeyList getKeysByCommand(const ::rtl::OUString& sCommand) const; - + //--------------------------------------- /** TODO */ virtual ::rtl::OUString getCommandByKey(const css::awt::KeyEvent& aKey) const; - + //--------------------------------------- /** TODO */ virtual void removeKey(const css::awt::KeyEvent& aKey); |