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

spire/presentation/IShape.py

@@ -8,15 +8,16 @@ import abc
 
 class IShape (SpireObject) :
     """
-
+    Represents a shape object in a presentation slide.
+    Provides properties and methods for manipulating shape appearance, position, and content.
+    Inherits from SpireObject.
     """
     @property
     def IsPlaceholder(self)->bool:
         """
-    <summary>
-        Indicates whether the shape is Placeholder.
-            Read-only <see cref="T:System.Boolean" />.
-    </summary>
+        Indicates whether the shape is a placeholder.
+        Returns:
+            bool: True if placeholder, False otherwise.
         """
         GetDllLibPpt().IShape_get_IsPlaceholder.argtypes=[c_void_p]
         GetDllLibPpt().IShape_get_IsPlaceholder.restype=c_bool
@@ -26,10 +27,9 @@ class IShape (SpireObject) :
     @property
     def IsTextBox(self)->bool:
         """
-    <summary>
-        Indicates whether the shape is TextBox.
-            Read-only <see cref="T:System.Boolean" />.
-    </summary>
+        Indicates whether the shape is a text box.
+        Returns:
+            bool: True if text box, False otherwise.
         """
         GetDllLibPpt().IShape_get_IsTextBox.argtypes=[c_void_p]
         GetDllLibPpt().IShape_get_IsTextBox.restype=c_bool
@@ -40,10 +40,9 @@ class IShape (SpireObject) :
 
     def Placeholder(self)->'Placeholder':
         """
-    <summary>
-        Gets the placeholder for a shape.
-            Read-only <see cref="P:Spire.Presentation.IShape.Placeholder" />.
-    </summary>
+        Gets the placeholder properties of the shape (read-only).
+        Returns:
+            Placeholder: Placeholder object or None.
         """
         
         GetDllLibPpt().IShape_get_Placeholder.argtypes=[c_void_p]
@@ -57,10 +56,9 @@ class IShape (SpireObject) :
 
     def TagsList(self)->'TagCollection':
         """
-    <summary>
-        Gets the shape's tags collection.
-            Read-only <see cref="T:Spire.Presentation.Collections.TagCollection" />.
-    </summary>
+        Gets the collection of tags associated with the shape.
+        Returns:
+            TagCollection: Collection of shape tags.
         """
         GetDllLibPpt().IShape_get_TagsList.argtypes=[c_void_p]
         GetDllLibPpt().IShape_get_TagsList.restype=c_void_p
@@ -73,10 +71,9 @@ class IShape (SpireObject) :
 
     def Frame(self)->'GraphicFrame':
         """
-    <summary>
-        Gets or sets the shape frame's properties.
-            Read/write <see cref="T:Spire.Presentation.Drawing.GraphicFrame" />.
-    </summary>
+        Gets or sets the graphic frame properties of the shape.
+        Returns:
+            GraphicFrame: Current graphic frame settings.
         """
         GetDllLibPpt().IShape_get_Frame.argtypes=[c_void_p]
         GetDllLibPpt().IShape_get_Frame.restype=c_void_p
@@ -87,6 +84,11 @@ class IShape (SpireObject) :
 
     @Frame.setter
     def Frame(self, value:'GraphicFrame'):
+        """
+        Sets the graphic frame properties of the shape.
+        Parameters:
+            value: New GraphicFrame settings.
+        """
         GetDllLibPpt().IShape_set_Frame.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibPpt().IShape_set_Frame,self.Ptr, value.Ptr)
 
@@ -94,11 +96,10 @@ class IShape (SpireObject) :
 
     def Line(self)->'TextLineFormat':
         """
-    <summary>
-        Gets the LineFormat object that contains line formatting properties for a shape.
-            Read-only <see cref="P:Spire.Presentation.IShape.Line" />.
-            Note: can return null for certain types of shapes which don't have line properties.
-    </summary>
+        Gets line formatting properties.
+        
+        Returns:
+            TextLineFormat: Line format object (may be null).
         """
         GetDllLibPpt().IShape_get_Line.argtypes=[c_void_p]
         GetDllLibPpt().IShape_get_Line.restype=c_void_p
@@ -111,11 +112,10 @@ class IShape (SpireObject) :
 
     def ThreeD(self)->'FormatThreeD':
         """
-    <summary>
-        Gets the ThreeDFormat object that 3d effect properties for a shape.
-            Read-only <see cref="T:Spire.Presentation.Drawing.FormatThreeD" />.
-            Note: can return null for certain types of shapes which don't have 3d properties.
-    </summary>
+        Gets 3D effect properties.
+        
+        Returns:
+            FormatThreeD: 3D format object (may be null).
         """
         GetDllLibPpt().IShape_get_ThreeD.argtypes=[c_void_p]
         GetDllLibPpt().IShape_get_ThreeD.restype=c_void_p
@@ -127,12 +127,11 @@ class IShape (SpireObject) :
     @property
 
     def EffectDag(self)->'EffectDag':
-        """
-    <summary>
-        Gets the EffectFormat object which contains pixel effects applied to a shape.
-            Read-only <see cref="P:Spire.Presentation.IShape.EffectDag" />
-            Note: can return null for certain types of shapes which don't have effect properties.
-    </summary>
+        """""
+        Gets effect properties.
+        
+        Returns:
+            EffectDag: Effect object (may be null).
         """
         GetDllLibPpt().IShape_get_EffectDag.argtypes=[c_void_p]
         GetDllLibPpt().IShape_get_EffectDag.restype=c_void_p
@@ -145,11 +144,10 @@ class IShape (SpireObject) :
 
     def Fill(self)->'FillFormat':
         """
-    <summary>
-        Gets the FillFormat object that contains fill formatting properties for a shape.
-            Read-only <see cref="P:Spire.Presentation.IShape.Fill" />.
-            Note: can return null for certain types of shapes which don't have fill properties.
-    </summary>
+        Gets fill properties.
+        
+        Returns:
+            FillFormat: Fill format object (may be null).
         """
         GetDllLibPpt().IShape_get_Fill.argtypes=[c_void_p]
         GetDllLibPpt().IShape_get_Fill.restype=c_void_p
@@ -162,10 +160,10 @@ class IShape (SpireObject) :
 
     def Click(self)->'ClickHyperlink':
         """
-    <summary>
-        Gets or sets the hyperlink defined for mouse click.
-            Read/write <see cref="T:Spire.Presentation.ClickHyperlink" />.
-    </summary>
+        Gets or sets mouse click hyperlink.
+        
+        Returns:
+            ClickHyperlink: Hyperlink for click action.
         """
         GetDllLibPpt().IShape_get_Click.argtypes=[c_void_p]
         GetDllLibPpt().IShape_get_Click.restype=c_void_p
@@ -176,6 +174,12 @@ class IShape (SpireObject) :
 
     @Click.setter
     def Click(self, value:'ClickHyperlink'):
+        """
+        Sets mouse click hyperlink.
+        
+        Args:
+            value (ClickHyperlink): New click hyperlink.
+        """
         GetDllLibPpt().IShape_set_Click.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibPpt().IShape_set_Click,self.Ptr, value.Ptr)
 
@@ -183,10 +187,10 @@ class IShape (SpireObject) :
 
     def MouseOver(self)->'ClickHyperlink':
         """
-    <summary>
-        Gets or sets the hyperlink defined for mouse over.
-            Read/write <see cref="T:Spire.Presentation.ClickHyperlink" />.
-    </summary>
+        Gets or sets mouse over hyperlink.
+        
+        Returns:
+            ClickHyperlink: Hyperlink for mouseover action.
         """
         GetDllLibPpt().IShape_get_MouseOver.argtypes=[c_void_p]
         GetDllLibPpt().IShape_get_MouseOver.restype=c_void_p
@@ -197,16 +201,22 @@ class IShape (SpireObject) :
 
     @MouseOver.setter
     def MouseOver(self, value:'ClickHyperlink'):
+        """
+        Sets mouse over hyperlink.
+        
+        Args:
+            value (ClickHyperlink): New mouseover hyperlink.
+        """
         GetDllLibPpt().IShape_set_MouseOver.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibPpt().IShape_set_MouseOver,self.Ptr, value.Ptr)
 
     @property
     def IsHidden(self)->bool:
         """
-    <summary>
         Indicates whether the shape is hidden.
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+        
+        Returns:
+            bool: True if hidden, False otherwise.
         """
         GetDllLibPpt().IShape_get_IsHidden.argtypes=[c_void_p]
         GetDllLibPpt().IShape_get_IsHidden.restype=c_bool
@@ -215,6 +225,12 @@ class IShape (SpireObject) :
 
     @IsHidden.setter
     def IsHidden(self, value:bool):
+        """
+        Sets shape visibility.
+        
+        Args:
+            value (bool): True to hide, False to show.
+        """
         GetDllLibPpt().IShape_set_IsHidden.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibPpt().IShape_set_IsHidden,self.Ptr, value)
 
@@ -222,10 +238,8 @@ class IShape (SpireObject) :
 
     def Parent(self)->'ActiveSlide':
         """
-    <summary>
         Gets the parent slide of a shape.
-            Read-only <see cref="T:Spire.Presentation.ActiveSlide" />.
-    </summary>
+           
         """
         from spire.presentation import ActiveSlide
         GetDllLibPpt().IShape_get_Parent.argtypes=[c_void_p]
@@ -238,12 +252,10 @@ class IShape (SpireObject) :
     @property
     def ZOrderPosition(self)->int:
         """
-    <summary>
-        Gets or sets the position of a shape in the z-order.
-            Shapes[0] returns the shape at the back of the z-order,
-            and Shapes[Shapes.Count - 1] returns the shape at the front of the z-order.
-            Read/Write <see cref="T:System.Int32" />.
-    </summary>
+        Gets or sets z-order position.
+        
+        Returns:
+            int: Position in z-order stack.
         """
         GetDllLibPpt().IShape_get_ZOrderPosition.argtypes=[c_void_p]
         GetDllLibPpt().IShape_get_ZOrderPosition.restype=c_int
@@ -252,18 +264,22 @@ class IShape (SpireObject) :
 
     @ZOrderPosition.setter
     def ZOrderPosition(self, value:int):
+        """
+        Sets z-order position.
+        
+        Args:
+            value (int): New z-order position.
+        """
         GetDllLibPpt().IShape_set_ZOrderPosition.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().IShape_set_ZOrderPosition,self.Ptr, value)
 
     @property
     def Rotation(self)->float:
         """
-    <summary>
-        Gets or sets the number of degrees the specified shape is rotated around
-            the z-axis. A positive value indicates clockwise rotation; a negative value
-            indicates counterclockwise rotation.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets rotation angle.
+        
+        Returns:
+            float: Rotation in degrees (positive = clockwise).
         """
         GetDllLibPpt().IShape_get_Rotation.argtypes=[c_void_p]
         GetDllLibPpt().IShape_get_Rotation.restype=c_float
@@ -272,16 +288,22 @@ class IShape (SpireObject) :
 
     @Rotation.setter
     def Rotation(self, value:float):
+        """
+        Sets rotation angle.
+        
+        Args:
+            value (float): New rotation in degrees.
+        """
         GetDllLibPpt().IShape_set_Rotation.argtypes=[c_void_p, c_float]
         CallCFunction(GetDllLibPpt().IShape_set_Rotation,self.Ptr, value)
 
     @property
     def Left(self)->float:
         """
-    <summary>
-        Gets or sets the x-coordinate of the upper-left corner of the shape.
-            Read/write <see cref="T:System.Int32" />.
-    </summary>
+        Gets or sets horizontal position.
+        
+        Returns:
+            float: X-coordinate of upper-left corner.
         """
         GetDllLibPpt().IShape_get_Left.argtypes=[c_void_p]
         GetDllLibPpt().IShape_get_Left.restype=c_float
@@ -290,16 +312,22 @@ class IShape (SpireObject) :
 
     @Left.setter
     def Left(self, value:float):
+        """
+        Sets horizontal position.
+        
+        Args:
+            value (float): New left position.
+        """
         GetDllLibPpt().IShape_set_Left.argtypes=[c_void_p, c_float]
         CallCFunction(GetDllLibPpt().IShape_set_Left,self.Ptr, value)
 
     @property
     def Top(self)->float:
         """
-    <summary>
-        Gets or sets the y-coordinate of the upper-left corner of the shape.
-            Read/write <see cref="T:System.Int32" />.
-    </summary>
+        Gets or sets vertical position.
+        
+        Returns:
+            float: Y-coordinate of upper-left corner.
         """
         GetDllLibPpt().IShape_get_Top.argtypes=[c_void_p]
         GetDllLibPpt().IShape_get_Top.restype=c_float
@@ -308,16 +336,22 @@ class IShape (SpireObject) :
 
     @Top.setter
     def Top(self, value:float):
+        """
+        Sets vertical position.
+        
+        Args:
+            value (float): New top position.
+        """
         GetDllLibPpt().IShape_set_Top.argtypes=[c_void_p, c_float]
         CallCFunction(GetDllLibPpt().IShape_set_Top,self.Ptr, value)
 
     @property
     def Width(self)->float:
         """
-    <summary>
-        Gets or sets the width of the shape.
-            Read/write <see cref="T:System.Int32" />.
-    </summary>
+        Gets or sets object width.
+        
+        Returns:
+            float: Width of the OLE object.
         """
         GetDllLibPpt().IShape_get_Width.argtypes=[c_void_p]
         GetDllLibPpt().IShape_get_Width.restype=c_float
@@ -326,16 +360,22 @@ class IShape (SpireObject) :
 
     @Width.setter
     def Width(self, value:float):
+        """
+        Sets object width.
+        
+        Args:
+            value (float): New width value.
+        """
         GetDllLibPpt().IShape_set_Width.argtypes=[c_void_p, c_float]
         CallCFunction(GetDllLibPpt().IShape_set_Width,self.Ptr, value)
 
     @property
     def Height(self)->float:
         """
-    <summary>
-        Gets or sets the height of the shape.
-            Read/write <see cref="T:System.Int32" />.
-    </summary>
+        Gets or sets object height.
+        
+        Returns:
+            float: Height of the OLE object.
         """
         GetDllLibPpt().IShape_get_Height.argtypes=[c_void_p]
         GetDllLibPpt().IShape_get_Height.restype=c_float
@@ -344,6 +384,12 @@ class IShape (SpireObject) :
 
     @Height.setter
     def Height(self, value:float):
+        """
+        Sets object height.
+        
+        Args:
+            value (float): New height value.
+        """
         GetDllLibPpt().IShape_set_Height.argtypes=[c_void_p, c_float]
         CallCFunction(GetDllLibPpt().IShape_set_Height,self.Ptr, value)
 
@@ -351,10 +397,10 @@ class IShape (SpireObject) :
 
     def AlternativeText(self)->str:
         """
-    <summary>
-        Gets or sets the alternative text associated with a shape.
-            Read/write <see cref="T:System.String" />.
-    </summary>
+        Gets or sets alternative text.
+        
+        Returns:
+            str: Alternative text description.
         """
         GetDllLibPpt().IShape_get_AlternativeText.argtypes=[c_void_p]
         GetDllLibPpt().IShape_get_AlternativeText.restype=c_void_p
@@ -364,6 +410,12 @@ class IShape (SpireObject) :
 
     @AlternativeText.setter
     def AlternativeText(self, value:str):
+        """
+        Sets alternative text.
+        
+        Args:
+            value (str): New alternative text.
+        """
         valuePtr = StrToPtr(value)
         GetDllLibPpt().IShape_set_AlternativeText.argtypes=[c_void_p, c_char_p]
         CallCFunction(GetDllLibPpt().IShape_set_AlternativeText,self.Ptr,valuePtr)
@@ -372,9 +424,8 @@ class IShape (SpireObject) :
 
     def AlternativeTitle(self)->str:
         """
-    <summary>
         Gets or sets the alternative title associated with a shape.
-            Read/write <see cref="T:System.String" /></summary>
+           
         """
         GetDllLibPpt().IShape_get_AlternativeTitle.argtypes=[c_void_p]
         GetDllLibPpt().IShape_get_AlternativeTitle.restype=c_void_p
@@ -392,10 +443,10 @@ class IShape (SpireObject) :
 
     def Name(self)->str:
         """
-    <summary>
-        Gets or sets the name of a shape.
-            Read/write <see cref="T:System.String" />.
-    </summary>
+        Gets or sets shape name.
+        
+        Returns:
+            str: Name of the shape.
         """
         GetDllLibPpt().IShape_get_Name.argtypes=[c_void_p]
         GetDllLibPpt().IShape_get_Name.restype=c_void_p
@@ -405,6 +456,12 @@ class IShape (SpireObject) :
 
     @Name.setter
     def Name(self, value:str):
+        """
+        Sets shape name.
+        
+        Args:
+            value (str): New shape name.
+        """
         valuePtr = StrToPtr(value)
         GetDllLibPpt().IShape_set_Name.argtypes=[c_void_p, c_char_p]
         CallCFunction(GetDllLibPpt().IShape_set_Name,self.Ptr,valuePtr)
@@ -413,10 +470,10 @@ class IShape (SpireObject) :
 
     def Slide(self)->'ActiveSlide':
         """
-    <summary>
-        Gets the parent slide of a shape.
-            Read-only <see cref="T:Spire.Presentation.ActiveSlide" />.
-    </summary>
+        Gets parent slide.
+        
+        Returns:
+            ActiveSlide: Read-only parent slide.
         """
         from spire.presentation import ActiveSlide
         GetDllLibPpt().IShape_get_Slide.argtypes=[c_void_p]
@@ -429,9 +486,7 @@ class IShape (SpireObject) :
     @property
 
     def Presentation(self)->'Presentation':
-        """
-
-        """
+        """Gets parent presentation."""
         from spire.presentation import Presentation
         GetDllLibPpt().IShape_get_Presentation.argtypes=[c_void_p]
         GetDllLibPpt().IShape_get_Presentation.restype=c_void_p
@@ -441,19 +496,14 @@ class IShape (SpireObject) :
 
 
     def RemovePlaceholder(self):
-        """
-    <summary>
-        Removes placeholder from the shape.
-    </summary>
-        """
+        """Removes placeholder properties from the shape."""
         GetDllLibPpt().IShape_RemovePlaceholder.argtypes=[c_void_p]
         CallCFunction(GetDllLibPpt().IShape_RemovePlaceholder,self.Ptr)
 
     def Dispose(self):
         """
-    <summary>
         Dispose object and free resources.
-    </summary>
+    
         """
         GetDllLibPpt().IShape_Dispose.argtypes=[c_void_p]
         CallCFunction(GetDllLibPpt().IShape_Dispose,self.Ptr)
@@ -461,9 +511,8 @@ class IShape (SpireObject) :
 
     def SetShapeAlignment(self ,shapeAlignment:'ShapeAlignment'):
         """
-    <summary>
         Sets the alignment with a shape.
-    </summary>
+    
         """
         enumshapeAlignment:c_int = shapeAlignment.value
 
@@ -473,9 +522,8 @@ class IShape (SpireObject) :
 
     def SetShapeArrange(self ,shapeArrange:'ShapeArrange'):
         """
-    <summary>
         Sets the arrangement with a shape.
-    </summary>
+    
         """
         enumshapeArrange:c_int = shapeArrange.value
 
@@ -485,10 +533,9 @@ class IShape (SpireObject) :
 
     def InsertVideo(self ,filepath:str):
         """
-    <summary>
         Insert a video into placeholder shape.
-    </summary>
-    <param name="filepath">Video file path</param>
+        Args:
+            filepath:Video file path.
         """
         
         filepathPtr = StrToPtr(filepath)
@@ -498,10 +545,9 @@ class IShape (SpireObject) :
 
     def InsertSmartArt(self ,smartArtLayoutType:'SmartArtLayoutType'):
         """
-    <summary>
         Insert a smartArt into placeholder shape.
-    </summary>
-    <param name="type">smartArt Type</param>
+        Args:
+            type:smartArt Type.
         """
         enumsmartArtLayoutType:c_int = smartArtLayoutType.value
 
@@ -511,10 +557,9 @@ class IShape (SpireObject) :
 
     def InsertChart(self ,type:'ChartType'):
         """
-    <summary>
         Insert a chart into placeholder shape.
-    </summary>
-    <param name="type">Chart Type</param>
+        Args:
+            type:Chart Type.
         """
         enumtype:c_int = type.value
 
@@ -524,13 +569,11 @@ class IShape (SpireObject) :
 
     def InsertTable(self ,tableColumnCount:int,tableRowCount:int):
         """
-    <summary>
         Insert a table into placeholder shape.
-    </summary>
-    <param name="tableColumnCount">Tablecolumn count</param>
-    <param name="tableRowCount">Tablerow count</param>
+        Args:
+            tableColumnCount:Tablecolumn count.
+            tableRowCount:Tablerow count.
         """
-        
         GetDllLibPpt().IShape_InsertTable.argtypes=[c_void_p ,c_int,c_int]
         CallCFunction(GetDllLibPpt().IShape_InsertTable,self.Ptr, tableColumnCount,tableRowCount)
 
@@ -538,10 +581,9 @@ class IShape (SpireObject) :
 
     def InsertPicture(self ,stream:Stream):
         """
-    <summary>
         Insert a picture into placeholder shape from stream.
-    </summary>
-    <param name="stream">the picture stream</param>
+        Args:
+            stream:the picture stream.
         """
         intPtrstream:c_void_p = stream.Ptr
 
@@ -552,10 +594,9 @@ class IShape (SpireObject) :
 
     def InsertPicture(self ,filepath:str):
         """
-    <summary>
         Insert a picture into placeholder shape.
-    </summary>
-    <param name="filepath">Picture file path</param>
+        Args:
+            filepath:Picture file path.
         """
         
         filepathPtr = StrToPtr(filepath)
@@ -566,7 +607,7 @@ class IShape (SpireObject) :
 
     def Id(self)->'int':
         """
-
+        the identity number of shape.
         """
         GetDllLibPpt().IShape_get_Id.argtypes=[c_void_p]
         GetDllLibPpt().IShape_get_Id.restype=c_int
@@ -578,9 +619,10 @@ class IShape (SpireObject) :
 
     def ReplaceTextWithRegex(self ,regex:'Regex',newValue:str):
         """
-    <summary>
-        Replace text in shape with regex.
-    </summary>
+        Replaces text in the shape using regular expression matching.
+        Args:
+            regex: Regex object defining match pattern
+            newValue: Replacement text
         """
         intPtrregex:c_void_p = regex.Ptr
 
@@ -592,10 +634,9 @@ class IShape (SpireObject) :
 
     def SaveAsImage(self)->'Stream':
         """
-    <summary>
-        Save shape to Image.
-    </summary>
-    <returns></returns>
+        Renders the shape as an image stream.
+        Returns:
+            Stream: Image data stream.
         """
         GetDllLibPpt().IShape_SaveAsImage.argtypes=[c_void_p]
         GetDllLibPpt().IShape_SaveAsImage.restype=c_void_p
@@ -606,10 +647,9 @@ class IShape (SpireObject) :
 
     def SaveAsSvg(self)->'Stream':
         """
-    <summary>
         Save the shape to SVG format.
-    </summary>
-    <returns>A byte array of SVG file-stream.</returns>
+        returns:
+                A byte array of SVG file-stream.
         """
         GetDllLibPpt().IShape_SaveAsSvg.argtypes=[c_void_p]
         GetDllLibPpt().IShape_SaveAsSvg.restype=c_void_p
@@ -619,10 +659,9 @@ class IShape (SpireObject) :
 
     def SaveAsSvgInSlide(self)->'Stream':
         """
-    <summary>
         Save the shape to SVG format.
-    </summary>
-    <returns>A byte array of SVG file-stream.</returns>
+        returns:
+                A byte array of SVG file-stream.
         """
         GetDllLibPpt().IShape_SaveAsSvgInSlide.argtypes=[c_void_p]
         GetDllLibPpt().IShape_SaveAsSvgInSlide.restype=c_void_p