office-gobmx/slideshow/source/inc/animationeventhandler.hxx
2010-10-28 15:50:10 +01:00

74 lines
2.5 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* 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_ANIMATIONEVENTHANDLER_HXX
#define INCLUDED_SLIDESHOW_ANIMATIONEVENTHANDLER_HXX
#include <boost/shared_ptr.hpp>
#include "animationnode.hxx"
/* Definition of AnimationEventHandler interface */
namespace slideshow
{
namespace internal
{
/** Interface for handling animation events.
Classes implementing this interface can be added to an
EventMultiplexer object, and are called from there to
handle animation state change events.
*/
class AnimationEventHandler
{
public:
virtual ~AnimationEventHandler() {}
/** Handle the event.
@param rNode
Animation node which caused this event to fire
@return true, if this handler has successfully
processed the animation event. When this method
returns false, possibly other, less prioritized
handlers are called, too.
*/
virtual bool handleAnimationEvent( const AnimationNodeSharedPtr& rNode ) = 0;
};
typedef ::boost::shared_ptr< AnimationEventHandler > AnimationEventHandlerSharedPtr;
}
}
#endif /* INCLUDED_SLIDESHOW_ANIMATIONEVENTHANDLER_HXX */
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */