slideshow/source/inc/animationeventhandler.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: animationeventhandler.hxx,v $
  10  * $Revision: 1.6 $
  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_ANIMATIONEVENTHANDLER_HXX
  32 #define INCLUDED_SLIDESHOW_ANIMATIONEVENTHANDLER_HXX
  33
  34 #include <boost/shared_ptr.hpp>
  35 #include "animationnode.hxx"
  36
  37
  38 /* Definition of AnimationEventHandler interface */
  39
  40 namespace slideshow
  41 {
  42     namespace internal
  43     {
  44
  45         /** Interface for handling animation events.
  46
  47             Classes implementing this interface can be added to an
  48             EventMultiplexer object, and are called from there to
  49             handle animation state change events.
  50          */
  51         class AnimationEventHandler
  52         {
  53         public:
  54             virtual ~AnimationEventHandler() {}
  55
  56             /** Handle the event.
  57
  58                 @param rNode
  59                 Animation node which caused this event to fire
  60
  61                 @return true, if this handler has successfully
  62                 processed the animation event. When this method
  63                 returns false, possibly other, less prioritized
  64                 handlers are called, too.
  65              */
  66             virtual bool handleAnimationEvent( const AnimationNodeSharedPtr& rNode ) = 0;
  67         };
  68
  69         typedef ::boost::shared_ptr< AnimationEventHandler > AnimationEventHandlerSharedPtr;
  70
  71     }
  72 }
  73
  74 #endif /* INCLUDED_SLIDESHOW_ANIMATIONEVENTHANDLER_HXX */