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

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

@@ -8,9 +8,7 @@ import abc
 
 class SlideCollection (  SlideList) :
     """
-    <summary>
-        Represents a collection of a slides.
-    </summary>
+    Represents a collection of slides.
     """
 #
 #    def CopyTo(self ,array:'Array',index:int):
@@ -30,9 +28,10 @@ class SlideCollection (  SlideList) :
     @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().SlideCollection_get_IsSynchronized.argtypes=[c_void_p]
         GetDllLibPpt().SlideCollection_get_IsSynchronized.restype=c_bool
@@ -43,10 +42,10 @@ class SlideCollection (  SlideList) :
 
     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().SlideCollection_get_SyncRoot.argtypes=[c_void_p]
         GetDllLibPpt().SlideCollection_get_SyncRoot.restype=c_void_p

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

@@ -8,17 +8,16 @@ import abc
 
 class SlideColorSchemeCollection (  ICollection, IEnumerable) :
     """
-    <summary>
-        Represents a collection of additional color schemes.
-    </summary>
+    Represents a collection of additional color schemes.
+    
     """
     @property
     def Count(self)->int:
         """
-    <summary>
-        Gets a number of elements int the collection.
-            Readonly <see cref="T:System.Int32" />.
-    </summary>
+        Gets the number of elements in the collection.
+
+        Returns:
+            int: The count of elements.
         """
         GetDllLibPpt().SlideColorSchemeCollection_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().SlideColorSchemeCollection_get_Count.restype=c_int
@@ -28,10 +27,13 @@ class SlideColorSchemeCollection (  ICollection, IEnumerable) :
 
     def get_Item(self ,index:int)->'SlideColorScheme':
         """
-    <summary>
-        Gets an color scheme by index.
-            Readonly <see cref="T:Spire.Presentation.SlideColorScheme" />.
-    </summary>
+        Gets a color scheme by index.
+
+        Args:
+            index (int): The zero-based index of the scheme.
+
+        Returns:
+            SlideColorScheme: The color scheme at the specified index.
         """
         
         GetDllLibPpt().SlideColorSchemeCollection_get_Item.argtypes=[c_void_p ,c_int]
@@ -44,7 +46,13 @@ class SlideColorSchemeCollection (  ICollection, IEnumerable) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
+        Checks equality with another object.
+
+        Args:
+            obj (SpireObject): The object to compare.
 
+        Returns:
+            bool: True if objects are equal, False otherwise.
         """
         intPtrobj:c_void_p = obj.Ptr
 
@@ -56,10 +64,10 @@ class SlideColorSchemeCollection (  ICollection, IEnumerable) :
 
     def GetEnumerator(self)->'IEnumerator':
         """
-    <summary>
-        Gets an enumerator, which can be used to iterate through the collection.
-    </summary>
-    <returns>Enumeraton <see cref="T:System.Collections.IEnumerator" />.</returns>
+        Gets an enumerator to iterate through the collection.
+
+        Returns:
+            IEnumerator: An enumerator for the collection.
         """
         GetDllLibPpt().SlideColorSchemeCollection_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().SlideColorSchemeCollection_GetEnumerator.restype=c_void_p
@@ -86,10 +94,10 @@ class SlideColorSchemeCollection (  ICollection, IEnumerable) :
     @property
     def IsSynchronized(self)->bool:
         """
-    <summary>
-        Gets a value indicating whether access to the ArrayList is synchronized (thread safe).
-            Readonly <see cref="T:System.Boolean" />.
-    </summary>
+        Indicates whether access to the collection is thread-safe.
+
+        Returns:
+            bool: True if thread-safe, False otherwise.
         """
         GetDllLibPpt().SlideColorSchemeCollection_get_IsSynchronized.argtypes=[c_void_p]
         GetDllLibPpt().SlideColorSchemeCollection_get_IsSynchronized.restype=c_bool
@@ -100,10 +108,10 @@ class SlideColorSchemeCollection (  ICollection, IEnumerable) :
 
     def SyncRoot(self)->'SpireObject':
         """
-    <summary>
-        Gets an object that can be used to synchronize access to the collection.
-            Readonly <see cref="T:System.Object" />.
-    </summary>
+        Gets an object to synchronize access to the collection.
+
+        Returns:
+            SpireObject: The synchronization root object.
         """
         GetDllLibPpt().SlideColorSchemeCollection_get_SyncRoot.argtypes=[c_void_p]
         GetDllLibPpt().SlideColorSchemeCollection_get_SyncRoot.restype=c_void_p

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

@@ -8,9 +8,8 @@ import abc
 
 class TabStopCollection (  TabStopList, ICollection) :
     """
-    <summary>
-        Represents a collection of tabs.
-    </summary>
+    Represents a collection of tabs.
+    
     """
 #
 #    def CopyTo(self ,array:'Array',index:int):
@@ -30,9 +29,10 @@ class TabStopCollection (  TabStopList, 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; otherwise, False.
         """
         GetDllLibPpt().TabStopCollection_get_IsSynchronized.argtypes=[c_void_p]
         GetDllLibPpt().TabStopCollection_get_IsSynchronized.restype=c_bool
@@ -43,10 +43,10 @@ class TabStopCollection (  TabStopList, ICollection) :
 
     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().TabStopCollection_get_SyncRoot.argtypes=[c_void_p]
         GetDllLibPpt().TabStopCollection_get_SyncRoot.restype=c_void_p

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

@@ -8,17 +8,18 @@ import abc
 
 class TabStopList (SpireObject) :
     """
-    <summary>
-        Represents a collection of tabs.
-    </summary>
+    Represents a collection of tabs.
+
+    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.
-            Read-only <see cref="T:System.Int32" />.
-    </summary>
+        Gets the number of properties contained in the collection.
+        
+        Returns:
+            int: The total number of properties in the collection.
         """
         GetDllLibPpt().TabStopList_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().TabStopList_get_Count.restype=c_int
@@ -28,10 +29,13 @@ class TabStopList (SpireObject) :
 
     def get_Item(self ,index:int)->'TabStop':
         """
-    <summary>
         Gets the element at the specified index.
-            Read-only <see cref="T:Spire.Presentation.TabStop" />.
-    </summary>
+
+        Args:
+            index: The zero-based index of the element to retrieve
+
+        Returns:
+            TabStop: The element at the specified index
         """
         
         GetDllLibPpt().TabStopList_get_Item.argtypes=[c_void_p ,c_int]
@@ -44,11 +48,13 @@ class TabStopList (SpireObject) :
 
     def Append(self ,value:'TabStop')->int:
         """
-    <summary>
         Adds a Tab to the collection.
-    </summary>
-    <param name="value">The Tab object to be added at the end of the collection.</param>
-    <returns>The index at which the tab was added.</returns>
+
+        Args:
+            value: The Tab object to be added at the end of the collection
+
+        Returns:
+            int: The index at which the tab was added
         """
         intPtrvalue:c_void_p = value.Ptr
 
@@ -58,21 +64,17 @@ class TabStopList (SpireObject) :
         return ret
 
     def Clear(self):
-        """
-    <summary>
-        Removes all elements from the collection.
-    </summary>
-        """
+        """Removes all elements from the collection."""
         GetDllLibPpt().TabStopList_Clear.argtypes=[c_void_p]
         CallCFunction(GetDllLibPpt().TabStopList_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 the element at the specified index.
+
+        Args:
+            index: The zero-based index of the element to remove
         """
         
         GetDllLibPpt().TabStopList_RemoveAt.argtypes=[c_void_p ,c_int]
@@ -81,12 +83,13 @@ class TabStopList (SpireObject) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-    <summary>
         Indicates whether two Tabs instances are equal.
-    </summary>
-    <param name="obj">The Tabs to compare with the current Tabs.</param>
-    <returns>
-  <b>true</b> if the specified Tabs is equal to the current Tabs; otherwise, <b>false</b>.</returns>
+
+        Args:
+            obj: The Tabs to compare with the current Tabs
+
+        Returns:
+            bool: True if the specified Tabs is equal to the current Tabs, False otherwise
         """
         intPtrobj:c_void_p = obj.Ptr
 
@@ -97,9 +100,10 @@ class TabStopList (SpireObject) :
 
     def GetHashCode(self)->int:
         """
-    <summary>
         Gets hash code for this object.
-    </summary>
+
+        Returns:
+            int: The hash code for this object
         """
         GetDllLibPpt().TabStopList_GetHashCode.argtypes=[c_void_p]
         GetDllLibPpt().TabStopList_GetHashCode.restype=c_int
@@ -109,10 +113,10 @@ class TabStopList (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>
+
+        Returns:
+            IEnumerator: An enumerator for the entire collection
         """
         GetDllLibPpt().TabStopList_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().TabStopList_GetEnumerator.restype=c_void_p

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

@@ -8,31 +8,17 @@ import abc
 
 class TagCollection (TagList) :
     """
-    <summary>
-        Represents the collection of tags (user defined pairs of strings)
-    </summary>
+    Represents the collection of tags (user defined pairs of strings)
+   
     """
-#
-#    def CopyTo(self ,array:'Array',index:int):
-#        """
-#    <summary>
-#        Copies all elements from the collection into the specified array.
-#    </summary>
-#    <param name="array">Array to fill.</param>
-#    <param name="index">Starting position in target array.</param>
-#        """
-#        intPtrarray:c_void_p = array.Ptr
-#
-#        GetDllLibPpt().TagCollection_CopyTo.argtypes=[c_void_p ,c_void_p,c_int]
-#        CallCFunction(GetDllLibPpt().TagCollection_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 synchronized, False otherwise
         """
         GetDllLibPpt().TagCollection_get_IsSynchronized.argtypes=[c_void_p]
         GetDllLibPpt().TagCollection_get_IsSynchronized.restype=c_bool
@@ -43,10 +29,10 @@ class TagCollection (TagList) :
 
     def SyncRoot(self)->'SpireObject':
         """
-    <summary>
         Gets a synchronization root.
-            Readonly <see cref="T:System.Object" />.
-    </summary>
+
+        Returns:
+            SpireObject: An object that can be used to synchronize access
         """
         GetDllLibPpt().TagCollection_get_SyncRoot.argtypes=[c_void_p]
         GetDllLibPpt().TagCollection_get_SyncRoot.restype=c_void_p
@@ -58,9 +44,10 @@ class TagCollection (TagList) :
 
     def GetEnumerator(self)->'IEnumerator':
         """
-    <summary>
         Gets an enumerator for the entire collection.
-    </summary>
+
+        Returns:
+            IEnumerator: An enumerator for the entire collection
         """
         GetDllLibPpt().TagCollection_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().TagCollection_GetEnumerator.restype=c_void_p

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

@@ -8,16 +8,16 @@ import abc
 
 class TagList (SpireObject) :
     """
-    <summary>
-        Represents the collection of tags
-    </summary>
+    Represents the collection of tags
+    
     """
     @property
     def Count(self)->int:
         """
-    <summary>
-        Gets a number of tags in the collectoin.
-    </summary>
+        Gets the number of tags in the collection.
+
+        Returns:
+            int: The number of tags in the collection
         """
         GetDllLibPpt().TagList_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().TagList_get_Count.restype=c_int
@@ -27,14 +27,15 @@ class TagList (SpireObject) :
 
     def Append(self ,name:str,value:str)->int:
         """
-    <summary>
         Adds a new tag to collection.
-    </summary>
-    <param name="name">The name of the tag.</param>
-    <param name="value">The value of the tag.</param>
-    <returns>The index of the added tag.</returns>
+
+        Args:
+            name: The name of the tag
+            value: The value of the tag
+
+        Returns:
+            int: The index of the added tag
         """
-        
         namePtr = StrToPtr(name)
         valuePtr = StrToPtr(value)
         GetDllLibPpt().TagList_Append.argtypes=[c_void_p ,c_char_p,c_char_p]
@@ -45,12 +46,11 @@ class TagList (SpireObject) :
 
     def Remove(self ,name:str):
         """
-    <summary>
         Removes the tag with a specified name from the collection.
-    </summary>
-    <param name="name">The name of tag to remove.</param>
+
+        Args:
+            name: The name of tag to remove
         """
-        
         namePtr = StrToPtr(name)
         GetDllLibPpt().TagList_Remove.argtypes=[c_void_p ,c_char_p]
         CallCFunction(GetDllLibPpt().TagList_Remove,self.Ptr,namePtr)
@@ -58,13 +58,14 @@ class TagList (SpireObject) :
 
     def IndexOfKey(self ,name:str)->int:
         """
-    <summary>
         Gets the zero-based index of the specified key in the collection.
-    </summary>
-    <param name="name">The name to locate in the collection.</param>
-    <returns>The zero-based index of key, if key is found in the collection; otherwise, -1.</returns>
+
+        Args:
+            name: The name to locate in the collection
+
+        Returns:
+            int: The zero-based index if found, otherwise -1
         """
-        
         namePtr = StrToPtr(name)
         GetDllLibPpt().TagList_IndexOfKey.argtypes=[c_void_p ,c_char_p]
         GetDllLibPpt().TagList_IndexOfKey.restype=c_int
@@ -74,11 +75,13 @@ class TagList (SpireObject) :
 
     def Contains(self ,name:str)->bool:
         """
-    <summary>
         Indicates whether the collection contains a specific name.
-    </summary>
-    <param name="name">The key to locate.</param>
-    <returns>True if the collection contains an tag with the specified key; otherwise, false.</returns>
+
+        Args:
+            name: The key to locate
+
+        Returns:
+            bool: True if the key exists, False otherwise
         """
         
         namePtr = StrToPtr(name)
@@ -90,34 +93,30 @@ class TagList (SpireObject) :
 
     def RemoveAt(self ,index:int):
         """
-    <summary>
         Removes the tag at the specified index.
-    </summary>
-    <param name="index">The zero-based index of the tag to remove.</param>
+
+        Args:
+            index: The zero-based index of the tag to remove
         """
-        
         GetDllLibPpt().TagList_RemoveAt.argtypes=[c_void_p ,c_int]
         CallCFunction(GetDllLibPpt().TagList_RemoveAt,self.Ptr, index)
 
     def Clear(self):
-        """
-    <summary>
-        Removes all tags from the collection.
-    </summary>
-        """
+        """Removes all tags from the collection."""
         GetDllLibPpt().TagList_Clear.argtypes=[c_void_p]
         CallCFunction(GetDllLibPpt().TagList_Clear,self.Ptr)
 
 
     def GetByInd(self ,index:int)->str:
         """
-    <summary>
         Gets value of a tag at the specified index.
-    </summary>
-    <param name="index">Index of a tag to return.</param>
-    <returns>Value of a tag.</returns>
+
+        Args:
+            index: Index of the tag to retrieve
+
+        Returns:
+            str: Value of the specified tag
         """
-        
         GetDllLibPpt().TagList_GetByInd.argtypes=[c_void_p ,c_int]
         GetDllLibPpt().TagList_GetByInd.restype=c_void_p
         ret = PtrToStr(CallCFunction(GetDllLibPpt().TagList_GetByInd,self.Ptr, index))
@@ -127,13 +126,14 @@ class TagList (SpireObject) :
 
     def GetKey(self ,index:int)->str:
         """
-    <summary>
         Gets key of a tag at the specified index.
-    </summary>
-    <param name="index">Index of a tag to return.</param>
-    <returns>Key of a tag.</returns>
+
+        Args:
+            index: Index of the tag to retrieve
+
+        Returns:
+            str: Key of the specified tag
         """
-        
         GetDllLibPpt().TagList_GetKey.argtypes=[c_void_p ,c_int]
         GetDllLibPpt().TagList_GetKey.restype=c_void_p
         ret = PtrToStr(CallCFunction(GetDllLibPpt().TagList_GetKey,self.Ptr, index))
@@ -143,13 +143,14 @@ class TagList (SpireObject) :
 
     def get_Item(self ,name:str)->str:
         """
-    <summary>
-        Gets or sets a key and a value pair of a tag.
-    </summary>
-    <param name="name">Key of a tag.</param>
-    <returns>Value of a tag.</returns>
+        Gets the value associated with the specified tag name.
+
+        Args:
+            name: Key of the tag
+
+        Returns:
+            str: Value associated with the tag
         """
-        
         namePtr = StrToPtr(name)
         GetDllLibPpt().TagList_get_Item.argtypes=[c_void_p ,c_char_p]
         GetDllLibPpt().TagList_get_Item.restype=c_void_p
@@ -160,9 +161,12 @@ class TagList (SpireObject) :
 
     def set_Item(self ,name:str,value:str):
         """
+        Sets the value associated with the specified tag name.
 
+        Args:
+            name: Key of the tag
+            value: New value for the tag
         """
-        
         namePtr = StrToPtr(name)
         valuePtr = StrToPtr(value)
         GetDllLibPpt().TagList_set_Item.argtypes=[c_void_p ,c_char_p,c_char_p]

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

@@ -8,31 +8,17 @@ import abc
 
 class TextLineFormatCollection (  TextLineFormatList, ICollection) :
     """
-    <summary>
-        Represents a collection of LineFormat objects.
-    </summary>
+    Represents a collection of LineFormat objects.
+  
     """
-#
-#    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().TextLineFormatCollection_CopyTo.argtypes=[c_void_p ,c_void_p,c_int]
-#        CallCFunction(GetDllLibPpt().TextLineFormatCollection_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().TextLineFormatCollection_get_IsSynchronized.argtypes=[c_void_p]
         GetDllLibPpt().TextLineFormatCollection_get_IsSynchronized.restype=c_bool
@@ -43,10 +29,10 @@ class TextLineFormatCollection (  TextLineFormatList, ICollection) :
 
     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().TextLineFormatCollection_get_SyncRoot.argtypes=[c_void_p]
         GetDllLibPpt().TextLineFormatCollection_get_SyncRoot.restype=c_void_p