xref: /aoo42x/main/offapi/com/sun/star/awt/MouseEvent.idl (revision d1766043)
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_MouseEvent_idl__
24#define __com_sun_star_awt_MouseEvent_idl__
25
26#ifndef __com_sun_star_awt_InputEvent_idl__
27#include <com/sun/star/awt/InputEvent.idl>
28#endif
29
30
31//=============================================================================
32
33 module com {  module sun {  module star {  module awt {
34
35//=============================================================================
36
37/** specifies an event from the mouse.
38
39    <p>This event is also used for popup menu requests on objects.
40    See <member>PopupTrigger</member> for details.</p>
41
42    @see XMouseListener
43    @see XMouseMotionListener
44    @see InputEvent
45 */
46published struct MouseEvent: com::sun::star::awt::InputEvent
47{
48	//-------------------------------------------------------------------------
49
50	/** contains the pressed mouse buttons.
51
52		<p>Zero ore more constants from the
53        <type scope="com::sun::star::awt">MouseButton</type> group.</p>
54	 */
55	short Buttons;
56
57	//-------------------------------------------------------------------------
58
59	/** contains the x coordinate location of the mouse.
60	 */
61	long X;
62
63	//-------------------------------------------------------------------------
64
65	/** contains the y coordinate location of the mouse.
66	 */
67	long Y;
68
69	//-------------------------------------------------------------------------
70
71	/** contains the number of mouse clicks associated with event.
72	 */
73	long ClickCount;
74
75	//-------------------------------------------------------------------------
76
77	/** specifies if this event is a popup-menu trigger event.
78
79        <p>If this member is <TRUE/>, the event describes a request for a popup menu,
80        also known as context menu, on an object.</p>
81
82        <p>In this case, <member>X</member> and <member>Y</member> describe the position
83        where the request was issued. If those members are <code>-1</code>, then the
84        request was issued using the keyboard, by pressing the operating-system dependent
85        key combination for this purpose.</p>
86
87        @see XMouseListener::mousePressed
88    */
89	boolean PopupTrigger;
90
91};
92
93//=============================================================================
94
95}; }; }; };
96
97#endif
98