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

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

@@ -8,12 +8,24 @@ import abc
 
 class CommonBehaviorCollection (  SpireObject) :
     """
-    <summary>
-        Represents collection of behavior effects.
-    </summary>
+    Represents a collection of behavior effects for animations in a presentation.
+    
+    This class provides methods to manage and manipulate a collection of animation behaviors.
     """
     @dispatch
     def __getitem__(self, key):
+        """
+        Gets the behavior at the specified index.
+        
+        Args:
+            key: The zero-based index of the behavior to retrieve.
+        
+        Returns:
+            The behavior at the specified index.
+        
+        Raises:
+            StopIteration: If the index is equal to or greater than Count.
+        """
         if key >= self.Count:
             raise StopIteration
         GetDllLibPpt().CommonBehaviorCollection_get_Item.argtypes=[c_void_p ,c_int]
@@ -24,15 +36,25 @@ class CommonBehaviorCollection (  SpireObject) :
 
     @staticmethod
     def _create(intPtrWithTypeName:IntPtrWithTypeName)->'CommonBehavior':
-        from spire.presentation import AnimationColorBehavior
-        from spire.presentation import AnimationCommandBehavior
-        from spire.presentation import AnimationFilterEffect
-        from spire.presentation import AnimationMotion
-        from spire.presentation import AnimationProperty
-        from spire.presentation import AnimationRotation
-        from spire.presentation import AnimationScale
-        from spire.presentation import AnimationSet
-        from spire.presentation import CommonBehavior
+        """
+        Creates a specific CommonBehavior subclass instance based on type information.
+        
+        Args:
+            intPtrWithTypeName: Pointer and type name information for behavior creation.
+        
+        Returns:
+            A concrete CommonBehavior subclass instance (e.g., AnimationColorBehavior, 
+            AnimationMotion, etc.) based on the provided type information.
+        """
+        from spire.presentation.animation.AnimationColorBehavior import AnimationColorBehavior
+        from spire.presentation.animation.AnimationCommandBehavior import AnimationCommandBehavior
+        from spire.presentation.animation.AnimationFilterEffect import AnimationFilterEffect
+        from spire.presentation.animation.AnimationMotion import AnimationMotion
+        from spire.presentation.animation.AnimationProperty import AnimationProperty
+        from spire.presentation.animation.AnimationRotation import AnimationRotation
+        from spire.presentation.animation.AnimationScale import AnimationScale
+        from spire.presentation.animation.AnimationSet import AnimationSet
+        from spire.presentation.animation.CommonBehavior import CommonBehavior
 
         ret = None
         if intPtrWithTypeName == None :
@@ -63,9 +85,10 @@ class CommonBehaviorCollection (  SpireObject) :
     @property
     def Count(self)->int:
         """
-    <summary>
-        Gets the number of behaviors in a collection.
-    </summary>
+        Gets the number of behaviors in the collection.
+        
+        Returns:
+            The total number of behaviors in the collection.
         """
         GetDllLibPpt().CommonBehaviorCollection_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().CommonBehaviorCollection_get_Count.restype=c_int
@@ -75,11 +98,13 @@ class CommonBehaviorCollection (  SpireObject) :
 
     def Append(self ,item:'CommonBehavior')->int:
         """
-    <summary>
-        Add new behavior to a collection.
-    </summary>
-    <param name="item">Behavior to add.</param>
-    <returns>Index of a new behavior in a collection.</returns>
+        Adds a new behavior to the end of the collection.
+        
+        Args:
+            item: The behavior to add to the collection.
+        
+        Returns:
+            The index at which the behavior has been added.
         """
         intPtritem:c_void_p = item.Ptr
 
@@ -91,11 +116,11 @@ class CommonBehaviorCollection (  SpireObject) :
 
     def Insert(self ,index:int,item:'CommonBehavior'):
         """
-    <summary>
-        Inserts new behavior to a collection at the specified index.
-    </summary>
-    <param name="index">Index where new behavior should be inserted.</param>
-    <param name="item">Behavior to insert.</param>
+        Inserts a behavior into the collection at the specified index.
+        
+        Args:
+            index: The zero-based index at which to insert the behavior.
+            item: The behavior to insert.
         """
         intPtritem:c_void_p = item.Ptr
 
@@ -105,10 +130,10 @@ class CommonBehaviorCollection (  SpireObject) :
 
     def Remove(self ,item:'CommonBehavior'):
         """
-    <summary>
-        Removes specified behavior from a collection.
-    </summary>
-    <param name="item">Behavior to remove.</param>
+        Removes the specified behavior from the collection.
+        
+        Args:
+            item: The behavior to remove.
         """
         intPtritem:c_void_p = item.Ptr
 
@@ -118,32 +143,30 @@ class CommonBehaviorCollection (  SpireObject) :
 
     def RemoveAt(self ,index:int):
         """
-    <summary>
-        Removes behavior from a collection at the specified index.
-    </summary>
-    <param name="index">Index of a behavior to remove.</param>
+        Removes the behavior at the specified index.
+        
+        Args:
+            index: The zero-based index of the behavior to remove.
         """
         
         GetDllLibPpt().CommonBehaviorCollection_RemoveAt.argtypes=[c_void_p ,c_int]
         CallCFunction(GetDllLibPpt().CommonBehaviorCollection_RemoveAt,self.Ptr, index)
 
     def Clear(self):
-        """
-    <summary>
-        Removes all behaviors from a collection.
-    </summary>
-        """
+        """Removes all behaviors from the collection."""
         GetDllLibPpt().CommonBehaviorCollection_Clear.argtypes=[c_void_p]
         CallCFunction(GetDllLibPpt().CommonBehaviorCollection_Clear,self.Ptr)
 
 
     def get_Item(self ,index:int)->'CommonBehavior':
         """
-    <summary>
-        Retirns a behavior at the specified index.
-    </summary>
-    <param name="index">Index of a behavior to return.</param>
-    <returns>Animation begavior.</returns>
+        Retrieves the behavior at the specified index.
+        
+        Args:
+            index: The zero-based index of the behavior to retrieve.
+        
+        Returns:
+            The behavior at the specified index.
         """
         
         GetDllLibPpt().CommonBehaviorCollection_get_Item.argtypes=[c_void_p ,c_int]
@@ -156,7 +179,13 @@ class CommonBehaviorCollection (  SpireObject) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines whether the current object is equal to another object.
+        
+        Args:
+            obj: The object to compare with.
+        
+        Returns:
+            True if the objects are equal; otherwise, False.
         """
         intPtrobj:c_void_p = obj.Ptr
 
@@ -168,10 +197,10 @@ class CommonBehaviorCollection (  SpireObject) :
 
     def GetEnumerator(self)->'IEnumerator':
         """
-    <summary>
         Gets an iterator for the entire collection.
-    </summary>
-    <returns>Iterator.</returns>
+        
+        Returns:
+            An enumerator that iterates through the collection.
         """
         GetDllLibPpt().CommonBehaviorCollection_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().CommonBehaviorCollection_GetEnumerator.restype=c_void_p

spire/presentation/animation/FilterEffectSubtype.py

@@ -0,0 +1,70 @@
+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 FilterEffectSubtype(Enum):
+    """
+    Represents specific variations of filter effects for slide transitions.
+    
+    Attributes:
+        none (int): No specific subtype applied. 
+        Across (int): Effect applied across the slide.
+        Down (int): Effect applied downward direction.
+        DownLeft (int): Effect applied diagonally down-left direction.
+        DownRight (int): Effect applied diagonally down-right direction.  
+        FromBottom (int): Effect originating from the bottom.
+        FromLeft (int): Effect originating from the left.
+        FromRight (int): Effect originating from the right.
+        FromTop (int): Effect originating from the top.
+        Horizontal (int): Horizontal effect application.
+        In (int): Effect moving inward.
+        InHorizontal (int): Horizontal inward effect.
+        InVertical (int): Vertical inward effect.
+        Left (int):Effect applied to the left.
+        Out (int): Effect moving outward.
+        OutHorizontal (int): Horizontal outward effect.
+        OutVertical (int):Vertical outward effect.
+        Right (int): Effect applied to the right.
+        Spokes1 (int): Spoke effect with 1 spoke.
+        Spokes2 (int):Spoke effect with 2 spokes.
+        Spokes3 (int): Spoke effect with 3 spokes.
+        Spokes4 (int): Spoke effect with 4 spokes.
+        Spokes8 (int): Spoke effect with 8 spokes.
+        Up (int Effect applied upward.
+        UpLeft (int): Effect applied diagonally up-left.
+        UpRight (int): Effect applied diagonally up-right.
+        Vertical (int): Vertical effect application.
+
+    """
+    none = 0
+    Across = 1
+    Down = 2
+    DownLeft = 3
+    DownRight = 4
+    FromBottom = 5
+    FromLeft = 6
+    FromRight = 7
+    FromTop = 8
+    Horizontal = 9
+    In = 10
+    InHorizontal = 11
+    InVertical = 12
+    Left = 13
+    Out = 14
+    OutHorizontal = 15
+    OutVertical = 16
+    Right = 17
+    Spokes1 = 18
+    Spokes2 = 19
+    Spokes3 = 20
+    Spokes4 = 21
+    Spokes8 = 22
+    Up = 23
+    UpLeft = 24
+    UpRight = 25
+    Vertical = 26
+

spire/presentation/animation/FilterEffectType.py

@@ -0,0 +1,71 @@
+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 FilterEffectType(Enum):
+    """
+    Represents the types of filter effects that can be applied in presentations.
+    
+    These effects define various visual transitions between slides or elements.
+    """
+    none = 0
+    """No filter effect applied"""
+    
+    Barn = 1
+    """Barn door transition effect where content splits diagonally"""
+    
+    Blinds = 2
+    """Blinds effect where content is revealed through horizontal or vertical strips"""
+    
+    Box = 3
+    """Box effect where content appears/disappears through a rectangular shape"""
+    
+    Checkerboard = 4
+    """Checkerboard pattern transition where content tiles appear in sequence"""
+    
+    Circle = 5
+    """Circular reveal effect that expands from a center point"""
+    
+    Diamond = 6
+    """Diamond-shaped reveal effect that expands from the center"""
+    
+    Dissolve = 7
+    """Dissolve transition where content gradually fades between slides"""
+    
+    Fade = 8
+    """Simple fade transition between slides or elements"""
+    
+    Image = 9
+    """Custom image-based transition effect"""
+    
+    Pixelate = 10
+    """Pixelation effect that transitions through blocky pixels"""
+    
+    Plus = 11
+    """Plus-sign shaped reveal effect that expands from the center"""
+    
+    RandomBar = 12
+    """Transition with randomly appearing horizontal or vertical bars"""
+    
+    Slide = 13
+    """Slide effect where new content pushes previous content off-screen"""
+    
+    Stretch = 14
+    """Stretching effect that distorts content during transition"""
+    
+    Strips = 15
+    """Diagonal strip transition effect"""
+    
+    Wedge = 16
+    """Wedge-shaped reveal effect that expands from a point"""
+    
+    Wheel = 17
+    """Wheel/spokes effect that rotates around a center point"""
+    
+    Wipe = 18
+    """Wipe effect where new content replaces old content in a directional sweep"""
+

spire/presentation/animation/FilterEffectsType.py

@@ -0,0 +1,21 @@
+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 FilterEffectsType(Enum):
+    """
+    Specifies the direction of filter effects applied to slide transitions.
+    
+    Attributes:
+        Both (int): Apply filter effects in both horizontal and vertical directions.
+        Horizontal (int): Apply filter effects only in the horizontal direction.
+        Vertical (int): Apply filter effects only in the vertical direction.
+    """
+    Both = 0
+    Horizontal = 1
+    Vertical = 2
+

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

@@ -8,9 +8,13 @@ import abc
 
 class FilterRevealType(Enum):
     """
-    <summary>
-        Represents filter reveal type.
-    </summary>
+    Represents reveal behavior for filter effects.
+    
+    Attributes:
+        UnDefined: Undefined reveal behavior.  
+        none: No reveal effect applied.  
+        In: Reveal effect moving inward.
+        Out: Reveal effect moving outward.
     """
     UnDefined = -1
     none = 0

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

@@ -8,15 +8,15 @@ import abc
 
 class GraphicAnimation (  PptObject) :
     """
-    <summary>
-        Represent text animation.
-    </summary>
+    Represents animation properties for graphical elements.
+    Inherits from PptObject to provide animation-specific functionality.
     """
     @property
 
     def ShapeRef(self)->'Shape':
         """
-
+        Gets the target shape associated with the animation.
+        Returns: Reference to the animated Shape object.
         """
         GetDllLibPpt().GraphicAnimation_get_ShapeRef.argtypes=[c_void_p]
         GetDllLibPpt().GraphicAnimation_get_ShapeRef.restype=c_void_p
@@ -29,7 +29,8 @@ class GraphicAnimation (  PptObject) :
 
     def BuildType(self)->'GraphicBuildType':
         """
-
+        Gets or sets the animation build type.
+        Returns: Current GraphicBuildType enum value.
         """
         GetDllLibPpt().GraphicAnimation_get_BuildType.argtypes=[c_void_p]
         GetDllLibPpt().GraphicAnimation_get_BuildType.restype=c_int
@@ -45,7 +46,10 @@ class GraphicAnimation (  PptObject) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines if this animation equals another object.
+        Args:
+            obj: Target object to compare.
+        Returns: True if animations are identical, False otherwise.
         """
         intPtrobj:c_void_p = obj.Ptr
 

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

@@ -8,16 +8,13 @@ import abc
 
 class GraphicAnimationCollection (  ICollection, IEnumerable) :
     """
-    <summary>
-        Represent collection of graphic animations.
-    </summary>
+    Represent collection of graphic animations.
+
     """
     @property
     def Count(self)->int:
         """
-    <summary>
         Gets a number of elements in the collection.
-    </summary>
         """
         GetDllLibPpt().GraphicAnimationCollection_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().GraphicAnimationCollection_get_Count.restype=c_int
@@ -28,9 +25,13 @@ class GraphicAnimationCollection (  ICollection, IEnumerable) :
 
     def get_Item(self ,index:int)->GraphicAnimation:
         """
-    <summary>
         Gets element by index.
-    </summary>
+        
+        Args:
+            index (int): The index of the element.
+            
+        Returns:
+            GraphicAnimation: The animation at the specified index.
         """
         
         GetDllLibPpt().GraphicAnimationCollection_get_Item.argtypes=[c_void_p ,c_int]
@@ -62,7 +63,13 @@ class GraphicAnimationCollection (  ICollection, IEnumerable) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines whether the current collection 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
 
@@ -74,10 +81,10 @@ class GraphicAnimationCollection (  ICollection, IEnumerable) :
 
     def GetEnumerator(self)->'IEnumerator':
         """
-    <summary>
-        Gets an iterator for a collection.
-    </summary>
-    <returns></returns>
+        Gets an iterator for the collection.
+        
+        Returns:
+            IEnumerator: An iterator object.
         """
         GetDllLibPpt().GraphicAnimationCollection_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().GraphicAnimationCollection_GetEnumerator.restype=c_void_p
@@ -104,9 +111,7 @@ class GraphicAnimationCollection (  ICollection, IEnumerable) :
     @property
     def IsSynchronized(self)->bool:
         """
-    <summary>
         Gets a value indicating whether access to the collection is synchronized (thread-safe).
-    </summary>
         """
         GetDllLibPpt().GraphicAnimationCollection_get_IsSynchronized.argtypes=[c_void_p]
         GetDllLibPpt().GraphicAnimationCollection_get_IsSynchronized.restype=c_bool
@@ -117,10 +122,8 @@ class GraphicAnimationCollection (  ICollection, IEnumerable) :
 
     def SyncRoot(self)->'SpireObject':
         """
-    <summary>
         Gets a synchronization root.
-            Readonly <see cref="T:System.Object" />.
-    </summary>
+        Readonly.
         """
         GetDllLibPpt().GraphicAnimationCollection_get_SyncRoot.argtypes=[c_void_p]
         GetDllLibPpt().GraphicAnimationCollection_get_SyncRoot.restype=c_void_p

spire/presentation/animation/GraphicBuildType.py

@@ -0,0 +1,25 @@
+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 GraphicBuildType(Enum):
+    """
+    Indicates how graphic display style during animation.
+    
+    Attributes:
+        BuildAsOne: The entire graphic is built as one object.
+        BuildAsSeries: The graphic is built by series.
+        BuildAsCategory: The graphic is built by category.
+        BuildAsSeriesElement: The graphic is built by series elements.
+        BuildAsCategoryElement: The graphic is built by category elements.
+    """
+    BuildAsOne = 0
+    BuildAsSeries = 1
+    BuildAsCategory = 2
+    BuildAsSeriesElement = 3
+    BuildAsCategoryElement = 4
+

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

@@ -8,15 +8,16 @@ import abc
 
 class MotionCmdPath (SpireObject) :
     """
-    <summary>
-        Represent one command of a path.
-    </summary>
+    Represents a single command segment within an animation motion path.
     """
     @property
 
     def Points(self)->List['PointF']:
         """
-
+        Gets the collection of points defining the path segment.
+        
+        Returns:
+            List[PointF]: Array of point coordinates
         """
         GetDllLibPpt().MotionCmdPath_get_Points.argtypes=[c_void_p]
         GetDllLibPpt().MotionCmdPath_get_Points.restype=IntPtrArray
@@ -40,7 +41,10 @@ class MotionCmdPath (SpireObject) :
 
     def CommandType(self)->'MotionCommandPathType':
         """
-
+        Gets or sets the command type for this path segment.
+        
+        Returns:
+            MotionCommandPathType: Current command type
         """
         GetDllLibPpt().MotionCmdPath_get_CommandType.argtypes=[c_void_p]
         GetDllLibPpt().MotionCmdPath_get_CommandType.restype=c_int
@@ -50,13 +54,22 @@ class MotionCmdPath (SpireObject) :
 
     @CommandType.setter
     def CommandType(self, value:'MotionCommandPathType'):
+        """
+        Sets the command type for this path segment.
+        
+        Args:
+            value (MotionCommandPathType): New command type
+        """
         GetDllLibPpt().MotionCmdPath_set_CommandType.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().MotionCmdPath_set_CommandType,self.Ptr, value.value)
 
     @property
     def IsRelative(self)->bool:
         """
-
+        Determines if path coordinates are relative to starting position.
+        
+        Returns:
+            bool: True if coordinates are relative
         """
         GetDllLibPpt().MotionCmdPath_get_IsRelative.argtypes=[c_void_p]
         GetDllLibPpt().MotionCmdPath_get_IsRelative.restype=c_bool
@@ -65,6 +78,12 @@ class MotionCmdPath (SpireObject) :
 
     @IsRelative.setter
     def IsRelative(self, value:bool):
+        """
+        Sets whether path coordinates are relative to starting position.
+        
+        Args:
+            value (bool): True for relative coordinates
+        """
         GetDllLibPpt().MotionCmdPath_set_IsRelative.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibPpt().MotionCmdPath_set_IsRelative,self.Ptr, value)
 
@@ -72,7 +91,10 @@ class MotionCmdPath (SpireObject) :
 
     def PointsType(self)->'MotionPathPointsType':
         """
-
+        Gets or sets the interpretation method for path points.
+        
+        Returns:
+            MotionPathPointsType: Current points interpretation
         """
         GetDllLibPpt().MotionCmdPath_get_PointsType.argtypes=[c_void_p]
         GetDllLibPpt().MotionCmdPath_get_PointsType.restype=c_int
@@ -82,6 +104,12 @@ class MotionCmdPath (SpireObject) :
 
     @PointsType.setter
     def PointsType(self, value:'MotionPathPointsType'):
+        """
+        Sets the interpretation method for path points.
+        
+        Args:
+            value (MotionPathPointsType): New points interpretation
+        """
         GetDllLibPpt().MotionCmdPath_set_PointsType.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().MotionCmdPath_set_PointsType,self.Ptr, value.value)
 

spire/presentation/animation/MotionCommandPathType.py

@@ -0,0 +1,25 @@
+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 MotionCommandPathType(Enum):
+    """
+    Defines command types for animation motion path segments.
+    
+    Attributes:
+        MoveTo: Represents a move-to command (reposition without drawing)
+        LineTo: Represents a straight line path segment
+        CurveTo: Represents a curved path segment (Bezier)
+        CloseLoop: Closes the current path loop
+        End: Terminates the path definition
+    """
+    MoveTo = 0
+    LineTo = 1
+    CurveTo = 2
+    CloseLoop = 3
+    End = 4
+