sd/source/filter/ppt/ppt97animations.hxx

   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 #pragma once
  21
  22 #include <rtl/ustring.hxx>
  23 #include <sal/types.h>
  24 #include <tools/color.hxx>
  25
  26 class SdrObject;
  27 class SvStream;
  28
  29 /// helper class for reading PPT AnimationInfoAtom
  30 class Ppt97AnimationInfoAtom
  31 {
  32     friend class Ppt97Animation;
  33
  34 //-- member
  35     Color               nDimColor;
  36     sal_uInt32          nFlags;         ///< 0x0004: time instead of click
  37     sal_uInt32          nSoundRef;
  38     sal_Int32           nDelayTime;     ///< 1/1000 sec
  39     sal_uInt16          nOrderID;
  40     sal_uInt16          nSlideCount;
  41     sal_uInt8           nBuildType;
  42     sal_uInt8           nFlyMethod;
  43     sal_uInt8           nFlyDirection;
  44     sal_uInt8           nAfterEffect;   ///< nAfterEffect: 0: none; 1: change color; 2: dim on next effect; 3: dim after effect;
  45     sal_uInt8           nSubEffect;
  46     sal_uInt8           nOLEVerb;
  47
  48     // unknown, because whole size needs to be 28
  49     sal_uInt8           nUnknown1;
  50     sal_uInt8           nUnknown2;
  51
  52 //-- methods
  53     void ReadStream( SvStream& rIn );
  54 /*
  55     nFlags:
  56     decimal / hexadecimal / binary
  57     1040 0x00000410     10000010000 mouseclick
  58    17428 0x00004414 100010000010100 after previous 0 sec (animate form)
  59    17412 0x00004404 100010000000100 after previous 0 sec
  60     1088 0x00000440     10001000000 stop previous sound and mouseclick
  61     1044 0x00000414     10000010100 play sound automatic
  62     1041 0x00000411     10000010001
  63                     |   |   | | | |
  64                     |   |   | | | reverse order
  65                     |   |   | | after previous
  66                     |   |   | sound
  67                     |   |   stop previous sound
  68                     |   ?
  69                     animate form
  70
  71     nAfterEffect:
  72     1: color
  73     0: nothing
  74     3: hide after animation
  75     2: hide at next mouse click
  76 */
  77 };
  78
  79 /** this is a helping class for import of PPT 97 animations
  80         1. use the constructor Ppt97Animation( SvStream& rIn ) to import information from the stream
  81         2. use the set methods to modify and complete the data
  82         3. use the method createAndSetCustomAnimationEffect( ) to create an effect in sd model
  83     */
  84 class Ppt97Animation
  85 {
  86
  87 public: //public methods
  88     explicit Ppt97Animation( SvStream& rIn );
  89
  90     bool operator < ( const Ppt97Animation& rAnimation ) const;//later is greater
  91     bool operator > ( const Ppt97Animation& rAnimation ) const;//later is greater
  92
  93     //get methods
  94     bool HasEffect() const;
  95     bool HasParagraphEffect() const;
  96     bool HasSoundEffect() const;
  97     sal_Int32 GetDimColor() const { return static_cast<sal_Int32>(m_aAtom.nDimColor);}
  98     sal_uInt32 GetSoundRef() const { return m_aAtom.nSoundRef;}
  99     /// @return true if the shape should be animated in addition to the text
 100     bool HasAnimateAssociatedShape() const;
 101
 102     //set methods
 103     void SetDimColor( Color nDimColor );
 104     void SetSoundFileUrl( const OUString& rSoundFileUrl );
 105     void SetAnimateAssociatedShape( bool bAnimate ); //true if the shape should be animated in addition to the text
 106
 107     //action methods
 108     /** this method creates a CustomAnimationEffect for the given SdrObject
 109     from internal data and stores the created effect at the draw model
 110     */
 111     void createAndSetCustomAnimationEffect( SdrObject* pObj );
 112
 113 private: //private methods
 114
 115     //read methods
 116     OUString const & GetPresetId() const;
 117     OUString const & GetPresetSubType() const;
 118     bool HasAfterEffect() const;
 119     bool HasAfterEffect_ChangeColor() const;
 120     bool HasAfterEffect_DimAtNextEffect() const;
 121     bool HasStopPreviousSound() const;
 122
 123     /// @return true if the text paragraphs should be animated in reverse order
 124     bool HasReverseOrder() const;
 125
 126     ///paragraph level that is animated ( that paragraph and higher levels )
 127     sal_Int32 GetParagraphLevel() const;
 128
 129     ///@see css::presentation::TextAnimationType
 130     sal_Int16 GetTextAnimationType() const;
 131
 132     ///@see css::presentation::EffectNodeType
 133     sal_Int16 GetEffectNodeType() const;
 134
 135     /// @return -1 for start on mouseclick or >= 0 for a delay in seconds for automatic start
 136     double GetDelayTimeInSeconds() const;
 137     bool GetSpecialDuration( double& rfDurationInSeconds ) const;
 138     bool GetSpecialTextIterationDelay( double& rfTextIterationDelay ) const;
 139
 140     void UpdateCacheData() const;
 141     void ClearCacheData() const;
 142
 143 private: //private member
 144     //input information:
 145     Ppt97AnimationInfoAtom  m_aAtom;         ///< pure input from stream
 146     OUString         m_aSoundFileUrl; ///< this needs to be set in addition from outside as this class has not the knowledge to translate the sound bits to a file url
 147
 148     //cached generated output information:
 149     mutable bool            m_bDirtyCache;
 150     mutable OUString m_aPresetId; // m_aPresetId and m_aSubType match to the values in sd/xml/effects.xml
 151     mutable OUString m_aSubType;
 152     mutable bool            m_bHasSpecialDuration;
 153     mutable double          m_fDurationInSeconds;
 154 };
 155
 156 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */