slideshow/source/engine/animationnodes/generateevent.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: generateevent.hxx,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef INCLUDED_SLIDESHOW_GENERATEEVENT_HXX
  32 #define INCLUDED_SLIDESHOW_GENERATEEVENT_HXX
  33
  34 #include "slideshowcontext.hxx"
  35 #include "delayevent.hxx"
  36 #include "com/sun/star/uno/Any.hxx"
  37
  38 namespace slideshow {
  39 namespace internal {
  40
  41 /** Create an event for the given description, calling the given functor.
  42
  43     @param rEventDescription
  44     Directly from API
  45
  46     @param rFunctor
  47     Functor to call when event fires.
  48
  49     @param rContext
  50     Context struct, to provide event queue
  51
  52     @param nAdditionalDelay
  53     Additional delay, gets added on top of timeout.
  54 */
  55 EventSharedPtr generateEvent(
  56     ::com::sun::star::uno::Any const& rEventDescription,
  57     Delay::FunctorT const& rFunctor,
  58     SlideShowContext const& rContext,
  59     double nAdditionalDelay );
  60
  61 } // namespace internal
  62 } // namespace slideshow
  63
  64 #endif /* INCLUDED_SLIDESHOW_GENERATEEVENT_HXX */
  65