1*b1cdbd2cSJim Jagielski /************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski #ifndef INCLUDED_SLIDESHOW_ACTIVITY_HXX 25*b1cdbd2cSJim Jagielski #define INCLUDED_SLIDESHOW_ACTIVITY_HXX 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski #include <sal/types.h> 28*b1cdbd2cSJim Jagielski 29*b1cdbd2cSJim Jagielski #include <boost/shared_ptr.hpp> 30*b1cdbd2cSJim Jagielski 31*b1cdbd2cSJim Jagielski #include "disposable.hxx" 32*b1cdbd2cSJim Jagielski 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski /* Definition of Activity interface */ 35*b1cdbd2cSJim Jagielski 36*b1cdbd2cSJim Jagielski namespace slideshow 37*b1cdbd2cSJim Jagielski { 38*b1cdbd2cSJim Jagielski namespace internal 39*b1cdbd2cSJim Jagielski { 40*b1cdbd2cSJim Jagielski 41*b1cdbd2cSJim Jagielski class Activity : public Disposable 42*b1cdbd2cSJim Jagielski { 43*b1cdbd2cSJim Jagielski public: 44*b1cdbd2cSJim Jagielski /** Perform the activity associated with this interface's 45*b1cdbd2cSJim Jagielski implementation. 46*b1cdbd2cSJim Jagielski 47*b1cdbd2cSJim Jagielski @return true, if activity continues, or false, if activity has 48*b1cdbd2cSJim Jagielski ended. 49*b1cdbd2cSJim Jagielski */ 50*b1cdbd2cSJim Jagielski virtual bool perform() = 0; 51*b1cdbd2cSJim Jagielski 52*b1cdbd2cSJim Jagielski /** Calculates whether the activity lags time. 53*b1cdbd2cSJim Jagielski 54*b1cdbd2cSJim Jagielski If this method returns a time lag greater than 0.0, 55*b1cdbd2cSJim Jagielski the ActivitiesQueue will adjust the global slideshow 56*b1cdbd2cSJim Jagielski time, by subtracting the given amount of lag. 57*b1cdbd2cSJim Jagielski 58*b1cdbd2cSJim Jagielski @return time lag or 0.0. Value must be greater or 59*b1cdbd2cSJim Jagielski equal than zero. 60*b1cdbd2cSJim Jagielski */ 61*b1cdbd2cSJim Jagielski virtual double calcTimeLag() const = 0; 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski /** Query whether this activity is still continuing 64*b1cdbd2cSJim Jagielski 65*b1cdbd2cSJim Jagielski @return true, if this activity still 66*b1cdbd2cSJim Jagielski continues. Returns false, if activity has ended. It is 67*b1cdbd2cSJim Jagielski required that operator() returns false, when 68*b1cdbd2cSJim Jagielski isActive() returns false. Furthermore, it is required 69*b1cdbd2cSJim Jagielski that the inactive state is persistent; an activity 70*b1cdbd2cSJim Jagielski that has become inactive (i.e. isActive() once 71*b1cdbd2cSJim Jagielski returned false) must stay in that state eternally. 72*b1cdbd2cSJim Jagielski */ 73*b1cdbd2cSJim Jagielski virtual bool isActive() const = 0; 74*b1cdbd2cSJim Jagielski 75*b1cdbd2cSJim Jagielski /** Notifies the Activity that it has now left the 76*b1cdbd2cSJim Jagielski ActivitiesQueue 77*b1cdbd2cSJim Jagielski 78*b1cdbd2cSJim Jagielski Use this method to react on the queue removal 79*b1cdbd2cSJim Jagielski event. For animated shapes, this is e.g. used to 80*b1cdbd2cSJim Jagielski switch back to the non-sprite presentation mode of the 81*b1cdbd2cSJim Jagielski shape. 82*b1cdbd2cSJim Jagielski */ 83*b1cdbd2cSJim Jagielski virtual void dequeued() = 0; 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski /** Forces this activity deactivate and get to its end state 86*b1cdbd2cSJim Jagielski (if possible), but does _not_ dispose. 87*b1cdbd2cSJim Jagielski */ 88*b1cdbd2cSJim Jagielski virtual void end() = 0; 89*b1cdbd2cSJim Jagielski }; 90*b1cdbd2cSJim Jagielski 91*b1cdbd2cSJim Jagielski typedef ::boost::shared_ptr< Activity > ActivitySharedPtr; 92*b1cdbd2cSJim Jagielski 93*b1cdbd2cSJim Jagielski } 94*b1cdbd2cSJim Jagielski } 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski #endif /* INCLUDED_SLIDESHOW_ACTIVITY_HXX */ 97