82 lines
2.7 KiB
C++
82 lines
2.7 KiB
C++
/*************************************************************************
|
|
*
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
*
|
|
* Copyright 2008 by Sun Microsystems, Inc.
|
|
*
|
|
* OpenOffice.org - a multi-platform office productivity suite
|
|
*
|
|
* $RCSfile: enumanimation.hxx,v $
|
|
* $Revision: 1.6 $
|
|
*
|
|
* 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_ENUMANIMATION_HXX
|
|
#define INCLUDED_SLIDESHOW_ENUMANIMATION_HXX
|
|
|
|
#include "animation.hxx"
|
|
|
|
|
|
/* Definition of EnumAnimation interface */
|
|
|
|
namespace slideshow
|
|
{
|
|
namespace internal
|
|
{
|
|
/** Interface defining an enum animation.
|
|
|
|
This interface is a specialization of the Animation
|
|
interface, and is used to animate attributes representable
|
|
by a set of constant values, such as UNO constantsm, or enums.
|
|
*/
|
|
class EnumAnimation : public Animation
|
|
{
|
|
public:
|
|
typedef sal_Int16 ValueType;
|
|
|
|
/** Set the animation to value k
|
|
|
|
@param k
|
|
Current animation value (must be in an
|
|
attribute-specific permissible range). Overflowing
|
|
values will be clipped to the permissible range
|
|
internally.
|
|
*/
|
|
virtual bool operator()( ValueType k ) = 0;
|
|
|
|
/** Request the underlying value for this animation.
|
|
|
|
This is necessary for pure To or By animations, as the
|
|
Activity cannot determine a sensible start value
|
|
otherwise.
|
|
|
|
@attention Note that you are only permitted to query
|
|
for the underlying value, if the animation has actually
|
|
been started (via start() call).
|
|
*/
|
|
virtual ValueType getUnderlyingValue() const = 0;
|
|
};
|
|
|
|
typedef ::boost::shared_ptr< EnumAnimation > EnumAnimationSharedPtr;
|
|
|
|
}
|
|
}
|
|
|
|
#endif /* INCLUDED_SLIDESHOW_ENUMANIMATION_HXX */
|