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