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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_XEnhancedMouseClickBroadcaster_idl__
  21 #define __com_sun_star_sheet_XEnhancedMouseClickBroadcaster_idl__
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/awt/XEnhancedMouseClickHandler.idl>
  25
  26
  27
  28 module com {  module sun {  module star {  module sheet {
  29
  30
  31 /** provides methods to add and remove EnhancedMouseClickHandler
  32
  33     @since OOo 2.0
  34
  35  */
  36 published interface XEnhancedMouseClickBroadcaster: com::sun::star::uno::XInterface
  37 {
  38
  39     /** allows a component supporting the
  40         XEnhancedMouseClickHandler interface to
  41         register as listener.  The component will be notified with a
  42         EnhancedMouseEvent every time the mouse is clicked
  43         in the spreadsheet</p>
  44
  45         @param aListener
  46             the component that is to be added as listener
  47
  48         @see XEnhancedMouseClickHandler
  49         @see EnhancedMouseEvent
  50
  51         The interfaces in the EnhancedMouseEvent can be XCell or XShape
  52
  53         @see XShape
  54         @see XCell
  55
  56      */
  57     void addEnhancedMouseClickHandler([in] com::sun::star::awt::XEnhancedMouseClickHandler aListener);
  58
  59
  60     /** removes a previously registered listener.
  61
  62         @param aListener
  63             the component that is to be removed
  64      */
  65     void removeEnhancedMouseClickHandler( [in] com::sun::star::awt::XEnhancedMouseClickHandler aListener );
  66
  67 };
  68
  69
  70 }; }; }; };
  71
  72 #endif
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */