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

spire/presentation/SlideList.py

@@ -9,16 +9,18 @@ import abc
 class SlideList (SpireObject) :
 
     """
-    <summary>
-        Represents a collection of a slides.
-    </summary>
+    Represents a collection of slides in a presentation.
+    
+    This class provides methods to manage slides, including adding, inserting, 
+    removing, and rearranging slides.
     """
     @property
     def Count(self)->int:
         """
-    <summary>
-        Gets the number of elements actually contained in the collection.
-    </summary>
+        Gets the number of slides in the collection.
+        
+        Returns:
+            int: The number of slides.
         """
         GetDllLibPpt().SlideList_get_Count.argtypes=[c_void_p]
         GetDllLibPpt().SlideList_get_Count.restype=c_int
@@ -27,6 +29,15 @@ class SlideList (SpireObject) :
 
      #support x[]
     def __getitem__(self, key):
+        """
+        Gets a slide by index.
+        
+        Args:
+            key (int): The zero-based index of the slide.
+            
+        Returns:
+            ISlide: The slide at the specified index.
+        """
         if key >= self.Count:
             raise StopIteration
         GetDllLibPpt().SlideList_get_Item.argtypes=[c_void_p ,c_int]
@@ -37,10 +48,13 @@ class SlideList (SpireObject) :
 
     def get_Item(self ,index:int)->'ISlide':
         """
-    <summary>
-        Gets the element at the specified index.
-            Read-only <see cref="T:Spire.Presentation.Slide" />.
-    </summary>
+        Gets the slide at the specified index.
+        
+        Args:
+            index (int): The zero-based index of the slide.
+            
+        Returns:
+            ISlide: The slide at the specified index.
         """
         
         GetDllLibPpt().SlideList_get_Item.argtypes=[c_void_p ,c_int]
@@ -54,10 +68,10 @@ class SlideList (SpireObject) :
 
     def Append(self)->ISlide:
         """
-    <summary>
-        Append new slide.
-    </summary>
-    <returns></returns>
+        Appends a new slide with default layout.
+        
+        Returns:
+            ISlide: The newly created slide.
         """
         GetDllLibPpt().SlideList_Append.argtypes=[c_void_p]
         GetDllLibPpt().SlideList_Append.restype=c_void_p
@@ -70,7 +84,13 @@ class SlideList (SpireObject) :
 
     def AppendByLayoutType(self ,templateType:SlideLayoutType):
         """
-
+        Appends a new slide with specified layout type.
+        
+        Args:
+            templateType (SlideLayoutType): The layout type for the new slide.
+            
+        Returns:
+            ISlide: The newly created slide.
         """
         enumtemplateType:c_int = templateType.value
 
@@ -85,9 +105,13 @@ class SlideList (SpireObject) :
 
     def AppendBySlide(self ,slide:ISlide)->int:
         """
-    <summary>
-        Adds a slide to the collection.
-    </summary>
+        Appends an existing slide to the collection.
+        
+        Args:
+            slide (ISlide): The slide to append.
+            
+        Returns:
+            int: The index of the added slide.
         """
         intPtrslide:c_void_p = slide.Ptr
 
@@ -100,9 +124,11 @@ class SlideList (SpireObject) :
 
     def Insert(self ,index:int,slide:ISlide):
         """
-    <summary>
-        Inserts a slide to the collection.
-    </summary>
+        Inserts a slide at the specified position.
+        
+        Args:
+            index (int): The zero-based index at which to insert.
+            slide (ISlide): The slide to insert.
         """
         intPtrslide:c_void_p = slide.Ptr
 
@@ -113,11 +139,13 @@ class SlideList (SpireObject) :
 
     def Insert(self ,index:int)->ISlide:
         """
-    <summary>
-        Insert a empty slide to collection.
-    </summary>
-    <param name="index"></param>
-    <returns></returns>
+        Inserts an empty slide at the specified position.
+        
+        Args:
+            index (int): The zero-based index at which to insert.
+            
+        Returns:
+            ISlide: The newly created slide.
         """
         
         GetDllLibPpt().SlideList_InsertI.argtypes=[c_void_p ,c_int]
@@ -131,12 +159,14 @@ class SlideList (SpireObject) :
 
     def InsertByLayoutType(self ,index:int,templateType:SlideLayoutType)->ISlide:
         """
-    <summary>
-        Insert a slide to collection.
-    </summary>
-    <param name="index"></param>
-    <param name="templateType"></param>
-    <returns></returns>
+        Inserts a slide with specified layout type at the specified position.
+        
+        Args:
+            index (int): The zero-based index at which to insert.
+            templateType (SlideLayoutType): The layout type for the new slide.
+            
+        Returns:
+            ISlide: The newly created slide.
         """
         enumtemplateType:c_int = templateType.value
 
@@ -151,7 +181,14 @@ class SlideList (SpireObject) :
 
     def Append(self ,slide:ISlide,layout:ILayout)->int:
         """
-
+        Appends a slide with a specific layout.
+        
+        Args:
+            slide (ISlide): The slide to append.
+            layout (ILayout): The layout to apply.
+            
+        Returns:
+            int: The index of the added slide.
         """
         intPtrslide:c_void_p = slide.Ptr
         intPtrlayout:c_void_p = layout.Ptr
@@ -165,7 +202,14 @@ class SlideList (SpireObject) :
 
     def Insert(self ,index:int,slide:ISlide,layout:ILayout):
         """
-
+        Inserts a slide with specified layout type at the specified position.
+        
+        Args:
+            index (int): The zero-based index at which to insert.
+            templateType (SlideLayoutType): The layout type for the new slide.
+            
+        Returns:
+            ISlide: The newly created slide.
         """
         intPtrslide:c_void_p = slide.Ptr
         intPtrlayout:c_void_p = layout.Ptr
@@ -193,9 +237,14 @@ class SlideList (SpireObject) :
 
     def InsertByMaster(self ,index:int,slide:ISlide,master:IMasterSlide):
         """
-    <summary>
-        Inserts a slide to the collection.
-    </summary>
+        Appends a slide with a specific master slide.
+        
+        Args:
+            slide (ISlide): The slide to append.
+            master (IMasterSlide): The master slide to apply.
+            
+        Returns:
+            int: The index of the added slide.
         """
         intPtrslide:c_void_p = slide.Ptr
         intPtrmaster:c_void_p = master.Ptr
@@ -206,10 +255,10 @@ class SlideList (SpireObject) :
 
     def Remove(self ,value:'ISlide'):
         """
-    <summary>
-        Removes the first occurrence of a specific object from the collection.
-    </summary>
-    <param name="value">The slide to remove from the collection.</param>
+        Removes the first occurrence of a specific slide.
+        
+        Args:
+            value (ISlide): The slide to remove.
         """
         intPtrvalue:c_void_p = value.Ptr
 
@@ -219,10 +268,10 @@ class SlideList (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 slide at the specified index.
+        
+        Args:
+            index (int): The zero-based index of the slide to remove.
         """
         
         GetDllLibPpt().SlideList_RemoveAt.argtypes=[c_void_p ,c_int]
@@ -231,10 +280,10 @@ class SlideList (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 to iterate through the collection.
+        
+        Returns:
+            IEnumerator: An enumerator for the collection.
         """
         GetDllLibPpt().SlideList_GetEnumerator.argtypes=[c_void_p]
         GetDllLibPpt().SlideList_GetEnumerator.restype=c_void_p
@@ -276,11 +325,11 @@ class SlideList (SpireObject) :
 
     def Move(self ,newIndex:int,OldIndex:int):
         """
-    <summary>
-        Moves slide from the collection to the specified position.
-    </summary>
-    <param name="newIndex">Target index.</param>
-    <param name="OldIndex">move from.</param>
+        Moves a slide from one position to another.
+        
+        Args:
+            newIndex (int): The target index position.
+            OldIndex (int): The current index position of the slide.
         """
         
         GetDllLibPpt().SlideList_Move.argtypes=[c_void_p ,c_int,c_int]
@@ -289,7 +338,13 @@ class SlideList (SpireObject) :
 
     def IndexOf(self ,slide:'ISlide')->int:
         """
-
+        Gets the index of a specific slide.
+        
+        Args:
+            slide (ISlide): The slide to locate.
+            
+        Returns:
+            int: The zero-based index of the slide, or -1 if not found.
         """
         intPtrslide:c_void_p = slide.Ptr
 

spire/presentation/SlideOrienation.py

@@ -8,9 +8,11 @@ import abc
 
 class SlideOrienation(Enum):
     """
-    <summary>
-        Represents the slide orientation.
-    </summary>
+    Represents the slide orientation.
+
+    Attributes:
+        Landscape: Landscape orientation (value = 0)
+        Portrait: Portrait orientation (value = 1)
     """
     Landscape = 0
     Portrait = 1

spire/presentation/SlidePicture.py

@@ -8,13 +8,16 @@ import abc
 
 class SlidePicture (  ShapeNode, IEmbedImage) :
     """
-
+    Represents a picture in a slide.
     """
     @property
 
     def ShapeLocking(self)->'SlidePictureLocking':
         """
+        Get the shape locking settings.
 
+        Returns:
+            SlidePictureLocking: The locking settings for the picture.
         """
         GetDllLibPpt().SlidePicture_get_ShapeLocking.argtypes=[c_void_p]
         GetDllLibPpt().SlidePicture_get_ShapeLocking.restype=c_void_p
@@ -27,7 +30,10 @@ class SlidePicture (  ShapeNode, IEmbedImage) :
 
     def ShapeType(self)->'ShapeType':
         """
+        Get the type of the shape.
 
+        Returns:
+            ShapeType: The current shape type.
         """
         GetDllLibPpt().SlidePicture_get_ShapeType.argtypes=[c_void_p]
         GetDllLibPpt().SlidePicture_get_ShapeType.restype=c_int
@@ -43,12 +49,10 @@ class SlidePicture (  ShapeNode, IEmbedImage) :
     @property
     def IsCropped(self)->bool:
         """
-    <summary>
-        Determines if the picture is cropped.
-    </summary>
-    <returns>
-            If the picture is cropped,the value is "true",otherwise the value is "false"
-            ,the default value is "false".</returns>
+        Determine if the picture is cropped.
+
+        Returns:
+            bool: True if the picture is cropped, False otherwise.
         """
         GetDllLibPpt().SlidePicture_get_IsCropped.argtypes=[c_void_p]
         GetDllLibPpt().SlidePicture_get_IsCropped.restype=c_bool
@@ -59,7 +63,10 @@ class SlidePicture (  ShapeNode, IEmbedImage) :
 
     def PictureFill(self)->'PictureFillFormat':
         """
+        Get the picture fill format.
 
+        Returns:
+            PictureFillFormat: The fill format of the picture.
         """
         GetDllLibPpt().SlidePicture_get_PictureFill.argtypes=[c_void_p]
         GetDllLibPpt().SlidePicture_get_PictureFill.restype=c_void_p
@@ -69,24 +76,20 @@ class SlidePicture (  ShapeNode, IEmbedImage) :
 
 
     def PictureAdjust(self):
-        """
-    <summary>
-        Adjust the picture of slide
-    </summary>
-        """
+        """Adjust the picture of the slide."""
         GetDllLibPpt().SlidePicture_PictureAdjust.argtypes=[c_void_p]
         CallCFunction(GetDllLibPpt().SlidePicture_PictureAdjust,self.Ptr)
 
 
     def Crop(self ,x:float,y:float,width:float,height:float):
         """
-    <summary>
-        Crop the picture of slide
-    </summary>
-    <param name="x"> x coordinate </param>
-    <param name="y"> y coordinate </param>
-    <param name="width"> cropped width </param>
-    <param name="height"> cropped height </param>
+        Crop the picture of the slide.
+
+        Args:
+            x: The x-coordinate for cropping.
+            y: The y-coordinate for cropping.
+            width: The width of the cropped area.
+            height: The height of the cropped area.
         """
         
         GetDllLibPpt().SlidePicture_Crop.argtypes=[c_void_p ,c_float,c_float,c_float,c_float]

spire/presentation/SlidePictureLocking.py

@@ -8,16 +8,18 @@ import abc
 
 class SlidePictureLocking (  SimpleShapeBaseLocking) :
     """
-    <summary>
-        Indicates which operations are disabled on the parent PictureFrame.
-    </summary>
+    Indicates which operations are disabled on the parent PictureFrame.
+
+    Properties:
+        CropProtection: Indicates whether image cropping is forbidden.
     """
     @property
     def CropProtection(self)->bool:
         """
-    <summary>
-        Indicates whether an image cropping is forbidden.
-    </summary>
+        Get whether image cropping is forbidden.
+
+        Returns:
+            bool: True if cropping is forbidden, False otherwise.
         """
         GetDllLibPpt().SlidePictureLocking_get_CropProtection.argtypes=[c_void_p]
         GetDllLibPpt().SlidePictureLocking_get_CropProtection.restype=c_bool
@@ -26,6 +28,12 @@ class SlidePictureLocking (  SimpleShapeBaseLocking) :
 
     @CropProtection.setter
     def CropProtection(self, value:bool):
+        """
+        Set whether image cropping is forbidden.
+
+        Args:
+            value: True to forbid cropping, False to allow it.
+        """
         GetDllLibPpt().SlidePictureLocking_set_CropProtection.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibPpt().SlidePictureLocking_set_CropProtection,self.Ptr, value)
 

spire/presentation/SlideShowType.py

@@ -8,7 +8,12 @@ import abc
 
 class SlideShowType(Enum):
     """
-
+    Specifies the presentation display mode for slide shows.
+    
+    Attributes:
+        Present: Standard presentation mode (value: 0)
+        Browse: Browsing mode (value: 1)
+        Kiosk: Self-running kiosk mode (value: 2)
     """
     Present = 0
     Browse = 1

spire/presentation/SlideSize.py

@@ -8,18 +8,19 @@ import abc
 
 class SlideSize (SpireObject) :
     """
-    <summary>
-        Represents a size of slide.
-    </summary>
+    Manages dimensions and orientation of presentation slides.
+
+    This class handles both the physical size and display characteristics
+    of slides in various measurement units and orientations.
     """
     @property
 
     def Size(self)->'SizeF':
         """
-    <summary>
-        Gets or sets the size in points.
-            Read/Write <see cref="T:System.Drawing.SizeF" />.
-    </summary>
+        Gets or sets slide dimensions in points.
+
+        Returns:
+            SizeF: Current size in points.
         """
         GetDllLibPpt().SlideSize_get_Size.argtypes=[c_void_p]
         GetDllLibPpt().SlideSize_get_Size.restype=c_void_p
@@ -30,6 +31,12 @@ class SlideSize (SpireObject) :
 
     @Size.setter
     def Size(self, value:'SizeF'):
+        """
+        Sets slide dimensions in points.
+
+        Args:
+            value (SizeF): New size in points.
+        """
         GetDllLibPpt().SlideSize_set_Size.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibPpt().SlideSize_set_Size,self.Ptr, value.Ptr)
 
@@ -37,10 +44,10 @@ class SlideSize (SpireObject) :
 
     def SizeOfPx(self)->'SizeF':
         """
-    <summary>
-        Gets or sets the size in pixel.
-            Read/Write <see cref="T:System.Drawing.SizeF" />.
-    </summary>
+        Gets or sets slide dimensions in pixels.
+
+        Returns:
+            SizeF: Current size in pixels.
         """
         GetDllLibPpt().SlideSize_get_SizeOfPx.argtypes=[c_void_p]
         GetDllLibPpt().SlideSize_get_SizeOfPx.restype=c_void_p
@@ -51,6 +58,12 @@ class SlideSize (SpireObject) :
 
     @SizeOfPx.setter
     def SizeOfPx(self, value:'SizeF'):
+        """
+        Sets slide dimensions in pixels.
+
+        Args:
+            value (SizeF): New size in pixels.
+        """
         GetDllLibPpt().SlideSize_set_SizeOfPx.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibPpt().SlideSize_set_SizeOfPx,self.Ptr, value.Ptr)
 
@@ -58,10 +71,10 @@ class SlideSize (SpireObject) :
 
     def Type(self)->'SlideSizeType':
         """
-    <summary>
-        Gets or sets the type of slide size.
-            Read/Write <see cref="T:Spire.Presentation.SlideSizeType" />.
-    </summary>
+        Gets or sets the size classification type.
+
+        Returns:
+            SlideSizeType: Standard size category.
         """
         GetDllLibPpt().SlideSize_get_Type.argtypes=[c_void_p]
         GetDllLibPpt().SlideSize_get_Type.restype=c_int
@@ -71,6 +84,12 @@ class SlideSize (SpireObject) :
 
     @Type.setter
     def Type(self, value:'SlideSizeType'):
+        """
+        Sets the size classification type.
+
+        Args:
+            value (SlideSizeType): New size category.
+        """
         GetDllLibPpt().SlideSize_set_Type.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().SlideSize_set_Type,self.Ptr, value.value)
 
@@ -78,10 +97,10 @@ class SlideSize (SpireObject) :
 
     def Orientation(self)->'SlideOrienation':
         """
-    <summary>
         Gets or sets the slide orientation.
-            Read/Write <see cref="T:Spire.Presentation.SlideOrienation" />.
-    </summary>
+
+        Returns:
+            SlideOrienation: Current orientation (Landscape/Portrait).
         """
         GetDllLibPpt().SlideSize_get_Orientation.argtypes=[c_void_p]
         GetDllLibPpt().SlideSize_get_Orientation.restype=c_int
@@ -91,6 +110,12 @@ class SlideSize (SpireObject) :
 
     @Orientation.setter
     def Orientation(self, value:'SlideOrienation'):
+        """
+        Sets the slide orientation.
+
+        Args:
+            value (SlideOrienation): New orientation to apply.
+        """
         GetDllLibPpt().SlideSize_set_Orientation.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().SlideSize_set_Orientation,self.Ptr, value.value)
 

spire/presentation/SlideSizeType.py

@@ -8,9 +8,26 @@ import abc
 
 class SlideSizeType(Enum):
     """
-    <summary>
-        Represents the slide size preset.
-    </summary>
+    Enumerates different standard slide size presets used in presentations.
+    
+    Attributes:
+        none: No predefined size
+        Screen4x3: Standard screen aspect ratio (4:3)
+        Letter: US Letter paper size (8.5 x 11 inches)
+        A4: ISO A4 paper size (210 x 297 mm)
+        Film35mm: Standard 35mm film frame size
+        Overhead: Overhead projector slide size
+        Banner: Banner/poster format
+        Custom: Custom-sized slides
+        Ledger: Ledger/tabloid paper size (11 x 17 inches)
+        A3: ISO A3 paper size (297 x 420 mm)
+        B4ISO: ISO B4 paper size (250 x 353 mm)
+        B5ISO: ISO B5 paper size (176 x 250 mm)
+        B4JIS: JIS B4 paper size (257 x 364 mm)
+        B5JIS: JIS B5 paper size (182 x 257 mm)
+        HagakiCard: Japanese postcard size (100 x 148 mm)
+        Screen16x9: Widescreen aspect ratio (16:9)
+        Screen16x10: Alternate widescreen aspect ratio (16:10)
     """
     none = -1
     Screen4x3 = 0

spire/presentation/SystemColorType.py

@@ -8,9 +8,9 @@ import abc
 
 class SystemColorType(Enum):
     """
-    <summary>
-        Represents predefined system colors.
-    </summary>
+    Represents predefined system colors.
+    
+    Enumerates various system-defined color types used in UI elements.
     """
     none = -1
     ScrollBar = 0

spire/presentation/TabAlignmentType.py

@@ -8,9 +8,9 @@ import abc
 
 class TabAlignmentType(Enum):
     """
-    <summary>
-        Represents the tab alignment.
-    </summary>
+    Represents text tab alignment options.
+    
+    Defines how text aligns relative to tab stops in documents.
     """
     none = -1
     Left = 0

spire/presentation/TabData.py

@@ -8,18 +8,15 @@ import abc
 
 class TabData (SpireObject) :
     """
-    <summary>
-        Represents a text's tabulation stop.
-    </summary>
+    Represents a text's tabulation stop.
     """
     @property
     def Position(self)->float:
         """
-    <summary>
-        Gets or sets position of a tab.
-            Assigning this property can change tab's index in collection and invalidate Enumerator.
-            Read/write <see cref="T:System.Double" />.
-    </summary>
+        Gets or sets the tab position.
+        
+        Returns:
+            float: The position of the tab.
         """
         GetDllLibPpt().TabData_get_Position.argtypes=[c_void_p]
         GetDllLibPpt().TabData_get_Position.restype=c_double
@@ -30,10 +27,10 @@ class TabData (SpireObject) :
 
     def Alignment(self)->'TabAlignmentType':
         """
-    <summary>
-        Gets or sets align style of a tab.
-            Read/write <see cref="T:Spire.Presentation.Converter.Entity.TabAlignment" />.
-    </summary>
+        Gets or sets the alignment style of the tab.
+        
+        Returns:
+            TabAlignmentType: The alignment type of the tab.
         """
         GetDllLibPpt().TabData_get_Alignment.argtypes=[c_void_p]
         GetDllLibPpt().TabData_get_Alignment.restype=c_int
@@ -44,13 +41,16 @@ class TabData (SpireObject) :
 
     def CompareTo(self ,obj:'SpireObject')->int:
         """
-    <summary>
         Compares the current instance with another object of the same type.
-    </summary>
-    <param name="obj">An object to compare with this instance.</param>
-    <returns>A 32-bit integer that indicates the relative order of the comparands.
-            The return value has these meanings:
-            <UL><LI> &lt; 0 - This instance is less than obj.</LI><LI> = 0 - This instance is equal to obj.</LI><LI> &gt; 0 - This instance is greater than obj.</LI></UL></returns>
+        
+        Args:
+            obj (SpireObject): An object to compare with this instance.
+            
+        Returns:
+            int: A 32-bit integer that indicates the relative order of the comparands:
+                - < 0 : This instance is less than obj
+                - = 0 : This instance is equal to obj
+                - > 0 : This instance is greater than obj
         """
         intPtrobj:c_void_p = obj.Ptr