Line data    Source code

       1             : /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
       2             : /*
       3             :  * This file is part of the LibreOffice project.
       4             :  *
       5             :  * This Source Code Form is subject to the terms of the Mozilla Public
       6             :  * License, v. 2.0. If a copy of the MPL was not distributed with this
       7             :  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
       8             :  *
       9             :  * This file incorporates work covered by the following license notice:
      10             :  *
      11             :  *   Licensed to the Apache Software Foundation (ASF) under one or more
      12             :  *   contributor license agreements. See the NOTICE file distributed
      13             :  *   with this work for additional information regarding copyright
      14             :  *   ownership. The ASF licenses this file to you under the Apache
      15             :  *   License, Version 2.0 (the "License"); you may not use this file
      16             :  *   except in compliance with the License. You may obtain a copy of
      17             :  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
      18             :  */
      19             : 
      20             : #ifndef INCLUDED_SLIDESHOW_ANIMATIONEVENTHANDLER_HXX
      21             : #define INCLUDED_SLIDESHOW_ANIMATIONEVENTHANDLER_HXX
      22             : 
      23             : #include <boost/shared_ptr.hpp>
      24             : #include "animationnode.hxx"
      25             : 
      26             : 
      27             : /* Definition of AnimationEventHandler interface */
      28             : 
      29             : namespace slideshow
      30             : {
      31             :     namespace internal
      32             :     {
      33             : 
      34             :         /** Interface for handling animation events.
      35             : 
      36             :             Classes implementing this interface can be added to an
      37             :             EventMultiplexer object, and are called from there to
      38             :             handle animation state change events.
      39             :          */
      40           2 :         class AnimationEventHandler
      41             :         {
      42             :         public:
      43           2 :             virtual ~AnimationEventHandler() {}
      44             : 
      45             :             /** Handle the event.
      46             : 
      47             :                 @param rNode
      48             :                 Animation node which caused this event to fire
      49             : 
      50             :                 @return true, if this handler has successfully
      51             :                 processed the animation event. When this method
      52             :                 returns false, possibly other, less prioritized
      53             :                 handlers are called, too.
      54             :              */
      55             :             virtual bool handleAnimationEvent( const AnimationNodeSharedPtr& rNode ) = 0;
      56             :         };
      57             : 
      58             :         typedef ::boost::shared_ptr< AnimationEventHandler > AnimationEventHandlerSharedPtr;
      59             : 
      60             :     }
      61             : }
      62             : 
      63             : #endif /* INCLUDED_SLIDESHOW_ANIMATIONEVENTHANDLER_HXX */
      64             : 
      65             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */