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

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 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 OOo 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