xref: /aoo41x/main/offapi/com/sun/star/sheet/XEnhancedMouseClickBroadcaster.idl (revision fbef625e)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_sheet_XEnhancedMouseClickBroadcaster_idl__
#define __com_sun_star_sheet_XEnhancedMouseClickBroadcaster_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_awt_XEnhancedMouseClickHandler_idl__
#include <com/sun/star/awt/XEnhancedMouseClickHandler.idl>
#endif


//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** provides methods to add and remove EnhancedMouseClickHandler

	@since OpenOffice 2.0

 */
published interface XEnhancedMouseClickBroadcaster: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------

	/** allows a component supporting the
        <type>XEnhancedMouseClickHandler</type> interface to
        register as listener.  The component will be notified with a
        <type>EnhancedMouseEvent</type> every time the mouse is clicked
        in the spreadsheet</p>

        @param aListener
        	the component that is to be added as listener

        @see XEnhancedMouseClickHandler
        @see EnhancedMouseEvent

        The interfaces in the EnhancedMouseEvent can be XCell or XShape

        @see XShape
        @see XCell

	 */
	void addEnhancedMouseClickHandler([in] com::sun::star::awt::XEnhancedMouseClickHandler aListener);

	//-------------------------------------------------------------------------

	/** removes a previously registered listener.

        @param aListener
        	the component that is to be removed
	 */
	void removeEnhancedMouseClickHandler( [in] com::sun::star::awt::XEnhancedMouseClickHandler aListener );

};

//=============================================================================

}; }; }; };

#endif