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_STRINGANIMATION_HXX
      21             : #define INCLUDED_SLIDESHOW_STRINGANIMATION_HXX
      22             : 
      23             : #include "animation.hxx"
      24             : #include <rtl/ustring.hxx>
      25             : 
      26             : 
      27             : /* Definition of StringAnimation interface */
      28             : 
      29             : namespace slideshow
      30             : {
      31             :     namespace internal
      32             :     {
      33             :         /** Interface defining a string animation.
      34             : 
      35             :             This interface is a specialization of the Animation
      36             :             interface, and is used to animate attributes representable
      37             :             by a discrete character string (e.g. font names)
      38             :          */
      39           0 :         class StringAnimation : public Animation
      40             :         {
      41             :         public:
      42             :             typedef ::rtl::OUString ValueType;
      43             : 
      44             :             /** Set the animation to value rStr
      45             : 
      46             :                 @param rStr
      47             :                 Current animation value.
      48             :              */
      49             :             virtual bool operator()( const ValueType& rStr ) = 0;
      50             : 
      51             :             /** Request the underlying value for this animation.
      52             : 
      53             :                 This is necessary for pure To or By animations, as the
      54             :                 Activity cannot determine a sensible start value
      55             :                 otherwise.
      56             : 
      57             :                 @attention Note that you are only permitted to query
      58             :                 for the underlying value, if the animation has actually
      59             :                 been started (via start() call).
      60             :              */
      61             :             virtual ValueType getUnderlyingValue() const = 0;
      62             :         };
      63             : 
      64             :         typedef ::boost::shared_ptr< StringAnimation > StringAnimationSharedPtr;
      65             : 
      66             :     }
      67             : }
      68             : 
      69             : #endif /* INCLUDED_SLIDESHOW_STRINGANIMATION_HXX */
      70             : 
      71             : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */