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