summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/KeyStroke.idl
blob: 3c1397125df1657f3a8702c5b8f8eee8a0cddb39 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: KeyStroke.idl,v $
 * $Revision: 1.8 $
 *
 * 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_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