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