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