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

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

@@ -8,16 +8,17 @@ import abc
 
 class LineStyleList (  IEnumerable) :
     """
-    <summary>
-        Represents the collection of line styles.
-    </summary>
+    Represents a collection of line formatting styles.
+    
+    This class provides enumeration capabilities for a collection of line styles.
     """
     @property
     def Count(self)->int:
         """
-    <summary>
-        Gets the number of elements actually contained in the collection.
-    </summary>
+        Gets the number of line styles in the collection.
+        
+        Returns:
+            int: The actual number of elements in the collection.
         """
         GetDllLibPpt().LineStyleList_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().LineStyleList_get_Count.restype=c_int
@@ -27,10 +28,13 @@ class LineStyleList (  IEnumerable) :
 
     def get_Item(self ,index:int)->'TextLineFormat':
         """
-    <summary>
-        Gets the element at the specified index.
-            Read-only <see cref="T:Spire.Presentation.TextLineFormat" />.
-    </summary>
+        Gets the line style at the specified index.
+        
+        Args:
+            index (int): The zero-based index of the element to get.
+            
+        Returns:
+            TextLineFormat: The line style at the specified index.
         """
         
         GetDllLibPpt().LineStyleList_get_Item.argtypes=[c_void_p ,c_int]
@@ -43,7 +47,13 @@ class LineStyleList (  IEnumerable) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines whether the specified object is equal to the current LineStyleList.
+        
+        Args:
+            obj (SpireObject): The object to compare with.
+            
+        Returns:
+            bool: True if the objects are equal; otherwise, False.
         """
         intPtrobj:c_void_p = obj.Ptr
 
@@ -55,10 +65,10 @@ class LineStyleList (  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 that can be used to iterate through the collection.
         """
         GetDllLibPpt().LineStyleList_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().LineStyleList_GetEnumerator.restype=c_void_p

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

@@ -7,32 +7,15 @@ from ctypes import *
 import abc
 
 class MasterSlideCollection (  MasterSlideList) :
-    """
-    <summary>
-        Represents a collection of master slides.
-    </summary>
-    """
-#
-#    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().MasterSlideCollection_CopyTo.argtypes=[c_void_p ,c_void_p,c_int]
-#        CallCFunction(GetDllLibPpt().MasterSlideCollection_CopyTo,self.Ptr, intPtrarray,index)
-
+    """Represents a collection of master slides."""
 
     @property
     def IsSynchronized(self)->bool:
         """
-    <summary>
-        Gets a value indicating whether access to the collection is synchronized (thread-safe).
-    </summary>
+        Gets a value indicating whether access to the collection is thread-safe.
+        
+        Returns:
+            bool: True if thread-safe, otherwise False
         """
         GetDllLibPpt().MasterSlideCollection_get_IsSynchronized.argtypes=[c_void_p]
         GetDllLibPpt().MasterSlideCollection_get_IsSynchronized.restype=c_bool
@@ -43,10 +26,10 @@ class MasterSlideCollection (  MasterSlideList) :
 
     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: Synchronization root object
         """
         GetDllLibPpt().MasterSlideCollection_get_SyncRoot.argtypes=[c_void_p]
         GetDllLibPpt().MasterSlideCollection_get_SyncRoot.restype=c_void_p

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

@@ -8,17 +8,16 @@ import abc
 
 class MasterSlideList (SpireObject) :
     """
-    <summary>
-         Represents a collection of master slides.
-     </summary>
+    Represents a collection of master slides.
+     
     """
     @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 elements in the collection.
+        
+        Returns:
+            int: Number of master slides
         """
         GetDllLibPpt().MasterSlideList_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().MasterSlideList_get_Count.restype=c_int
@@ -27,6 +26,15 @@ class MasterSlideList (SpireObject) :
 
     @dispatch
     def __getitem__(self, index):
+        """
+        Gets the master slide at the specified index.
+        
+        Args:
+            index (int): Zero-based index
+            
+        Returns:
+            IMasterSlide: Master slide at specified position
+        """
         if index >= self.Count:
             raise StopIteration
         GetDllLibPpt().MasterSlideList_get_Item.argtypes=[c_void_p ,c_int]
@@ -37,10 +45,13 @@ class MasterSlideList (SpireObject) :
 
     def get_Item(self ,index:int)->'IMasterSlide':
         """
-    <summary>
-        Gets the element at the specified index.
-            Read-only <see cref="T:Spire.Presentation.MasterSlide" />.
-    </summary>
+        Gets the master slide at the specified index.
+        
+        Args:
+            index (int): Zero-based index
+            
+        Returns:
+            IMasterSlide: Master slide at specified position
         """
         
         GetDllLibPpt().MasterSlideList_get_Item.argtypes=[c_void_p ,c_int]
@@ -53,10 +64,10 @@ class MasterSlideList (SpireObject) :
 
     def Remove(self ,value:'IMasterSlide'):
         """
-    <summary>
-        Removes the first occurrence of a specific object from the collection.
-    </summary>
-    <param name="value">The master slide to remove from the collection.</param>
+        Removes the first occurrence of a specific master slide.
+        
+        Args:
+            value (IMasterSlide): Master slide to remove
         """
         intPtrvalue:c_void_p = value.Ptr
 
@@ -66,31 +77,30 @@ class MasterSlideList (SpireObject) :
 
     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 the master slide at the specified index.
+        
+        Args:
+            index (int): Zero-based index of element to remove
         """
         
         GetDllLibPpt().MasterSlideList_RemoveAt.argtypes=[c_void_p ,c_int]
         CallCFunction(GetDllLibPpt().MasterSlideList_RemoveAt,self.Ptr, index)
 
     def CleanupDesigns(self):
-        """
-    <summary>
-        Removes unused master slides.
-    </summary>
-        """
+        """Removes unused master slides from the collection."""
         GetDllLibPpt().MasterSlideList_CleanupDesigns.argtypes=[c_void_p]
         CallCFunction(GetDllLibPpt().MasterSlideList_CleanupDesigns,self.Ptr)
 
 
     def AppendSlide(self ,slide:'IMasterSlide')->int:
         """
-    <summary>
-        Adds a new master slide to the end of the collection.
-    </summary>
-    <returns>Index of new slide.</returns>
+        Appends a new master slide to the end of the collection.
+        
+        Args:
+            slide (IMasterSlide): Master slide to add
+            
+        Returns:
+            int: Index of the newly added slide
         """
         intPtrslide:c_void_p = slide.Ptr
 
@@ -102,7 +112,11 @@ class MasterSlideList (SpireObject) :
 
     def InsertSlide(self ,index:int,slide:'IMasterSlide'):
         """
-
+        Inserts a master slide at the specified index.
+        
+        Args:
+            index (int): Zero-based insertion position
+            slide (IMasterSlide): Master slide to insert
         """
         intPtrslide:c_void_p = slide.Ptr
 
@@ -112,10 +126,10 @@ class MasterSlideList (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 that iterates through the collection.
+        
+        Returns:
+            IEnumerator: Enumerator object
         """
         GetDllLibPpt().MasterSlideList_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().MasterSlideList_GetEnumerator.restype=c_void_p

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

@@ -8,16 +8,16 @@ import abc
 
 class OleObjectCollection (  ICollection, IEnumerable) :
     """
-    <summary>
-        A collection of OleObject controls.
-    </summary>
+    Represents a collection of OLE object controls embedded in a presentation.
+    This collection provides methods to manage and manipulate OLE objects within a slide.
     """
     @property
     def Count(self)->int:
         """
-    <summary>
-        Gets a number of objects in the collection.
-    </summary>
+        Gets the number of OLE objects contained in the collection.
+        
+        Returns:
+            int: The total number of OLE objects in the collection.
         """
         GetDllLibPpt().OleObjectCollection_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().OleObjectCollection_get_Count.restype=c_int
@@ -27,10 +27,10 @@ class OleObjectCollection (  ICollection, IEnumerable) :
 
     def Remove(self ,item:'OleObject'):
         """
-    <summary>
-        Removes an OleObject control from the collection.
-    </summary>
-    <param name="item">A control to remove.</param>
+        Removes a specific OLE object from the collection.
+        
+        Args:
+            item (OleObject): The OLE object to remove from the collection.
         """
         intPtritem:c_void_p = item.Ptr
 
@@ -40,10 +40,10 @@ class OleObjectCollection (  ICollection, IEnumerable) :
 
     def RemoveAt(self ,index:int):
         """
-    <summary>
-        Removes an OleObject control stored at specified position from the collection.
-    </summary>
-    <param name="index">Index of a control to remove.</param>
+        Removes the OLE object at the specified index location.
+        
+        Args:
+            index (int): The zero-based index of the OLE object to remove.
         """
         
         GetDllLibPpt().OleObjectCollection_RemoveAt.argtypes=[c_void_p ,c_int]
@@ -51,9 +51,7 @@ class OleObjectCollection (  ICollection, IEnumerable) :
 
     def Clear(self):
         """
-    <summary>
-        Removes all controls from the collection.
-    </summary>
+        Removes all OLE objects from the collection.
         """
         GetDllLibPpt().OleObjectCollection_Clear.argtypes=[c_void_p]
         CallCFunction(GetDllLibPpt().OleObjectCollection_Clear,self.Ptr)
@@ -61,10 +59,13 @@ class OleObjectCollection (  ICollection, IEnumerable) :
 
     def get_Item(self ,index:int)->'OleObject':
         """
-    <summary>
-        Gets a control at the specified position.
-    </summary>
-    <param name="index">Index of a control.</param>
+        Retrieves the OLE object at the specified index position.
+        
+        Args:
+            index (int): The zero-based index of the OLE object to retrieve.
+        
+        Returns:
+            OleObject: The OLE object at the specified index.
         """
         
         GetDllLibPpt().OleObjectCollection_get_Item.argtypes=[c_void_p ,c_int]
@@ -77,10 +78,10 @@ class OleObjectCollection (  ICollection, IEnumerable) :
 
     def GetEnumerator(self)->'IEnumerator':
         """
-    <summary>
-        Gets an enumerator for the entire collection.
-    </summary>
-    <returns></returns>
+        Returns an enumerator that iterates through the collection.
+        
+        Returns:
+            IEnumerator: An enumerator that can be used to iterate through the collection.
         """
         GetDllLibPpt().OleObjectCollection_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().OleObjectCollection_GetEnumerator.restype=c_void_p
@@ -88,28 +89,13 @@ class OleObjectCollection (  ICollection, IEnumerable) :
         ret = None if intPtr==None else IEnumerator(intPtr)
         return ret
 
-
-#
-#    def CopyTo(self ,array:'Array',index:int):
-#        """
-#    <summary>
-#        Copies the entire collection to the specified array.
-#    </summary>
-#    <param name="array">Target array</param>
-#    <param name="index">Index in the target array.</param>
-#        """
-#        intPtrarray:c_void_p = array.Ptr
-#
-#        GetDllLibPpt().OleObjectCollection_CopyTo.argtypes=[c_void_p ,c_void_p,c_int]
-#        CallCFunction(GetDllLibPpt().OleObjectCollection_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 synchronized (thread-safe).
+        
+        Returns:
+            bool: True if access is thread-safe; otherwise, False.
         """
         GetDllLibPpt().OleObjectCollection_get_IsSynchronized.argtypes=[c_void_p]
         GetDllLibPpt().OleObjectCollection_get_IsSynchronized.restype=c_bool
@@ -120,10 +106,10 @@ class OleObjectCollection (  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.
+        
+        Returns:
+            SpireObject: An object that can be used to synchronize access to the collection.
         """
         GetDllLibPpt().OleObjectCollection_get_SyncRoot.argtypes=[c_void_p]
         GetDllLibPpt().OleObjectCollection_get_SyncRoot.restype=c_void_p

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

@@ -8,20 +8,19 @@ import abc
 
 class OleObjectProperties (  ICollection, IEnumerable) :
     """
-    <summary>
-        A collection of OleObject properties.
-    </summary>
+    Represents a collection of properties associated with an OLE object.
+    This collection stores key-value pairs that define various attributes of an OLE object.
+    
     """
 
     def Add(self ,name:str,value:str):
         """
-    <summary>
-        Adds a property to the collection.
-    </summary>
-    <param name="name">The name of the property.</param>
-    <param name="value">The alue of the property.</param>
-        """
+        Adds a new property to the collection with the specified name and value.
         
+        Args:
+            name (str): The name of the property to add.
+            value (str): The value of the property to add.
+        """
         namePtr = StrToPtr(name)
         valuePtr = StrToPtr(value)
         GetDllLibPpt().OleObjectProperties_Add.argtypes=[c_void_p ,c_char_p,c_char_p]
@@ -30,10 +29,10 @@ class OleObjectProperties (  ICollection, IEnumerable) :
 
     def Remove(self ,name:str):
         """
-    <summary>
-        Removes a property with the specified name.
-    </summary>
-    <param name="name">The name of property to remove.</param>
+        Removes the property with the specified name from the collection.
+        
+        Args:
+            name (str): The name of the property to remove.
         """
         
         namePtr = StrToPtr(name)
@@ -44,11 +43,13 @@ class OleObjectProperties (  ICollection, IEnumerable) :
 
     def get_Item(self ,name:str)->str:
         """
-    <summary>
-        Gets or sets property.
-    </summary>
-    <param name="name">Name of property.</param>
-    <returns></returns>
+        Gets the value of the property with the specified name.
+        
+        Args:
+            name (str): The name of the property to retrieve.
+        
+        Returns:
+            str: The value associated with the specified property name.
         """
         
         namePtr = StrToPtr(name)
@@ -59,13 +60,11 @@ class OleObjectProperties (  ICollection, IEnumerable) :
 
     def Keys(self)->List[str]:
         """
-    <summary>
-        Gets or sets property.
-    </summary>
-    <param name="name">Name of property.</param>
-    <returns></returns>
-        """
+        Gets all property names in the collection.
         
+        Returns:
+            List[str]: A list of all property names in the collection.
+        """
         GetDllLibPpt().OleObjectProperties_get_Keys.argtypes=[c_void_p]
         GetDllLibPpt().OleObjectProperties_get_Keys.restype=IntPtrArray
         intPtrArray = CallCFunction(GetDllLibPpt().OleObjectProperties_get_Keys,self.Ptr)
@@ -76,7 +75,11 @@ class OleObjectProperties (  ICollection, IEnumerable) :
 
     def set_Item(self ,name:str,value:str):
         """
-
+        Sets the value of the property with the specified name.
+        
+        Args:
+            name (str): The name of the property to set.
+            value (str): The value to assign to the specified property.
         """
         
         namePtr = StrToPtr(name)
@@ -86,34 +89,19 @@ class OleObjectProperties (  ICollection, IEnumerable) :
 
     def Clear(self):
         """
-    <summary>
-        Removes all properties.
-    </summary>
+        Removes all properties from the collection.
         """
         GetDllLibPpt().OleObjectProperties_Clear.argtypes=[c_void_p]
         CallCFunction(GetDllLibPpt().OleObjectProperties_Clear,self.Ptr)
 
-#
-#    def CopyTo(self ,array:'Array',index:int):
-#        """
-#    <summary>
-#        Copies all property-value pairs to the specified array.
-#    </summary>
-#    <param name="array">The target array.</param>
-#    <param name="index">Index in the target array.</param>
-#        """
-#        intPtrarray:c_void_p = array.Ptr
-#
-#        GetDllLibPpt().OleObjectProperties_CopyTo.argtypes=[c_void_p ,c_void_p,c_int]
-#        CallCFunction(GetDllLibPpt().OleObjectProperties_CopyTo,self.Ptr, intPtrarray,index)
-
 
     @property
     def Count(self)->int:
         """
-    <summary>
-        Gets a number of properties in the collection.
-    </summary>
+        Gets the number of properties contained in the collection.
+        
+        Returns:
+            int: The total number of properties in the collection.
         """
         GetDllLibPpt().OleObjectProperties_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().OleObjectProperties_get_Count.restype=c_int
@@ -123,9 +111,10 @@ class OleObjectProperties (  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).
+        
+        Returns:
+            bool: True if access is thread-safe; otherwise, False.
         """
         GetDllLibPpt().OleObjectProperties_get_IsSynchronized.argtypes=[c_void_p]
         GetDllLibPpt().OleObjectProperties_get_IsSynchronized.restype=c_bool
@@ -136,10 +125,10 @@ class OleObjectProperties (  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.
+        
+        Returns:
+            SpireObject: An object that can be used to synchronize access to the collection.
         """
         GetDllLibPpt().OleObjectProperties_get_SyncRoot.argtypes=[c_void_p]
         GetDllLibPpt().OleObjectProperties_get_SyncRoot.restype=c_void_p
@@ -151,10 +140,10 @@ class OleObjectProperties (  ICollection, IEnumerable) :
 
     def GetEnumerator(self)->'IEnumerator':
         """
-    <summary>
-        Gets an enumerator for entire collection.
-    </summary>
-    <returns></returns>
+        Returns an enumerator that iterates through the collection.
+        
+        Returns:
+            IEnumerator: An enumerator that can be used to iterate through the collection.
         """
         GetDllLibPpt().OleObjectProperties_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().OleObjectProperties_GetEnumerator.restype=c_void_p

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

@@ -7,14 +7,18 @@ from ctypes import *
 
 class ParagraphCollection (  ParagraphList) :
     """
-    <summary>
-        Represents a collection of a paragraphs.
-    </summary>
+    Represents a collection of paragraphs in a presentation.
     """
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines whether the specified object is equal to the current object.
+        
+        Args:
+            obj: The object 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
 
@@ -23,27 +27,13 @@ class ParagraphCollection (  ParagraphList) :
         ret = CallCFunction(GetDllLibPpt().ParagraphCollection_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().ParagraphCollection_CopyTo.argtypes=[c_void_p ,c_void_p,c_int]
-#        CallCFunction(GetDllLibPpt().ParagraphCollection_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().ParagraphCollection_get_IsSynchronized.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphCollection_get_IsSynchronized.restype=c_bool
@@ -54,10 +44,10 @@ class ParagraphCollection (  ParagraphList) :
 
     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 to synchronize access to the collection
         """
         GetDllLibPpt().ParagraphCollection_get_SyncRoot.argtypes=[c_void_p]
         GetDllLibPpt().ParagraphCollection_get_SyncRoot.restype=c_void_p