spire-presentation 10.6.4__py3-none-win_amd64.whl → 10.8.1__py3-none-win_amd64.whl

spire/presentation/{AnimationEffect.py → animation/AnimationEffect.py}

@@ -8,17 +8,18 @@ import abc
 
 class AnimationEffect (  PptObject) :
     """
-    <summary>
-        Represents timing information about a slide animation.
-    </summary>
+    Represents timing information about a slide animation.
+    
+    This class controls the timing and behavior of animation effects.
     """
     @property
 
     def TimeNodeAudios(self)->List['TimeNodeAudio']:
         """
-    <summary>
-        TimeNodeAudios
-    </summary>
+        Gets the collection of audio elements associated with the animation.
+        
+        Returns:
+            List[TimeNodeAudio]: The list of audio elements.
         """
         GetDllLibPpt().AnimationEffect_get_TimeNodeAudios.argtypes=[c_void_p]
         GetDllLibPpt().AnimationEffect_get_TimeNodeAudios.restype=IntPtrArray
@@ -30,12 +31,10 @@ class AnimationEffect (  PptObject) :
     @property
     def IterateTimeValue(self)->float:
         """
-    <summary>
-        if the value is less than 0,
-            this element describes the duration of the iteration interval in absolute time.
-            if the value is greater than 0,
-            this element describes the duration of the iteration interval in percentage of time.
-    </summary>
+        Gets the iteration interval value.
+        
+        Returns:
+            float: The iteration interval value.
         """
         GetDllLibPpt().AnimationEffect_get_IterateTimeValue.argtypes=[c_void_p]
         GetDllLibPpt().AnimationEffect_get_IterateTimeValue.restype=c_float
@@ -44,6 +43,12 @@ class AnimationEffect (  PptObject) :
 
     @IterateTimeValue.setter
     def IterateTimeValue(self, value:float):
+        """
+        Sets the iteration interval value.
+        
+        Args:
+            value: The iteration interval value to set.
+        """
         GetDllLibPpt().AnimationEffect_set_IterateTimeValue.argtypes=[c_void_p, c_float]
         CallCFunction(GetDllLibPpt().AnimationEffect_set_IterateTimeValue,self.Ptr, value)
 
@@ -51,7 +56,10 @@ class AnimationEffect (  PptObject) :
 
     def IterateType(self)->'AnimateType':
         """
-
+        Gets the iteration type.
+        
+        Returns:
+            AnimateType: The iteration type.
         """
         GetDllLibPpt().AnimationEffect_get_IterateType.argtypes=[c_void_p]
         GetDllLibPpt().AnimationEffect_get_IterateType.restype=c_int
@@ -61,6 +69,12 @@ class AnimationEffect (  PptObject) :
 
     @IterateType.setter
     def IterateType(self, value:'AnimateType'):
+        """
+        Sets the iteration type.
+        
+        Args:
+            value: The iteration type to set.
+        """
         GetDllLibPpt().AnimationEffect_set_IterateType.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().AnimationEffect_set_IterateType,self.Ptr, value.value)
 
@@ -68,10 +82,10 @@ class AnimationEffect (  PptObject) :
 
     def Effects(self)->'AnimationEffectCollection':
         """
-    <summary>
-        Gets a sequence for an effect.
-            Read-only <see cref="P:Spire.Presentation.Drawing.Animation.AnimationEffect.Effects" />.
-    </summary>
+        Gets the sequence of effects.
+        
+        Returns:
+            AnimationEffectCollection: The collection of effects.
         """
         GetDllLibPpt().AnimationEffect_get_Effects.argtypes=[c_void_p]
         GetDllLibPpt().AnimationEffect_get_Effects.restype=c_void_p
@@ -84,7 +98,10 @@ class AnimationEffect (  PptObject) :
 
     def TextAnimation(self)->'TextAnimation':
         """
-<summary></summary>
+        Gets the text animation settings.
+        
+        Returns:
+            TextAnimation: The text animation object.
         """
         GetDllLibPpt().AnimationEffect_get_TextAnimation.argtypes=[c_void_p]
         GetDllLibPpt().AnimationEffect_get_TextAnimation.restype=c_void_p
@@ -97,7 +114,10 @@ class AnimationEffect (  PptObject) :
 
     def GraphicAnimation(self)->'GraphicAnimation':
         """
-
+        Gets the graphic animation settings.
+        
+        Returns:
+            GraphicAnimation: The graphic animation object.
         """
         GetDllLibPpt().AnimationEffect_get_GraphicAnimation.argtypes=[c_void_p]
         GetDllLibPpt().AnimationEffect_get_GraphicAnimation.restype=c_void_p
@@ -110,9 +130,10 @@ class AnimationEffect (  PptObject) :
 
     def ShapeTarget(self)->'Shape':
         """
-    <summary>
-        Returns the shape that is applied with the specific animation effect.
-    </summary>
+        Gets the shape that the animation is applied to.
+        
+        Returns:
+            Shape: The target shape.
         """
         GetDllLibPpt().AnimationEffect_get_ShapeTarget.argtypes=[c_void_p]
         GetDllLibPpt().AnimationEffect_get_ShapeTarget.restype=c_void_p
@@ -125,10 +146,10 @@ class AnimationEffect (  PptObject) :
 
     def PresetClassType(self)->'TimeNodePresetClassType':
         """
-    <summary>
-        Defines class of effect.
-            Read/write <see cref="T:Spire.Presentation.Drawing.Animation.TimeNodePresetClassType" />.
-    </summary>
+        Gets the class type of the effect.
+        
+        Returns:
+            TimeNodePresetClassType: The effect class type.
         """
         GetDllLibPpt().AnimationEffect_get_PresetClassType.argtypes=[c_void_p]
         GetDllLibPpt().AnimationEffect_get_PresetClassType.restype=c_int
@@ -138,6 +159,12 @@ class AnimationEffect (  PptObject) :
 
     @PresetClassType.setter
     def PresetClassType(self, value:'TimeNodePresetClassType'):
+        """
+        Sets the class type of the effect.
+        
+        Args:
+            value: The effect class type to set.
+        """
         GetDllLibPpt().AnimationEffect_set_PresetClassType.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().AnimationEffect_set_PresetClassType,self.Ptr, value.value)
 
@@ -145,10 +172,10 @@ class AnimationEffect (  PptObject) :
 
     def AnimationEffectType(self)->'AnimationEffectType':
         """
-    <summary>
-        Defines type of effect.
-            Read/write <see cref="P:Spire.Presentation.Drawing.Animation.AnimationEffect.AnimationEffectType" />.
-    </summary>
+        Gets the type of animation effect.
+        
+        Returns:
+            AnimationEffectType: The effect type.
         """
         GetDllLibPpt().AnimationEffect_get_AnimationEffectType.argtypes=[c_void_p]
         GetDllLibPpt().AnimationEffect_get_AnimationEffectType.restype=c_int
@@ -158,6 +185,12 @@ class AnimationEffect (  PptObject) :
 
     @AnimationEffectType.setter
     def AnimationEffectType(self, value:'AnimationEffectType'):
+        """
+        Sets the type of animation effect.
+        
+        Args:
+            value: The effect type to set.
+        """
         GetDllLibPpt().AnimationEffect_set_AnimationEffectType.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().AnimationEffect_set_AnimationEffectType,self.Ptr, value.value)
 
@@ -165,7 +198,10 @@ class AnimationEffect (  PptObject) :
 
     def Subtype(self)->'AnimationEffectSubtype':
         """
-
+        Gets the subtype of the animation effect.
+        
+        Returns:
+            AnimationEffectSubtype: The effect subtype.
         """
         GetDllLibPpt().AnimationEffect_get_Subtype.argtypes=[c_void_p]
         GetDllLibPpt().AnimationEffect_get_Subtype.restype=c_int
@@ -175,6 +211,12 @@ class AnimationEffect (  PptObject) :
 
     @Subtype.setter
     def Subtype(self, value:'AnimationEffectSubtype'):
+        """
+        Sets the subtype of the animation effect.
+        
+        Args:
+            value: The effect subtype to set.
+        """
         GetDllLibPpt().AnimationEffect_set_Subtype.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().AnimationEffect_set_Subtype,self.Ptr, value.value)
 
@@ -182,12 +224,12 @@ class AnimationEffect (  PptObject) :
 
     def CommonBehaviorCollection(self)->'CommonBehaviorCollection':
         """
-    <summary>
-        Gets collection of behavior for effect.
-            Read/write <see cref="P:Spire.Presentation.Drawing.Animation.AnimationEffect.CommonBehaviorCollection" />.
-    </summary>
+        Gets the collection of behaviors for the effect.
+        
+        Returns:
+            CommonBehaviorCollection: The behavior collection.
         """
-        from spire.presentation import CommonBehaviorCollection
+        from spire.presentation.animation.CommonBehaviorCollection import CommonBehaviorCollection
         GetDllLibPpt().AnimationEffect_get_CommonBehaviorCollection.argtypes=[c_void_p]
         GetDllLibPpt().AnimationEffect_get_CommonBehaviorCollection.restype=c_void_p
         intPtr = CallCFunction(GetDllLibPpt().AnimationEffect_get_CommonBehaviorCollection,self.Ptr)
@@ -197,6 +239,12 @@ class AnimationEffect (  PptObject) :
 
     @CommonBehaviorCollection.setter
     def CommonBehaviorCollection(self, value:'CommonBehaviorCollection'):
+        """
+        Sets the collection of behaviors for the effect.
+        
+        Args:
+            value: The behavior collection to set.
+        """
         GetDllLibPpt().AnimationEffect_set_CommonBehaviorCollection.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibPpt().AnimationEffect_set_CommonBehaviorCollection,self.Ptr, value.Ptr)
 
@@ -204,12 +252,12 @@ class AnimationEffect (  PptObject) :
 
     def Timing(self)->'Timing':
         """
-    <summary>
-        Defines timing value for effect.
-            Read/write <see cref="T:Spire.Presentation.Drawing.Animation.Timing" />.
-    </summary>
+        Gets the timing settings for the effect.
+        
+        Returns:
+            Timing: The timing settings.
         """
-        from spire.presentation import Timing;
+        from spire.presentation.animation.Timing import Timing;
         GetDllLibPpt().AnimationEffect_get_Timing.argtypes=[c_void_p]
         GetDllLibPpt().AnimationEffect_get_Timing.restype=c_void_p
         intPtr = CallCFunction(GetDllLibPpt().AnimationEffect_get_Timing,self.Ptr)
@@ -219,6 +267,12 @@ class AnimationEffect (  PptObject) :
 
     @Timing.setter
     def Timing(self, value:'Timing'):
+        """
+        Sets the timing settings for the effect.
+        
+        Args:
+            value: The timing settings to set.
+        """
         GetDllLibPpt().AnimationEffect_set_Timing.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibPpt().AnimationEffect_set_Timing,self.Ptr, value.Ptr)
 
@@ -226,10 +280,10 @@ class AnimationEffect (  PptObject) :
 
     def StartParagraph(self)->'TextParagraph':
         """
-    <summary>
-        Starting text paragraph which effect is applied to.
-            Read-only
-    </summary>
+        Gets the starting text paragraph for the effect.
+        
+        Returns:
+            TextParagraph: The starting paragraph.
         """
         GetDllLibPpt().AnimationEffect_get_StartParagraph.argtypes=[c_void_p]
         GetDllLibPpt().AnimationEffect_get_StartParagraph.restype=c_void_p
@@ -242,10 +296,10 @@ class AnimationEffect (  PptObject) :
 
     def EndParagraph(self)->'TextParagraph':
         """
-    <summary>
-        Ending text paragraph which effect is applied to.
-            Read-only
-    </summary>
+        Gets the ending text paragraph for the effect.
+        
+        Returns:
+            TextParagraph: The ending paragraph.
         """
         GetDllLibPpt().AnimationEffect_get_EndParagraph.argtypes=[c_void_p]
         GetDllLibPpt().AnimationEffect_get_EndParagraph.restype=c_void_p
@@ -257,9 +311,11 @@ class AnimationEffect (  PptObject) :
 
     def SetStartEndParagraphs(self ,startParaIndex:int,endParaIndex:int):
         """
-    <summary>
-        Starting and Ending text paragraph which effect is applied to.
-    </summary>
+        Sets the start and end paragraphs for the effect.
+        
+        Args:
+            startParaIndex: Index of the starting paragraph.
+            endParaIndex: Index of the ending paragraph.
         """
         
         GetDllLibPpt().AnimationEffect_SetStartEndParagraphs.argtypes=[c_void_p ,c_int,c_int]
@@ -268,7 +324,13 @@ class AnimationEffect (  PptObject) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines if this object is equal to another.
+        
+        Args:
+            obj: The object to compare with.
+            
+        Returns:
+            bool: True if equal, False otherwise.
         """
         intPtrobj:c_void_p = obj.Ptr
 

spire/presentation/{AnimationEffectCollection.py → animation/AnimationEffectCollection.py}

@@ -7,9 +7,23 @@ from ctypes import *
 import abc
 
 class AnimationEffectCollection ( SpireObject) :
+    """
+    Represents a collection of animation effects.
+    
+    This class manages a collection of animation effects for a slide.
+    """
 
     @dispatch
     def __getitem__(self, index):
+        """
+        Gets the animation effect at the specified index.
+        
+        Args:
+            index: The index of the effect.
+            
+        Returns:
+            AnimationEffect: The animation effect at the index.
+        """
         if index >= self.Count:
             raise StopIteration
         GetDllLibPpt().AnimationEffectCollection_get_Item.argtypes=[c_void_p ,c_int]
@@ -17,17 +31,14 @@ class AnimationEffectCollection ( SpireObject) :
         intPtr = CallCFunction(GetDllLibPpt().AnimationEffectCollection_get_Item,self.Ptr, index)
         ret = None if intPtr==None else AnimationEffect(intPtr)
         return ret
-    """
-    <summary>
-        Represent collection of effects.
-    </summary>
-    """
+   
     @property
     def Count(self)->int:
         """
-    <summary>
-        Gets the number of effects in a sequense.
-    </summary>
+        Gets the number of effects in the collection.
+        
+        Returns:
+            int: The number of effects.
         """
         GetDllLibPpt().AnimationEffectCollection_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().AnimationEffectCollection_get_Count.restype=c_int
@@ -37,10 +48,10 @@ class AnimationEffectCollection ( SpireObject) :
 
     def Remove(self ,item:'AnimationEffect'):
         """
-    <summary>
-        Removes specified effect from a collection.
-    </summary>
-    <param name="item">Effect to remove.</param>
+        Removes a specific effect from the collection.
+        
+        Args:
+            item: The effect to remove.
         """
         intPtritem:c_void_p = item.Ptr
 
@@ -50,32 +61,30 @@ class AnimationEffectCollection ( SpireObject) :
 
     def RemoveAt(self ,index:int):
         """
-    <summary>
-        Removes an effect from a collection.
-    </summary>
-    <param name="index"></param>
+        Removes the effect at the specified index.
+        
+        Args:
+            index: The index of the effect to remove.
         """
         
         GetDllLibPpt().AnimationEffectCollection_RemoveAt.argtypes=[c_void_p ,c_int]
         CallCFunction(GetDllLibPpt().AnimationEffectCollection_RemoveAt,self.Ptr, index)
 
     def Clear(self):
-        """
-    <summary>
-        Removes all effects from a collection.
-    </summary>
-        """
+        """Removes all effects from the collection."""
         GetDllLibPpt().AnimationEffectCollection_Clear.argtypes=[c_void_p]
         CallCFunction(GetDllLibPpt().AnimationEffectCollection_Clear,self.Ptr)
 
 
     def get_Item(self ,index:int)->'AnimationEffect':
         """
-    <summary>
-        Gets an effect at the specified index.
-    </summary>
-    <param name="index"></param>
-    <returns></returns>
+        Gets the animation effect at the specified index.
+        
+        Args:
+            index: The index of the effect.
+            
+        Returns:
+            AnimationEffect: The animation effect at the index.
         """
         
         GetDllLibPpt().AnimationEffectCollection_get_Item.argtypes=[c_void_p ,c_int]
@@ -88,10 +97,10 @@ class AnimationEffectCollection ( SpireObject) :
 
     def GetEnumerator(self)->'IEnumerator':
         """
-    <summary>
-        Gets an iterator for a collection.
-    </summary>
-    <returns></returns>
+        Gets an enumerator for the collection.
+        
+        Returns:
+            IEnumerator: An enumerator for the collection.
         """
         GetDllLibPpt().AnimationEffectCollection_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().AnimationEffectCollection_GetEnumerator.restype=c_void_p
@@ -104,7 +113,10 @@ class AnimationEffectCollection ( SpireObject) :
 
     def TriggerShape(self)->'Shape':
         """
-
+        Gets or sets the trigger shape for the animation.
+        
+        Returns:
+            Shape: The trigger shape.
         """
         GetDllLibPpt().AnimationEffectCollection_get_TriggerShape.argtypes=[c_void_p]
         GetDllLibPpt().AnimationEffectCollection_get_TriggerShape.restype=c_void_p
@@ -115,18 +127,26 @@ class AnimationEffectCollection ( SpireObject) :
 
     @TriggerShape.setter
     def TriggerShape(self, value:'Shape'):
+        """
+        Sets the trigger shape for the animation.
+        
+        Args:
+            value: The trigger shape to set.
+        """
         GetDllLibPpt().AnimationEffectCollection_set_TriggerShape.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibPpt().AnimationEffectCollection_set_TriggerShape,self.Ptr, value.Ptr)
 
 
     def AddEffect(self ,shape:'IShape',animationEffectType:'AnimationEffectType')->'AnimationEffect':
         """
-    <summary>
-        Add new effect to the end of sequence.
-    </summary>
-    <param name="shape"></param>
-    <param name="animationEffectType"></param>
-    <returns></returns>
+        Adds a new effect to the end of the sequence.
+        
+        Args:
+            shape: The shape to apply the effect to.
+            animationEffectType: The type of animation effect.
+            
+        Returns:
+            AnimationEffect: The newly created effect.
         """
         intPtrshape:c_void_p = shape.Ptr
         enumanimationEffectType:c_int = animationEffectType.value
@@ -141,7 +161,13 @@ class AnimationEffectCollection ( SpireObject) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines if this object is equal to another.
+        
+        Args:
+            obj: The object to compare with.
+            
+        Returns:
+            bool: True if equal, False otherwise.
         """
         intPtrobj:c_void_p = obj.Ptr
 

spire/presentation/animation/AnimationEffectSubtype.py

@@ -0,0 +1,164 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar,Union,Generic,List,Tuple
+from spire.presentation.common import *
+from spire.presentation import *
+from ctypes import *
+import abc
+
+class AnimationEffectSubtype(Enum):
+    """
+    Represents subtypes of animation effects in PowerPoint presentations.
+    These subtypes define variations and specific behaviors for animation effects.
+
+    """
+    none = 0
+    """No specific subtype defined for the animation effect."""
+    
+    Across = 1
+    """Animation moves across the screen horizontally."""
+    
+    Bottom = 2
+    """Animation enters or exits from the bottom of the screen."""
+    
+    BottomLeft = 3
+    """Animation enters or exits from the bottom-left corner of the screen."""
+    
+    BottomRight = 4
+    """Animation enters or exits from the bottom-right corner of the screen."""
+    
+    Center = 5
+    """Animation originates from or converges to the center of the screen."""
+    
+    Clockwise = 6
+    """Animation rotates in a clockwise direction."""
+    
+    CounterClockwise = 7
+    """Animation rotates in a counter-clockwise direction."""
+    
+    GradualAndCycleClockwise = 8
+    """Animation gradually cycles in a clockwise direction."""
+    
+    GradualAndCycleCounterClockwise = 9
+    """Animation gradually cycles in a counter-clockwise direction."""
+    
+    Down = 10
+    """Animation moves downward on the screen."""
+    
+    DownLeft = 11
+    """Animation moves diagonally down to the left."""
+    
+    DownRight = 12
+    """Animation moves diagonally down to the right."""
+    
+    FontAllCaps = 13
+    """Animation effect specific to changing text to all capital letters."""
+    
+    FontBold = 14
+    """Animation effect specific to applying bold formatting to text."""
+    
+    FontItalic = 15
+    """Animation effect specific to applying italic formatting to text."""
+    
+    FontShadow = 16
+    """Animation effect specific to applying shadow effect to text."""
+    
+    FontStrikethrough = 17
+    """Animation effect specific to applying strikethrough formatting to text."""
+    
+    FontUnderline = 18
+    """Animation effect specific to applying underline formatting to text."""
+    
+    Gradual = 19
+    """Animation occurs gradually over time."""
+    
+    Horizontal = 20
+    """Animation moves horizontally across the screen."""
+    
+    HorizontalIn = 21
+    """Animation enters horizontally from the edges toward the center."""
+    
+    HorizontalOut = 22
+    """Animation exits horizontally from the center toward the edges."""
+    
+    In = 23
+    """Generic entrance animation effect."""
+    
+    InBottom = 24
+    """Animation enters from the bottom of the screen."""
+    
+    InCenter = 25
+    """Animation enters from the center of the screen."""
+    
+    InSlightly = 26
+    """Animation enters with a subtle, slight motion."""
+    
+    Instant = 27
+    """Animation occurs instantly without any transition."""
+    
+    Left = 28
+    """Animation moves to the left side of the screen."""
+    
+    OrdinalMask = 29
+    """Special mask effect for ordinal animations."""
+    
+    Out = 30
+    """Generic exit animation effect."""
+    
+    OutBottom = 31
+    """Animation exits toward the bottom of the screen."""
+    
+    OutCenter = 32
+    """Animation exits from the center of the screen."""
+    
+    OutSlightly = 33
+    """Animation exits with a subtle, slight motion."""
+    
+    Right = 34
+    """Animation moves to the right side of the screen."""
+    
+    Slightly = 35
+    """Animation occurs with subtle, slight motion."""
+    
+    Top = 36
+    """Animation enters or exits from the top of the screen."""
+    
+    TopLeft = 37
+    """Animation enters or exits from the top-left corner of the screen."""
+    
+    TopRight = 38
+    """Animation enters or exits from the top-right corner of the screen."""
+    
+    Up = 39
+    """Animation moves upward on the screen."""
+    
+    UpLeft = 40
+    """Animation moves diagonally up to the left."""
+    
+    UpRight = 41
+    """Animation moves diagonally up to the right."""
+    
+    Vertical = 42
+    """Animation moves vertically on the screen."""
+    
+    VerticalIn = 43
+    """Animation enters vertically from the top or bottom toward the center."""
+    
+    VerticalOut = 44
+    """Animation exits vertically from the center toward the top or bottom."""
+    
+    Wheel1 = 45
+    """Wheel animation effect with 1 spoke."""
+    
+    Wheel2 = 46
+    """Wheel animation effect with 2 spokes."""
+    
+    Wheel3 = 47
+    """Wheel animation effect with 3 spokes."""
+    
+    Wheel4 = 48
+    """Wheel animation effect with 4 spokes."""
+    
+    Wheel8 = 49
+    """Wheel animation effect with 8 spokes."""
+