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

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

@@ -8,17 +8,17 @@ import abc
 
 class CommentList (SpireObject) :
     """
-    <summary>
-        Represents a collection of comments of one author.
-    </summary>
+    Represents a collection of comments from a single author.
+    
+    Provides methods for managing comments in a presentation.
     """
     @property
     def Count(self)->int:
         """
-    <summary>
-        Gets the number of elements actually contained in the collection.
-            Read-only <see cref="T:System.Int32" />.
-    </summary>
+        Gets the number of comments in the collection.
+        
+        Returns:
+            int: The actual number of elements in the collection.
         """
         GetDllLibPpt().CommentList_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().CommentList_get_Count.restype=c_int
@@ -27,6 +27,15 @@ class CommentList (SpireObject) :
 
     @dispatch
     def __getitem__(self, index):
+        """
+        Gets the comment at the specified index.
+        
+        Args:
+            index: The zero-based index of the comment to retrieve
+            
+        Returns:
+            Comment: The comment at the specified position
+        """
         if index >= self.Count:
             raise StopIteration
         GetDllLibPpt().CommentList_get_Item.argtypes=[c_void_p ,c_int]
@@ -37,10 +46,13 @@ class CommentList (SpireObject) :
 
     def get_Item(self ,index:int)->'Comment':
         """
-    <summary>
-        Gets the element at the specified index.
-            Read-only <see cref="T:Spire.Presentation.Comment" />.
-    </summary>
+        Gets the comment at the specified index.
+        
+        Args:
+            index: The zero-based index of the comment to retrieve
+            
+        Returns:
+            Comment: The comment at the specified position
         """
         
         GetDllLibPpt().CommentList_get_Item.argtypes=[c_void_p ,c_int]
@@ -53,14 +65,16 @@ class CommentList (SpireObject) :
 
     def AppendComment(self ,slide:'ISlide',text:str,x:float,y:float)->'Comment':
         """
-    <summary>
-        Adds a new comment added to a slide.
-    </summary>
-    <param name="slide">Slide object</param>
-    <param name="text">Text of new comment.</param>
-    <param name="x">x position</param>
-    <param name="y">y position</param>
-    <returns></returns>
+        Adds a new comment to a slide.
+        
+        Args:
+            slide: The target slide object
+            text: Text content of the new comment
+            x: Horizontal position coordinate of the comment
+            y: Vertical position coordinate of the comment
+            
+        Returns:
+            Comment: The newly created comment object
         """
         intPtrslide:c_void_p = slide.Ptr
 
@@ -75,15 +89,17 @@ class CommentList (SpireObject) :
 
     def InsertComment(self ,slide:'ISlide',Index:int,text:str,x:float,y:float)->'Comment':
         """
-    <summary>
-        Adds a new comment added to a slide.
-    </summary>
-    <param name="slide">Slide object</param>
-    <param name="Index">Text of new comment.</param>
-    <param name="text"></param>
-    <param name="x">x position</param>
-    <param name="y">y position</param>
-    <returns></returns>
+        Inserts a new comment at the specified position.
+        
+        Args:
+            slide: The target slide object
+            index: The insertion position index
+            text: Text content of the new comment
+            x: Horizontal position coordinate
+            y: Vertical position coordinate
+            
+        Returns:
+            Comment: The newly created comment object
         """
         intPtrslide:c_void_p = slide.Ptr
 
@@ -94,41 +110,12 @@ class CommentList (SpireObject) :
         ret = None if intPtr==None else Comment(intPtr)
         return ret
 
-
-#    @dispatch
-#
-#    def ToArray(self)->List[Comment]:
-#        """
-#
-#        """
-#        GetDllLibPpt().CommentList_ToArray.argtypes=[c_void_p]
-#        GetDllLibPpt().CommentList_ToArray.restype=IntPtrArray
-#        intPtrArray = CallCFunction(GetDllLibPpt().CommentList_ToArray,self.Ptr)
-#        ret = GetVectorFromArray(intPtrArray, Comment)
-#        return ret
-
-
-#    @dispatch
-#
-#    def ToArray(self ,startIndex:int,count:int)->List[Comment]:
-#        """
-#
-#        """
-#        
-#        GetDllLibPpt().CommentList_ToArraySC.argtypes=[c_void_p ,c_int,c_int]
-#        GetDllLibPpt().CommentList_ToArraySC.restype=IntPtrArray
-#        intPtrArray = CallCFunction(GetDllLibPpt().CommentList_ToArraySC,self.Ptr, startIndex,count)
-#        ret = GetObjVectorFromArray(intPtrArray, Comment)
-#        return ret
-
-
-
     def RemoveAt(self ,index:int):
         """
-    <summary>
-        Removes the element at the specified index in a collection.
-    </summary>
-    <param name="index">The zero-based index of the element to remove.</param>
+        Removes the comment at the specified index.
+        
+        Args:
+            index: The zero-based index of the comment to remove
         """
         
         GetDllLibPpt().CommentList_RemoveAt.argtypes=[c_void_p ,c_int]
@@ -137,10 +124,10 @@ class CommentList (SpireObject) :
 
     def Remove(self ,comment:'Comment'):
         """
-    <summary>
-        Removes the first occurrence of the specified comment in a collection.
-    </summary>
-    <param name="comment">The comment to remove from a collection.</param>
+        Removes the specified comment from the collection.
+        
+        Args:
+            comment: The comment object to remove
         """
         intPtrcomment:c_void_p = comment.Ptr
 
@@ -150,10 +137,10 @@ class CommentList (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 an enumerator for iterating through the collection.
+        
+        Returns:
+            IEnumerator: An enumerator for the entire collection
         """
         GetDllLibPpt().CommentList_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().CommentList_GetEnumerator.restype=c_void_p
@@ -166,10 +153,10 @@ class CommentList (SpireObject) :
 
     def Presentation(self)->'Presentation':
         """
-    <summary>
-        Gets parent PresentationPptx object for a collection of comments.
-            Read-only <see cref="T:Spire.Presentation.PresentationPptx" />.
-    </summary>
+        Gets the parent presentation object.
+        
+        Returns:
+            Presentation: The parent presentation containing this comment collection.
         """
         GetDllLibPpt().CommentList_get_Presentation.argtypes=[c_void_p]
         GetDllLibPpt().CommentList_get_Presentation.restype=c_void_p

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

@@ -8,17 +8,19 @@ import abc
 
 class EffectDataCollection (  ICollection, IEnumerable) :
     """
-    <summary>
-        Represents a readonly collection of EffectData objects.
-    </summary>
+    Represents a readonly collection of EffectData objects.
+    
+    This collection provides access to effect data nodes in a presentation.
+    
+    Attributes:
+        Count (int): Gets the number of image effects in the collection (read-only).
+        IsSynchronized (bool): Indicates whether access to the collection is thread-safe.
+        SyncRoot (SpireObject): Gets an object that can be used to synchronize access to the collection.
     """
     @property
     def Count(self)->int:
         """
-    <summary>
-        Gets the number of image effects in a collection.
-            Read-only <see cref="T:System.Int32" />.
-    </summary>
+        Gets the number of image effects in the collection.
         """
         GetDllLibPpt().EffectDataCollection_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().EffectDataCollection_get_Count.restype=c_int
@@ -28,10 +30,10 @@ class EffectDataCollection (  ICollection, IEnumerable) :
 
     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 an enumerator that iterates through the collection.
+        
+        Returns:
+            IEnumerator: An enumerator for the entire collection.
         """
         GetDllLibPpt().EffectDataCollection_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().EffectDataCollection_GetEnumerator.restype=c_void_p
@@ -43,11 +45,13 @@ class EffectDataCollection (  ICollection, IEnumerable) :
 
     def get_Item(self ,index:int)->'EffectNode':
         """
-    <summary>
-        Gets element by index.
-    </summary>
-    <param name="index"></param>
-    <returns></returns>
+        Gets the EffectNode at the specified index position.
+        
+        Args:
+            index: The zero-based index of the element to get.
+            
+        Returns:
+            EffectNode: The EffectNode at the specified index.
         """
         
         GetDllLibPpt().EffectDataCollection_get_Item.argtypes=[c_void_p ,c_int]
@@ -75,9 +79,7 @@ class EffectDataCollection (  ICollection, IEnumerable) :
     @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 synchronized (thread-safe).
         """
         GetDllLibPpt().EffectDataCollection_get_IsSynchronized.argtypes=[c_void_p]
         GetDllLibPpt().EffectDataCollection_get_IsSynchronized.restype=c_bool
@@ -88,10 +90,7 @@ class EffectDataCollection (  ICollection, IEnumerable) :
 
     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.
         """
         GetDllLibPpt().EffectDataCollection_get_SyncRoot.argtypes=[c_void_p]
         GetDllLibPpt().EffectDataCollection_get_SyncRoot.restype=c_void_p

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

@@ -8,13 +8,16 @@ import abc
 
 class EffectStyleCollection (  EffectStyleList, ICollection) :
     """
-    <summary>
-        Represents a collection of effect styles.
-    </summary>
+    Represents a collection of effect styles that inherit functionality from EffectStyleList and ICollection interfaces.
     """
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
+        Determines whether the specified SpireObject is equal to the current object.
+        Args:
+            obj: The SpireObject to compare with the current object.
+        Returns:
+            True if the objects are equal; otherwise, False.
 
         """
         intPtrobj:c_void_p = obj.Ptr
@@ -42,9 +45,10 @@ class EffectStyleCollection (  EffectStyleList, ICollection) :
     @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 synchronized (thread-safe).
+        
+        Returns:
+            bool: True if access is thread-safe, False otherwise.
         """
         GetDllLibPpt().EffectStyleCollection_get_IsSynchronized.argtypes=[c_void_p]
         GetDllLibPpt().EffectStyleCollection_get_IsSynchronized.restype=c_bool
@@ -55,10 +59,10 @@ class EffectStyleCollection (  EffectStyleList, ICollection) :
 
     def SyncRoot(self)->'SpireObject':
         """
-    <summary>
-        Gets a synchronization root.
-            Readonly <see cref="T:System.Object" />.
-    </summary>
+        Gets the synchronization root object for thread-safe access.
+        
+        Returns:
+            SpireObject: An object that can be used to synchronize access to the collection.
         """
         GetDllLibPpt().EffectStyleCollection_get_SyncRoot.argtypes=[c_void_p]
         GetDllLibPpt().EffectStyleCollection_get_SyncRoot.restype=c_void_p

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

@@ -8,17 +8,12 @@ import abc
 
 class EffectStyleList (  IEnumerable) :
     """
-    <summary>
-        Represents a collection of effect styles.
-    </summary>
+    Base class representing a collection of effect styles with enumeration capabilities.
     """
     @property
     def Count(self)->int:
         """
-    <summary>
-        Gets a number of elements in the collection.
-            Readonly <see cref="T:System.Int32" />,
-    </summary>
+        Gets the number of elements in the collection (read-only).
         """
         GetDllLibPpt().EffectStyleList_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().EffectStyleList_get_Count.restype=c_int
@@ -28,12 +23,11 @@ class EffectStyleList (  IEnumerable) :
 
     def get_Item(self ,index:int)->'EffectStyle':
         """
-    <summary>
-        Gets an element at specified position.
-            Readonly <see cref="T:Spire.Presentation.Drawing.EffectStyle" />.
-    </summary>
-    <param name="index">Position of element.</param>
-    <returns>Element at specified position.</returns>
+        Gets the effect style element at the specified position.
+        Args:
+            index: Zero-based position index of the element.
+        Returns:
+            EffectStyle object at specified position.
         """
         
         GetDllLibPpt().EffectStyleList_get_Item.argtypes=[c_void_p ,c_int]
@@ -46,7 +40,11 @@ class EffectStyleList (  IEnumerable) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines whether the specified SpireObject is equal to the current object.
+        Args:
+            obj: The SpireObject to compare with the current object.
+        Returns:
+            True if the objects are equal; otherwise, False.
         """
         intPtrobj:c_void_p = obj.Ptr
 
@@ -58,9 +56,9 @@ class EffectStyleList (  IEnumerable) :
 
     def GetEnumerator(self)->'IEnumerator':
         """
-    <summary>
-        Gets an enumerator for the entire collection.
-    </summary>
+        Gets an enumerator that iterates through the collection.
+        Returns:
+            IEnumerator object for the entire collection.
         """
         GetDllLibPpt().EffectStyleList_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().EffectStyleList_GetEnumerator.restype=c_void_p

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

@@ -8,16 +8,12 @@ import abc
 
 class EmbedImageList ( SpireObject ) :
     """
-    <summary>
-        Summary description for Images.
-    </summary>
+    Manages a collection of embedded images within a presentation.
     """
     @property
     def Count(self)->int:
         """
-    <summary>
-        Gets a number of images in the collection.
-    </summary>
+        Gets the number of images in the collection.
         """
         GetDllLibPpt().EmbedImageList_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().EmbedImageList_get_Count.restype=c_int
@@ -26,6 +22,13 @@ class EmbedImageList ( SpireObject ) :
 
     @dispatch
     def __getitem__(self, index):
+        """
+        Indexer to get the image element at specified position.
+        Args:
+            index: Zero-based position index.
+        Returns:
+            IImageData object at specified position.
+        """
         if index >= self.Count:
             raise StopIteration
         GetDllLibPpt().EmbedImageList_get_Item.argtypes=[c_void_p ,c_int]
@@ -36,10 +39,12 @@ class EmbedImageList ( SpireObject ) :
 
     def get_Item(self ,index:int)->'IImageData':
         """
-    <summary>
-        Gets the element at the specified index.
-            Read-only <see cref="T:Spire.Presentation.Drawing.ImageData" />.
-    </summary>
+        Gets the image element at specified position.
+        Args:
+            index: Zero-based position index.
+        Returns:
+            IImageData object at specified position.
+    
         """
         
         GetDllLibPpt().EmbedImageList_get_Item.argtypes=[c_void_p ,c_int]
@@ -50,11 +55,11 @@ class EmbedImageList ( SpireObject ) :
 
     def AppendImageData(self ,embedImage:IImageData)->IImageData:
         """
-    <summary>
-        Adds a copy of an image from an another presentation.
-    </summary>
-    <param name="embedImage">Source image.</param>
-    <returns>Added image.</returns>
+        Adds a copy of an image from another presentation.
+        Args:
+            embedImage: Source image data to copy.
+        Returns:
+            Added IImageData object.
         """
         intPtrembedImage:c_void_p = embedImage.Ptr
 
@@ -85,11 +90,11 @@ class EmbedImageList ( SpireObject ) :
 
     def AppendStream(self ,stream:'Stream')->'IImageData':
         """
-    <summary>
-        Add an image to a presentation from stream.
-    </summary>
-    <param name="stream">Stream to add image from.</param>
-    <returns>Added image.</returns>
+        Adds an image to the presentation from a stream.
+        Args:
+            stream: Input stream containing image data.
+        Returns:
+            Added IImageData object.
         """
         intPtrstream:c_void_p = stream.Ptr
 
@@ -103,10 +108,9 @@ class EmbedImageList ( 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 an enumerator for iterating through the collection.
+        Returns:
+            IEnumerator object for the entire collection.
         """
         GetDllLibPpt().EmbedImageList_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().EmbedImageList_GetEnumerator.restype=c_void_p

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

@@ -8,31 +8,19 @@ import abc
 
 class FillFormatCollection (  FillFormatList, ICollection) :
     """
-    <summary>
-        Represents a collection of FillFormat objects.
-    </summary>
+    Represents a collection of FillFormat objects.
+    
+    Provides management capabilities for groups of fill formats with collection 
+    functionality including synchronization properties.
     """
-#
-#    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().FillFormatCollection_CopyTo.argtypes=[c_void_p ,c_void_p,c_int]
-#        CallCFunction(GetDllLibPpt().FillFormatCollection_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 for synchronized access
         """
         GetDllLibPpt().FillFormatCollection_get_IsSynchronized.argtypes=[c_void_p]
         GetDllLibPpt().FillFormatCollection_get_IsSynchronized.restype=c_bool
@@ -43,10 +31,10 @@ class FillFormatCollection (  FillFormatList, ICollection) :
 
     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().FillFormatCollection_get_SyncRoot.argtypes=[c_void_p]
         GetDllLibPpt().FillFormatCollection_get_SyncRoot.restype=c_void_p

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

@@ -8,7 +8,6 @@ import abc
 
 class FillFormatList (  FillListBase) :
     """
-    <summary>
-        Represents a collection of FillFormat objects.
-    </summary>
+    Represents a collection of FillFormat objects.
+    
     """

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

@@ -8,16 +8,17 @@ import abc
 
 class FillListBase (  IEnumerable) :
     """
-    <summary>
-        Represents a collection of FillFormat objects.
-    </summary>
+    Represents a collection of FillFormat objects used in presentations.
+    
+    Provides access to fill formats through enumeration and indexing.
     """
     @property
     def Count(self)->int:
         """
-    <summary>
-        Gets the number of elements actually contained in the collection.
-    </summary>
+        Gets the number of FillFormat elements actually contained in the collection.
+        
+        Returns:
+            int: The number of elements in the collection.
         """
         GetDllLibPpt().FillListBase_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().FillListBase_get_Count.restype=c_int
@@ -27,12 +28,14 @@ class FillListBase (  IEnumerable) :
 
     def get_Item(self ,index:int)->'FillFormat':
         """
-    <summary>
-        Gets the element at the specified index.
-            Read-only <see cref="T:Spire.Presentation.Drawing.FillFormat" />.
-    </summary>
-        """
+        Retrieves the FillFormat element at the specified index.
         
+        Args:
+            index: Zero-based index of the element to retrieve
+        
+        Returns:
+            FillFormat: The fill format at the specified position
+        """
         GetDllLibPpt().FillListBase_get_Item.argtypes=[c_void_p ,c_int]
         GetDllLibPpt().FillListBase_get_Item.restype=c_void_p
         intPtr = CallCFunction(GetDllLibPpt().FillListBase_get_Item,self.Ptr, index)
@@ -43,7 +46,13 @@ class FillListBase (  IEnumerable) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines whether the current collection is equal to another object.
+        
+        Args:
+            obj: The object to compare with
+        
+        Returns:
+            bool: True if the objects are equal, otherwise False
         """
         intPtrobj:c_void_p = obj.Ptr
 
@@ -55,10 +64,10 @@ class FillListBase (  IEnumerable) :
 
     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 an enumerator that iterates through the collection.
+        
+        Returns:
+            IEnumerator: Enumerator for iterating through FillFormat objects
         """
         GetDllLibPpt().FillListBase_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().FillListBase_GetEnumerator.restype=c_void_p