1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef __FRAMEWORK_ACCELERATORS_ACCELERATORCACHE_HXX_ 25*b1cdbd2cSJim Jagielski #define __FRAMEWORK_ACCELERATORS_ACCELERATORCACHE_HXX_ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski //__________________________________________ 28*b1cdbd2cSJim Jagielski // own includes 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski #include <threadhelp/threadhelpbase.hxx> 31*b1cdbd2cSJim Jagielski #include <general.h> 32*b1cdbd2cSJim Jagielski #include <stdtypes.h> 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski //__________________________________________ 35*b1cdbd2cSJim Jagielski // interface includes 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielski #ifndef __COM_SUN_STAR_AWT_KEYEVENT_HPP_ 38*b1cdbd2cSJim Jagielski #include <com/sun/star/awt/KeyEvent.hpp> 39*b1cdbd2cSJim Jagielski #endif 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski //__________________________________________ 42*b1cdbd2cSJim Jagielski // other includes 43*b1cdbd2cSJim Jagielski #include <comphelper/sequenceasvector.hxx> 44*b1cdbd2cSJim Jagielski 45*b1cdbd2cSJim Jagielski //__________________________________________ 46*b1cdbd2cSJim Jagielski // definition 47*b1cdbd2cSJim Jagielski 48*b1cdbd2cSJim Jagielski namespace framework 49*b1cdbd2cSJim Jagielski { 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski //__________________________________________ 52*b1cdbd2cSJim Jagielski /** 53*b1cdbd2cSJim Jagielski @short implements a cache for any accelerator configuration. 54*b1cdbd2cSJim Jagielski 55*b1cdbd2cSJim Jagielski @descr Its implemented threadsafe, supports copy-on-write pattern 56*b1cdbd2cSJim Jagielski and a flush mechansim to support concurrent access to the same 57*b1cdbd2cSJim Jagielski configuration. 58*b1cdbd2cSJim Jagielski 59*b1cdbd2cSJim Jagielski copy-on-write ... How? Do the following: 60*b1cdbd2cSJim Jagielski */ 61*b1cdbd2cSJim Jagielski class AcceleratorCache : public ThreadHelpBase // attention! Must be the first base class to guarentee right initialize lock ... 62*b1cdbd2cSJim Jagielski { 63*b1cdbd2cSJim Jagielski //______________________________________ 64*b1cdbd2cSJim Jagielski // const, types 65*b1cdbd2cSJim Jagielski 66*b1cdbd2cSJim Jagielski public: 67*b1cdbd2cSJim Jagielski 68*b1cdbd2cSJim Jagielski //--------------------------------------- 69*b1cdbd2cSJim Jagielski /** TODO document me 70*b1cdbd2cSJim Jagielski commands -> keys 71*b1cdbd2cSJim Jagielski */ 72*b1cdbd2cSJim Jagielski typedef ::comphelper::SequenceAsVector< css::awt::KeyEvent > TKeyList; 73*b1cdbd2cSJim Jagielski typedef BaseHash< TKeyList > TCommand2Keys; 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski //--------------------------------------- 76*b1cdbd2cSJim Jagielski /** TODO document me 77*b1cdbd2cSJim Jagielski keys -> commands 78*b1cdbd2cSJim Jagielski */ 79*b1cdbd2cSJim Jagielski typedef ::std::hash_map< css::awt::KeyEvent , 80*b1cdbd2cSJim Jagielski ::rtl::OUString , 81*b1cdbd2cSJim Jagielski KeyEventHashCode , 82*b1cdbd2cSJim Jagielski KeyEventEqualsFunc > TKey2Commands; 83*b1cdbd2cSJim Jagielski 84*b1cdbd2cSJim Jagielski //______________________________________ 85*b1cdbd2cSJim Jagielski // member 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski private: 88*b1cdbd2cSJim Jagielski 89*b1cdbd2cSJim Jagielski //--------------------------------------- 90*b1cdbd2cSJim Jagielski /** map commands to keys in relation 1:n. 91*b1cdbd2cSJim Jagielski First key is interpreted as preferred one! */ 92*b1cdbd2cSJim Jagielski TCommand2Keys m_lCommand2Keys; 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski //--------------------------------------- 95*b1cdbd2cSJim Jagielski /** map keys to commands in relation 1:1. */ 96*b1cdbd2cSJim Jagielski TKey2Commands m_lKey2Commands; 97*b1cdbd2cSJim Jagielski 98*b1cdbd2cSJim Jagielski //______________________________________ 99*b1cdbd2cSJim Jagielski // interface 100*b1cdbd2cSJim Jagielski 101*b1cdbd2cSJim Jagielski public: 102*b1cdbd2cSJim Jagielski 103*b1cdbd2cSJim Jagielski //--------------------------------------- 104*b1cdbd2cSJim Jagielski /** @short creates a new - but empty - cache instance. */ 105*b1cdbd2cSJim Jagielski AcceleratorCache(); 106*b1cdbd2cSJim Jagielski 107*b1cdbd2cSJim Jagielski //--------------------------------------- 108*b1cdbd2cSJim Jagielski /** @short make a copy of this cache. 109*b1cdbd2cSJim Jagielski @descr Used for the copy-on-write feature. 110*b1cdbd2cSJim Jagielski */ 111*b1cdbd2cSJim Jagielski AcceleratorCache(const AcceleratorCache& rCopy); 112*b1cdbd2cSJim Jagielski 113*b1cdbd2cSJim Jagielski //--------------------------------------- 114*b1cdbd2cSJim Jagielski /** @short does nothing real. */ 115*b1cdbd2cSJim Jagielski virtual ~AcceleratorCache(); 116*b1cdbd2cSJim Jagielski 117*b1cdbd2cSJim Jagielski //--------------------------------------- 118*b1cdbd2cSJim Jagielski /** @short write changes back to the original container. 119*b1cdbd2cSJim Jagielski 120*b1cdbd2cSJim Jagielski @param rCopy 121*b1cdbd2cSJim Jagielski the (changed!) copy, which should be written 122*b1cdbd2cSJim Jagielski back to this original container. 123*b1cdbd2cSJim Jagielski */ 124*b1cdbd2cSJim Jagielski virtual void takeOver(const AcceleratorCache& rCopy); 125*b1cdbd2cSJim Jagielski 126*b1cdbd2cSJim Jagielski //--------------------------------------- 127*b1cdbd2cSJim Jagielski /** TODO document me */ 128*b1cdbd2cSJim Jagielski virtual AcceleratorCache& operator=(const AcceleratorCache& rCopy); 129*b1cdbd2cSJim Jagielski 130*b1cdbd2cSJim Jagielski //--------------------------------------- 131*b1cdbd2cSJim Jagielski /** @short checks if the specified key exists. 132*b1cdbd2cSJim Jagielski 133*b1cdbd2cSJim Jagielski @param aKey 134*b1cdbd2cSJim Jagielski the key, which should be checked. 135*b1cdbd2cSJim Jagielski 136*b1cdbd2cSJim Jagielski @return [bool] 137*b1cdbd2cSJim Jagielski sal_True if the speicfied key exists inside this container. 138*b1cdbd2cSJim Jagielski */ 139*b1cdbd2cSJim Jagielski virtual sal_Bool hasKey(const css::awt::KeyEvent& aKey) const; 140*b1cdbd2cSJim Jagielski virtual sal_Bool hasCommand(const ::rtl::OUString& sCommand) const; 141*b1cdbd2cSJim Jagielski 142*b1cdbd2cSJim Jagielski //--------------------------------------- 143*b1cdbd2cSJim Jagielski /** TODO document me */ 144*b1cdbd2cSJim Jagielski virtual TKeyList getAllKeys() const; 145*b1cdbd2cSJim Jagielski 146*b1cdbd2cSJim Jagielski //--------------------------------------- 147*b1cdbd2cSJim Jagielski /** @short add a new or change an existing key-command pair 148*b1cdbd2cSJim Jagielski of this container. 149*b1cdbd2cSJim Jagielski 150*b1cdbd2cSJim Jagielski @param aKey 151*b1cdbd2cSJim Jagielski describe the key. 152*b1cdbd2cSJim Jagielski 153*b1cdbd2cSJim Jagielski @param sCommand 154*b1cdbd2cSJim Jagielski describe the command. 155*b1cdbd2cSJim Jagielski */ 156*b1cdbd2cSJim Jagielski virtual void setKeyCommandPair(const css::awt::KeyEvent& aKey , 157*b1cdbd2cSJim Jagielski const ::rtl::OUString& sCommand); 158*b1cdbd2cSJim Jagielski 159*b1cdbd2cSJim Jagielski //--------------------------------------- 160*b1cdbd2cSJim Jagielski /** @short returns the list of keys, which are registered 161*b1cdbd2cSJim Jagielski for this command. 162*b1cdbd2cSJim Jagielski 163*b1cdbd2cSJim Jagielski @param sCommand 164*b1cdbd2cSJim Jagielski describe the command. 165*b1cdbd2cSJim Jagielski 166*b1cdbd2cSJim Jagielski @return [TKeyList] 167*b1cdbd2cSJim Jagielski the list of registered keys. Can be empty! 168*b1cdbd2cSJim Jagielski */ 169*b1cdbd2cSJim Jagielski virtual TKeyList getKeysByCommand(const ::rtl::OUString& sCommand) const; 170*b1cdbd2cSJim Jagielski 171*b1cdbd2cSJim Jagielski //--------------------------------------- 172*b1cdbd2cSJim Jagielski /** TODO */ 173*b1cdbd2cSJim Jagielski virtual ::rtl::OUString getCommandByKey(const css::awt::KeyEvent& aKey) const; 174*b1cdbd2cSJim Jagielski 175*b1cdbd2cSJim Jagielski //--------------------------------------- 176*b1cdbd2cSJim Jagielski /** TODO */ 177*b1cdbd2cSJim Jagielski virtual void removeKey(const css::awt::KeyEvent& aKey); 178*b1cdbd2cSJim Jagielski virtual void removeCommand(const ::rtl::OUString& sCommand); 179*b1cdbd2cSJim Jagielski }; 180*b1cdbd2cSJim Jagielski 181*b1cdbd2cSJim Jagielski } // namespace framework 182*b1cdbd2cSJim Jagielski 183*b1cdbd2cSJim Jagielski #endif // __FRAMEWORK_ACCELERATORS_ACCELERATORCACHE_HXX_ 184