/************************************************************************* * * $RCSfile: mouseeventhandler.hxx,v $ * * $Revision: 1.2 $ * * last change: $Author: rt $ $Date: 2004-11-26 19:18:24 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses * * - GNU Lesser General Public License Version 2.1 * - Sun Industry Standards Source License Version 1.1 * * Sun Microsystems Inc., October, 2000 * * GNU Lesser General Public License Version 2.1 * ============================================= * Copyright 2000 by Sun Microsystems, Inc. * 901 San Antonio Road, Palo Alto, CA 94303, USA * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License version 2.1, as published by the Free Software Foundation. * * This library 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 for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, * MA 02111-1307 USA * * * Sun Industry Standards Source License Version 1.1 * ================================================= * The contents of this file are subject to the Sun Industry Standards * Source License Version 1.1 (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.openoffice.org/license.html. * * Software provided under this License is provided on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. * See the License for the specific provisions governing your rights and * obligations concerning the Software. * * The Initial Developer of the Original Code is: Sun Microsystems, Inc. * * Copyright: 2000 by Sun Microsystems, Inc. * * All Rights Reserved. * * Contributor(s): _______________________________________ * * ************************************************************************/ #ifndef _SLIDESHOW_MOUSEEVENTHANDLER_HXX #define _SLIDESHOW_MOUSEEVENTHANDLER_HXX #ifndef BOOST_SHARED_PTR_HPP_INCLUDED #include #endif #include namespace com { namespace sun { namespace star { namespace awt { struct MouseEvent; } } } } /* Definition of MouseEventHandler interface */ namespace presentation { namespace internal { /** Interface for handling mouse events. Classes implementing this interface can be added to an EventMultiplexer object, and are called from there to handle mouse events. */ class MouseEventHandler : public Disposable { public: /** Handle a mouse button pressed event. @param e The mouse event that occurred. The x,y coordinates of the event are already transformed back to user coordinate space, taking the inverse transform of the view in which the event occurred. @return true, if this handler has successfully processed the mouse event. When this method returns false, possibly other, less prioritized handlers can be called, too. */ virtual bool handleMousePressed( const ::com::sun::star::awt::MouseEvent& e ) = 0; /** Handle a mouse button released event. @param e The mouse event that occurred. The x,y coordinates of the event are already transformed back to user coordinate space, taking the inverse transform of the view in which the event occurred. @return true, if this handler has successfully processed the pause event. When this method returns false, possibly other, less prioritized handlers are called, too. */ virtual bool handleMouseReleased( const ::com::sun::star::awt::MouseEvent& e ) = 0; /** Handle a mouse entered the view event. @param e The mouse event that occurred. The x,y coordinates of the event are already transformed back to user coordinate space, taking the inverse transform of the view in which the event occurred. @return true, if this handler has successfully processed the pause event. When this method returns false, possibly other, less prioritized handlers are called, too. */ virtual bool handleMouseEntered( const ::com::sun::star::awt::MouseEvent& e ) = 0; /** Handle a mouse exited the view event. @param e The mouse event that occurred. The x,y coordinates of the event are already transformed back to user coordinate space, taking the inverse transform of the view in which the event occurred. @return true, if this handler has successfully processed the pause event. When this method returns false, possibly other, less prioritized handlers are called, too. */ virtual bool handleMouseExited( const ::com::sun::star::awt::MouseEvent& e ) = 0; /** Handle a mouse was moved with a pressed button event. @param e The mouse event that occurred. The x,y coordinates of the event are already transformed back to user coordinate space, taking the inverse transform of the view in which the event occurred. @return true, if this handler has successfully processed the pause event. When this method returns false, possibly other, less prioritized handlers are called, too. */ virtual bool handleMouseDragged( const ::com::sun::star::awt::MouseEvent& e ) = 0; /** Handle a mouse was moved event. @param e The mouse event that occurred. The x,y coordinates of the event are already transformed back to user coordinate space, taking the inverse transform of the view in which the event occurred. @return true, if this handler has successfully processed the pause event. When this method returns false, possibly other, less prioritized handlers are called, too. */ virtual bool handleMouseMoved( const ::com::sun::star::awt::MouseEvent& e ) = 0; }; typedef ::boost::shared_ptr< MouseEventHandler > MouseEventHandlerSharedPtr; } } #endif /* _SLIDESHOW_MOUSEEVENTHANDLER_HXX */