offapi/com/sun/star/awt/XMouseClickHandler.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XMouseClickHandler.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_awt_XMouseClickHandler_idl__
  31 #define __com_sun_star_awt_XMouseClickHandler_idl__
  32
  33 #ifndef __com_sun_star_lang_XEventListener_idl__
  34 #include <com/sun/star/lang/XEventListener.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_awt_MouseEvent_idl__
  38 #include <com/sun/star/awt/MouseEvent.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module awt {
  45
  46 //=============================================================================
  47
  48 /** makes it possible to receive events from the mouse in a certain window.
  49
  50     @since OOo 1.1.2
  51  */
  52 published interface XMouseClickHandler: ::com::sun::star::lang::XEventListener
  53 {
  54     //-------------------------------------------------------------------------
  55
  56     /** is invoked when a mouse button has been pressed on a window.
  57
  58         @return
  59             When <FALSE/> is returned the other handlers are called and a
  60             following handling of the event by the broadcaster takes place.
  61             Otherwise, when <TRUE/> is returned, no other handler will be
  62             called and the broadcaster will take no further actions
  63             regarding the event.
  64      */
  65     boolean mousePressed( [in] com::sun::star::awt::MouseEvent e );
  66
  67     //-------------------------------------------------------------------------
  68
  69     /** is invoked when a mouse button has been released on a window.
  70
  71         @return
  72             When <FALSE/> is returned the other handlers are called and a
  73             following handling of the event by the broadcaster takes place.
  74             Otherwise, when <TRUE/> is returned, no other handler will be
  75             called and the broadcaster will take no further actions
  76             regarding the event.
  77     */
  78     boolean mouseReleased( [in] com::sun::star::awt::MouseEvent e );
  79
  80 };
  81
  82 //=============================================================================
  83
  84 }; }; }; };
  85
  86 #endif