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