offapi/com/sun/star/sheet/XEnhancedMouseClickBroadcaster.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_sheet_XEnhancedMouseClickBroadcaster_idl__
  29 #define __com_sun_star_sheet_XEnhancedMouseClickBroadcaster_idl__
  30
  31 #ifndef __com_sun_star_uno_XInterface_idl__
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_awt_XEnhancedMouseClickHandler_idl__
  36 #include <com/sun/star/awt/XEnhancedMouseClickHandler.idl>
  37 #endif
  38
  39
  40 //=============================================================================
  41
  42 module com {  module sun {  module star {  module sheet {
  43
  44 //=============================================================================
  45
  46 /** provides methods to add and remove EnhancedMouseClickHandler
  47
  48     @since OOo 2.0.0
  49
  50  */
  51 published interface XEnhancedMouseClickBroadcaster: com::sun::star::uno::XInterface
  52 {
  53     //-------------------------------------------------------------------------
  54
  55     /** allows a component supporting the
  56         <type>XEnhancedMouseClickHandler</type> interface to
  57         register as listener.  The component will be notified with a
  58         <type>EnhancedMouseEvent</type> every time the mouse is clicked
  59         in the spreadsheet</p>
  60
  61         @param aListener
  62             the component that is to be added as listener
  63
  64         @see XEnhancedMouseClickHandler
  65         @see EnhancedMouseEvent
  66
  67         The interfaces in the EnhancedMouseEvent can be XCell or XShape
  68
  69         @see XShape
  70         @see XCell
  71
  72      */
  73     void addEnhancedMouseClickHandler([in] com::sun::star::awt::XEnhancedMouseClickHandler aListener);
  74
  75     //-------------------------------------------------------------------------
  76
  77     /** removes a previously registered listener.
  78
  79         @param aListener
  80             the component that is to be removed
  81      */
  82     void removeEnhancedMouseClickHandler( [in] com::sun::star::awt::XEnhancedMouseClickHandler aListener );
  83
  84 };
  85
  86 //=============================================================================
  87
  88 }; }; }; };
  89
  90 #endif
  91