1*aaef562fSAndrew Rist /************************************************************** 2cdf0e10cSrcweir * 3*aaef562fSAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*aaef562fSAndrew Rist * or more contributor license agreements. See the NOTICE file 5*aaef562fSAndrew Rist * distributed with this work for additional information 6*aaef562fSAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*aaef562fSAndrew Rist * to you under the Apache License, Version 2.0 (the 8*aaef562fSAndrew Rist * "License"); you may not use this file except in compliance 9*aaef562fSAndrew Rist * with the License. You may obtain a copy of the License at 10*aaef562fSAndrew Rist * 11*aaef562fSAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*aaef562fSAndrew Rist * 13*aaef562fSAndrew Rist * Unless required by applicable law or agreed to in writing, 14*aaef562fSAndrew Rist * software distributed under the License is distributed on an 15*aaef562fSAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*aaef562fSAndrew Rist * KIND, either express or implied. See the License for the 17*aaef562fSAndrew Rist * specific language governing permissions and limitations 18*aaef562fSAndrew Rist * under the License. 19*aaef562fSAndrew Rist * 20*aaef562fSAndrew Rist *************************************************************/ 21*aaef562fSAndrew Rist 22*aaef562fSAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir #ifndef INCLUDED_SLIDESHOW_MOUSEEVENTHANDLER_HXX 25cdf0e10cSrcweir #define INCLUDED_SLIDESHOW_MOUSEEVENTHANDLER_HXX 26cdf0e10cSrcweir 27cdf0e10cSrcweir #include <boost/shared_ptr.hpp> 28cdf0e10cSrcweir 29cdf0e10cSrcweir namespace com { namespace sun { namespace star { namespace awt 30cdf0e10cSrcweir { 31cdf0e10cSrcweir struct MouseEvent; 32cdf0e10cSrcweir } } } } 33cdf0e10cSrcweir 34cdf0e10cSrcweir 35cdf0e10cSrcweir /* Definition of MouseEventHandler interface */ 36cdf0e10cSrcweir 37cdf0e10cSrcweir namespace slideshow 38cdf0e10cSrcweir { 39cdf0e10cSrcweir namespace internal 40cdf0e10cSrcweir { 41cdf0e10cSrcweir 42cdf0e10cSrcweir /** Interface for handling mouse events. 43cdf0e10cSrcweir 44cdf0e10cSrcweir Classes implementing this interface can be added to an 45cdf0e10cSrcweir EventMultiplexer object, and are called from there to 46cdf0e10cSrcweir handle mouse events. 47cdf0e10cSrcweir */ 48cdf0e10cSrcweir class MouseEventHandler 49cdf0e10cSrcweir { 50cdf0e10cSrcweir public: ~MouseEventHandler()51cdf0e10cSrcweir virtual ~MouseEventHandler() {} 52cdf0e10cSrcweir 53cdf0e10cSrcweir /** Handle a mouse button pressed event. 54cdf0e10cSrcweir 55cdf0e10cSrcweir @param e 56cdf0e10cSrcweir The mouse event that occurred. The x,y coordinates of 57cdf0e10cSrcweir the event are already transformed back to user 58cdf0e10cSrcweir coordinate space, taking the inverse transform of the 59cdf0e10cSrcweir view in which the event occurred. 60cdf0e10cSrcweir 61cdf0e10cSrcweir @return true, if this handler has successfully 62cdf0e10cSrcweir processed the mouse event. When this method returns 63cdf0e10cSrcweir false, possibly other, less prioritized handlers can be 64cdf0e10cSrcweir called, too. 65cdf0e10cSrcweir */ 66cdf0e10cSrcweir virtual bool handleMousePressed( const ::com::sun::star::awt::MouseEvent& e ) = 0; 67cdf0e10cSrcweir 68cdf0e10cSrcweir /** Handle a mouse button released event. 69cdf0e10cSrcweir 70cdf0e10cSrcweir @param e 71cdf0e10cSrcweir The mouse event that occurred. The x,y coordinates of 72cdf0e10cSrcweir the event are already transformed back to user 73cdf0e10cSrcweir coordinate space, taking the inverse transform of the 74cdf0e10cSrcweir view in which the event occurred. 75cdf0e10cSrcweir 76cdf0e10cSrcweir @return true, if this handler has successfully 77cdf0e10cSrcweir processed the pause event. When this method returns 78cdf0e10cSrcweir false, possibly other, less prioritized handlers are 79cdf0e10cSrcweir called, too. 80cdf0e10cSrcweir */ 81cdf0e10cSrcweir virtual bool handleMouseReleased( const ::com::sun::star::awt::MouseEvent& e ) = 0; 82cdf0e10cSrcweir 83cdf0e10cSrcweir /** Handle a mouse entered the view event. 84cdf0e10cSrcweir 85cdf0e10cSrcweir @param e 86cdf0e10cSrcweir The mouse event that occurred. The x,y coordinates of 87cdf0e10cSrcweir the event are already transformed back to user 88cdf0e10cSrcweir coordinate space, taking the inverse transform of the 89cdf0e10cSrcweir view in which the event occurred. 90cdf0e10cSrcweir 91cdf0e10cSrcweir @return true, if this handler has successfully 92cdf0e10cSrcweir processed the pause event. When this method returns 93cdf0e10cSrcweir false, possibly other, less prioritized handlers are 94cdf0e10cSrcweir called, too. 95cdf0e10cSrcweir */ 96cdf0e10cSrcweir virtual bool handleMouseEntered( const ::com::sun::star::awt::MouseEvent& e ) = 0; 97cdf0e10cSrcweir 98cdf0e10cSrcweir /** Handle a mouse exited the view event. 99cdf0e10cSrcweir 100cdf0e10cSrcweir @param e 101cdf0e10cSrcweir The mouse event that occurred. The x,y coordinates of 102cdf0e10cSrcweir the event are already transformed back to user 103cdf0e10cSrcweir coordinate space, taking the inverse transform of the 104cdf0e10cSrcweir view in which the event occurred. 105cdf0e10cSrcweir 106cdf0e10cSrcweir @return true, if this handler has successfully 107cdf0e10cSrcweir processed the pause event. When this method returns 108cdf0e10cSrcweir false, possibly other, less prioritized handlers are 109cdf0e10cSrcweir called, too. 110cdf0e10cSrcweir */ 111cdf0e10cSrcweir virtual bool handleMouseExited( const ::com::sun::star::awt::MouseEvent& e ) = 0; 112cdf0e10cSrcweir 113cdf0e10cSrcweir /** Handle a mouse was moved with a pressed button event. 114cdf0e10cSrcweir 115cdf0e10cSrcweir @param e 116cdf0e10cSrcweir The mouse event that occurred. The x,y coordinates of 117cdf0e10cSrcweir the event are already transformed back to user 118cdf0e10cSrcweir coordinate space, taking the inverse transform of the 119cdf0e10cSrcweir view in which the event occurred. 120cdf0e10cSrcweir 121cdf0e10cSrcweir @return true, if this handler has successfully 122cdf0e10cSrcweir processed the pause event. When this method returns 123cdf0e10cSrcweir false, possibly other, less prioritized handlers are 124cdf0e10cSrcweir called, too. 125cdf0e10cSrcweir */ 126cdf0e10cSrcweir virtual bool handleMouseDragged( const ::com::sun::star::awt::MouseEvent& e ) = 0; 127cdf0e10cSrcweir 128cdf0e10cSrcweir /** Handle a mouse was moved event. 129cdf0e10cSrcweir 130cdf0e10cSrcweir @param e 131cdf0e10cSrcweir The mouse event that occurred. The x,y coordinates of 132cdf0e10cSrcweir the event are already transformed back to user 133cdf0e10cSrcweir coordinate space, taking the inverse transform of the 134cdf0e10cSrcweir view in which the event occurred. 135cdf0e10cSrcweir 136cdf0e10cSrcweir @return true, if this handler has successfully 137cdf0e10cSrcweir processed the pause event. When this method returns 138cdf0e10cSrcweir false, possibly other, less prioritized handlers are 139cdf0e10cSrcweir called, too. 140cdf0e10cSrcweir */ 141cdf0e10cSrcweir virtual bool handleMouseMoved( const ::com::sun::star::awt::MouseEvent& e ) = 0; 142cdf0e10cSrcweir }; 143cdf0e10cSrcweir 144cdf0e10cSrcweir typedef ::boost::shared_ptr< MouseEventHandler > MouseEventHandlerSharedPtr; 145cdf0e10cSrcweir 146cdf0e10cSrcweir } 147cdf0e10cSrcweir } 148cdf0e10cSrcweir 149cdf0e10cSrcweir #endif /* INCLUDED_SLIDESHOW_MOUSEEVENTHANDLER_HXX */ 150