/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: KeyStroke.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-07 21:09:05 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_awt_KeyStroke_idl__
#define __com_sun_star_awt_KeyStroke_idl__


//=============================================================================

module com {  module sun {  module star {  module awt {

//=============================================================================

/** Describes a key stroke for hotkeys etc.

    @since OOo 1.1.2
 */
published struct KeyStroke
{
    //-------------------------------------------------------------------------

    /** contains the modifier keys which were pressed while the event occurred.

        <p>Zero or more constants from the group
        <type scope="com::sun::star::awt">KeyModifier</type>.</p>
     */
    short Modifiers;

    //-------------------------------------------------------------------------

    /** contains the integer code representing the key of the event.

        <p>This is a constant from the constant group
        <type scope="com::sun::star::awt">Key</type>.</p>
     */
    short KeyCode;

    //-------------------------------------------------------------------------

    /** contains the Unicode character generated by this event or 0.
     */
    char KeyChar;

    //-------------------------------------------------------------------------

    /** contains the function type of the key event.

        <p>This is a constant from the constant group
        <type scope="com::sun::star::awt">KeyFunction</type>.</p>
     */
    short KeyFunc;
};

//=============================================================================

}; }; }; };

#endif
