diff options
Diffstat (limited to 'slideshow/source/inc/wakeupevent.hxx')
-rw-r--r-- | slideshow/source/inc/wakeupevent.hxx | 93 |
1 files changed, 93 insertions, 0 deletions
diff --git a/slideshow/source/inc/wakeupevent.hxx b/slideshow/source/inc/wakeupevent.hxx new file mode 100644 index 000000000000..58e818a91459 --- /dev/null +++ b/slideshow/source/inc/wakeupevent.hxx @@ -0,0 +1,93 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef INCLUDED_SLIDESHOW_WAKEUPEVENT_HXX +#define INCLUDED_SLIDESHOW_WAKEUPEVENT_HXX + +#include <canvas/elapsedtime.hxx> + +#include "event.hxx" +#include "activitiesqueue.hxx" + +#include <boost/bind.hpp> +#include <boost/noncopyable.hpp> + +namespace slideshow { +namespace internal { + +/** Little helper class, used to set Activities active again + after some sleep period. + + Clients can use this class to schedule wakeup events at + the EventQueue, to avoid busy-waiting for the next + discrete time instant. +*/ +class WakeupEvent : public Event, + private ::boost::noncopyable +{ +public: + WakeupEvent( + ::boost::shared_ptr< ::canvas::tools::ElapsedTime > const& pTimeBase, + ActivitiesQueue & rActivityQueue ); + + virtual void dispose(); + virtual bool fire(); + virtual bool isCharged() const; + virtual double getActivationTime( double nCurrentTime ) const; + + /// Start the internal timer + void start(); + + /** Set the next timeout this object should generate. + + @param nextTime + Absolute time, measured from the last start() call, + when this event should wakeup the Activity again. If + your time is relative, simply call start() just before + every setNextTimeout() call. + */ + void setNextTimeout( double nextTime ); + + /** Set activity to wakeup. + + The activity given here will be reinserted into the + ActivitiesQueue, once the timeout is reached. + */ + void setActivity( const ActivitySharedPtr& rActivity ); + +private: + ::canvas::tools::ElapsedTime maTimer; + double mnNextTime; + ActivitySharedPtr mpActivity; + ActivitiesQueue& mrActivityQueue; +}; + +typedef ::boost::shared_ptr< WakeupEvent > WakeupEventSharedPtr; + +} // namespace internal +} // namespace presentation + +#endif /* INCLUDED_SLIDESHOW_WAKEUPEVENT_HXX */ |