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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_awt_KeyStroke_idl__
  29 #define __com_sun_star_awt_KeyStroke_idl__
  30
  31
  32 //=============================================================================
  33
  34 module com {  module sun {  module star {  module awt {
  35
  36 //=============================================================================
  37
  38 /** Describes a key stroke for hotkeys etc.
  39
  40     @since OOo 1.1.2
  41  */
  42 published struct KeyStroke
  43 {
  44     //-------------------------------------------------------------------------
  45
  46     /** contains the modifier keys which were pressed while the event occurred.
  47
  48         <p>Zero or more constants from the group
  49         <type scope="com::sun::star::awt">KeyModifier</type>.</p>
  50      */
  51     short Modifiers;
  52
  53     //-------------------------------------------------------------------------
  54
  55     /** contains the integer code representing the key of the event.
  56
  57         <p>This is a constant from the constant group
  58         <type scope="com::sun::star::awt">Key</type>.</p>
  59      */
  60     short KeyCode;
  61
  62     //-------------------------------------------------------------------------
  63
  64     /** contains the Unicode character generated by this event or 0.
  65      */
  66     char KeyChar;
  67
  68     //-------------------------------------------------------------------------
  69
  70     /** contains the function type of the key event.
  71
  72         <p>This is a constant from the constant group
  73         <type scope="com::sun::star::awt">KeyFunction</type>.</p>
  74      */
  75     short KeyFunc;
  76 };
  77
  78 //=============================================================================
  79
  80 }; }; }; };
  81
  82 #endif
  83
  84 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */