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_XMouseListener_idl__
24#define __com_sun_star_awt_XMouseListener_idl__
25
26#ifndef __com_sun_star_lang_XEventListener_idl__
27#include <com/sun/star/lang/XEventListener.idl>
28#endif
29
30#ifndef __com_sun_star_awt_MouseEvent_idl__
31#include <com/sun/star/awt/MouseEvent.idl>
32#endif
33
34
35//=============================================================================
36
37 module com {  module sun {  module star {  module awt {
38
39//=============================================================================
40
41/** makes it possible to receive events from the mouse in a certain window.
42 */
43published interface XMouseListener: com::sun::star::lang::XEventListener
44{
45	//-------------------------------------------------------------------------
46
47	/** is invoked when a mouse button has been pressed on a window.
48
49        <p>Since mouse presses are usually also used to indicate requests for popup menus
50        (also known as context menus) on objects, you might receive two events
51        for a single mouse press: For example, if, on your operating system,
52        pressing the right mouse button indicates the request for a context menu,
53        then you will receive one call to <member>mousePressed</member> indicating
54        the mouse click, and another one indicating the context menu request. For
55        the latter, the <member>MouseEvent::PopupTrigger</member> member of the
56        event will be set to <TRUE/>.</p>
57	*/
58	[oneway] void mousePressed( [in] com::sun::star::awt::MouseEvent e );
59
60	//-------------------------------------------------------------------------
61
62	/** is invoked when a mouse button has been released on a window.
63	 */
64	[oneway] void mouseReleased( [in] com::sun::star::awt::MouseEvent e );
65
66	//-------------------------------------------------------------------------
67
68	/** is invoked when the mouse enters a window.
69	 */
70	[oneway] void mouseEntered( [in] com::sun::star::awt::MouseEvent e );
71
72	//-------------------------------------------------------------------------
73
74	/** is invoked when the mouse exits a window.
75	 */
76	[oneway] void mouseExited( [in] com::sun::star::awt::MouseEvent e );
77
78};
79
80//=============================================================================
81
82}; }; }; };
83
84#endif
85