slideshow/source/inc/enumanimation.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: enumanimation.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_ENUMANIMATION_HXX
  32 #define INCLUDED_SLIDESHOW_ENUMANIMATION_HXX
  33
  34 #include "animation.hxx"
  35
  36
  37 /* Definition of EnumAnimation interface */
  38
  39 namespace slideshow
  40 {
  41     namespace internal
  42     {
  43         /** Interface defining an enum animation.
  44
  45             This interface is a specialization of the Animation
  46             interface, and is used to animate attributes representable
  47             by a set of constant values, such as UNO constantsm, or enums.
  48          */
  49         class EnumAnimation : public Animation
  50         {
  51         public:
  52             typedef sal_Int16 ValueType;
  53
  54             /** Set the animation to value k
  55
  56                 @param k
  57                 Current animation value (must be in an
  58                 attribute-specific permissible range). Overflowing
  59                 values will be clipped to the permissible range
  60                 internally.
  61              */
  62             virtual bool operator()( ValueType k ) = 0;
  63
  64             /** Request the underlying value for this animation.
  65
  66                 This is necessary for pure To or By animations, as the
  67                 Activity cannot determine a sensible start value
  68                 otherwise.
  69
  70                 @attention Note that you are only permitted to query
  71                 for the underlying value, if the animation has actually
  72                 been started (via start() call).
  73              */
  74             virtual ValueType getUnderlyingValue() const = 0;
  75         };
  76
  77         typedef ::boost::shared_ptr< EnumAnimation > EnumAnimationSharedPtr;
  78
  79     }
  80 }
  81
  82 #endif /* INCLUDED_SLIDESHOW_ENUMANIMATION_HXX */