diff options
Diffstat (limited to 'framework/source/inc/accelerators/acceleratorcache.hxx')
-rw-r--r-- | framework/source/inc/accelerators/acceleratorcache.hxx | 40 |
1 files changed, 20 insertions, 20 deletions
diff --git a/framework/source/inc/accelerators/acceleratorcache.hxx b/framework/source/inc/accelerators/acceleratorcache.hxx index 63986d98a41f..341cc85b7230 100644 --- a/framework/source/inc/accelerators/acceleratorcache.hxx +++ b/framework/source/inc/accelerators/acceleratorcache.hxx @@ -28,13 +28,13 @@ #include <comphelper/sequenceasvector.hxx> -//__________________________________________ + // definition namespace framework { -//__________________________________________ + /** @short implements a cache for any accelerator configuration. @@ -46,19 +46,19 @@ namespace framework */ class AcceleratorCache : public ThreadHelpBase // attention! Must be the first base class to guarentee right initialize lock ... { - //______________________________________ + // const, types public: - //--------------------------------------- + /** TODO document me commands -> keys */ typedef ::comphelper::SequenceAsVector< css::awt::KeyEvent > TKeyList; typedef BaseHash< TKeyList > TCommand2Keys; - //--------------------------------------- + /** TODO document me keys -> commands */ @@ -67,40 +67,40 @@ class AcceleratorCache : public ThreadHelpBase // attention! Must be the first b 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 @@ -109,11 +109,11 @@ class AcceleratorCache : public ThreadHelpBase // attention! Must be the first b */ virtual void takeOver(const AcceleratorCache& rCopy); - //--------------------------------------- + /** TODO document me */ AcceleratorCache& operator=(const AcceleratorCache& rCopy); - //--------------------------------------- + /** @short checks if the specified key exists. @param aKey @@ -125,11 +125,11 @@ class AcceleratorCache : public ThreadHelpBase // attention! Must be the first b 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. @@ -142,7 +142,7 @@ class AcceleratorCache : public ThreadHelpBase // attention! Must be the first b virtual void setKeyCommandPair(const css::awt::KeyEvent& aKey , const OUString& sCommand); - //--------------------------------------- + /** @short returns the list of keys, which are registered for this command. @@ -154,11 +154,11 @@ class AcceleratorCache : public ThreadHelpBase // attention! Must be the first b */ 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); |