office-gobmx/offapi/com/sun/star/awt/KeyEvent.idl

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_awt_KeyEvent_idl__
#define __com_sun_star_awt_KeyEvent_idl__

#include <com/sun/star/awt/InputEvent.idl>


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

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

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

/** specifies a key event.

    @see InputEvent
 */
published struct KeyEvent: com::sun::star::awt::InputEvent
{
    //-------------------------------------------------------------------------

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

        <p>This is a constant from the constant group <type>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>KeyFunction</type>.</p>
     */
    short KeyFunc;

};

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

}; }; }; };

#endif