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_ACTIVITY_HXX 29*cdf0e10cSrcweir #define INCLUDED_SLIDESHOW_ACTIVITY_HXX 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir #include <sal/types.h> 32*cdf0e10cSrcweir 33*cdf0e10cSrcweir #include <boost/shared_ptr.hpp> 34*cdf0e10cSrcweir 35*cdf0e10cSrcweir #include "disposable.hxx" 36*cdf0e10cSrcweir 37*cdf0e10cSrcweir 38*cdf0e10cSrcweir /* Definition of Activity interface */ 39*cdf0e10cSrcweir 40*cdf0e10cSrcweir namespace slideshow 41*cdf0e10cSrcweir { 42*cdf0e10cSrcweir namespace internal 43*cdf0e10cSrcweir { 44*cdf0e10cSrcweir 45*cdf0e10cSrcweir class Activity : public Disposable 46*cdf0e10cSrcweir { 47*cdf0e10cSrcweir public: 48*cdf0e10cSrcweir /** Perform the activity associated with this interface's 49*cdf0e10cSrcweir implementation. 50*cdf0e10cSrcweir 51*cdf0e10cSrcweir @return true, if activity continues, or false, if activity has 52*cdf0e10cSrcweir ended. 53*cdf0e10cSrcweir */ 54*cdf0e10cSrcweir virtual bool perform() = 0; 55*cdf0e10cSrcweir 56*cdf0e10cSrcweir /** Calculates whether the activity lags time. 57*cdf0e10cSrcweir 58*cdf0e10cSrcweir If this method returns a time lag greater than 0.0, 59*cdf0e10cSrcweir the ActivitiesQueue will adjust the global slideshow 60*cdf0e10cSrcweir time, by subtracting the given amount of lag. 61*cdf0e10cSrcweir 62*cdf0e10cSrcweir @return time lag or 0.0. Value must be greater or 63*cdf0e10cSrcweir equal than zero. 64*cdf0e10cSrcweir */ 65*cdf0e10cSrcweir virtual double calcTimeLag() const = 0; 66*cdf0e10cSrcweir 67*cdf0e10cSrcweir /** Query whether this activity is still continuing 68*cdf0e10cSrcweir 69*cdf0e10cSrcweir @return true, if this activity still 70*cdf0e10cSrcweir continues. Returns false, if activity has ended. It is 71*cdf0e10cSrcweir required that operator() returns false, when 72*cdf0e10cSrcweir isActive() returns false. Furthermore, it is required 73*cdf0e10cSrcweir that the inactive state is persistent; an activity 74*cdf0e10cSrcweir that has become inactive (i.e. isActive() once 75*cdf0e10cSrcweir returned false) must stay in that state eternally. 76*cdf0e10cSrcweir */ 77*cdf0e10cSrcweir virtual bool isActive() const = 0; 78*cdf0e10cSrcweir 79*cdf0e10cSrcweir /** Notifies the Activity that it has now left the 80*cdf0e10cSrcweir ActivitiesQueue 81*cdf0e10cSrcweir 82*cdf0e10cSrcweir Use this method to react on the queue removal 83*cdf0e10cSrcweir event. For animated shapes, this is e.g. used to 84*cdf0e10cSrcweir switch back to the non-sprite presentation mode of the 85*cdf0e10cSrcweir shape. 86*cdf0e10cSrcweir */ 87*cdf0e10cSrcweir virtual void dequeued() = 0; 88*cdf0e10cSrcweir 89*cdf0e10cSrcweir /** Forces this activity deactivate and get to its end state 90*cdf0e10cSrcweir (if possible), but does _not_ dispose. 91*cdf0e10cSrcweir */ 92*cdf0e10cSrcweir virtual void end() = 0; 93*cdf0e10cSrcweir }; 94*cdf0e10cSrcweir 95*cdf0e10cSrcweir typedef ::boost::shared_ptr< Activity > ActivitySharedPtr; 96*cdf0e10cSrcweir 97*cdf0e10cSrcweir } 98*cdf0e10cSrcweir } 99*cdf0e10cSrcweir 100*cdf0e10cSrcweir #endif /* INCLUDED_SLIDESHOW_ACTIVITY_HXX */ 101