framework/source/inc/accelerators/keymapping.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_FRAMEWORK_SOURCE_INC_ACCELERATORS_KEYMAPPING_HXX
  21 #define INCLUDED_FRAMEWORK_SOURCE_INC_ACCELERATORS_KEYMAPPING_HXX
  22
  23 #include <general.h>
  24 #include <stdtypes.h>
  25
  26 #include <com/sun/star/lang/IllegalArgumentException.hpp>
  27
  28 // definition
  29
  30 namespace framework
  31 {
  32
  33 /**
  34     can be used to map key identifier to the
  35     corresponding key codes ...
  36  */
  37 class KeyMapping
  38 {
  39
  40     // const, types
  41
  42     private:
  43
  44         /** @short  is used to map a key code
  45                     to the right key identifier, which is
  46                     used to make the xml file "human readable"
  47          */
  48         struct KeyIdentifierInfo
  49         {
  50             sal_Int16       Code;
  51             const char*     Identifier;
  52         };
  53
  54         /** @short  hash structure to map identifier to key codes. */
  55         typedef BaseHash< sal_Int16 > Identifier2CodeHash;
  56
  57         /** @short  hash structure to map key codes to identifier. */
  58         typedef std::unordered_map< sal_Int16                    ,
  59                                     OUString              ,
  60                                     ShortHashCode                ,
  61                                     std::equal_to< sal_Int16 > > Code2IdentifierHash;
  62
  63     // member
  64
  65     private:
  66
  67         static KeyIdentifierInfo KeyIdentifierMap[];
  68
  69         /** @short  hash to map identifier to key codes. */
  70         Identifier2CodeHash m_lIdentifierHash;
  71
  72         /** @short  hash to map key codes to identifier. */
  73         Code2IdentifierHash m_lCodeHash;
  74
  75     // interface
  76
  77     public:
  78
  79                  KeyMapping();
  80         virtual ~KeyMapping();
  81
  82         /** @short  return a suitable key code
  83                     for the specified key identifier.
  84
  85             @param  sIdentifier
  86                     string value, which describe the key.
  87
  88             @return [css::awt::KeyEvent]
  89                     the corresponding key code as
  90                     short value.
  91
  92             @throw  [css::lang::IllegalArgumentException]
  93                     if the given identifier does not describe
  94                     a well known key code.
  95          */
  96         sal_uInt16 mapIdentifierToCode(const OUString& sIdentifier)
  97             throw(css::lang::IllegalArgumentException);
  98
  99         /** @short  return a suitable key identifier
 100                     for the specified key code.
 101
 102             @param  nCode
 103                     short value, which describe the key.
 104
 105             @return The corresponding string identifier.
 106          */
 107         OUString mapCodeToIdentifier(sal_uInt16 nCode);
 108
 109     // helper
 110
 111     private:
 112
 113         /** @short  check if the given string describe a numeric
 114                     value ... and convert it.
 115
 116             @param  sIdentifier
 117                     the string value, which should be converted.
 118
 119             @param  rCode
 120                     contains the converted code, but is defined only
 121                     if this method returns sal_True!
 122
 123             @return [boolean]
 124                     sal_True if conversion was successfully.
 125           */
 126         bool impl_st_interpretIdentifierAsPureKeyCode(const OUString& sIdentifier,
 127                                                                 sal_uInt16&      rCode      );
 128 };
 129
 130 } // namespace framework
 131
 132 #endif // INCLUDED_FRAMEWORK_SOURCE_INC_ACCELERATORS_KEYMAPPING_HXX
 133
 134 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */