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