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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_awt_XMouseMotionHandler_idl__
  29 #define __com_sun_star_awt_XMouseMotionHandler_idl__
  30
  31 #include <com/sun/star/lang/XEventListener.idl>
  32
  33 #include <com/sun/star/awt/MouseEvent.idl>
  34
  35
  36 //=============================================================================
  37
  38  module com {  module sun {  module star {  module awt {
  39
  40 //=============================================================================
  41
  42 /** makes it possible to receive mouse motion events on a window.
  43  */
  44 published interface XMouseMotionHandler: com::sun::star::lang::XEventListener
  45 {
  46     //-------------------------------------------------------------------------
  47
  48     /** is invoked when a mouse button is pressed on a window and then
  49         dragged.
  50
  51         <p>Mouse drag events will continue to be delivered to
  52         the window where the first event originated until the mouse button is
  53         released (regardless of whether the mouse position is within the
  54         bounds of the window).</p>
  55
  56         @return
  57             When <FALSE/> is returned the other handlers are called and a
  58             following handling of the event by the broadcaster takes place.
  59             Otherwise, when <TRUE/> is returned, no other handler will be
  60             called and the broadcaster will take no further actions
  61             regarding the event.
  62
  63      */
  64     boolean mouseDragged( [in] com::sun::star::awt::MouseEvent e );
  65
  66     //-------------------------------------------------------------------------
  67
  68     /** is invoked when the mouse button has been moved on a window
  69         (with no buttons down).
  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      */
  79     boolean mouseMoved( [in] com::sun::star::awt::MouseEvent e );
  80
  81 };
  82
  83 //=============================================================================
  84
  85 }; }; }; };
  86
  87 #endif
  88
  89 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */