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

spire/presentation/{TextLineFormatList.py → collections/TextLineFormatList.py}

@@ -8,16 +8,18 @@ import abc
 
 class TextLineFormatList (  IEnumerable) :
     """
-    <summary>
-        Represents a collection of LineFormat objects.
-    </summary>
+    Represents a collection of LineFormat objects.
+    
+    Attributes:
+        Count (int): Gets the number of elements actually contained in the collection.
     """
     @property
     def Count(self)->int:
         """
-    <summary>
         Gets the number of elements actually contained in the collection.
-    </summary>
+        
+        Returns:
+            int: The number of elements in the collection.
         """
         GetDllLibPpt().TextLineFormatList_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().TextLineFormatList_get_Count.restype=c_int
@@ -27,11 +29,14 @@ class TextLineFormatList (  IEnumerable) :
 
     def get_Item(self ,index:int)->'TextLineFormat':
         """
-    <summary>
         Gets the element at the specified index.
-    </summary>
-        """
         
+        Args:
+            index (int): The zero-based index of the element to get.
+            
+        Returns:
+            TextLineFormat: The element at the specified index.
+        """
         GetDllLibPpt().TextLineFormatList_get_Item.argtypes=[c_void_p ,c_int]
         GetDllLibPpt().TextLineFormatList_get_Item.restype=c_void_p
         intPtr = CallCFunction(GetDllLibPpt().TextLineFormatList_get_Item,self.Ptr, index)
@@ -42,11 +47,10 @@ class TextLineFormatList (  IEnumerable) :
 
     def GetEnumerator(self)->'IEnumerator':
         """
-    <summary>
-        Gets the enumerator for an entire collection.
-    </summary>
-    <returns>
-  <see cref="T:System.Collections.IEnumerator" /> for an entire collection.</returns>
+        Gets the enumerator for the entire collection.
+        
+        Returns:
+            IEnumerator: An enumerator that iterates through the collection.
         """
         GetDllLibPpt().TextLineFormatList_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().TextLineFormatList_GetEnumerator.restype=c_void_p

spire/presentation/{TextRangeCollection.py → collections/TextRangeCollection.py}

@@ -4,18 +4,23 @@ from typing import TypeVar,Union,Generic,List,Tuple
 from spire.presentation.common import *
 from spire.presentation import *
 from ctypes import *
-from spire.presentation.TextRangeList import TextRangeList
+from spire.presentation.collections.TextRangeList import TextRangeList
 
 class TextRangeCollection (  TextRangeList) :
     """
-    <summary>
-        Represents a collection of a range.
-    </summary>
+    Represents a collection of a range.
+   
     """
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
+        Determines if the current object is equal to another object.
 
+        Args:
+            obj: The object to compare with the current object.
+
+        Returns:
+            bool: True if the objects are equal; otherwise False.
         """
         intPtrobj:c_void_p = obj.Ptr
 
@@ -24,27 +29,13 @@ class TextRangeCollection (  TextRangeList) :
         ret = CallCFunction(GetDllLibPpt().TextRangeCollection_Equals,self.Ptr, intPtrobj)
         return ret
 
-#
-#    def CopyTo(self ,array:'Array',index:int):
-#        """
-#    <summary>
-#        Copies all elements from the collection to the specified array.
-#    </summary>
-#    <param name="array">Target array.</param>
-#    <param name="index">Starting index in the target array.</param>
-#        """
-#        intPtrarray:c_void_p = array.Ptr
-#
-#        GetDllLibPpt().TextRangeCollection_CopyTo.argtypes=[c_void_p ,c_void_p,c_int]
-#        CallCFunction(GetDllLibPpt().TextRangeCollection_CopyTo,self.Ptr, intPtrarray,index)
-
-
     @property
     def IsSynchronized(self)->bool:
         """
-    <summary>
-        Gets a value indicating whether access to the collection is synchronized (thread-safe).
-    </summary>
+        Indicates whether access to the collection is thread-safe.
+
+        Returns:
+            bool: True if access is synchronized (thread-safe); otherwise False.
         """
         GetDllLibPpt().TextRangeCollection_get_IsSynchronized.argtypes=[c_void_p]
         GetDllLibPpt().TextRangeCollection_get_IsSynchronized.restype=c_bool
@@ -55,10 +46,10 @@ class TextRangeCollection (  TextRangeList) :
 
     def SyncRoot(self)->'SpireObject':
         """
-    <summary>
-        Gets a synchronization root.
-            Readonly <see cref="T:System.Object" />.
-    </summary>
+        Gets an object that can be used to synchronize access to the collection.
+
+        Returns:
+            SpireObject: An object that can be used for synchronization.
         """
         GetDllLibPpt().TextRangeCollection_get_SyncRoot.argtypes=[c_void_p]
         GetDllLibPpt().TextRangeCollection_get_SyncRoot.restype=c_void_p

spire/presentation/{TextRangeList.py → collections/TextRangeList.py}

@@ -8,12 +8,20 @@ from ctypes import *
 class TextRangeList (SpireObject) :
 
     """
-    <summary>
-        Represents a collection.
-    </summary>
+    Represents a collection of text ranges within presentation text elements.
+    
+    Provides list-like access to text fragments with formatting properties.
     """
 
     def __getitem__(self ,index:int)->'TextRange':
+        """Gets text range at the specified position.
+        
+        Args:
+            index: Zero-based index of the text range
+            
+        Returns:
+            TextRange object at the specified index.
+        """
         if index >= self.Count:
             raise StopIteration
         GetDllLibPpt().TextRangeList_get_Item.argtypes=[c_void_p ,c_int]
@@ -25,9 +33,10 @@ class TextRangeList (SpireObject) :
     @property
     def Count(self)->int:
         """
-    <summary>
-        Gets the number of elements actually contained in the collection.
-    </summary>
+        Gets number of text ranges in the collection.
+        
+        Returns:
+            Integer count of text range objects.
         """
         GetDllLibPpt().TextRangeList_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().TextRangeList_get_Count.restype=c_int
@@ -37,9 +46,13 @@ class TextRangeList (SpireObject) :
 
     def get_Item(self ,index:int)->'TextRange':
         """
-    <summary>
-        Gets the element at the specified index.
-    </summary>
+        Gets text range at the specified position (alternative accessor).
+        
+        Args:
+            index: Zero-based index of the text range
+            
+        Returns:
+            TextRange object at the specified index.
         """
         
         GetDllLibPpt().TextRangeList_get_Item.argtypes=[c_void_p ,c_int]
@@ -52,11 +65,13 @@ class TextRangeList (SpireObject) :
 
     def Append(self ,value:'TextRange')->int:
         """
-    <summary>
         Adds a text range to the end of collection.
-    </summary>
-    <param name="value">The text range </param>
-    <returns>The index at which the text range has been added.</returns>
+        
+        Args:
+            value: TextRange object to add
+            
+        Returns:
+            Index position where the range was added.
         """
         intPtrvalue:c_void_p = value.Ptr
 
@@ -68,11 +83,11 @@ class TextRangeList (SpireObject) :
 
     def Insert(self ,index:int,value:'TextRange'):
         """
-    <summary>
-        Inserts a Portion into the collection at the specified index.
-    </summary>
-    <param name="index">The zero-based index at which Portion should be inserted.</param>
-    <param name="value">The Portion to insert.</param>
+        Inserts text range at specified position.
+        
+        Args:
+            index: Insertion position (0-based)
+            value: TextRange object to insert
         """
         intPtrvalue:c_void_p = value.Ptr
 
@@ -80,21 +95,17 @@ class TextRangeList (SpireObject) :
         CallCFunction(GetDllLibPpt().TextRangeList_Insert,self.Ptr, index,intPtrvalue)
 
     def Clear(self):
-        """
-    <summary>
-        Removes all elements from the collection.
-    </summary>
-        """
+        """Removes all text ranges from the collection."""
         GetDllLibPpt().TextRangeList_Clear.argtypes=[c_void_p]
         CallCFunction(GetDllLibPpt().TextRangeList_Clear,self.Ptr)
 
 
     def RemoveAt(self ,index:int):
         """
-    <summary>
-        Removes the element at the specified index of the collection.
-    </summary>
-    <param name="index">The zero-based index of the element to remove.</param>
+        Removes text range at specified position.
+        
+        Args:
+            index: Zero-based index of range to remove
         """
         
         GetDllLibPpt().TextRangeList_RemoveAt.argtypes=[c_void_p ,c_int]
@@ -103,10 +114,10 @@ class TextRangeList (SpireObject) :
 
     def GetEnumerator(self)->'IEnumerator':
         """
-    <summary>
-        Gets an enumerator for the entire collection.
-    </summary>
-    <returns>An <see cref="T:System.Collections.IEnumerator" /> for the entire collection.</returns>
+        Gets enumerator for iterating through text ranges.
+        
+        Returns:
+            Enumerator object for the collection.
         """
         GetDllLibPpt().TextRangeList_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().TextRangeList_GetEnumerator.restype=c_void_p
@@ -117,8 +128,13 @@ class TextRangeList (SpireObject) :
 
 
     def Equals(self ,obj:'SpireObject')->bool:
-        """
-
+        """Determines collection equality with another object.
+        
+        Args:
+            obj: SpireObject to compare with
+            
+        Returns:
+            True if collections are equivalent, False otherwise.
         """
         intPtrobj:c_void_p = obj.Ptr
 

spire/presentation/{VideoCollection.py → collections/VideoCollection.py}

@@ -8,16 +8,15 @@ import abc
 
 class VideoCollection (  ICollection, IEnumerable) :
     """
-    <summary>
-        Represents a collection of Video objects.
-    </summary>
+    Represents a collection of Video objects.
     """
     @property
     def Count(self)->int:
         """
-    <summary>
-        Gets a number of video files in the collection.
-    </summary>
+        Gets number of text ranges in the collection.
+        
+        Returns:
+            Integer count of text range objects.
         """
         GetDllLibPpt().VideoCollection_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().VideoCollection_get_Count.restype=c_int
@@ -27,10 +26,13 @@ class VideoCollection (  ICollection, IEnumerable) :
 
     def get_Item(self ,index:int)->'VideoData':
         """
-    <summary>
-        Gets the element at the specified index.
-            Read-only <see cref="T:Spire.Presentation.VideoData" />.
-    </summary>
+        Get a video by index.
+        
+        Args:
+            index (int): Index of the video to retrieve
+            
+        Returns:
+            VideoData: Video object at the specified index
         """
         
         GetDllLibPpt().VideoCollection_get_Item.argtypes=[c_void_p ,c_int]
@@ -44,11 +46,13 @@ class VideoCollection (  ICollection, IEnumerable) :
 
     def AppendByVideoData(self ,videoData:VideoData)->VideoData:
         """
-    <summary>
-        Adds a copy of an video file from an another presentation.
-    </summary>
-    <param name="videoData">Source video.</param>
-    <returns>Added video.</returns>
+        Add a copy of a video from another presentation.
+        
+        Args:
+            videoData (VideoData): Source video to copy
+            
+        Returns:
+            VideoData: Newly added video object
         """
         intPtrvideoData:c_void_p = videoData.Ptr
 
@@ -63,11 +67,13 @@ class VideoCollection (  ICollection, IEnumerable) :
 
     def AppendByStream(self ,stream:Stream)->VideoData:
         """
-    <summary>
-        Creates and adds a video to a presentation from stream.
-    </summary>
-    <param name="stream">Stream to add video file from.</param>
-    <returns>Added <see cref="T:Spire.Presentation.VideoData" />.</returns>
+        Add a video from a stream.
+        
+        Args:
+            stream (Stream): Stream containing video data
+            
+        Returns:
+            VideoData: Newly added video object
         """
         intPtrstream:c_void_p = stream.Ptr
 

spire/presentation/{WavAudioCollection.py → collections/WavAudioCollection.py}

@@ -7,17 +7,15 @@ from ctypes import *
 import abc
 
 class WavAudioCollection (  ICollection, IEnumerable) :
-    """
-    <summary>
-        Represents a collection of embedded audio files.
-    </summary>
-    """
+    """Represents a collection of embedded WAV audio files."""
+
     @property
     def Count(self)->int:
         """
-    <summary>
-        Gets a number of audio files in the collection.
-    </summary>
+        Gets the number of audio files in the collection.
+
+        Returns:
+            int: The number of audio files.
         """
         GetDllLibPpt().WavAudioCollection_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().WavAudioCollection_get_Count.restype=c_int
@@ -27,12 +25,14 @@ class WavAudioCollection (  ICollection, IEnumerable) :
 
     def get_Item(self ,index:int)->'IAudioData':
         """
-    <summary>
-        Gets the element at the specified index.
-            Read-only <see cref="T:Spire.Presentation.Drawing.ImageData" />.
-    </summary>
+        Gets the audio element at the specified index.
+
+        Args:
+            index: The zero-based index of the element to get.
+
+        Returns:
+            IAudioData: The audio data at the specified index.
         """
-        
         GetDllLibPpt().WavAudioCollection_get_Item.argtypes=[c_void_p ,c_int]
         GetDllLibPpt().WavAudioCollection_get_Item.restype=c_void_p
         intPtr = CallCFunction(GetDllLibPpt().WavAudioCollection_get_Item,self.Ptr, index)
@@ -44,11 +44,13 @@ class WavAudioCollection (  ICollection, IEnumerable) :
 
     def Append(self ,audioData:IAudioData)->IAudioData:
         """
-    <summary>
-        Adds an audio file to list.
-    </summary>
-    <param name="audioData">Source audio.</param>
-    <returns>Added audio.</returns>
+        Adds an audio file to the collection.
+
+        Args:
+            audioData: Source audio object to add.
+
+        Returns:
+            IAudioData: The added audio object.
         """
         intPtraudioData:c_void_p = audioData.Ptr
 
@@ -63,11 +65,13 @@ class WavAudioCollection (  ICollection, IEnumerable) :
 
     def Append(self ,stream:Stream)->IAudioData:
         """
-    <summary>
-        Adds an audio to the list from stream.
-    </summary>
-    <param name="stream">Stream to add audio from.</param>
-    <returns>Added audio.</returns>
+        Adds an audio file from a stream to the collection.
+
+        Args:
+            stream: Stream containing audio data.
+
+        Returns:
+            IAudioData: The added audio object.
         """
         intPtrstream:c_void_p = stream.Ptr
 

spire/presentation/{ISmartArt.py → diagrams/ISmartArt.py}

@@ -8,13 +8,17 @@ import abc
 
 class ISmartArt (SpireObject) :
     """
-
+    Represents a SmartArt diagram in a presentation.
+    Provides access to SmartArt nodes, color styles, layout types, and styling options.
+    Inherits from SpireObject.
     """
     @property
 
     def Nodes(self)->'ISmartArtNodeCollection':
         """
-
+        Gets the collection of root nodes in the SmartArt diagram.
+        Returns:
+            ISmartArtNodeCollection: Collection of root nodes.
         """
         GetDllLibPpt().ISmartArt_get_Nodes.argtypes=[c_void_p]
         GetDllLibPpt().ISmartArt_get_Nodes.restype=c_void_p
@@ -27,7 +31,9 @@ class ISmartArt (SpireObject) :
 
     def ColorStyle(self)->'SmartArtColorType':
         """
-
+        Gets or sets the color style of the SmartArt diagram.
+        Returns:
+            SmartArtColorType: Current color style.
         """
         GetDllLibPpt().ISmartArt_get_ColorStyle.argtypes=[c_void_p]
         GetDllLibPpt().ISmartArt_get_ColorStyle.restype=c_int
@@ -37,6 +43,11 @@ class ISmartArt (SpireObject) :
 
     @ColorStyle.setter
     def ColorStyle(self, value:'SmartArtColorType'):
+        """
+        Sets the color style of the SmartArt diagram.
+        Args:
+            value: SmartArtColorType to apply.
+        """
         GetDllLibPpt().ISmartArt_set_ColorStyle.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().ISmartArt_set_ColorStyle,self.Ptr, value.value)
 
@@ -44,7 +55,9 @@ class ISmartArt (SpireObject) :
 
     def LayoutType(self)->'SmartArtLayoutType':
         """
-
+        Gets the layout type of the SmartArt diagram (read-only).
+        Returns:
+            SmartArtLayoutType: Current layout type.
         """
         GetDllLibPpt().ISmartArt_get_LayoutType.argtypes=[c_void_p]
         GetDllLibPpt().ISmartArt_get_LayoutType.restype=c_int
@@ -56,7 +69,9 @@ class ISmartArt (SpireObject) :
 
     def Style(self)->'SmartArtStyleType':
         """
-
+        Gets or sets the style of the SmartArt diagram.
+        Returns:
+            SmartArtStyleType: Current style.
         """
         GetDllLibPpt().ISmartArt_get_Style.argtypes=[c_void_p]
         GetDllLibPpt().ISmartArt_get_Style.restype=c_int
@@ -66,12 +81,17 @@ class ISmartArt (SpireObject) :
 
     @Style.setter
     def Style(self, value:'SmartArtStyleType'):
+        """
+        Sets the style of the SmartArt diagram.
+        Args:
+            value: SmartArtStyleType to apply.
+        """
         GetDllLibPpt().ISmartArt_set_Style.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().ISmartArt_set_Style,self.Ptr, value.value)
 
     def Reset(self):
         """
-
+        Resets the SmartArt diagram to its default state.
         """
         GetDllLibPpt().ISmartArt_Reset.argtypes=[c_void_p]
         CallCFunction(GetDllLibPpt().ISmartArt_Reset,self.Ptr)
@@ -79,10 +99,9 @@ class ISmartArt (SpireObject) :
     @property
     def Left(self)->float:
         """
-    <summary>
-        Gets or sets the x-coordinate of the upper-left corner of the smarart.
-            Read/write <see cref="T:System.Int32" />.
-    </summary>
+        Gets or sets the x-coordinate of the upper-left corner of the SmartArt.
+        Returns:
+            float: X-coordinate value.
         """
         GetDllLibPpt().IShape_get_Left.argtypes=[c_void_p]
         GetDllLibPpt().IShape_get_Left.restype=c_float
@@ -91,16 +110,20 @@ class ISmartArt (SpireObject) :
 
     @Left.setter
     def Left(self, value:float):
+        """
+        Sets the x-coordinate of the upper-left corner of the SmartArt.
+        Args:
+            value: New x-coordinate value.
+        """
         GetDllLibPpt().IShape_set_Left.argtypes=[c_void_p, c_float]
         CallCFunction(GetDllLibPpt().IShape_set_Left,self.Ptr, value)
 
     @property
     def Top(self)->float:
         """
-    <summary>
-        Gets or sets the y-coordinate of the upper-left corner of the smarart.
-            Read/write <see cref="T:System.Int32" />.
-    </summary>
+        Gets or sets the y-coordinate of the upper-left corner of the SmartArt.
+        Returns:
+            float: Y-coordinate value.
         """
         GetDllLibPpt().IShape_get_Top.argtypes=[c_void_p]
         GetDllLibPpt().IShape_get_Top.restype=c_float
@@ -109,6 +132,11 @@ class ISmartArt (SpireObject) :
 
     @Top.setter
     def Top(self, value:float):
+        """
+        Sets the y-coordinate of the upper-left corner of the SmartArt.
+        Args:
+            value: New y-coordinate value.
+        """
         GetDllLibPpt().IShape_set_Top.argtypes=[c_void_p, c_float]
         CallCFunction(GetDllLibPpt().IShape_set_Top,self.Ptr, value)