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 #ifndef INCLUDED_SLIDESHOW_EVENT_HXX 28*cdf0e10cSrcweir #define INCLUDED_SLIDESHOW_EVENT_HXX 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir #include "disposable.hxx" 31*cdf0e10cSrcweir #include "debug.hxx" 32*cdf0e10cSrcweir #include <rtl/ustring.hxx> 33*cdf0e10cSrcweir #include <boost/shared_ptr.hpp> 34*cdf0e10cSrcweir #include <vector> 35*cdf0e10cSrcweir 36*cdf0e10cSrcweir namespace slideshow { 37*cdf0e10cSrcweir namespace internal { 38*cdf0e10cSrcweir 39*cdf0e10cSrcweir /** Definition of Event interface 40*cdf0e10cSrcweir */ 41*cdf0e10cSrcweir class Event : public Disposable 42*cdf0e10cSrcweir { 43*cdf0e10cSrcweir public: 44*cdf0e10cSrcweir #if OSL_DEBUG_LEVEL > 1 45*cdf0e10cSrcweir Event (const ::rtl::OUString& rsDescription) : msDescription(rsDescription) {}; 46*cdf0e10cSrcweir #endif 47*cdf0e10cSrcweir 48*cdf0e10cSrcweir /** Execute the event. 49*cdf0e10cSrcweir 50*cdf0e10cSrcweir @return true, if event was successfully executed. 51*cdf0e10cSrcweir */ 52*cdf0e10cSrcweir virtual bool fire() = 0; 53*cdf0e10cSrcweir 54*cdf0e10cSrcweir /** Query whether this event is still charged, i.e. able 55*cdf0e10cSrcweir to fire. 56*cdf0e10cSrcweir 57*cdf0e10cSrcweir Inactive events are ignored by the normal event 58*cdf0e10cSrcweir containers (EventQueue, UserEventQueue etc.), and no 59*cdf0e10cSrcweir explicit fire() is called upon them. 60*cdf0e10cSrcweir 61*cdf0e10cSrcweir @return true, if this event has already been fired. 62*cdf0e10cSrcweir */ 63*cdf0e10cSrcweir virtual bool isCharged() const = 0; 64*cdf0e10cSrcweir 65*cdf0e10cSrcweir /** Query the activation time instant this event shall be 66*cdf0e10cSrcweir fired, if it was inserted at instant nCurrentTime into 67*cdf0e10cSrcweir the queue. 68*cdf0e10cSrcweir 69*cdf0e10cSrcweir @param nCurrentTime 70*cdf0e10cSrcweir The time from which the activation time is to be 71*cdf0e10cSrcweir calculated from. 72*cdf0e10cSrcweir 73*cdf0e10cSrcweir @return the time instant in seconds, on which this 74*cdf0e10cSrcweir event is to be fired. 75*cdf0e10cSrcweir */ 76*cdf0e10cSrcweir virtual double getActivationTime( double nCurrentTime ) const = 0; 77*cdf0e10cSrcweir 78*cdf0e10cSrcweir #if OSL_DEBUG_LEVEL > 1 79*cdf0e10cSrcweir ::rtl::OUString GetDescription (void) const { return msDescription; } 80*cdf0e10cSrcweir 81*cdf0e10cSrcweir private: 82*cdf0e10cSrcweir const ::rtl::OUString msDescription; 83*cdf0e10cSrcweir #endif 84*cdf0e10cSrcweir }; 85*cdf0e10cSrcweir 86*cdf0e10cSrcweir typedef ::boost::shared_ptr< Event > EventSharedPtr; 87*cdf0e10cSrcweir typedef ::std::vector< EventSharedPtr > VectorOfEvents; 88*cdf0e10cSrcweir 89*cdf0e10cSrcweir } // namespace internal 90*cdf0e10cSrcweir } // namespace presentation 91*cdf0e10cSrcweir 92*cdf0e10cSrcweir #endif /* INCLUDED_SLIDESHOW_EVENT_HXX */ 93