1*cdf0e10cSrcweir /************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir #ifndef INCLUDED_SLIDESHOW_MOUSEEVENTHANDLER_HXX 29*cdf0e10cSrcweir #define INCLUDED_SLIDESHOW_MOUSEEVENTHANDLER_HXX 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir #include <boost/shared_ptr.hpp> 32*cdf0e10cSrcweir 33*cdf0e10cSrcweir namespace com { namespace sun { namespace star { namespace awt 34*cdf0e10cSrcweir { 35*cdf0e10cSrcweir struct MouseEvent; 36*cdf0e10cSrcweir } } } } 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir 39*cdf0e10cSrcweir /* Definition of MouseEventHandler interface */ 40*cdf0e10cSrcweir 41*cdf0e10cSrcweir namespace slideshow 42*cdf0e10cSrcweir { 43*cdf0e10cSrcweir namespace internal 44*cdf0e10cSrcweir { 45*cdf0e10cSrcweir 46*cdf0e10cSrcweir /** Interface for handling mouse events. 47*cdf0e10cSrcweir 48*cdf0e10cSrcweir Classes implementing this interface can be added to an 49*cdf0e10cSrcweir EventMultiplexer object, and are called from there to 50*cdf0e10cSrcweir handle mouse events. 51*cdf0e10cSrcweir */ 52*cdf0e10cSrcweir class MouseEventHandler 53*cdf0e10cSrcweir { 54*cdf0e10cSrcweir public: 55*cdf0e10cSrcweir virtual ~MouseEventHandler() {} 56*cdf0e10cSrcweir 57*cdf0e10cSrcweir /** Handle a mouse button pressed event. 58*cdf0e10cSrcweir 59*cdf0e10cSrcweir @param e 60*cdf0e10cSrcweir The mouse event that occurred. The x,y coordinates of 61*cdf0e10cSrcweir the event are already transformed back to user 62*cdf0e10cSrcweir coordinate space, taking the inverse transform of the 63*cdf0e10cSrcweir view in which the event occurred. 64*cdf0e10cSrcweir 65*cdf0e10cSrcweir @return true, if this handler has successfully 66*cdf0e10cSrcweir processed the mouse event. When this method returns 67*cdf0e10cSrcweir false, possibly other, less prioritized handlers can be 68*cdf0e10cSrcweir called, too. 69*cdf0e10cSrcweir */ 70*cdf0e10cSrcweir virtual bool handleMousePressed( const ::com::sun::star::awt::MouseEvent& e ) = 0; 71*cdf0e10cSrcweir 72*cdf0e10cSrcweir /** Handle a mouse button released event. 73*cdf0e10cSrcweir 74*cdf0e10cSrcweir @param e 75*cdf0e10cSrcweir The mouse event that occurred. The x,y coordinates of 76*cdf0e10cSrcweir the event are already transformed back to user 77*cdf0e10cSrcweir coordinate space, taking the inverse transform of the 78*cdf0e10cSrcweir view in which the event occurred. 79*cdf0e10cSrcweir 80*cdf0e10cSrcweir @return true, if this handler has successfully 81*cdf0e10cSrcweir processed the pause event. When this method returns 82*cdf0e10cSrcweir false, possibly other, less prioritized handlers are 83*cdf0e10cSrcweir called, too. 84*cdf0e10cSrcweir */ 85*cdf0e10cSrcweir virtual bool handleMouseReleased( const ::com::sun::star::awt::MouseEvent& e ) = 0; 86*cdf0e10cSrcweir 87*cdf0e10cSrcweir /** Handle a mouse entered the view event. 88*cdf0e10cSrcweir 89*cdf0e10cSrcweir @param e 90*cdf0e10cSrcweir The mouse event that occurred. The x,y coordinates of 91*cdf0e10cSrcweir the event are already transformed back to user 92*cdf0e10cSrcweir coordinate space, taking the inverse transform of the 93*cdf0e10cSrcweir view in which the event occurred. 94*cdf0e10cSrcweir 95*cdf0e10cSrcweir @return true, if this handler has successfully 96*cdf0e10cSrcweir processed the pause event. When this method returns 97*cdf0e10cSrcweir false, possibly other, less prioritized handlers are 98*cdf0e10cSrcweir called, too. 99*cdf0e10cSrcweir */ 100*cdf0e10cSrcweir virtual bool handleMouseEntered( const ::com::sun::star::awt::MouseEvent& e ) = 0; 101*cdf0e10cSrcweir 102*cdf0e10cSrcweir /** Handle a mouse exited the view event. 103*cdf0e10cSrcweir 104*cdf0e10cSrcweir @param e 105*cdf0e10cSrcweir The mouse event that occurred. The x,y coordinates of 106*cdf0e10cSrcweir the event are already transformed back to user 107*cdf0e10cSrcweir coordinate space, taking the inverse transform of the 108*cdf0e10cSrcweir view in which the event occurred. 109*cdf0e10cSrcweir 110*cdf0e10cSrcweir @return true, if this handler has successfully 111*cdf0e10cSrcweir processed the pause event. When this method returns 112*cdf0e10cSrcweir false, possibly other, less prioritized handlers are 113*cdf0e10cSrcweir called, too. 114*cdf0e10cSrcweir */ 115*cdf0e10cSrcweir virtual bool handleMouseExited( const ::com::sun::star::awt::MouseEvent& e ) = 0; 116*cdf0e10cSrcweir 117*cdf0e10cSrcweir /** Handle a mouse was moved with a pressed button event. 118*cdf0e10cSrcweir 119*cdf0e10cSrcweir @param e 120*cdf0e10cSrcweir The mouse event that occurred. The x,y coordinates of 121*cdf0e10cSrcweir the event are already transformed back to user 122*cdf0e10cSrcweir coordinate space, taking the inverse transform of the 123*cdf0e10cSrcweir view in which the event occurred. 124*cdf0e10cSrcweir 125*cdf0e10cSrcweir @return true, if this handler has successfully 126*cdf0e10cSrcweir processed the pause event. When this method returns 127*cdf0e10cSrcweir false, possibly other, less prioritized handlers are 128*cdf0e10cSrcweir called, too. 129*cdf0e10cSrcweir */ 130*cdf0e10cSrcweir virtual bool handleMouseDragged( const ::com::sun::star::awt::MouseEvent& e ) = 0; 131*cdf0e10cSrcweir 132*cdf0e10cSrcweir /** Handle a mouse was moved event. 133*cdf0e10cSrcweir 134*cdf0e10cSrcweir @param e 135*cdf0e10cSrcweir The mouse event that occurred. The x,y coordinates of 136*cdf0e10cSrcweir the event are already transformed back to user 137*cdf0e10cSrcweir coordinate space, taking the inverse transform of the 138*cdf0e10cSrcweir view in which the event occurred. 139*cdf0e10cSrcweir 140*cdf0e10cSrcweir @return true, if this handler has successfully 141*cdf0e10cSrcweir processed the pause event. When this method returns 142*cdf0e10cSrcweir false, possibly other, less prioritized handlers are 143*cdf0e10cSrcweir called, too. 144*cdf0e10cSrcweir */ 145*cdf0e10cSrcweir virtual bool handleMouseMoved( const ::com::sun::star::awt::MouseEvent& e ) = 0; 146*cdf0e10cSrcweir }; 147*cdf0e10cSrcweir 148*cdf0e10cSrcweir typedef ::boost::shared_ptr< MouseEventHandler > MouseEventHandlerSharedPtr; 149*cdf0e10cSrcweir 150*cdf0e10cSrcweir } 151*cdf0e10cSrcweir } 152*cdf0e10cSrcweir 153*cdf0e10cSrcweir #endif /* INCLUDED_SLIDESHOW_MOUSEEVENTHANDLER_HXX */ 154