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 #pragma once
  21
  22 #include <rtl/ustring.hxx>
  23 #include <unordered_map>
  24
  25 // definition
  26
  27 namespace framework
  28 {
  29
  30 /**
  31     can be used to map key identifier to the
  32     corresponding key codes ...
  33  */
  34 class KeyMapping
  35 {
  36
  37     // const, types
  38
  39     private:
  40
  41         /** @short  is used to map a key code
  42                     to the right key identifier, which is
  43                     used to make the xml file "human readable"
  44          */
  45         struct KeyIdentifierInfo
  46         {
  47             sal_Int16       Code;
  48             OUString        Identifier;
  49         };
  50
  51         /** @short  hash structure to map identifier to key codes. */
  52         typedef std::unordered_map<OUString, sal_Int16> Identifier2CodeHash;
  53
  54         /** @short  hash structure to map key codes to identifier. */
  55         typedef std::unordered_map<sal_Int16, OUString> Code2IdentifierHash;
  56
  57     // member
  58
  59     private:
  60
  61         static KeyIdentifierInfo const KeyIdentifierMap[];
  62
  63         /** @short  hash to map identifier to key codes. */
  64         Identifier2CodeHash m_lIdentifierHash;
  65
  66         /** @short  hash to map key codes to identifier. */
  67         Code2IdentifierHash m_lCodeHash;
  68
  69     // interface
  70
  71     public:
  72
  73                  KeyMapping();
  74
  75         static KeyMapping & get();
  76
  77         /** @short  return a suitable key code
  78                     for the specified key identifier.
  79
  80             @param  sIdentifier
  81                     string value, which describe the key.
  82
  83             @return [css::awt::KeyEvent]
  84                     the corresponding key code as
  85                     short value.
  86
  87             @throw  [css::lang::IllegalArgumentException]
  88                     if the given identifier does not describe
  89                     a well known key code.
  90          */
  91         sal_uInt16 mapIdentifierToCode(const OUString& sIdentifier);
  92
  93         /** @short  return a suitable key identifier
  94                     for the specified key code.
  95
  96             @param  nCode
  97                     short value, which describe the key.
  98
  99             @return The corresponding string identifier.
 100          */
 101         OUString mapCodeToIdentifier(sal_uInt16 nCode);
 102
 103     // helper
 104
 105     private:
 106
 107         /** @short  check if the given string describe a numeric
 108                     value ... and convert it.
 109
 110             @param  sIdentifier
 111                     the string value, which should be converted.
 112
 113             @param  rCode
 114                     contains the converted code, but is defined only
 115                     if this method returns sal_True!
 116
 117             @return [boolean]
 118                     sal_True if conversion was successful.
 119           */
 120         static bool impl_st_interpretIdentifierAsPureKeyCode(std::u16string_view sIdentifier,
 121                                                                 sal_uInt16&      rCode      );
 122 };
 123
 124 } // namespace framework
 125
 126 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */