offapi/com/sun/star/awt/XMouseMotionHandler.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: XMouseMotionHandler.idl,v $
  10  * $Revision: 1.3 $
  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_XMouseMotionHandler_idl__
  31 #define __com_sun_star_awt_XMouseMotionHandler_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 mouse motion events on a window.
  49  */
  50 published interface XMouseMotionHandler: com::sun::star::lang::XEventListener
  51 {
  52     //-------------------------------------------------------------------------
  53
  54     /** is invoked when a mouse button is pressed on a window and then
  55         dragged.
  56
  57         <p>Mouse drag events will continue to be delivered to
  58         the window where the first event originated until the mouse button is
  59         released (regardless of whether the mouse position is within the
  60         bounds of the window).</p>
  61
  62         @return
  63             When <FALSE/> is returned the other handlers are called and a
  64             following handling of the event by the broadcaster takes place.
  65             Otherwise, when <TRUE/> is returned, no other handler will be
  66             called and the broadcaster will take no further actions
  67             regarding the event.
  68
  69      */
  70     boolean mouseDragged( [in] com::sun::star::awt::MouseEvent e );
  71
  72     //-------------------------------------------------------------------------
  73
  74     /** is invoked when the mouse button has been moved on a window
  75         (with no buttons down).
  76
  77         @return
  78             When <FALSE/> is returned the other handlers are called and a
  79             following handling of the event by the broadcaster takes place.
  80             Otherwise, when <TRUE/> is returned, no other handler will be
  81             called and the broadcaster will take no further actions
  82             regarding the event.
  83
  84      */
  85     boolean mouseMoved( [in] com::sun::star::awt::MouseEvent e );
  86
  87 };
  88
  89 //=============================================================================
  90
  91 }; }; }; };
  92
  93 #endif