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

spire/presentation/ClickHyperlink.py

@@ -7,15 +7,24 @@ from ctypes import *
 import abc
 
 class ClickHyperlink (SpireObject) :
-
+    """
+    Represents a hyperlink associated with a non-placeholder shape or text.
+    """
     @dispatch
     def __init__(self):
+        """Initializes a new instance of ClickHyperlink."""
         GetDllLibPpt().ClickHyperlink_Create.restype = c_void_p
         intPtr = CallCFunction(GetDllLibPpt().ClickHyperlink_Create)
         super(ClickHyperlink, self).__init__(intPtr)
 
     @dispatch
     def __init__(self,hyperlinkUrl:str):
+        """
+        Initializes a new instance with a URL hyperlink.
+
+        Args:
+            hyperlinkUrl (str): The URL to link to.
+        """
         hyperlinkUrlPtr = StrToPtr(hyperlinkUrl)
         GetDllLibPpt().ClickHyperlink_Create.argtypes=[c_char_p]
         GetDllLibPpt().ClickHyperlink_Create.restype = c_void_p
@@ -24,24 +33,25 @@ class ClickHyperlink (SpireObject) :
 
     @dispatch
     def __init__(self,targetSlide:'ISlide'):
+        """
+        Initializes a new instance with a slide hyperlink.
+
+        Args:
+            targetSlide (ISlide): The slide to link to.
+        """
         GetDllLibPpt().ClickHyperlink_Create_Slide.argtypes=[c_void_p]
         GetDllLibPpt().ClickHyperlink_Create_Slide.restype = c_void_p
         intPtr = CallCFunction(GetDllLibPpt().ClickHyperlink_Create_Slide,targetSlide.Ptr)
         super(ClickHyperlink, self).__init__(intPtr)
 
-    """
-    <summary>
-        Represents a hyperlink associated with a non-placeholder shape or text.
-    </summary>
-    """
     @staticmethod
 
     def get_NoAction()->'ClickHyperlink':
         """
-    <summary>
-        Returns a special "do nothing" hyperlink.
-            Readonly Hyperlink.
-    </summary>
+        Gets a special "do nothing" hyperlink.
+
+        Returns:
+            ClickHyperlink: Readonly hyperlink instance.
         """
         #GetDllLibPpt().ClickHyperlink_get_NoAction.argtypes=[]
         GetDllLibPpt().ClickHyperlink_get_NoAction.restype=c_void_p
@@ -54,10 +64,10 @@ class ClickHyperlink (SpireObject) :
 
     def get_NextSlide()->'ClickHyperlink':
         """
-    <summary>
-        Returns a hyperlink to the next slide.
-            Readonly <see cref="T:Spire.Presentation.ClickHyperlink" />.
-    </summary>
+        Gets a hyperlink to the next slide.
+
+        Returns:
+            ClickHyperlink: Readonly hyperlink instance.
         """
         #GetDllLibPpt().ClickHyperlink_get_NextSlide.argtypes=[]
         GetDllLibPpt().ClickHyperlink_get_NextSlide.restype=c_void_p
@@ -70,10 +80,10 @@ class ClickHyperlink (SpireObject) :
 
     def get_PreviousSlide()->'ClickHyperlink':
         """
-    <summary>
-        Returns a hyperlink to the previous slide.
-            Readonly <see cref="T:Spire.Presentation.ClickHyperlink" />.
-    </summary>
+        Gets a hyperlink to the previous slide.
+
+        Returns:
+            ClickHyperlink: Readonly hyperlink instance.
         """
         #GetDllLibPpt().ClickHyperlink_get_PreviousSlide.argtypes=[]
         GetDllLibPpt().ClickHyperlink_get_PreviousSlide.restype=c_void_p
@@ -86,10 +96,10 @@ class ClickHyperlink (SpireObject) :
 
     def get_FirstSlide()->'ClickHyperlink':
         """
-    <summary>
-        Returns a hyperlink to the first slide of the presentation.
-            Readonly <see cref="T:Spire.Presentation.ClickHyperlink" />.
-    </summary>
+        Gets a hyperlink to the first slide.
+
+        Returns:
+            ClickHyperlink: Readonly hyperlink instance.
         """
         #GetDllLibPpt().ClickHyperlink_get_FirstSlide.argtypes=[]
         GetDllLibPpt().ClickHyperlink_get_FirstSlide.restype=c_void_p
@@ -102,10 +112,10 @@ class ClickHyperlink (SpireObject) :
 
     def get_LastSlide()->'ClickHyperlink':
         """
-    <summary>
-        Returns a hyperlink to the last slide of the presentation.
-            Readonly <see cref="T:Spire.Presentation.ClickHyperlink" />.
-    </summary>
+        Gets a hyperlink to the last slide.
+
+        Returns:
+            ClickHyperlink: Readonly hyperlink instance.
         """
         #GetDllLibPpt().ClickHyperlink_get_LastSlide.argtypes=[]
         GetDllLibPpt().ClickHyperlink_get_LastSlide.restype=c_void_p
@@ -118,10 +128,10 @@ class ClickHyperlink (SpireObject) :
 
     def get_LastVievedSlide()->'ClickHyperlink':
         """
-    <summary>
-        Returns a hyperlink to the last viewed slide.
-            Readonly <see cref="T:Spire.Presentation.ClickHyperlink" />.
-    </summary>
+        Gets a hyperlink to the last viewed slide.
+
+        Returns:
+            ClickHyperlink: Readonly hyperlink instance.
         """
         #GetDllLibPpt().ClickHyperlink_get_LastVievedSlide.argtypes=[]
         GetDllLibPpt().ClickHyperlink_get_LastVievedSlide.restype=c_void_p
@@ -134,10 +144,10 @@ class ClickHyperlink (SpireObject) :
 
     def get_EndShow()->'ClickHyperlink':
         """
-    <summary>
-        Returns a hyperlink which ends the show.
-            Readonly <see cref="T:Spire.Presentation.ClickHyperlink" />.
-    </summary>
+        Gets a hyperlink that ends the slide show.
+
+        Returns:
+            ClickHyperlink: Readonly hyperlink instance.
         """
         #GetDllLibPpt().ClickHyperlink_get_EndShow.argtypes=[]
         GetDllLibPpt().ClickHyperlink_get_EndShow.restype=c_void_p
@@ -150,11 +160,13 @@ class ClickHyperlink (SpireObject) :
 
     def GetOtherPowerPointPresentation(filePath:str)->'ClickHyperlink':
         """
-    <summary>
-        Returns a hyperlink to other powerPoint presentation.
-    </summary>
-    <param name="filePath">the file full path.</param>
-    <returns></returns>
+        Creates a hyperlink to another PowerPoint presentation.
+
+        Args:
+            filePath (str): Full path to the target file.
+
+        Returns:
+            ClickHyperlink: New hyperlink instance.
         """
         
         filePathPtr = StrToPtr(filePath)
@@ -169,11 +181,13 @@ class ClickHyperlink (SpireObject) :
 
     def GetOtherFiles(filePath:str)->'ClickHyperlink':
         """
-    <summary>
-        Returns a hyperlink to other files.
-    </summary>
-    <param name="filePath">the file full path.</param>
-    <returns></returns>
+        Creates a hyperlink to other files.
+
+        Args:
+            filePath (str): Full path to the target file.
+
+        Returns:
+            ClickHyperlink: New hyperlink instance.
         """
         
         filePathPtr = StrToPtr(filePath)
@@ -188,9 +202,10 @@ class ClickHyperlink (SpireObject) :
 
     def Address(self)->str:
         """
-    <summary>
-        Returns or sets the Internet address (URL) to the target document.
-    </summary>
+        Gets or sets the URL address.
+
+        Returns:
+            str: The internet address.
         """
         GetDllLibPpt().ClickHyperlink_get_Address.argtypes=[c_void_p]
         GetDllLibPpt().ClickHyperlink_get_Address.restype=c_void_p
@@ -205,11 +220,8 @@ class ClickHyperlink (SpireObject) :
         CallCFunction(GetDllLibPpt().ClickHyperlink_set_Address,self.Ptr,valuePtr)
 
     @property
-
     def InvalidUrl(self)->str:
-        """
-
-        """
+        """Gets or sets the invalid URL (internal use)."""
         GetDllLibPpt().ClickHyperlink_get_InvalidUrl.argtypes=[c_void_p]
         GetDllLibPpt().ClickHyperlink_get_InvalidUrl.restype=c_void_p
         ret = PtrToStr(CallCFunction(GetDllLibPpt().ClickHyperlink_get_InvalidUrl,self.Ptr))
@@ -225,9 +237,7 @@ class ClickHyperlink (SpireObject) :
     @property
 
     def Action(self)->str:
-        """
-
-        """
+        """Gets or sets the action type (internal use)."""
         GetDllLibPpt().ClickHyperlink_get_Action.argtypes=[c_void_p]
         GetDllLibPpt().ClickHyperlink_get_Action.restype=c_void_p
         ret = PtrToStr(CallCFunction(GetDllLibPpt().ClickHyperlink_get_Action,self.Ptr))
@@ -244,10 +254,10 @@ class ClickHyperlink (SpireObject) :
 
     def ActionType(self)->'HyperlinkActionType':
         """
-    <summary>
-        Represents the type of hyperlink. Read-only.
-            Readonly <see cref="T:Spire.Presentation.HyperlinkActionType" />.
-    </summary>
+        Gets the type of hyperlink action.
+
+        Returns:
+            HyperlinkActionType: Readonly enum value.
         """
         GetDllLibPpt().ClickHyperlink_get_ActionType.argtypes=[c_void_p]
         GetDllLibPpt().ClickHyperlink_get_ActionType.restype=c_int
@@ -259,10 +269,10 @@ class ClickHyperlink (SpireObject) :
 
     def TargetSlide(self)->'ISlide':
         """
-    <summary>
-        If the Hyperlink targets specific slide returns this slide.
-            Readonly <see cref="T:Spire.Presentation.Slide" />.
-    </summary>
+        Gets the target slide if hyperlink targets a slide.
+
+        Returns:
+            ISlide: Readonly slide object.
         """
         from spire.presentation.ISlide import ISlide
         GetDllLibPpt().ClickHyperlink_get_TargetSlide.argtypes=[c_void_p]
@@ -276,10 +286,10 @@ class ClickHyperlink (SpireObject) :
 
     def TargetFrame(self)->str:
         """
-    <summary>
-        Gets the frame within the parent HTML frameset 
-            Read-only <see cref="T:System.String" />.
-    </summary>
+        Gets or sets the target frame within HTML frameset.
+
+        Returns:
+            str: Target frame name.
         """
         GetDllLibPpt().ClickHyperlink_get_TargetFrame.argtypes=[c_void_p]
         GetDllLibPpt().ClickHyperlink_get_TargetFrame.restype=c_void_p
@@ -297,10 +307,10 @@ class ClickHyperlink (SpireObject) :
 
     def Tooltip(self)->str:
         """
-    <summary>
-        Returns or sets the ScreenTip text of a hyperlink.
-            Read-only <see cref="T:System.String" />.
-    </summary>
+        Gets or sets the ScreenTip text.
+
+        Returns:
+            str: Tooltip text.
         """
         GetDllLibPpt().ClickHyperlink_get_Tooltip.argtypes=[c_void_p]
         GetDllLibPpt().ClickHyperlink_get_Tooltip.restype=c_void_p
@@ -317,11 +327,10 @@ class ClickHyperlink (SpireObject) :
     @property
     def History(self)->bool:
         """
-    <summary>
-        Indicates whether the target will be added
-            to a list.
-            Read-only <see cref="T:System.Boolean" />.
-    </summary>
+        Gets or sets whether to add target to history list.
+
+        Returns:
+            bool: True if target should be added to history.
         """
         GetDllLibPpt().ClickHyperlink_get_History.argtypes=[c_void_p]
         GetDllLibPpt().ClickHyperlink_get_History.restype=c_bool
@@ -336,10 +345,10 @@ class ClickHyperlink (SpireObject) :
     @property
     def IsHighlightClick(self)->bool:
         """
-    <summary>
-        Indicates whether the hyperlink should be highlighted on click.
-            Read-only <see cref="T:System.Boolean" />.
-    </summary>
+        Gets or sets whether to highlight on click.
+
+        Returns:
+            bool: True if should highlight on click.
         """
         GetDllLibPpt().ClickHyperlink_get_IsHighlightClick.argtypes=[c_void_p]
         GetDllLibPpt().ClickHyperlink_get_IsHighlightClick.restype=c_bool
@@ -348,16 +357,22 @@ class ClickHyperlink (SpireObject) :
 
     @IsHighlightClick.setter
     def IsHighlightClick(self, value:bool):
+        """
+        Sets whether to highlight on click.
+
+        Args:
+            value (bool): True to enable highlight.
+        """
         GetDllLibPpt().ClickHyperlink_set_IsHighlightClick.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibPpt().ClickHyperlink_set_IsHighlightClick,self.Ptr, value)
 
     @property
     def EndSounds(self)->bool:
         """
-    <summary>
-        Indicates whether the sound should be stopped on hyperlink click.
-            Read-only <see cref="T:System.Boolean" />.
-    </summary>
+        Gets or sets whether to stop sounds on click.
+
+        Returns:
+            bool: True if sounds should stop.
         """
         GetDllLibPpt().ClickHyperlink_get_EndSounds.argtypes=[c_void_p]
         GetDllLibPpt().ClickHyperlink_get_EndSounds.restype=c_bool
@@ -366,6 +381,12 @@ class ClickHyperlink (SpireObject) :
 
     @EndSounds.setter
     def EndSounds(self, value:bool):
+        """
+        Sets whether to stop sounds on click.
+
+        Args:
+            value (bool): True to stop sounds.
+        """
         GetDllLibPpt().ClickHyperlink_set_EndSounds.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibPpt().ClickHyperlink_set_EndSounds,self.Ptr, value)
 
@@ -373,10 +394,13 @@ class ClickHyperlink (SpireObject) :
 
     def Equals(self ,obj:SpireObject)->bool:
         """
-    <summary>
-        Indicates whether the two Hyperlink instances are equal.
-    </summary>
-    <param name="obj">The Hyperlink to compare with the current Hyperlink.</param>
+        Determines if two hyperlinks are equal.
+
+        Args:
+            obj (SpireObject): The hyperlink to compare.
+
+        Returns:
+            bool: True if equal.
         """
         intPtrobj:c_void_p = obj.Ptr
 
@@ -389,10 +413,13 @@ class ClickHyperlink (SpireObject) :
 
     def Equals(self ,hlink:'ClickHyperlink')->bool:
         """
-    <summary>
-        Indicates whether the two Hyperlink instances are equal.
-    </summary>
-    <param name="hlink">The Hyperlink to compare with the current Hyperlink.</param>
+        Determines if two hyperlinks are equal.
+
+        Args:
+            hlink (ClickHyperlink): The hyperlink to compare.
+
+        Returns:
+            bool: True if equal.
         """
         intPtrhlink:c_void_p = hlink.Ptr
 
@@ -405,7 +432,10 @@ class ClickHyperlink (SpireObject) :
 
     def op_Equality(hlink1:'ClickHyperlink',hlink2:'ClickHyperlink')->bool:
         """
+        Equality operator for hyperlinks.
 
+        Returns:
+            bool: True if equal.
         """
         intPtrhlink1:c_void_p = hlink1.Ptr
         intPtrhlink2:c_void_p = hlink2.Ptr
@@ -419,7 +449,10 @@ class ClickHyperlink (SpireObject) :
 
     def op_Inequality(hlink1:'ClickHyperlink',hlink2:'ClickHyperlink')->bool:
         """
+        Inequality operator for hyperlinks.
 
+        Returns:
+            bool: True if not equal.
         """
         intPtrhlink1:c_void_p = hlink1.Ptr
         intPtrhlink2:c_void_p = hlink2.Ptr
@@ -431,7 +464,10 @@ class ClickHyperlink (SpireObject) :
 
     def GetHashCode(self)->int:
         """
+        Gets hash code for the hyperlink.
 
+        Returns:
+            int: Hash code value.
         """
         GetDllLibPpt().ClickHyperlink_GetHashCode.argtypes=[c_void_p]
         GetDllLibPpt().ClickHyperlink_GetHashCode.restype=c_int

spire/presentation/Comment.py

@@ -8,18 +8,16 @@ import abc
 
 class Comment (  PptObject) :
     """
-    <summary>
-        Represents a comment on a slide.
-    </summary>
+    Represents a comment on a presentation slide.
     """
     @property
 
     def Text(self)->str:
         """
-    <summary>
-        Returns a String that represents the text in a comment
-            Read/write <see cref="T:System.String" />.
-    </summary>
+        Gets or sets the text content of the comment.
+        
+        Returns:
+            str: Comment text content.
         """
         GetDllLibPpt().Comment_get_Text.argtypes=[c_void_p]
         GetDllLibPpt().Comment_get_Text.restype=c_void_p
@@ -29,6 +27,12 @@ class Comment (  PptObject) :
 
     @Text.setter
     def Text(self, value:str):
+        """
+        Sets the text content of the comment.
+        
+        Args:
+            value (str): New comment text content.
+        """
         valuePtr = StrToPtr(value)
         GetDllLibPpt().Comment_set_Text.argtypes=[c_void_p, c_char_p]
         CallCFunction(GetDllLibPpt().Comment_set_Text,self.Ptr,valuePtr)
@@ -37,10 +41,10 @@ class Comment (  PptObject) :
 
     def DateTime(self)->'DateTime':
         """
-    <summary>
-        Returns the date and time a comment was created.
-            Read/write <see cref="T:System.DateTime" />.
-    </summary>
+        Gets or sets the creation date and time of the comment.
+        
+        Returns:
+            DateTime: Comment creation timestamp.
         """
         GetDllLibPpt().Comment_get_DateTime.argtypes=[c_void_p]
         GetDllLibPpt().Comment_get_DateTime.restype=c_void_p
@@ -51,6 +55,12 @@ class Comment (  PptObject) :
 
     @DateTime.setter
     def DateTime(self, value:'DateTime'):
+        """
+        Sets the creation date and time of the comment.
+        
+        Args:
+            value (DateTime): New creation timestamp.
+        """
         GetDllLibPpt().Comment_set_DateTime.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibPpt().Comment_set_DateTime,self.Ptr, value.Ptr)
 
@@ -58,10 +68,10 @@ class Comment (  PptObject) :
 
     def Slide(self)->'ISlide':
         """
-    <summary>
-        Gets or sets the parent slide of a comment.
-            Read-only <see cref="P:Spire.Presentation.Comment.Slide" />.
-    </summary>
+        Gets the parent slide containing this comment.
+        
+        Returns:
+            ISlide: Parent slide object.
         """
         GetDllLibPpt().Comment_get_Slide.argtypes=[c_void_p]
         GetDllLibPpt().Comment_get_Slide.restype=c_void_p
@@ -74,9 +84,10 @@ class Comment (  PptObject) :
 
     def AuthorName(self)->str:
         """
-    <summary>
-        Gets or sets a String that represents the author as for a specified Comment object.
-    </summary>
+        Gets or sets the author's display name.
+        
+        Returns:
+            str: Comment author's name.
         """
         GetDllLibPpt().Comment_get_AuthorName.argtypes=[c_void_p]
         GetDllLibPpt().Comment_get_AuthorName.restype=c_void_p
@@ -86,6 +97,12 @@ class Comment (  PptObject) :
 
     @AuthorName.setter
     def AuthorName(self, value:str):
+        """
+        Sets the author's display name.
+        
+        Args:
+            value (str): New author name.
+        """
         valuePtr = StrToPtr(value)
         GetDllLibPpt().Comment_set_AuthorName.argtypes=[c_void_p, c_char_p]
         CallCFunction(GetDllLibPpt().Comment_set_AuthorName,self.Ptr,valuePtr)
@@ -94,9 +111,10 @@ class Comment (  PptObject) :
 
     def AuthorInitials(self)->str:
         """
-    <summary>
-        Gets or sets the author's initials as a read-only String for a specified Comment object
-    </summary>
+        Gets or sets the author's initials.
+        
+        Returns:
+            str: Comment author's initials.
         """
         GetDllLibPpt().Comment_get_AuthorInitials.argtypes=[c_void_p]
         GetDllLibPpt().Comment_get_AuthorInitials.restype=c_void_p
@@ -106,6 +124,12 @@ class Comment (  PptObject) :
 
     @AuthorInitials.setter
     def AuthorInitials(self, value:str):
+        """
+        Sets the author's initials.
+        
+        Args:
+            value (str): New author initials.
+        """
         valuePtr = StrToPtr(value)
         GetDllLibPpt().Comment_set_AuthorInitials.argtypes=[c_void_p, c_char_p]
         CallCFunction(GetDllLibPpt().Comment_set_AuthorInitials,self.Ptr,valuePtr)
@@ -113,9 +137,10 @@ class Comment (  PptObject) :
     @property
     def Left(self)->float:
         """
-    <summary>
-        Represents the distance in points from the left edge of the comment to the left edge of the slide.
-    </summary>
+        Gets or sets horizontal position from slide left edge.
+        
+        Returns:
+            float: X-coordinate in points.
         """
         GetDllLibPpt().Comment_get_Left.argtypes=[c_void_p]
         GetDllLibPpt().Comment_get_Left.restype=c_float
@@ -124,15 +149,22 @@ class Comment (  PptObject) :
 
     @Left.setter
     def Left(self, value:float):
+        """
+        Sets horizontal position from slide left edge.
+        
+        Args:
+            value (float): New X-coordinate in points.
+        """
         GetDllLibPpt().Comment_set_Left.argtypes=[c_void_p, c_float]
         CallCFunction(GetDllLibPpt().Comment_set_Left,self.Ptr, value)
 
     @property
     def Top(self)->float:
         """
-    <summary>
-         Represents the distance in points from the left edge of the comment to the left edge of the slide.
-    </summary>
+        Gets or sets vertical position from slide top edge.
+        
+        Returns:
+            float: Y-coordinate in points.
         """
         GetDllLibPpt().Comment_get_Top.argtypes=[c_void_p]
         GetDllLibPpt().Comment_get_Top.restype=c_float
@@ -141,18 +173,24 @@ class Comment (  PptObject) :
 
     @Top.setter
     def Top(self, value:float):
+        """
+        Sets vertical position from slide top edge.
+        
+        Args:
+            value (float): New Y-coordinate in points.
+        """
         GetDllLibPpt().Comment_set_Top.argtypes=[c_void_p, c_float]
         CallCFunction(GetDllLibPpt().Comment_set_Top,self.Ptr, value)
 
 
     def Reply(self ,author:'ICommentAuthor',reply:str,time:'DateTime'):
         """
-    <summary>
-        reply the comment. Do nothing if the comment is a reply
-    </summary>
-    <param name="author">reply author.</param>
-    <param name="reply">reply.</param>
-    <param name="time">time.</param>
+        Adds a reply to this comment (does nothing if comment is already a reply).
+        
+        Args:
+            author (ICommentAuthor): Author of the reply.
+            reply (str): Text content of the reply.
+            time (DateTime): Timestamp of the reply.
         """
         intPtrauthor:c_void_p = author.Ptr
         intPtrtime:c_void_p = time.Ptr
@@ -164,9 +202,10 @@ class Comment (  PptObject) :
     @property
     def IsReply(self)->bool:
         """
-    <summary>
-        if the comment is reply.
-    </summary>
+        Determines if the comment is a reply to another comment.
+        
+        Returns:
+            bool: True if comment is a reply; otherwise False.
         """
         GetDllLibPpt().Comment_get_IsReply.argtypes=[c_void_p]
         GetDllLibPpt().Comment_get_IsReply.restype=c_bool

spire/presentation/ConnectorLocking.py

@@ -8,7 +8,7 @@ import abc
 
 class ConnectorLocking (  SimpleShapeBaseLocking) :
     """
-    <summary>
-        Indicates which operations are disabled on the parent Connector.
-    </summary>
+    Specifies which operations are disabled on a parent Connector shape.
+    
+    Inherits locking settings from SimpleShapeBaseLocking and adds connector-specific restrictions.
     """