xref: /AOO41X/main/offapi/com/sun/star/awt/XMouseClickHandler.idl (revision d1e7efc3a14909e0a68c915b160c0a3adcc02b1f)
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_XMouseClickHandler_idl__
24#define __com_sun_star_awt_XMouseClickHandler_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
37module 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
43    @since OpenOffice 1.1.2
44 */
45published interface XMouseClickHandler: ::com::sun::star::lang::XEventListener
46{
47    //-------------------------------------------------------------------------
48
49    /** is invoked when a mouse button has been pressed on a window.
50
51        @return
52            When <FALSE/> is returned the other handlers are called and a
53            following handling of the event by the broadcaster takes place.
54            Otherwise, when <TRUE/> is returned, no other handler will be
55            called and the broadcaster will take no further actions
56            regarding the event.
57     */
58    boolean 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        @return
65            When <FALSE/> is returned the other handlers are called and a
66            following handling of the event by the broadcaster takes place.
67            Otherwise, when <TRUE/> is returned, no other handler will be
68            called and the broadcaster will take no further actions
69            regarding the event.
70    */
71    boolean mouseReleased( [in] com::sun::star::awt::MouseEvent e );
72
73};
74
75//=============================================================================
76
77}; }; }; };
78
79#endif
80