offapi/com/sun/star/awt/KeyStroke.idl

   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 #ifndef __com_sun_star_awt_KeyStroke_idl__
  20 #define __com_sun_star_awt_KeyStroke_idl__
  21
  22
  23
  24 module com {  module sun {  module star {  module awt {
  25
  26
  27 /** Describes a key stroke for hotkeys etc.
  28
  29     @since OOo 1.1.2
  30  */
  31 published struct KeyStroke
  32 {
  33
  34     /** contains the modifier keys which were pressed while the event occurred.
  35
  36         <p>Zero or more constants from the group
  37         com::sun::star::awt::KeyModifier.</p>
  38      */
  39     short Modifiers;
  40
  41
  42     /** contains the integer code representing the key of the event.
  43
  44         <p>This is a constant from the constant group
  45         com::sun::star::awt::Key.</p>
  46      */
  47     short KeyCode;
  48
  49
  50     /** contains the Unicode character generated by this event or 0.
  51      */
  52     char KeyChar;
  53
  54
  55     /** contains the function type of the key event.
  56
  57         <p>This is a constant from the constant group
  58         com::sun::star::awt::KeyFunction.</p>
  59      */
  60     short KeyFunc;
  61 };
  62
  63
  64 }; }; }; };
  65
  66 #endif
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */