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

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

@@ -7,9 +7,16 @@ from ctypes import *
 import abc
 
 class MotionPath ( SpireObject ) :
+    """
+    Represents a complete animation motion path composed of command segments.
+    
+    """
 
     @dispatch
     def __init__(self):
+        """
+        Initializes a new empty MotionPath instance.
+        """
         GetDllLibPpt().MotionPath_CreateMotionPath.restype = c_void_p
         intPtr = CallCFunction(GetDllLibPpt().MotionPath_CreateMotionPath)
         super(MotionPath, self).__init__(intPtr)
@@ -18,6 +25,15 @@ class MotionPath ( SpireObject ) :
     """
     @dispatch
     def __getitem__(self, key):
+        """
+        Gets the path command segment at the specified index.
+        
+        Args:
+            key (int): Segment index
+            
+        Returns:
+            MotionCmdPath: Path command segment
+        """
         if key >= self.Count:
             raise StopIteration
         GetDllLibPpt().MotionPath_get_Item.argtypes=[c_void_p ,c_int]
@@ -27,15 +43,18 @@ class MotionPath ( SpireObject ) :
         return ret
 
     def Add(self ,pathType:'MotionCommandPathType',pts:'PointF[]',ptsType:'MotionPathPointsType',bRelativeCoord:bool)->int:
-    #    """
-    #<summary>
-    #    Add new command to path
-    #</summary>
-    #<param name="type">Motion Command Path Type</param>
-    #<param name="pts">Motion Path Points</param>
-    #<param name="ptsType">Motion Path PointsType</param>
-    #<param name="bRelativeCoord">Relative Coord</param>
-    #    """
+        """
+        Adds a new command segment to the motion path.
+        
+        Args:
+            pathType (MotionCommandPathType): Type of path command
+            pts (List[PointF]): Control points for the segment
+            ptsType (MotionPathPointsType): Interpretation method for points
+            bRelativeCoord (bool): Whether coordinates are relative
+            
+        Returns:
+            int: Index of the newly added command segment
+        """
         enumtype:c_int = pathType.value
         #arraypts:ArrayTypepts = ""
         countpts = len(pts)
@@ -55,9 +74,10 @@ class MotionPath ( SpireObject ) :
     @property
     def Count(self)->int:
         """
-    <summary>
-        Gets the number of paths in the collection.
-    </summary>
+        Gets the number of command segments in the motion path.
+        
+        Returns:
+            int: Total segment count
         """
         GetDllLibPpt().MotionPath_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().MotionPath_get_Count.restype=c_int
@@ -67,11 +87,13 @@ class MotionPath ( SpireObject ) :
 
     def get_Item(self ,index:int)->'MotionCmdPath':
         """
-    <summary>
-        Gets a command at the specified index.
-    </summary>
-    <param name="index"></param>
-    <returns></returns>
+        Retrieves a specific path command segment by index.
+        
+        Args:
+            index (int): Zero-based segment index
+            
+        Returns:
+            MotionCmdPath: Path command segment object
         """
         
         GetDllLibPpt().MotionPath_get_Item.argtypes=[c_void_p ,c_int]
@@ -84,10 +106,10 @@ class MotionPath ( SpireObject ) :
 
     def GetEnumerator(self)->'IEnumerator':
         """
-    <summary>
-        Gets an iterator for the collection.
-    </summary>
-    <returns>Iterator.</returns>
+        Gets an iterator for traversing all command segments.
+        
+        Returns:
+            IEnumerator: Enumerator object for path segments
         """
         GetDllLibPpt().MotionPath_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().MotionPath_GetEnumerator.restype=c_void_p

spire/presentation/animation/MotionPathPointsType.py

@@ -0,0 +1,33 @@
+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 MotionPathPointsType(Enum):
+    """
+    Specifies the types of points used in animation motion paths.
+    
+    Attributes:
+        none: No specific point type.
+        Auto: Automatically determined point type.
+        Corner: Point represents a sharp corner in the path.
+        Straight: Point connects straight path segments.
+        Smooth: Point creates a smooth curved path.
+        CurveAuto: Automatically determined curve point.
+        CurveCorner: Curve point with sharp corner behavior.
+        CurveStraight: Curve point connecting straight segments.
+        CurveSmooth: Curve point creating smooth transitions.
+    """
+    none = 0
+    Auto = 1
+    Corner = 2
+    Straight = 3
+    Smooth = 4
+    CurveAuto = 5
+    CurveCorner = 6
+    CurveStraight = 7
+    CurveSmooth = 8
+

spire/presentation/animation/ParagraphBuildType.py

@@ -0,0 +1,31 @@
+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 ParagraphBuildType(Enum):
+    """
+    Specifies how text is displayed during animation sequences.
+    
+    Attributes:
+        Whole: Display the entire paragraph at once
+        AllAtOnce: Display all paragraphs simultaneously
+        Paragraphs1: Build by individual paragraphs (level 1)
+        Paragraphs2: Build by individual paragraphs (level 2)
+        Paragraphs3: Build by individual paragraphs (level 3)
+        Paragraphs4: Build by individual paragraphs (level 4)
+        Paragraphs5: Build by individual paragraphs (level 5)
+        cust: Custom build behavior
+    """
+    Whole = 0
+    AllAtOnce = 1
+    Paragraphs1 = 2
+    Paragraphs2 = 3
+    Paragraphs3 = 4
+    Paragraphs4 = 5
+    Paragraphs5 = 6
+    cust = 7
+

spire/presentation/animation/PropertyValueType.py

@@ -0,0 +1,23 @@
+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 PropertyValueType(Enum):
+    """
+    Specifies the data type of a property value in presentation elements.
+    
+    Attributes:
+        none (-1): Uninitialized or undefined property value type
+        String (0): Property value is a text string
+        Number (1): Property value is a numerical value
+        Color (2): Property value specifies a color
+    """
+    none = -1
+    String = 0
+    Number = 1
+    Color = 2
+

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

@@ -8,16 +8,15 @@ import abc
 
 class SequenceCollection (  IEnumerable) :
     """
-    <summary>
-        Represent collection of interactive sequences.
-    </summary>
+    Manages interactive animation sequences for presentation objects.
     """
     @property
     def Count(self)->int:
         """
-    <summary>
-        Gets the number of elements in a collection
-    </summary>
+        Gets the total number of animation sequences.
+        
+        Returns:
+            int: Count of animation sequences.
         """
         GetDllLibPpt().SequenceCollection_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().SequenceCollection_get_Count.restype=c_int
@@ -27,10 +26,13 @@ class SequenceCollection (  IEnumerable) :
 
     def Add(self ,shape:'IShape')->'AnimationEffectCollection':
         """
-    <summary>
-        Add new interactive sequence.
-            Read/write <see cref="T:Spire.Presentation.Collections.AnimationEffectCollection" />.
-    </summary>
+        Creates a new animation sequence for a shape.
+        
+        Args:
+            shape: Target shape to animate.
+            
+        Returns:
+            AnimationEffectCollection: New animation sequence container.
         """
         intPtrshape:c_void_p = shape.Ptr
 
@@ -44,10 +46,10 @@ class SequenceCollection (  IEnumerable) :
 
     def Remove(self ,item:'AnimationEffectCollection'):
         """
-    <summary>
-        Removes specified sequence from a collection.
-    </summary>
-    <param name="item">Sequence to remove.</param>
+        Deletes a specific animation sequence.
+        
+        Args:
+            item: Animation sequence to remove.
         """
         intPtritem:c_void_p = item.Ptr
 
@@ -57,10 +59,10 @@ class SequenceCollection (  IEnumerable) :
 
     def RemoveAt(self ,index:int):
         """
-    <summary>
-        Removes sequence at the specified index.
-    </summary>
-    <param name="index"></param>
+        Deletes an animation sequence by position index.
+        
+        Args:
+            index: Zero-based sequence index.
         """
         
         GetDllLibPpt().SequenceCollection_RemoveAt.argtypes=[c_void_p ,c_int]
@@ -68,9 +70,7 @@ class SequenceCollection (  IEnumerable) :
 
     def Clear(self):
         """
-    <summary>
-        Removes all sequences from a collection.
-    </summary>
+        Removes all animation sequences from the collection.
         """
         GetDllLibPpt().SequenceCollection_Clear.argtypes=[c_void_p]
         CallCFunction(GetDllLibPpt().SequenceCollection_Clear,self.Ptr)
@@ -78,11 +78,13 @@ class SequenceCollection (  IEnumerable) :
 
     def get_Item(self ,index:int)->'AnimationEffectCollection':
         """
-    <summary>
-        Gets a sequense at the specified index.
-    </summary>
-    <param name="index"></param>
-    <returns></returns>
+        Retrieves an animation sequence by index.
+        
+        Args:
+            index: Zero-based sequence index.
+            
+        Returns:
+            AnimationEffectCollection: Animation sequence object.
         """
         
         GetDllLibPpt().SequenceCollection_get_Item.argtypes=[c_void_p ,c_int]
@@ -95,10 +97,10 @@ class SequenceCollection (  IEnumerable) :
 
     def GetEnumerator(self)->'IEnumerator':
         """
-    <summary>
-        Gets an iterator for a collection.
-    </summary>
-    <returns></returns>
+        Gets an iterator to traverse the sequence collection.
+        
+        Returns:
+            IEnumerator: Iterator object.
         """
         GetDllLibPpt().SequenceCollection_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().SequenceCollection_GetEnumerator.restype=c_void_p

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

@@ -8,15 +8,16 @@ import abc
 
 class TextAnimation (  PptObject) :
     """
-    <summary>
-        Represent text animation.
-    </summary>
+    Represents text animation effects in a presentation.
     """
     @property
 
     def ShapeRef(self)->'Shape':
         """
-
+        Gets the shape associated with the text animation.
+        
+        Returns:
+            Shape: The associated shape object.
         """
         GetDllLibPpt().TextAnimation_get_ShapeRef.argtypes=[c_void_p]
         GetDllLibPpt().TextAnimation_get_ShapeRef.restype=c_void_p
@@ -29,9 +30,7 @@ class TextAnimation (  PptObject) :
 
     def ParagraphBuildType(self)->'ParagraphBuildType':
         """
-    <summary>
-        Paragraph build type of text animation.
-    </summary>
+        Gets or sets the paragraph build type for text animation.
         """
         GetDllLibPpt().TextAnimation_get_ParagraphBuildType.argtypes=[c_void_p]
         GetDllLibPpt().TextAnimation_get_ParagraphBuildType.restype=c_int
@@ -48,9 +47,7 @@ class TextAnimation (  PptObject) :
 
     def Background(self)->'AnimationEffect':
         """
-    <summary>
-        Shape effect.
-    </summary>
+        Gets or sets the shape background animation effect.
         """
         GetDllLibPpt().TextAnimation_get_Background.argtypes=[c_void_p]
         GetDllLibPpt().TextAnimation_get_Background.restype=c_void_p
@@ -67,7 +64,13 @@ class TextAnimation (  PptObject) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines if the current object is equal to another object.
+        
+        Args:
+            obj (SpireObject): The object to compare with.
+            
+        Returns:
+            bool: True if the objects are equal, otherwise False.
         """
         intPtrobj:c_void_p = obj.Ptr
 

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

@@ -8,12 +8,21 @@ import abc
 
 class TextAnimationCollection (  SpireObject ) :
     """
-    <summary>
-        Represent collection of text animations.
-    </summary>
+    Represent collection of text animations.
+    
+    Provides methods to access and manage text animation elements.
     """
     @dispatch
     def __getitem__(self, index):
+        """
+        Gets the element at the specified index.
+        
+        Args:
+            index: Zero-based index of the element to retrieve
+            
+        Returns:
+            TextAnimation: The animation element at the specified position
+        """
         if index >= self.Count:
             raise StopIteration
         GetDllLibPpt().TextAnimationCollection_get_Item.argtypes=[c_void_p ,c_int]
@@ -25,9 +34,10 @@ class TextAnimationCollection (  SpireObject ) :
     @property
     def Count(self)->int:
         """
-    <summary>
-        Gets a number of elements in the collection.
-    </summary>
+        Gets the number of elements in the collection.
+        
+        Returns:
+            int: Total count of animation elements
         """
         GetDllLibPpt().TextAnimationCollection_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().TextAnimationCollection_get_Count.restype=c_int
@@ -38,9 +48,13 @@ class TextAnimationCollection (  SpireObject ) :
 
     def get_Item(self ,index:int)->TextAnimation:
         """
-    <summary>
         Gets element by index.
-    </summary>
+        
+        Args:
+            index: Zero-based index of the element to retrieve
+            
+        Returns:
+            TextAnimation: The animation element at the specified position
         """
         
         GetDllLibPpt().TextAnimationCollection_get_Item.argtypes=[c_void_p ,c_int]
@@ -72,7 +86,13 @@ class TextAnimationCollection (  SpireObject ) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines if objects are equal.
+        
+        Args:
+            obj: Object to compare with
+            
+        Returns:
+            bool: True if objects are equal, False otherwise
         """
         intPtrobj:c_void_p = obj.Ptr
 
@@ -84,10 +104,10 @@ class TextAnimationCollection (  SpireObject ) :
 
     def GetEnumerator(self)->'IEnumerator':
         """
-    <summary>
-        Gets an iterator for a collection.
-    </summary>
-    <returns></returns>
+        Gets an iterator for the collection.
+        
+        Returns:
+            IEnumerator: Iterator object for collection traversal
         """
         GetDllLibPpt().TextAnimationCollection_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().TextAnimationCollection_GetEnumerator.restype=c_void_p
@@ -114,9 +134,10 @@ class TextAnimationCollection (  SpireObject ) :
     @property
     def IsSynchronized(self)->bool:
         """
-    <summary>
-        Gets a value indicating whether access to the collection is synchronized (thread-safe).
-    </summary>
+        Indicates whether collection access is thread-safe.
+        
+        Returns:
+            bool: True if access is synchronized, False otherwise
         """
         GetDllLibPpt().TextAnimationCollection_get_IsSynchronized.argtypes=[c_void_p]
         GetDllLibPpt().TextAnimationCollection_get_IsSynchronized.restype=c_bool
@@ -127,10 +148,10 @@ class TextAnimationCollection (  SpireObject ) :
 
     def SyncRoot(self)->'SpireObject':
         """
-    <summary>
-        Gets a synchronization root.
-            Readonly <see cref="T:System.Object" />.
-    </summary>
+        Gets the synchronization root object.
+        
+        Returns:
+            SpireObject: Object used for synchronization
         """
         GetDllLibPpt().TextAnimationCollection_get_SyncRoot.argtypes=[c_void_p]
         GetDllLibPpt().TextAnimationCollection_get_SyncRoot.restype=c_void_p

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

@@ -8,17 +8,15 @@ import abc
 
 class TimeAnimationValue (  PptObject) :
     """
-    <summary>
-        Represent animation point.
-    </summary>
+    Represents an animation point with time, value, and formula properties.
     """
     @property
     def Time(self)->float:
         """
-    <summary>
-        Represents time value.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the time position in the animation sequence.
+        
+        Returns:
+            float: Time value in seconds relative to animation start
         """
         GetDllLibPpt().TimeAnimationValue_get_Time.argtypes=[c_void_p]
         GetDllLibPpt().TimeAnimationValue_get_Time.restype=c_float
@@ -34,9 +32,10 @@ class TimeAnimationValue (  PptObject) :
 
     def Value(self)->'SpireObject':
         """
-    <summary>
-        Represents value.
-    </summary>
+        Gets or sets the animated property value at this time point.
+        
+        Returns:
+            SpireObject: Can represent numeric, color, position or other animatable properties
         """
         GetDllLibPpt().TimeAnimationValue_get_Value.argtypes=[c_void_p]
         GetDllLibPpt().TimeAnimationValue_get_Value.restype=c_void_p
@@ -54,10 +53,11 @@ class TimeAnimationValue (  PptObject) :
 
     def Formula(self)->str:
         """
-    <summary>
-        Formulas values."
-            Read/write <see cref="T:System.String" />.
-    </summary>
+        Gets or sets the formula expression for calculating animated values.
+        Example: "sin(2*pi*t)" for sine wave animations.
+        
+        Returns:
+            str: Mathematical expression defining value calculation
         """
         GetDllLibPpt().TimeAnimationValue_get_Formula.argtypes=[c_void_p]
         GetDllLibPpt().TimeAnimationValue_get_Formula.restype=c_void_p

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

@@ -8,17 +8,11 @@ import abc
 
 class TimeAnimationValueCollection (  IEnumerable) :
     """
-    <summary>
-        Represent collection of animation points.
-    </summary>
+    Represents a collection of animation points.
     """
     @property
     def Count(self)->int:
-        """
-    <summary>
-        Gets the number of points in the collection.
-    </summary>
-        """
+        """Gets the number of points in the collection."""
         GetDllLibPpt().TimeAnimationValueCollection_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().TimeAnimationValueCollection_get_Count.restype=c_int
         ret = CallCFunction(GetDllLibPpt().TimeAnimationValueCollection_get_Count,self.Ptr)
@@ -27,11 +21,13 @@ class TimeAnimationValueCollection (  IEnumerable) :
 
     def get_Item(self ,index:int)->'TimeAnimationValue':
         """
-    <summary>
         Gets a point at the specified index.
-    </summary>
-    <param name="index"></param>
-    <returns></returns>
+        
+        Args:
+            index: The index of the point to retrieve
+            
+        Returns:
+            TimeAnimationValue: The animation point at the specified index
         """
         
         GetDllLibPpt().TimeAnimationValueCollection_get_Item.argtypes=[c_void_p ,c_int]
@@ -44,10 +40,10 @@ class TimeAnimationValueCollection (  IEnumerable) :
 
     def GetEnumerator(self)->'IEnumerator':
         """
-    <summary>
         Gets an iterator for the collection.
-    </summary>
-    <returns>Iterator.</returns>
+        
+        Returns:
+            IEnumerator: An iterator for traversing the collection
         """
         GetDllLibPpt().TimeAnimationValueCollection_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().TimeAnimationValueCollection_GetEnumerator.restype=c_void_p

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

@@ -8,17 +8,16 @@ import abc
 
 class TimeLine (  PptObject) :
     """
-    <summary>
-        Represent timline of animation.
-    </summary>
+    Represents the timeline of animations in a presentation slide.
     """
     @property
 
     def InteractiveSequences(self)->'SequenceCollection':
         """
-    <summary>
-        Gets collection of interactive sequences.
-    </summary>
+        Gets the collection of interactive animation sequences.
+        
+        Returns:
+            SequenceCollection: A collection of interactive animation sequences
         """
         GetDllLibPpt().TimeLine_get_InteractiveSequences.argtypes=[c_void_p]
         GetDllLibPpt().TimeLine_get_InteractiveSequences.restype=c_void_p
@@ -31,9 +30,10 @@ class TimeLine (  PptObject) :
 
     def MainSequence(self)->'AnimationEffectCollection':
         """
-    <summary>
-        Gets main sequence which may contain only main effects collection.
-    </summary>
+        Gets the main animation sequence of the timeline.
+        
+        Returns:
+            AnimationEffectCollection: The collection of main animation effects
         """
         GetDllLibPpt().TimeLine_get_MainSequence.argtypes=[c_void_p]
         GetDllLibPpt().TimeLine_get_MainSequence.restype=c_void_p
@@ -46,7 +46,10 @@ class TimeLine (  PptObject) :
 
     def TextAnimations(self)->'TextAnimationCollection':
         """
-
+        Gets the collection of text-specific animations.
+        
+        Returns:
+            TextAnimationCollection: A collection of text-specific animations
         """
         GetDllLibPpt().TimeLine_get_TextAnimations.argtypes=[c_void_p]
         GetDllLibPpt().TimeLine_get_TextAnimations.restype=c_void_p
@@ -58,7 +61,13 @@ class TimeLine (  PptObject) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines whether the specified object is equal to the current timeline.
+        
+        Args:
+            obj (SpireObject): The object to compare with the current timeline
+            
+        Returns:
+            bool: True if the specified object is equal to the current timeline; otherwise False
         """
         intPtrobj:c_void_p = obj.Ptr