framework/source/inc/accelerators/keymapping.hxx

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