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

spire/presentation/ISlide.py

@@ -7,15 +7,17 @@ from ctypes import *
 
 class ISlide (SpireObject) :
     """
-
+    Represents a slide in a presentation.
+    Provides properties and methods for slide content, layout, and rendering.
+    
     """
     @property
 
     def Theme(self)->'Theme':
         """
-    <summary>
-        Gets the theme object.
-    </summary>
+        Gets the theme associated with the slide.
+        Returns:
+            Theme: Slide theme object.
         """
         GetDllLibPpt().ISlide_get_Theme.argtypes=[c_void_p]
         GetDllLibPpt().ISlide_get_Theme.restype=c_void_p
@@ -27,10 +29,9 @@ class ISlide (SpireObject) :
     @property
     def SlideNumber(self)->int:
         """
-    <summary>
-        Gets a number of slide.
-            Index of slide in <see cref="P:Spire.Presentation.PresentationPptx.Slides" /> collection is always equal to SlideNumber - 1.
-    </summary>
+        Gets or sets the slide number in the presentation.
+        Returns:
+            int: Current slide number.
         """
         GetDllLibPpt().ISlide_get_SlideNumber.argtypes=[c_void_p]
         GetDllLibPpt().ISlide_get_SlideNumber.restype=c_int
@@ -39,16 +40,20 @@ class ISlide (SpireObject) :
 
     @SlideNumber.setter
     def SlideNumber(self, value:int):
+        """
+        Sets the slide number in the presentation.
+        Parameters:
+            value: New slide number.
+        """
         GetDllLibPpt().ISlide_set_SlideNumber.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().ISlide_set_SlideNumber,self.Ptr, value)
 
     @property
     def Hidden(self)->bool:
         """
-    <summary>
-        Indicates whether the specified slide is hidden during a slide show.
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+        Indicates whether the slide is hidden during slide shows.
+        Returns:
+            bool: True if hidden, False otherwise.
         """
         GetDllLibPpt().ISlide_get_Hidden.argtypes=[c_void_p]
         GetDllLibPpt().ISlide_get_Hidden.restype=c_bool
@@ -57,6 +62,11 @@ class ISlide (SpireObject) :
 
     @Hidden.setter
     def Hidden(self, value:bool):
+        """
+        Sets whether the slide is hidden during slide shows.
+        Parameters:
+            value: True to hide, False to show.
+        """
         GetDllLibPpt().ISlide_set_Hidden.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibPpt().ISlide_set_Hidden,self.Ptr, value)
 
@@ -64,10 +74,10 @@ class ISlide (SpireObject) :
 
     def NotesSlide(self)->'NotesSlide':
         """
-    <summary>
-        Gets the notes slide for the current slide.
-            Read-only <see cref="P:Spire.Presentation.ISlide.NotesSlide" />.
-    </summary>
+        Gets the notes slide.
+        
+        Returns:
+            NotesSlide: Read-only notes slide.
         """
         GetDllLibPpt().ISlide_get_NotesSlide.argtypes=[c_void_p]
         GetDllLibPpt().ISlide_get_NotesSlide.restype=c_void_p
@@ -80,9 +90,10 @@ class ISlide (SpireObject) :
 
     def Comments(self)->List['Comment']:
         """
-    <summary>
         Gets all author comments.
-    </summary>
+        
+        Returns:
+            List[Comment]: Collection of comments.
         """
         GetDllLibPpt().ISlide_get_Comments.argtypes=[c_void_p]
         GetDllLibPpt().ISlide_get_Comments.restype=IntPtrArray
@@ -95,10 +106,10 @@ class ISlide (SpireObject) :
 
     def Shapes(self)->'ShapeCollection':
         """
-    <summary>
-        Gets the shapes of a slide.
-            Read-only <see cref="T:Spire.Presentation.ShapeCollection" />.
-    </summary>
+        Gets all shapes on the slide.
+        
+        Returns:
+            ShapeCollection: Read-only collection of shapes.
         """
         GetDllLibPpt().ISlide_get_Shapes.argtypes=[c_void_p]
         GetDllLibPpt().ISlide_get_Shapes.restype=c_void_p
@@ -111,10 +122,10 @@ class ISlide (SpireObject) :
 
     def Name(self)->str:
         """
-    <summary>
-        Gets or sets the name of a slide.
-            Read/write <see cref="T:System.String" />.
-    </summary>
+        Gets or sets slide name.
+        
+        Returns:
+            str: Name of the slide.
         """
         GetDllLibPpt().ISlide_get_Name.argtypes=[c_void_p]
         GetDllLibPpt().ISlide_get_Name.restype=c_void_p
@@ -124,6 +135,12 @@ class ISlide (SpireObject) :
 
     @Name.setter
     def Name(self, value:str):
+        """
+        Sets slide name.
+        
+        Args:
+            value (str): New slide name.
+        """
         valuePtr = StrToPtr(value)
         GetDllLibPpt().ISlide_set_Name.argtypes=[c_void_p, c_char_p]
         CallCFunction(GetDllLibPpt().ISlide_set_Name,self.Ptr,valuePtr)
@@ -132,9 +149,10 @@ class ISlide (SpireObject) :
 
     def SlideID(self)->'int':
         """
-    <summary>
-        Gets the ID of a slide.
-    </summary>
+        Gets unique slide identifier.
+        
+        Returns:
+            int: Read-only slide ID.
         """
         GetDllLibPpt().ISlide_get_SlideID.argtypes=[c_void_p]
         GetDllLibPpt().ISlide_get_SlideID.restype=c_int
@@ -146,10 +164,10 @@ class ISlide (SpireObject) :
 
     def MasterSlideID(self)->'int':
         """
-    <summary>
-        Gets the ID of a masterslide.
-            Read-only <see cref="T:System.UInt32" />.
-    </summary>
+        Gets or sets master slide identifier.
+        
+        Returns:
+            int: ID of associated master slide.
         """
         GetDllLibPpt().ISlide_get_MasterSlideID.argtypes=[c_void_p]
         GetDllLibPpt().ISlide_get_MasterSlideID.restype=c_void_p
@@ -160,6 +178,12 @@ class ISlide (SpireObject) :
 
     @MasterSlideID.setter
     def MasterSlideID(self, value:'UInt32'):
+        """
+        Sets master slide identifier.
+        
+        Args:
+            value (int): New master slide ID.
+        """
         GetDllLibPpt().ISlide_set_MasterSlideID.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibPpt().ISlide_set_MasterSlideID,self.Ptr, value.Ptr)
 
@@ -167,10 +191,10 @@ class ISlide (SpireObject) :
 
     def TagsList(self)->'TagCollection':
         """
-    <summary>
-        Gets the slide's tags collection.
-            Read-only <see cref="T:Spire.Presentation.Collections.TagCollection" />.
-    </summary>
+        Gets slide's metadata tags.
+        
+        Returns:
+            TagCollection: Read-only tag collection.
         """
         GetDllLibPpt().ISlide_get_TagsList.argtypes=[c_void_p]
         GetDllLibPpt().ISlide_get_TagsList.restype=c_void_p
@@ -183,10 +207,10 @@ class ISlide (SpireObject) :
 
     def Timeline(self)->'TimeLine':
         """
-    <summary>
-        Gets animation timeline object.
-            Read-only <see cref="T:Spire.Presentation.Drawing.TimeLine.TimeLine" />.
-    </summary>
+        Gets animation timeline.
+        
+        Returns:
+            TimeLine: Read-only animation timeline.
         """
         GetDllLibPpt().ISlide_get_Timeline.argtypes=[c_void_p]
         GetDllLibPpt().ISlide_get_Timeline.restype=c_void_p
@@ -199,11 +223,10 @@ class ISlide (SpireObject) :
 
     def SlideShowTransition(self)->'SlideShowTransition':
         """
-    <summary>
-        Gets the Transition object which contains information about
-            how the specified slide advances during a slide show.
-            Read-only <see cref="P:Spire.Presentation.ISlide.SlideShowTransition" />.
-    </summary>
+        Gets slide transition settings.
+        
+        Returns:
+            SlideShowTransition: Read-only transition properties.
         """
         GetDllLibPpt().ISlide_get_SlideShowTransition.argtypes=[c_void_p]
         GetDllLibPpt().ISlide_get_SlideShowTransition.restype=c_void_p
@@ -216,10 +239,10 @@ class ISlide (SpireObject) :
 
     def SlideBackground(self)->'SlideBackground':
         """
-    <summary>
-        Gets slide's background.
-            Read only <see cref="P:Spire.Presentation.ISlide.SlideBackground" />.
-    </summary>
+        Gets slide background properties.
+        
+        Returns:
+            SlideBackground: Read-only background settings.
         """
         GetDllLibPpt().ISlide_get_SlideBackground.argtypes=[c_void_p]
         GetDllLibPpt().ISlide_get_SlideBackground.restype=c_void_p
@@ -232,10 +255,10 @@ class ISlide (SpireObject) :
 
     def DisplaySlideBackground(self)->'SlideBackground':
         """
-    <summary>
-        Gets slide's display background.
-            Read only <see cref="P:Spire.Presentation.ISlide.DisplaySlideBackground" />.
-    </summary>
+        Gets display background properties.
+        
+        Returns:
+            SlideBackground: Read-only display background.
         """
         GetDllLibPpt().ISlide_get_DisplaySlideBackground.argtypes=[c_void_p]
         GetDllLibPpt().ISlide_get_DisplaySlideBackground.restype=c_void_p
@@ -248,7 +271,10 @@ class ISlide (SpireObject) :
 
     def Presentation(self)->'Presentation':
         """
-
+        Gets parent presentation.
+        
+        Returns:
+            Presentation: Parent presentation object.
         """
         from spire.presentation import Presentation
         GetDllLibPpt().ISlide_get_Presentation.argtypes=[c_void_p]
@@ -261,9 +287,10 @@ class ISlide (SpireObject) :
     @property
     def ShowMasterShape(self)->bool:
         """
-    <summary>
-        Hide background graphics
-    </summary>
+        Indicates whether to show master shapes.
+        
+        Returns:
+            bool: True to show master shapes, False to hide.
         """
         GetDllLibPpt().ISlide_get_ShowMasterShape.argtypes=[c_void_p]
         GetDllLibPpt().ISlide_get_ShowMasterShape.restype=c_bool
@@ -272,6 +299,12 @@ class ISlide (SpireObject) :
 
     @ShowMasterShape.setter
     def ShowMasterShape(self, value:bool):
+        """
+        Sets visibility of master shapes.
+        
+        Args:
+            value (bool): True to show, False to hide.
+        """
         GetDllLibPpt().ISlide_set_ShowMasterShape.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibPpt().ISlide_set_ShowMasterShape,self.Ptr, value)
 
@@ -296,7 +329,10 @@ class ISlide (SpireObject) :
     
     def SaveAsImage(self)->'Stream':
         """
-
+        Saves slide as image.
+        
+        Returns:
+            Stream: Image data stream.
         """
         GetDllLibPpt().ISlide_SaveAsImage.argtypes=[c_void_p]
         GetDllLibPpt().ISlide_SaveAsImage.restype=c_void_p
@@ -307,7 +343,14 @@ class ISlide (SpireObject) :
     
     def SaveAsImageByWH(self ,width:int,height:int)->'Stream':
         """
-
+        Saves slide as image with specified dimensions.
+        
+        Args:
+            width (int): Image width.
+            height (int): Image height.
+        
+        Returns:
+            Stream: Image data stream.
         """
         
         GetDllLibPpt().ISlide_SaveAsImageWH.argtypes=[c_void_p ,c_int,c_int]
@@ -353,9 +396,10 @@ class ISlide (SpireObject) :
 
     def SaveDisplayBackgroundAsImage(self)->'Stream':
         """
-    <summary>
-        Saves the Slide Display Background to image. 
-    </summary>
+        Saves display background as image.
+        
+        Returns:
+            Stream: Image data stream.
         """
         GetDllLibPpt().ISlide_SaveDisplayBackgroundAsImage.argtypes=[c_void_p]
         GetDllLibPpt().ISlide_SaveDisplayBackgroundAsImage.restype=c_void_p
@@ -367,11 +411,11 @@ class ISlide (SpireObject) :
 
     def SaveToFile(self ,file:str,fileFormat:'FileFormat'):
         """
-    <summary>
-        Saves the Slide to the specified file. 
-    </summary>
-    <param name="file">A string that contains the path of the file to which to save this document.</param>
-    <param name="fileFormat">convert to fileFormat.</param>
+        Saves slide to file.
+        
+        Args:
+            file (str): Output file path.
+            file_format (FileFormat): File format.
         """
         enumfileFormat:c_int = fileFormat.value
 
@@ -382,10 +426,10 @@ class ISlide (SpireObject) :
 
     def SaveToSVG(self)->'Stream':
         """
-    <summary>
-        Save the slide to SVG format
-    </summary>
-    <returns>A byte array of SVG file-stream.</returns>
+        Saves slide as SVG.
+        
+        Returns:
+            Stream: SVG data stream.
         """
         GetDllLibPpt().ISlide_SaveToSVG.argtypes=[c_void_p]
         GetDllLibPpt().ISlide_SaveToSVG.restype=c_void_p
@@ -397,11 +441,10 @@ class ISlide (SpireObject) :
 
     def AddNotesSlide(self)->'NotesSlide':
         """
-    <summary>
-        Adds a new notes slide.
-    </summary>
-    <returns>
-  <see cref="P:Spire.Presentation.Slide.NotesSlide" /> for this slide.</returns>
+        Adds a notes slide.
+        
+        Returns:
+            NotesSlide: Newly created notes slide.
         """
         GetDllLibPpt().ISlide_AddNotesSlide.argtypes=[c_void_p]
         GetDllLibPpt().ISlide_AddNotesSlide.restype=c_void_p
@@ -414,13 +457,13 @@ class ISlide (SpireObject) :
 
     def AddComment(self ,author:ICommentAuthor,text:str,position:PointF,dateTime:DateTime):
         """
-    <summary>
-        Adds a new comment.
-    </summary>
-    <param name="ICommentAuthor">comment author</param>
-    <param name="text">comment text</param>
-    <param name="position">position</param>
-    <param name="dateTime"></param>
+        Adds a comment.
+        
+        Args:
+            author (ICommentAuthor): Comment author.
+            text (str): Comment text.
+            position (PointF): Position on slide.
+            date_time (DateTime): Comment timestamp.
         """
         intPtrauthor:c_void_p = author.Ptr
         intPtrposition:c_void_p = position.Ptr
@@ -434,10 +477,10 @@ class ISlide (SpireObject) :
 
     def AddComment(self ,comment:Comment):
         """
-    <summary>
-        Adds a new comment.
-    </summary>
-    <param name="comment"></param>
+        Adds a comment.
+        
+        Args:
+            comment (Comment): Comment object to add.
         """
         intPtrcomment:c_void_p = comment.Ptr
 
@@ -448,10 +491,10 @@ class ISlide (SpireObject) :
 
     def DeleteComment(self ,comment:Comment):
         """
-    <summary>
-        Delete a comment.
-    </summary>
-    <param name="comment"></param>
+        Deletes a comment.
+        
+        Args:
+            comment (Comment): Comment to delete.
         """
         intPtrcomment:c_void_p = comment.Ptr
 
@@ -462,11 +505,11 @@ class ISlide (SpireObject) :
 
     def DeleteComment(self ,author:ICommentAuthor,text:str):
         """
-    <summary>
-        Delete comments of specific text or specific author.
-    </summary>
-    <param name="ICommentAuthor">author of comments to delete or null to delete all comments.</param>
-    <param name="string">text of comments to delete or "" to delete all comments.</param>
+        Deletes comments by author and text.
+        
+        Args:
+            author (ICommentAuthor): Author of comments.
+            text (str): Text to match.
         """
         intPtrauthor:c_void_p = author.Ptr
 
@@ -478,11 +521,10 @@ class ISlide (SpireObject) :
 
     def DeleteComment(self ,author:ICommentAuthor):
         """
-    <summary>
-        Delete comments of specific author.
-    </summary>
-    <param name="ICommentAuthor">author of comments to delete</param>
-    <param name="string">text of comments to delete or "" to delete all comments.</param>
+        Deletes all comments by author.
+        
+        Args:
+            author (ICommentAuthor): Author of comments.
         """
         intPtrauthor:c_void_p = author.Ptr
 
@@ -493,10 +535,10 @@ class ISlide (SpireObject) :
 
     def DeleteComment(self ,text:str):
         """
-    <summary>
-        Delete comments of specific text.
-    </summary>
-    <param name="string">text of comments to delete or "" to delete all comments.</param>
+        Deletes comments by text.
+        
+        Args:
+            text (str): Text to match.
         """
         
         textPtr = StrToPtr(text)
@@ -563,10 +605,10 @@ class ISlide (SpireObject) :
 
     def ApplyTheme(self ,scheme:'SlideColorScheme'):
         """
-    <summary>
-        Applies extra color scheme to a slide.
-    </summary>
-    <param name="scheme"></param>
+        Applies color scheme to slide.
+        
+        Args:
+            scheme (SlideColorScheme): Color scheme to apply.
         """
         intPtrscheme:c_void_p = scheme.Ptr
 
@@ -574,11 +616,7 @@ class ISlide (SpireObject) :
         CallCFunction(GetDllLibPpt().ISlide_ApplyTheme,self.Ptr, intPtrscheme)
 
     def Dispose(self):
-        """
-    <summary>
-        Dispose object and free resources.
-    </summary>
-        """
+        """Releases resources associated with the object."""
         GetDllLibPpt().ISlide_Dispose.argtypes=[c_void_p]
         CallCFunction(GetDllLibPpt().ISlide_Dispose,self.Ptr)
 
@@ -586,9 +624,10 @@ class ISlide (SpireObject) :
 
     def Layout(self)->'ILayout':
         """
-    <summary>
-        get or set the layout.
-    </summary>
+        Gets or sets slide layout.
+        
+        Returns:
+            ILayout: Current slide layout.
         """
         GetDllLibPpt().ISlide_get_Layout.argtypes=[c_void_p]
         GetDllLibPpt().ISlide_get_Layout.restype=c_void_p
@@ -599,16 +638,25 @@ class ISlide (SpireObject) :
 
     @Layout.setter
     def Layout(self, value:'ILayout'):
+        """
+        Sets slide layout.
+        
+        Args:
+            value (ILayout): New layout.
+        """
         GetDllLibPpt().ISlide_set_Layout.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibPpt().ISlide_set_Layout,self.Ptr, value.Ptr)
 
 #
     def GroupShapes(self ,shapeList:'List')->'GroupShape':
         """
-    <summary>
-        Combine multiple shape together.
-    </summary>
-    <param name="shapeList"></param>
+        Groups shapes together.
+        
+        Args:
+            shape_list (List): Shapes to group.
+        
+        Returns:
+            GroupShape: New group shape.
         """
         countShapes = len(shapeList)
         ArrayTypeshapeList = c_void_p * countShapes
@@ -627,10 +675,10 @@ class ISlide (SpireObject) :
 
     def Ungroup(self ,groupShape:'GroupShape'):
         """
-    <summary>
-        Ungroup the GroupShape.
-    </summary>
-    <param name="groupShape">the group shape which needs to ungroup.</param>
+        Ungroups shapes.
+        
+        Args:
+            group_shape (GroupShape): Group to ungroup.
         """
         intPtrgroupShape:c_void_p = groupShape.Ptr
 
@@ -640,12 +688,12 @@ class ISlide (SpireObject) :
 
     def ReplaceFirstText(self ,matchedString:str,newValue:str,caseSensitive:bool):
         """
-    <summary>
-        Replaces first matched string with new value in the slide.
-    </summary>
-    <param name="matchedString">old value</param>
-    <param name="newValue">new value</param>
-    <param name="caseSensitive">case sensitive</param>
+        Replaces first occurrence of text.
+        
+        Args:
+            matched_string (str): Text to find.
+            new_value (str): Replacement text.
+            case_sensitive (bool): Case sensitivity flag.
         """
         
         matchedStringPtr = StrToPtr(matchedString)
@@ -656,12 +704,12 @@ class ISlide (SpireObject) :
 
     def ReplaceAllText(self ,matchedString:str,newValue:str,caseSensitive:bool):
         """
-    <summary>
-        Replaces all matched string with new value in the slide.
-    </summary>
-    <param name="matchedString">old value</param>
-    <param name="newValue">new value</param>
-    <param name="caseSensitive">case sensitive</param>
+        Replaces all occurrences of text.
+        
+        Args:
+            matched_string (str): Text to find.
+            new_value (str): Replacement text.
+            case_sensitive (bool): Case sensitivity flag.
         """
         
         matchedStringPtr = StrToPtr(matchedString)
@@ -673,9 +721,10 @@ class ISlide (SpireObject) :
 
     def Title(self)->str:
         """
-    <summary>
-        Gets or Sets the Title of silde.
-    </summary>
+        Gets or sets slide title.
+        
+        Returns:
+            str: Title text.
         """
         GetDllLibPpt().ISlide_get_Title.argtypes=[c_void_p]
         GetDllLibPpt().ISlide_get_Title.restype=c_void_p
@@ -685,6 +734,12 @@ class ISlide (SpireObject) :
 
     @Title.setter
     def Title(self, value:str):
+        """
+        Sets slide title.
+        
+        Args:
+            value (str): New title.
+        """
         valuePtr = StrToPtr(value)
         GetDllLibPpt().ISlide_set_Title.argtypes=[c_void_p, c_char_p]
         CallCFunction(GetDllLibPpt().ISlide_set_Title,self.Ptr,valuePtr)
@@ -723,11 +778,11 @@ class ISlide (SpireObject) :
 
     def GetAllTextFrame(self)->List[str]:
        """
-    <summary>
-        Get all text in the slide
-    </summary>
-    <returns></returns>
-       """
+        Gets all text content.
+        
+        Returns:
+            List[str]: Collection of text content.
+        """
        GetDllLibPpt().ISlide_GetAllTextFrame.argtypes=[c_void_p]
        GetDllLibPpt().ISlide_GetAllTextFrame.restype=IntPtrArray
        intPtrArray = CallCFunction(GetDllLibPpt().ISlide_GetAllTextFrame,self.Ptr)
@@ -739,13 +794,14 @@ class ISlide (SpireObject) :
 
     def FindFirstTextAsRange(self ,text:str)->'TextRange':
         """
-    <summary>
-        Find first text as a TextRange.
-    </summary>
-    <param name="text">Found text.</param>
-    <returns></returns>
-        """
+        Finds first occurrence of text.
         
+        Args:
+            text (str): Text to find.
+        
+        Returns:
+            TextRange: Found text range.
+        """
         textPtr = StrToPtr(text)
         GetDllLibPpt().ISlide_FindFirstTextAsRange.argtypes=[c_void_p ,c_char_p]
         GetDllLibPpt().ISlide_FindFirstTextAsRange.restype=c_void_p
@@ -756,8 +812,11 @@ class ISlide (SpireObject) :
     @property
     def OleObjects(self)->'OleObjectCollection':
         """
-        """
+        Gets OLE objects collection.
         
+        Returns:
+            OleObjectCollection: Collection of OLE objects.
+        """
         GetDllLibPpt().ISlide_get_OleObjects.argtypes=[c_void_p]
         GetDllLibPpt().ISlide_get_OleObjects.restype=c_void_p
         intPtr = CallCFunction(GetDllLibPpt().ISlide_get_OleObjects,self.Ptr)