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

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

@@ -8,13 +8,16 @@ import abc
 
 class TimeNode (SpireObject) :
     """
-
+     Represents a node in the animation timeline hierarchy.
     """
     @property
 
     def ChildNodes(self)->'TimeNodes':
         """
-
+        Gets the direct child nodes of this time node.
+        
+        Returns:
+            TimeNodes: A collection of direct child time nodes
         """
         GetDllLibPpt().TimeNode_get_ChildNodes.argtypes=[c_void_p]
         GetDllLibPpt().TimeNode_get_ChildNodes.restype=c_void_p
@@ -27,7 +30,10 @@ class TimeNode (SpireObject) :
 
     def SubNodes(self)->'TimeNodes':
         """
-
+        Gets the subordinated nodes associated with this time node.
+        
+        Returns:
+            TimeNodes: A collection of subordinate time nodes
         """
         GetDllLibPpt().TimeNode_get_SubNodes.argtypes=[c_void_p]
         GetDllLibPpt().TimeNode_get_SubNodes.restype=c_void_p
@@ -39,7 +45,13 @@ class TimeNode (SpireObject) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines whether the specified object is equal to the current time node.
+        
+        Args:
+            obj (SpireObject): The object to compare with the current time node
+            
+        Returns:
+            bool: True if the specified object is equal to the current time node; otherwise False
         """
         intPtrobj:c_void_p = obj.Ptr
 

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

@@ -8,7 +8,8 @@ import abc
 
 class TimeNodeAudio (  TimeNodeMedia) :
     """
-
+    Represents an audio node within an animation timeline.
+    
     """
 #    @dispatch
 #
@@ -29,10 +30,10 @@ class TimeNodeAudio (  TimeNodeMedia) :
 
     def SetAudioData(self ,stream:Stream):
         """
-    <summary>
-        Set Audio Data.
-    </summary>
-    <param name="stream"></param>
+        Sets audio data from a stream source.
+        
+        Args:
+            stream (Stream): Input stream containing audio data
         """
         intPtrstream:c_void_p = stream.Ptr
 
@@ -42,10 +43,10 @@ class TimeNodeAudio (  TimeNodeMedia) :
 
     def GetAudioData(self)->List['Byte']:
         """
-    <summary>
-        GetTimeNodeAudio : get audio bytes
-    </summary>
-    <returns></returns>
+        Retrieves the raw audio byte data.
+        
+        Returns:
+            List[Byte]: Byte array containing the audio data
         """
         GetDllLibPpt().TimeNodeAudio_GetAudioData.argtypes=[c_void_p]
         GetDllLibPpt().TimeNodeAudio_GetAudioData.restype=IntPtrArray
@@ -57,9 +58,12 @@ class TimeNodeAudio (  TimeNodeMedia) :
     @property
     def Volume(self)->float:
         """
-    <summary>
-        Volume :value range 0 - 1
-    </summary>
+        Gets or sets the audio playback volume.
+        
+        Value ranges from 0.0 (silent) to 1.0 (maximum volume)
+        
+        Returns:
+            float: Current volume level
         """
         GetDllLibPpt().TimeNodeAudio_get_Volume.argtypes=[c_void_p]
         GetDllLibPpt().TimeNodeAudio_get_Volume.restype=c_float
@@ -74,9 +78,10 @@ class TimeNodeAudio (  TimeNodeMedia) :
     @property
     def IsMute(self)->bool:
         """
-    <summary>
-        is mute default:false
-    </summary>
+        Gets or sets whether the audio is muted.
+        
+        Returns:
+            bool: True if audio is muted, False otherwise
         """
         GetDllLibPpt().TimeNodeAudio_get_IsMute.argtypes=[c_void_p]
         GetDllLibPpt().TimeNodeAudio_get_IsMute.restype=c_bool
@@ -92,9 +97,10 @@ class TimeNodeAudio (  TimeNodeMedia) :
 
     def SoundName(self)->str:
         """
-    <summary>
-        SoundName
-    </summary>
+        Gets the name identifier of the sound.
+        
+        Returns:
+            str: Name associated with the audio element
         """
         GetDllLibPpt().TimeNodeAudio_get_SoundName.argtypes=[c_void_p]
         GetDllLibPpt().TimeNodeAudio_get_SoundName.restype=c_void_p
@@ -105,7 +111,13 @@ class TimeNodeAudio (  TimeNodeMedia) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines whether the specified object is equal to the current audio node.
+        
+        Args:
+            obj (SpireObject): The object to compare with the current audio node
+            
+        Returns:
+            bool: True if the specified object is equal to the current audio node; otherwise False
         """
         intPtrobj:c_void_p = obj.Ptr
 

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

@@ -6,14 +6,20 @@ from spire.presentation import *
 from ctypes import *
 import abc
 
-class TimeNodeMedia (  TimeNode) :
+class TimeNodeMedia (TimeNode) :
     """
-
+    Represents a media time node in a presentation animation sequence.
     """
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines whether the specified SpireObject is equal to the current TimeNodeMedia.
+        
+        Args:
+            obj: The SpireObject to compare with the current object.
+            
+        Returns:
+            bool: True if the specified object is equal to the current object; otherwise, False.
         """
         intPtrobj:c_void_p = obj.Ptr
 

spire/presentation/animation/TimeNodePresetClassType.py

@@ -0,0 +1,29 @@
+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 TimeNodePresetClassType(Enum):
+    """
+    Specifies the classification type of animation effects in presentation timing nodes.
+    
+    Attributes:
+        none: No specific effect class.
+        Entrance: Entrance animation effects.
+        Exit: Exit animation effects.
+        Emphasis: Emphasis animation effects.
+        Path: Motion path animation effects.
+        Verb: Action verb animation effects.
+        MediaCall: Media-specific animation effects.
+    """
+    none = 0
+    Entrance = 1
+    Exit = 2
+    Emphasis = 3
+    Path = 4
+    Verb = 5
+    MediaCall = 6
+

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

@@ -8,12 +8,15 @@ import abc
 
 class TimeNodes (  IEnumerable) :
     """
-
+    Represents a collection of TimeNode objects in a presentation animation sequence.
     """
     @property
     def Count(self)->int:
         """
-
+        Gets the number of TimeNode objects contained in the collection.
+        
+        Returns:
+            int: The number of time nodes in the collection.
         """
         GetDllLibPpt().TimeNodes_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().TimeNodes_get_Count.restype=c_int
@@ -23,7 +26,13 @@ class TimeNodes (  IEnumerable) :
 
     def get_Item(self ,index:int)->'TimeNode':
         """
-
+        Gets the TimeNode at the specified index position.
+        
+        Args:
+            index: The zero-based index of the element to retrieve.
+            
+        Returns:
+            TimeNode: The TimeNode at the specified index.
         """
         
         GetDllLibPpt().TimeNodes_get_Item.argtypes=[c_void_p ,c_int]
@@ -36,7 +45,10 @@ class TimeNodes (  IEnumerable) :
 
     def RemoveAt(self ,index:int):
         """
-
+        Removes the TimeNode at the specified index position from the collection.
+        
+        Args:
+            index: The zero-based index of the element to remove.
         """
         
         GetDllLibPpt().TimeNodes_RemoveAt.argtypes=[c_void_p ,c_int]
@@ -45,7 +57,10 @@ class TimeNodes (  IEnumerable) :
 
     def Remove(self ,node:'TimeNode'):
         """
-
+        Removes the first occurrence of a specific TimeNode from the collection.
+        
+        Args:
+            node: The TimeNode to remove from the collection.
         """
         intPtrnode:c_void_p = node.Ptr
 
@@ -54,7 +69,7 @@ class TimeNodes (  IEnumerable) :
 
     def Clear(self):
         """
-
+        Removes all TimeNode objects from the collection.
         """
         GetDllLibPpt().TimeNodes_Clear.argtypes=[c_void_p]
         CallCFunction(GetDllLibPpt().TimeNodes_Clear,self.Ptr)
@@ -62,7 +77,13 @@ class TimeNodes (  IEnumerable) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines whether the specified SpireObject is equal to the current TimeNodes collection.
+        
+        Args:
+            obj: The SpireObject to compare with the current object.
+            
+        Returns:
+            bool: True if the specified object is equal to the current object; otherwise, False.
         """
         intPtrobj:c_void_p = obj.Ptr
 
@@ -74,7 +95,10 @@ class TimeNodes (  IEnumerable) :
 
     def GetEnumerator(self)->'IEnumerator':
         """
-
+        Returns an enumerator that iterates through the TimeNodes collection.
+        
+        Returns:
+            IEnumerator: An enumerator that can be used to iterate through the collection.
         """
         GetDllLibPpt().TimeNodes_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().TimeNodes_GetEnumerator.restype=c_void_p

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

@@ -8,17 +8,17 @@ import abc
 
 class Timing (  PptObject) :
     """
-    <summary>
-        Represents animation timing.
-    </summary>
+    Represents the timing properties for animation effects in a presentation.
     """
     @property
     def Accelerate(self)->float:
         """
-    <summary>
-        Percentage of the duration over which acceleration should take place
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the acceleration percentage of the animation duration.
+        
+        Value range: 0.0 to 1.0 (0% to 100%)
+        
+        Returns:
+            float: Acceleration percentage of animation duration
         """
         GetDllLibPpt().Timing_get_Accelerate.argtypes=[c_void_p]
         GetDllLibPpt().Timing_get_Accelerate.restype=c_float
@@ -33,10 +33,12 @@ class Timing (  PptObject) :
     @property
     def Decelerate(self)->float:
         """
-    <summary>
-        Percentage of the duration over which acceleration should take place
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the deceleration percentage of the animation duration.
+        
+        Value range: 0.0 to 1.0 (0% to 100%)
+        
+        Returns:
+            float: Deceleration percentage of animation duration
         """
         GetDllLibPpt().Timing_get_Decelerate.argtypes=[c_void_p]
         GetDllLibPpt().Timing_get_Decelerate.restype=c_float
@@ -51,10 +53,10 @@ class Timing (  PptObject) :
     @property
     def AutoReverse(self)->bool:
         """
-    <summary>
-        Whether an effect should play forward and then reverse, thereby doubling the duration
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+        Gets or sets whether the animation automatically reverses after completion.
+        
+        Returns:
+            bool: True if auto-reverse is enabled, False otherwise
         """
         GetDllLibPpt().Timing_get_AutoReverse.argtypes=[c_void_p]
         GetDllLibPpt().Timing_get_AutoReverse.restype=c_bool
@@ -69,10 +71,10 @@ class Timing (  PptObject) :
     @property
     def Duration(self)->float:
         """
-    <summary>
-        Length of animation (in seconds)
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the length of the animation in seconds.
+        
+        Returns:
+            float: Animation duration in seconds
         """
         GetDllLibPpt().Timing_get_Duration.argtypes=[c_void_p]
         GetDllLibPpt().Timing_get_Duration.restype=c_float
@@ -87,10 +89,16 @@ class Timing (  PptObject) :
     @property
     def RepeatCount(self)->float:
         """
-    <summary>
-        Describes the number of times the effect should repeat.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the number of times the animation should repeat.
+        
+        Special values:
+            - 0: No repeat
+            - 1: Play once (default)
+            - n: Repeat n times
+            - -1: Loop indefinitely until interrupted
+        
+        Returns:
+            float: Animation repeat count
         """
         GetDllLibPpt().Timing_get_RepeatCount.argtypes=[c_void_p]
         GetDllLibPpt().Timing_get_RepeatCount.restype=c_float
@@ -105,10 +113,10 @@ class Timing (  PptObject) :
     @property
     def RepeatDuration(self)->float:
         """
-    <summary>
-        How long should the repeats last (in seconds)
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the total duration for all animation repetitions in seconds.
+       
+        Returns:
+            float: Total duration for all repetitions in seconds
         """
         GetDllLibPpt().Timing_get_RepeatDuration.argtypes=[c_void_p]
         GetDllLibPpt().Timing_get_RepeatDuration.restype=c_float
@@ -124,10 +132,10 @@ class Timing (  PptObject) :
 
     def Restart(self)->'AnimationRestartType':
         """
-    <summary>
-        Indicatesif a effect is to restart after complete.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the restart behavior of the animation.
+        
+        Returns:
+            AnimationRestartType: Restart behavior enumeration
         """
         GetDllLibPpt().Timing_get_Restart.argtypes=[c_void_p]
         GetDllLibPpt().Timing_get_Restart.restype=c_int
@@ -143,10 +151,15 @@ class Timing (  PptObject) :
     @property
     def Speed(self)->float:
         """
-    <summary>
-        Returns or sets a valeue. 
-            specifies the percentage by which to speed up (or slow down) the timing.
-    </summary>
+        Gets or sets the playback speed multiplier for the animation.
+        
+        Values:
+            - 1.0: Normal speed (100%)
+            - 2.0: Double speed (200%)
+            - 0.5: Half speed (50%)
+        
+        Returns:
+            float: Playback speed multiplier
         """
         GetDllLibPpt().Timing_get_Speed.argtypes=[c_void_p]
         GetDllLibPpt().Timing_get_Speed.restype=c_float
@@ -161,10 +174,10 @@ class Timing (  PptObject) :
     @property
     def TriggerDelayTime(self)->float:
         """
-    <summary>
-        Delay time from when the trigger is enabled (in seconds)
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the delay time after trigger activation before animation starts.
+        
+        Returns:
+            float: Trigger delay time in seconds
         """
         GetDllLibPpt().Timing_get_TriggerDelayTime.argtypes=[c_void_p]
         GetDllLibPpt().Timing_get_TriggerDelayTime.restype=c_float
@@ -180,10 +193,10 @@ class Timing (  PptObject) :
 
     def TriggerType(self)->'AnimationTriggerType':
         """
-    <summary>
-        Describes trigger type.
-            Read/write <see cref="T:Spire.Presentation.Drawing.Animation.AnimationTriggerType" />.
-    </summary>
+        Gets or sets the condition that triggers the animation.
+        
+        Returns:
+            AnimationTriggerType: Animation trigger condition enumeration
         """
         GetDllLibPpt().Timing_get_TriggerType.argtypes=[c_void_p]
         GetDllLibPpt().Timing_get_TriggerType.restype=c_int
@@ -200,9 +213,10 @@ class Timing (  PptObject) :
 
     def AnimationRepeatType(self)->'AnimationRepeatType':
         """
-    <summary>
-        Gets or set repeat type of animation.
-    </summary>
+        Gets or sets the repeat behavior type for the animation.
+        
+        Returns:
+            AnimationRepeatType: Animation repeat behavior enumeration
         """
         GetDllLibPpt().Timing_get_AnimationRepeatType.argtypes=[c_void_p]
         GetDllLibPpt().Timing_get_AnimationRepeatType.restype=c_int
@@ -218,7 +232,13 @@ class Timing (  PptObject) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines whether the specified object is equal to the current timing settings.
+        
+        Args:
+            obj (SpireObject): The object to compare with the current timing
+            
+        Returns:
+            bool: True if the specified object has identical timing properties, otherwise False
         """
         intPtrobj:c_void_p = obj.Ptr
 

spire/presentation/{AxisPositionType.py → charts/AxisPositionType.py}

@@ -8,9 +8,13 @@ import abc
 
 class AxisPositionType(Enum):
     """
-    <summary>
-        Indicates a position of axis.
-    </summary>
+    Indicates the position of an axis.
+    
+    Attributes:
+        Bottom: Bottom position.
+        Left: Left position.
+        Right: Right position.
+        Top: Top position.
     """
     Bottom = 0
     Left = 1

spire/presentation/{AxisType.py → charts/AxisType.py}

@@ -8,9 +8,12 @@ import abc
 
 class AxisType(Enum):
     """
-    <summary>
-        CategoryAxis Type.
-    </summary>
+    Specifies the type of a chart axis.
+    
+    Attributes:
+        Auto: Automatic axis type determination.
+        TextAxis: Text-based category axis.
+        DateAxis: Date-based category axis.
     """
     Auto = 0
     TextAxis = 1