1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir #ifndef __FRAMEWORK_ACCELERATORS_KEYMAPPING_HXX_ 29*cdf0e10cSrcweir #define __FRAMEWORK_ACCELERATORS_KEYMAPPING_HXX_ 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir //__________________________________________ 32*cdf0e10cSrcweir // own includes 33*cdf0e10cSrcweir 34*cdf0e10cSrcweir #include <general.h> 35*cdf0e10cSrcweir #include <stdtypes.h> 36*cdf0e10cSrcweir 37*cdf0e10cSrcweir //__________________________________________ 38*cdf0e10cSrcweir // interface includes 39*cdf0e10cSrcweir #include <com/sun/star/lang/IllegalArgumentException.hpp> 40*cdf0e10cSrcweir 41*cdf0e10cSrcweir //__________________________________________ 42*cdf0e10cSrcweir // other includes 43*cdf0e10cSrcweir 44*cdf0e10cSrcweir //__________________________________________ 45*cdf0e10cSrcweir // definition 46*cdf0e10cSrcweir 47*cdf0e10cSrcweir namespace framework 48*cdf0e10cSrcweir { 49*cdf0e10cSrcweir 50*cdf0e10cSrcweir //__________________________________________ 51*cdf0e10cSrcweir /** 52*cdf0e10cSrcweir can be used to map key identifier to the 53*cdf0e10cSrcweir corresponding key codes ... 54*cdf0e10cSrcweir */ 55*cdf0e10cSrcweir class KeyMapping 56*cdf0e10cSrcweir { 57*cdf0e10cSrcweir //______________________________________ 58*cdf0e10cSrcweir // const, types 59*cdf0e10cSrcweir 60*cdf0e10cSrcweir private: 61*cdf0e10cSrcweir 62*cdf0e10cSrcweir //--------------------------------------- 63*cdf0e10cSrcweir /** @short is used to map a key code 64*cdf0e10cSrcweir to the right key identifier, which is 65*cdf0e10cSrcweir used to make the xml file "human readable" 66*cdf0e10cSrcweir */ 67*cdf0e10cSrcweir struct KeyIdentifierInfo 68*cdf0e10cSrcweir { 69*cdf0e10cSrcweir sal_Int16 Code ; 70*cdf0e10cSrcweir const char* Identifier; 71*cdf0e10cSrcweir }; 72*cdf0e10cSrcweir 73*cdf0e10cSrcweir //--------------------------------------- 74*cdf0e10cSrcweir /** @short hash structure to map identifier to key codes. */ 75*cdf0e10cSrcweir typedef BaseHash< sal_Int16 > Identifier2CodeHash; 76*cdf0e10cSrcweir 77*cdf0e10cSrcweir //--------------------------------------- 78*cdf0e10cSrcweir /** @short hash structure to map key codes to identifier. */ 79*cdf0e10cSrcweir typedef ::std::hash_map< sal_Int16 , 80*cdf0e10cSrcweir ::rtl::OUString , 81*cdf0e10cSrcweir ShortHashCode , 82*cdf0e10cSrcweir ::std::equal_to< sal_Int16 > > Code2IdentifierHash; 83*cdf0e10cSrcweir 84*cdf0e10cSrcweir //______________________________________ 85*cdf0e10cSrcweir // member 86*cdf0e10cSrcweir 87*cdf0e10cSrcweir private: 88*cdf0e10cSrcweir 89*cdf0e10cSrcweir static KeyIdentifierInfo KeyIdentifierMap[]; 90*cdf0e10cSrcweir 91*cdf0e10cSrcweir //--------------------------------------- 92*cdf0e10cSrcweir /** @short hash to map identifier to key codes. */ 93*cdf0e10cSrcweir Identifier2CodeHash m_lIdentifierHash; 94*cdf0e10cSrcweir 95*cdf0e10cSrcweir //--------------------------------------- 96*cdf0e10cSrcweir /** @short hash to map key codes to identifier. */ 97*cdf0e10cSrcweir Code2IdentifierHash m_lCodeHash; 98*cdf0e10cSrcweir 99*cdf0e10cSrcweir //______________________________________ 100*cdf0e10cSrcweir // interface 101*cdf0e10cSrcweir 102*cdf0e10cSrcweir public: 103*cdf0e10cSrcweir 104*cdf0e10cSrcweir KeyMapping(); 105*cdf0e10cSrcweir virtual ~KeyMapping(); 106*cdf0e10cSrcweir 107*cdf0e10cSrcweir //---------------------------------- 108*cdf0e10cSrcweir /** @short return a suitable key code 109*cdf0e10cSrcweir for the specified key identifier. 110*cdf0e10cSrcweir 111*cdf0e10cSrcweir @param sIdentifier 112*cdf0e10cSrcweir string value, which describe the key. 113*cdf0e10cSrcweir 114*cdf0e10cSrcweir @return [css::awt::KeyEvent] 115*cdf0e10cSrcweir the corresponding key code as 116*cdf0e10cSrcweir short value. 117*cdf0e10cSrcweir 118*cdf0e10cSrcweir @throw [css::lang::IllegalArgumentException] 119*cdf0e10cSrcweir if the given identifier does not describe 120*cdf0e10cSrcweir a well known key code. 121*cdf0e10cSrcweir */ 122*cdf0e10cSrcweir virtual sal_uInt16 mapIdentifierToCode(const ::rtl::OUString& sIdentifier) 123*cdf0e10cSrcweir throw(css::lang::IllegalArgumentException); 124*cdf0e10cSrcweir 125*cdf0e10cSrcweir //---------------------------------- 126*cdf0e10cSrcweir /** @short return a suitable key identifier 127*cdf0e10cSrcweir for the specified key code. 128*cdf0e10cSrcweir 129*cdf0e10cSrcweir @param nCode 130*cdf0e10cSrcweir short value, which describe the key. 131*cdf0e10cSrcweir 132*cdf0e10cSrcweir @return The corresponding string identifier. 133*cdf0e10cSrcweir */ 134*cdf0e10cSrcweir virtual ::rtl::OUString mapCodeToIdentifier(sal_uInt16 nCode); 135*cdf0e10cSrcweir 136*cdf0e10cSrcweir //______________________________________ 137*cdf0e10cSrcweir // helper 138*cdf0e10cSrcweir 139*cdf0e10cSrcweir private: 140*cdf0e10cSrcweir 141*cdf0e10cSrcweir //---------------------------------- 142*cdf0e10cSrcweir /** @short check if the given string describe a numeric 143*cdf0e10cSrcweir value ... and convert it. 144*cdf0e10cSrcweir 145*cdf0e10cSrcweir @param sIdentifier 146*cdf0e10cSrcweir the string value, which should be converted. 147*cdf0e10cSrcweir 148*cdf0e10cSrcweir 149*cdf0e10cSrcweir @param rCode 150*cdf0e10cSrcweir contains the converted code, but is defined only 151*cdf0e10cSrcweir if this method returns sal_True! 152*cdf0e10cSrcweir 153*cdf0e10cSrcweir @return [boolean] 154*cdf0e10cSrcweir sal_True if convertion was successfully. 155*cdf0e10cSrcweir */ 156*cdf0e10cSrcweir sal_Bool impl_st_interpretIdentifierAsPureKeyCode(const ::rtl::OUString& sIdentifier, 157*cdf0e10cSrcweir sal_uInt16& rCode ); 158*cdf0e10cSrcweir }; 159*cdf0e10cSrcweir 160*cdf0e10cSrcweir } // namespace framework 161*cdf0e10cSrcweir 162*cdf0e10cSrcweir #endif // __FRAMEWORK_ACCELERATORS_KEYMAPPING_HXX_ 163