xref: /trunk/main/offapi/com/sun/star/awt/KeyStroke.idl (revision d1e7efc3)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_awt_KeyStroke_idl__
24#define __com_sun_star_awt_KeyStroke_idl__
25
26
27//=============================================================================
28
29module com {  module sun {  module star {  module awt {
30
31//=============================================================================
32
33/** Describes a key stroke for hotkeys etc.
34
35    @since OpenOffice 1.1.2
36 */
37published struct KeyStroke
38{
39    //-------------------------------------------------------------------------
40
41    /** contains the modifier keys which were pressed while the event occurred.
42
43        <p>Zero or more constants from the group
44        <type scope="com::sun::star::awt">KeyModifier</type>.</p>
45     */
46    short Modifiers;
47
48    //-------------------------------------------------------------------------
49
50	/** contains the integer code representing the key of the event.
51
52		<p>This is a constant from the constant group
53        <type scope="com::sun::star::awt">Key</type>.</p>
54	 */
55	short KeyCode;
56
57	//-------------------------------------------------------------------------
58
59	/** contains the Unicode character generated by this event or 0.
60	 */
61	char KeyChar;
62
63	//-------------------------------------------------------------------------
64
65	/** contains the function type of the key event.
66
67		<p>This is a constant from the constant group
68		<type scope="com::sun::star::awt">KeyFunction</type>.</p>
69	 */
70	short KeyFunc;
71};
72
73//=============================================================================
74
75}; }; }; };
76
77#endif
78