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

   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: KeyStroke.idl,v $
  10  * $Revision: 1.8 $
  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 #ifndef __com_sun_star_awt_KeyStroke_idl__
  31 #define __com_sun_star_awt_KeyStroke_idl__
  32
  33
  34 //=============================================================================
  35
  36 module com {  module sun {  module star {  module awt {
  37
  38 //=============================================================================
  39
  40 /** Describes a key stroke for hotkeys etc.
  41
  42     @since OOo 1.1.2
  43  */
  44 published struct KeyStroke
  45 {
  46     //-------------------------------------------------------------------------
  47
  48     /** contains the modifier keys which were pressed while the event occurred.
  49
  50         <p>Zero or more constants from the group
  51         <type scope="com::sun::star::awt">KeyModifier</type>.</p>
  52      */
  53     short Modifiers;
  54
  55     //-------------------------------------------------------------------------
  56
  57     /** contains the integer code representing the key of the event.
  58
  59         <p>This is a constant from the constant group
  60         <type scope="com::sun::star::awt">Key</type>.</p>
  61      */
  62     short KeyCode;
  63
  64     //-------------------------------------------------------------------------
  65
  66     /** contains the Unicode character generated by this event or 0.
  67      */
  68     char KeyChar;
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** contains the function type of the key event.
  73
  74         <p>This is a constant from the constant group
  75         <type scope="com::sun::star::awt">KeyFunction</type>.</p>
  76      */
  77     short KeyFunc;
  78 };
  79
  80 //=============================================================================
  81
  82 }; }; }; };
  83
  84 #endif