offapi/com/sun/star/sheet/XEnhancedMouseClickBroadcaster.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: XEnhancedMouseClickBroadcaster.idl,v $
  10  * $Revision: 1.6 $
  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
  31 #ifndef __com_sun_star_sheet_XEnhancedMouseClickBroadcaster_idl__
  32 #define __com_sun_star_sheet_XEnhancedMouseClickBroadcaster_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_awt_XEnhancedMouseClickHandler_idl__
  39 #include <com/sun/star/awt/XEnhancedMouseClickHandler.idl>
  40 #endif
  41
  42
  43 //=============================================================================
  44
  45 module com {  module sun {  module star {  module sheet {
  46
  47 //=============================================================================
  48
  49 /** provides methods to add and remove EnhancedMouseClickHandler
  50
  51     @since OOo 2.0.0
  52
  53  */
  54 published interface XEnhancedMouseClickBroadcaster: com::sun::star::uno::XInterface
  55 {
  56     //-------------------------------------------------------------------------
  57
  58     /** allows a component supporting the
  59         <type>XEnhancedMouseClickHandler</type> interface to
  60         register as listener.  The component will be notified with a
  61         <type>EnhancedMouseEvent</type> every time the mouse is clicked
  62         in the spreadsheet</p>
  63
  64         @param aListener
  65             the component that is to be added as listener
  66
  67         @see XEnhancedMouseClickHandler
  68         @see EnhancedMouseEvent
  69
  70         The interfaces in the EnhancedMouseEvent can be XCell or XShape
  71
  72         @see XShape
  73         @see XCell
  74
  75      */
  76     void addEnhancedMouseClickHandler([in] com::sun::star::awt::XEnhancedMouseClickHandler aListener);
  77
  78     //-------------------------------------------------------------------------
  79
  80     /** removes a previously registered listener.
  81
  82         @param aListener
  83             the component that is to be removed
  84      */
  85     void removeEnhancedMouseClickHandler( [in] com::sun::star::awt::XEnhancedMouseClickHandler aListener );
  86
  87 };
  88
  89 //=============================================================================
  90
  91 }; }; }; };
  92
  93 #endif
  94