framework/source/accelerators/keymapping.cxx

   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.cxx,v $
  10  * $Revision: 1.7 $
  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 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_framework.hxx"
  33 #include <accelerators/keymapping.hxx>
  34
  35 //_______________________________________________
  36 // own includes
  37
  38 #include <macros/generic.hxx>
  39
  40 //_______________________________________________
  41 // interface includes
  42 #include <com/sun/star/awt/Key.hpp>
  43
  44 //_______________________________________________
  45 // other includes
  46
  47 //_______________________________________________
  48 // namespace
  49
  50 namespace framework
  51 {
  52
  53 //_______________________________________________
  54 // helper
  55
  56 KeyMapping::KeyIdentifierInfo KeyMapping::KeyIdentifierMap[] =
  57 {
  58     {css::awt::Key::NUM0          , "KEY_0"          },
  59     {css::awt::Key::NUM1          , "KEY_1"          },
  60     {css::awt::Key::NUM2          , "KEY_2"          },
  61     {css::awt::Key::NUM3          , "KEY_3"          },
  62     {css::awt::Key::NUM4          , "KEY_4"          },
  63     {css::awt::Key::NUM5          , "KEY_5"          },
  64     {css::awt::Key::NUM6          , "KEY_6"          },
  65     {css::awt::Key::NUM7          , "KEY_7"          },
  66     {css::awt::Key::NUM8          , "KEY_8"          },
  67     {css::awt::Key::NUM9          , "KEY_9"          },
  68     {css::awt::Key::A             , "KEY_A"          },
  69     {css::awt::Key::B             , "KEY_B"          },
  70     {css::awt::Key::C             , "KEY_C"          },
  71     {css::awt::Key::D             , "KEY_D"          },
  72     {css::awt::Key::E             , "KEY_E"          },
  73     {css::awt::Key::F             , "KEY_F"          },
  74     {css::awt::Key::G             , "KEY_G"          },
  75     {css::awt::Key::H             , "KEY_H"          },
  76     {css::awt::Key::I             , "KEY_I"          },
  77     {css::awt::Key::J             , "KEY_J"          },
  78     {css::awt::Key::K             , "KEY_K"          },
  79     {css::awt::Key::L             , "KEY_L"          },
  80     {css::awt::Key::M             , "KEY_M"          },
  81     {css::awt::Key::N             , "KEY_N"          },
  82     {css::awt::Key::O             , "KEY_O"          },
  83     {css::awt::Key::P             , "KEY_P"          },
  84     {css::awt::Key::Q             , "KEY_Q"          },
  85     {css::awt::Key::R             , "KEY_R"          },
  86     {css::awt::Key::S             , "KEY_S"          },
  87     {css::awt::Key::T             , "KEY_T"          },
  88     {css::awt::Key::U             , "KEY_U"          },
  89     {css::awt::Key::V             , "KEY_V"          },
  90     {css::awt::Key::W             , "KEY_W"          },
  91     {css::awt::Key::X             , "KEY_X"          },
  92     {css::awt::Key::Y             , "KEY_Y"          },
  93     {css::awt::Key::Z             , "KEY_Z"          },
  94     {css::awt::Key::F1            , "KEY_F1"         },
  95     {css::awt::Key::F2            , "KEY_F2"         },
  96     {css::awt::Key::F3            , "KEY_F3"         },
  97     {css::awt::Key::F4            , "KEY_F4"         },
  98     {css::awt::Key::F5            , "KEY_F5"         },
  99     {css::awt::Key::F6            , "KEY_F6"         },
 100     {css::awt::Key::F7            , "KEY_F7"         },
 101     {css::awt::Key::F8            , "KEY_F8"         },
 102     {css::awt::Key::F9            , "KEY_F9"         },
 103     {css::awt::Key::F10           , "KEY_F10"        },
 104     {css::awt::Key::F11           , "KEY_F11"        },
 105     {css::awt::Key::F12           , "KEY_F12"        },
 106     {css::awt::Key::F13           , "KEY_F13"        },
 107     {css::awt::Key::F14           , "KEY_F14"        },
 108     {css::awt::Key::F15           , "KEY_F15"        },
 109     {css::awt::Key::F16           , "KEY_F16"        },
 110     {css::awt::Key::F17           , "KEY_F17"        },
 111     {css::awt::Key::F18           , "KEY_F18"        },
 112     {css::awt::Key::F19           , "KEY_F19"        },
 113     {css::awt::Key::F20           , "KEY_F20"        },
 114     {css::awt::Key::F21           , "KEY_F21"        },
 115     {css::awt::Key::F22           , "KEY_F22"        },
 116     {css::awt::Key::F23           , "KEY_F23"        },
 117     {css::awt::Key::F24           , "KEY_F24"        },
 118     {css::awt::Key::F25           , "KEY_F25"        },
 119     {css::awt::Key::F26           , "KEY_F26"        },
 120     {css::awt::Key::DOWN          , "KEY_DOWN"       },
 121     {css::awt::Key::UP            , "KEY_UP"         },
 122     {css::awt::Key::LEFT          , "KEY_LEFT"       },
 123     {css::awt::Key::RIGHT         , "KEY_RIGHT"      },
 124     {css::awt::Key::HOME          , "KEY_HOME"       },
 125     {css::awt::Key::END           , "KEY_END"        },
 126     {css::awt::Key::PAGEUP        , "KEY_PAGEUP"     },
 127     {css::awt::Key::PAGEDOWN      , "KEY_PAGEDOWN"   },
 128     {css::awt::Key::RETURN        , "KEY_RETURN"     },
 129     {css::awt::Key::ESCAPE        , "KEY_ESCAPE"     },
 130     {css::awt::Key::TAB           , "KEY_TAB"        },
 131     {css::awt::Key::BACKSPACE     , "KEY_BACKSPACE"  },
 132     {css::awt::Key::SPACE         , "KEY_SPACE"      },
 133     {css::awt::Key::INSERT        , "KEY_INSERT"     },
 134     {css::awt::Key::DELETE        , "KEY_DELETE"     },
 135     {css::awt::Key::ADD           , "KEY_ADD"        },
 136     {css::awt::Key::SUBTRACT      , "KEY_SUBTRACT"   },
 137     {css::awt::Key::MULTIPLY      , "KEY_MULTIPLY"   },
 138     {css::awt::Key::DIVIDE        , "KEY_DIVIDE"     },
 139     {css::awt::Key::POINT         , "KEY_POINT"      },
 140     {css::awt::Key::COMMA         , "KEY_COMMA"      },
 141     {css::awt::Key::LESS          , "KEY_LESS"       },
 142     {css::awt::Key::GREATER       , "KEY_GREATER"    },
 143     {css::awt::Key::EQUAL         , "KEY_EQUAL"      },
 144     {css::awt::Key::OPEN          , "KEY_OPEN"       },
 145     {css::awt::Key::CUT           , "KEY_CUT"        },
 146     {css::awt::Key::COPY          , "KEY_COPY"       },
 147     {css::awt::Key::PASTE         , "KEY_PASTE"      },
 148     {css::awt::Key::UNDO          , "KEY_UNDO"       },
 149     {css::awt::Key::REPEAT        , "KEY_REPEAT"     },
 150     {css::awt::Key::FIND          , "KEY_FIND"       },
 151     {css::awt::Key::PROPERTIES    , "KEY_PROPERTIES" },
 152     {css::awt::Key::FRONT         , "KEY_FRONT"      },
 153     {css::awt::Key::CONTEXTMENU   , "KEY_CONTEXTMENU"},
 154     {css::awt::Key::HELP          , "KEY_HELP"       },
 155     {css::awt::Key::MENU          , "KEY_MENU"       },
 156     {css::awt::Key::HANGUL_HANJA  , "KEY_HANGUL_HANJA"},
 157     {css::awt::Key::DECIMAL       , "KEY_DECIMAL"    },
 158     {css::awt::Key::TILDE         , "KEY_TILDE"      },
 159     {css::awt::Key::QUOTELEFT     , "KEY_QUOTELEFT"  },
 160     {0                            , ""               } // mark the end of this array!
 161 };
 162
 163 //-----------------------------------------------
 164 KeyMapping::KeyMapping()
 165 {
 166     sal_Int32 i = 0;
 167     while(KeyIdentifierMap[i].Code != 0)
 168     {
 169         ::rtl::OUString sIdentifier = ::rtl::OUString::createFromAscii(KeyIdentifierMap[i].Identifier);
 170         sal_Int16       nCode       = KeyIdentifierMap[i].Code;
 171
 172         m_lIdentifierHash[sIdentifier] = nCode      ;
 173         m_lCodeHash      [nCode]       = sIdentifier;
 174
 175         ++i;
 176     }
 177 }
 178
 179 //-----------------------------------------------
 180 KeyMapping::~KeyMapping()
 181 {
 182 }
 183
 184 //-----------------------------------------------
 185 sal_uInt16 KeyMapping::mapIdentifierToCode(const ::rtl::OUString& sIdentifier)
 186     throw(css::lang::IllegalArgumentException)
 187 {
 188     Identifier2CodeHash::const_iterator pIt = m_lIdentifierHash.find(sIdentifier);
 189     if (pIt != m_lIdentifierHash.end())
 190         return pIt->second;
 191
 192     // Its not well known identifier - but may be a pure key code formated as string ...
 193     // Check and convert it!
 194     sal_uInt16 nCode = 0;
 195     if (!KeyMapping::impl_st_interpretIdentifierAsPureKeyCode(sIdentifier, nCode))
 196         throw css::lang::IllegalArgumentException(
 197                 DECLARE_ASCII("Cant map given identifier to a valid key code value."),
 198                 css::uno::Reference< css::uno::XInterface >(),
 199                 0);
 200
 201     return (sal_uInt16)nCode;
 202 }
 203
 204 //-----------------------------------------------
 205 ::rtl::OUString KeyMapping::mapCodeToIdentifier(sal_uInt16 nCode)
 206 {
 207     Code2IdentifierHash::const_iterator pIt = m_lCodeHash.find(nCode);
 208     if (pIt != m_lCodeHash.end())
 209         return pIt->second;
 210
 211     // If we have no well known identifier - use the pure code value!
 212     return ::rtl::OUString::valueOf((sal_Int32)nCode);
 213 }
 214
 215 //-----------------------------------------------
 216 sal_Bool KeyMapping::impl_st_interpretIdentifierAsPureKeyCode(const ::rtl::OUString& sIdentifier,
 217                                                                     sal_uInt16&      rCode      )
 218 {
 219     sal_Int32 nCode = sIdentifier.toInt32();
 220     if (nCode > 0)
 221     {
 222         rCode = (sal_uInt16)nCode;
 223         return sal_True;
 224     }
 225
 226     // 0 is normaly an error of the called method toInt32() ...
 227     // But we must be aware, that the identifier is "0"!
 228     rCode = 0;
 229     return sIdentifier.equalsAscii("0");
 230 }
 231
 232 } // namespace framework