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

spire/presentation/IAutoShape.py

@@ -6,17 +6,15 @@ from spire.presentation import *
 from ctypes import *
 
 class IAutoShape (IShape) :
-    """
+    """Represents an AutoShape in a presentation slide."""
 
-    """
     @property
-
     def Locking(self)->'ShapeLocking':
         """
-    <summary>
         Gets shape's locks.
-            Read-only <see cref="P:Spire.Presentation.IAutoShape.Locking" />.
-    </summary>
+        
+        Returns:
+            ShapeLocking: Read-only shape locking settings.
         """
         GetDllLibPpt().IAutoShape_get_Locking.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_Locking.restype=c_void_p
@@ -29,10 +27,10 @@ class IAutoShape (IShape) :
 
     def TextFrame(self)->'ITextFrameProperties':
         """
-    <summary>
         Gets TextFrame object for the AutoShape.
-            Read-only <see cref="T:Spire.Presentation.TextFrameProperties" />.
-    </summary>
+        
+        Returns:
+            ITextFrameProperties: Read-only text frame properties.
         """
         GetDllLibPpt().IAutoShape_get_TextFrame.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_TextFrame.restype=c_void_p
@@ -44,10 +42,10 @@ class IAutoShape (IShape) :
     @property
     def UseBackgroundFill(self)->bool:
         """
-    <summary>
-        Indicates whether this autoshape should be filled with slide's background fill instead of specified by style or fill format.
-            Read/write bool.
-    </summary>
+        Indicates whether this autoshape should be filled with slide's background fill.
+        
+        Returns:
+            bool: True if using background fill, False otherwise.
         """
         GetDllLibPpt().IAutoShape_get_UseBackgroundFill.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_UseBackgroundFill.restype=c_bool
@@ -56,15 +54,19 @@ class IAutoShape (IShape) :
 
     @UseBackgroundFill.setter
     def UseBackgroundFill(self, value:bool):
+        """
+        Sets whether to use slide's background fill.
+        
+        Args:
+            value (bool): True to use background fill, False otherwise.
+        """
         GetDllLibPpt().IAutoShape_set_UseBackgroundFill.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibPpt().IAutoShape_set_UseBackgroundFill,self.Ptr, value)
 
     @property
 
     def ShapeStyle(self)->'ShapeStyle':
-        """
-
-        """
+        """Gets the shape style object."""
         GetDllLibPpt().IAutoShape_get_ShapeStyle.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_ShapeStyle.restype=c_void_p
         intPtr = CallCFunction(GetDllLibPpt().IAutoShape_get_ShapeStyle,self.Ptr)
@@ -75,9 +77,7 @@ class IAutoShape (IShape) :
     @property
 
     def ShapeType(self)->'ShapeType':
-        """
-
-        """
+        """Gets the type of the shape."""
         GetDllLibPpt().IAutoShape_get_ShapeType.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_ShapeType.restype=c_int
         ret = CallCFunction(GetDllLibPpt().IAutoShape_get_ShapeType,self.Ptr)
@@ -86,15 +86,19 @@ class IAutoShape (IShape) :
 
     @ShapeType.setter
     def ShapeType(self, value:'ShapeType'):
+        """
+        Sets the type of the shape.
+        
+        Args:
+            value (ShapeType): New shape type.
+        """
         GetDllLibPpt().IAutoShape_set_ShapeType.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().IAutoShape_set_ShapeType,self.Ptr, value.value)
 
     @property
 
     def Adjustments(self)->'ShapeAdjustCollection':
-        """
-
-        """
+        """Gets shape adjustment values collection."""
         GetDllLibPpt().IAutoShape_get_Adjustments.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_Adjustments.restype=c_void_p
         intPtr = CallCFunction(GetDllLibPpt().IAutoShape_get_Adjustments,self.Ptr)
@@ -105,10 +109,10 @@ class IAutoShape (IShape) :
     @property
     def IsPlaceholder(self)->bool:
         """
-    <summary>
         Indicates whether the shape is Placeholder.
-            Read-only <see cref="T:System.Boolean" />.
-    </summary>
+        
+        Returns:
+            bool: True if placeholder, False otherwise.
         """
         GetDllLibPpt().IAutoShape_get_IsPlaceholder.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_IsPlaceholder.restype=c_bool
@@ -118,10 +122,10 @@ class IAutoShape (IShape) :
     @property
     def IsTextBox(self)->bool:
         """
-    <summary>
         Indicates whether the shape is TextBox.
-            Read-only <see cref="T:System.Boolean" />.
-    </summary>
+        
+        Returns:
+            bool: True if text box, False otherwise.
         """
         GetDllLibPpt().IAutoShape_get_IsTextBox.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_IsTextBox.restype=c_bool
@@ -132,10 +136,10 @@ class IAutoShape (IShape) :
 
     def Placeholder(self)->'Placeholder':
         """
-    <summary>
         Gets the placeholder for a shape.
-            Read-only <see cref="P:Spire.Presentation.IAutoShape.Placeholder" />.
-    </summary>
+        
+        Returns:
+            Placeholder: Read-only placeholder object.
         """
         GetDllLibPpt().IAutoShape_get_Placeholder.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_Placeholder.restype=c_void_p
@@ -148,10 +152,10 @@ class IAutoShape (IShape) :
 
     def TagsList(self)->'TagCollection':
         """
-    <summary>
         Gets the shape's tags collection.
-            Read-only <see cref="T:Spire.Presentation.Collections.TagCollection" />.
-    </summary>
+        
+        Returns:
+            TagCollection: Read-only tag collection.
         """
         GetDllLibPpt().IAutoShape_get_TagsList.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_TagsList.restype=c_void_p
@@ -164,10 +168,10 @@ class IAutoShape (IShape) :
 
     def Frame(self)->'GraphicFrame':
         """
-    <summary>
         Gets or sets the shape frame's properties.
-            Read/write <see cref="T:Spire.Presentation.Drawing.GraphicFrame" />.
-    </summary>
+        
+        Returns:
+            GraphicFrame: Frame properties object.
         """
         GetDllLibPpt().IAutoShape_get_Frame.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_Frame.restype=c_void_p
@@ -178,6 +182,12 @@ class IAutoShape (IShape) :
 
     @Frame.setter
     def Frame(self, value:'GraphicFrame'):
+        """
+        Sets the shape frame's properties.
+        
+        Args:
+            value (GraphicFrame): New frame properties.
+        """
         GetDllLibPpt().IAutoShape_set_Frame.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibPpt().IAutoShape_set_Frame,self.Ptr, value.Ptr)
 
@@ -185,10 +195,10 @@ class IAutoShape (IShape) :
 
     def Line(self)->'TextLineFormat':
         """
-    <summary>
-        Gets the LineFormat object that contains line formatting properties for a shape.
-            Read-only <see cref="P:Spire.Presentation.IAutoShape.Line" />.
-    </summary>
+        Gets line formatting properties.
+        
+        Returns:
+            TextLineFormat: Read-only line format object.
         """
         GetDllLibPpt().IAutoShape_get_Line.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_Line.restype=c_void_p
@@ -201,10 +211,10 @@ class IAutoShape (IShape) :
 
     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" />.
-    </summary>
+        Gets 3D effect properties.
+        
+        Returns:
+            FormatThreeD: Read-only 3D format object.
         """
         GetDllLibPpt().IAutoShape_get_ThreeD.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_ThreeD.restype=c_void_p
@@ -217,11 +227,10 @@ class IAutoShape (IShape) :
 
     def EffectDag(self)->'EffectDag':
         """
-    <summary>
-        Gets the EffectFormat object which contains pixel effects applied to a shape.
-            Read-only <see cref="P:Spire.Presentation.IAutoShape.EffectDag" />
-            Note: can return null for certain types of shapes which don't have effect properties.
-    </summary>
+        Gets pixel effects applied to a shape.
+        
+        Returns:
+            EffectDag: Read-only effect object (may be null).
         """
         GetDllLibPpt().IAutoShape_get_EffectDag.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_EffectDag.restype=c_void_p
@@ -234,10 +243,10 @@ class IAutoShape (IShape) :
 
     def Fill(self)->'FillFormat':
         """
-    <summary>
-        Gets the FillFormat object that contains fill formatting properties for a shape.
-            Read-only <see cref="P:Spire.Presentation.IAutoShape.Fill" />.
-    </summary>
+        Gets fill formatting properties.
+        
+        Returns:
+            FillFormat: Read-only fill format object.
         """
         GetDllLibPpt().IAutoShape_get_Fill.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_Fill.restype=c_void_p
@@ -250,10 +259,10 @@ class IAutoShape (IShape) :
 
     def Click(self)->'ClickHyperlink':
         """
-    <summary>
         Gets or sets the hyperlink defined for mouse click.
-            Read/write <see cref="T:Spire.Presentation.ClickHyperlink" />.
-    </summary>
+        
+        Returns:
+            ClickHyperlink: Hyperlink for click action.
         """
         GetDllLibPpt().IAutoShape_get_Click.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_Click.restype=c_void_p
@@ -264,6 +273,12 @@ class IAutoShape (IShape) :
 
     @Click.setter
     def Click(self, value:'ClickHyperlink'):
+        """
+        Sets the hyperlink for mouse click.
+        
+        Args:
+            value (ClickHyperlink): New click hyperlink.
+        """
         GetDllLibPpt().IAutoShape_set_Click.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibPpt().IAutoShape_set_Click,self.Ptr, value.Ptr)
 
@@ -271,10 +286,10 @@ class IAutoShape (IShape) :
 
     def MouseOver(self)->'ClickHyperlink':
         """
-    <summary>
         Gets or sets the hyperlink defined for mouse over.
-            Read/write <see cref="T:Spire.Presentation.ClickHyperlink" />.
-    </summary>
+        
+        Returns:
+            ClickHyperlink: Hyperlink for mouseover action.
         """
         GetDllLibPpt().IAutoShape_get_MouseOver.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_MouseOver.restype=c_void_p
@@ -285,16 +300,22 @@ class IAutoShape (IShape) :
 
     @MouseOver.setter
     def MouseOver(self, value:'ClickHyperlink'):
+        """
+        Sets the hyperlink for mouse over.
+        
+        Args:
+            value (ClickHyperlink): New mouseover hyperlink.
+        """
         GetDllLibPpt().IAutoShape_set_MouseOver.argtypes=[c_void_p, c_void_p]
         CallCFunction(GetDllLibPpt().IAutoShape_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().IAutoShape_get_IsHidden.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_IsHidden.restype=c_bool
@@ -303,6 +324,12 @@ class IAutoShape (IShape) :
 
     @IsHidden.setter
     def IsHidden(self, value:bool):
+        """
+        Sets whether the shape is hidden.
+        
+        Args:
+            value (bool): True to hide, False to show.
+        """
         GetDllLibPpt().IAutoShape_set_IsHidden.argtypes=[c_void_p, c_bool]
         CallCFunction(GetDllLibPpt().IAutoShape_set_IsHidden,self.Ptr, value)
 
@@ -310,10 +337,10 @@ class IAutoShape (IShape) :
 
     def Parent(self)->'ActiveSlide':
         """
-    <summary>
         Gets the parent slide of a shape.
-            Read-only <see cref="T:Spire.Presentation.ActiveSlide" />.
-    </summary>
+        
+        Returns:
+            ActiveSlide: Read-only parent slide.
         """
         GetDllLibPpt().IAutoShape_get_Parent.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_Parent.restype=c_void_p
@@ -325,10 +352,10 @@ class IAutoShape (IShape) :
     @property
     def ZOrderPosition(self)->int:
         """
-    <summary>
-        Gets or sets the position of a shape in the z-order.
-            Read/Write <see cref="T:System.Int32" />.
-    </summary>
+        Gets or sets the position in z-order.
+        
+        Returns:
+            int: Z-order position index.
         """
         GetDllLibPpt().IAutoShape_get_ZOrderPosition.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_ZOrderPosition.restype=c_int
@@ -337,16 +364,22 @@ class IAutoShape (IShape) :
 
     @ZOrderPosition.setter
     def ZOrderPosition(self, value:int):
+        """
+        Sets z-order position.
+        
+        Args:
+            value (int): New z-order position.
+        """
         GetDllLibPpt().IAutoShape_set_ZOrderPosition.argtypes=[c_void_p, c_int]
         CallCFunction(GetDllLibPpt().IAutoShape_set_ZOrderPosition,self.Ptr, value)
 
     @property
     def Rotation(self)->float:
         """
-    <summary>
-        Gets or sets the number of degrees the specified shape is rotated.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets rotation in degrees.
+        
+        Returns:
+            float: Rotation angle in degrees.
         """
         GetDllLibPpt().IAutoShape_get_Rotation.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_Rotation.restype=c_float
@@ -355,16 +388,22 @@ class IAutoShape (IShape) :
 
     @Rotation.setter
     def Rotation(self, value:float):
+        """
+        Sets rotation angle.
+        
+        Args:
+            value (float): New rotation in degrees.
+        """
         GetDllLibPpt().IAutoShape_set_Rotation.argtypes=[c_void_p, c_float]
         CallCFunction(GetDllLibPpt().IAutoShape_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 x-coordinate of upper-left corner.
+        
+        Returns:
+            float: X-coordinate position.
         """
         GetDllLibPpt().IAutoShape_get_Left.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_Left.restype=c_float
@@ -373,16 +412,22 @@ class IAutoShape (IShape) :
 
     @Left.setter
     def Left(self, value:float):
+        """
+        Sets horizontal position.
+        
+        Args:
+            value (float): New left position.
+        """
         GetDllLibPpt().IAutoShape_set_Left.argtypes=[c_void_p, c_float]
         CallCFunction(GetDllLibPpt().IAutoShape_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 y-coordinate of upper-left corner.
+        
+        Returns:
+            float: Y-coordinate position.
         """
         GetDllLibPpt().IAutoShape_get_Top.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_Top.restype=c_float
@@ -391,16 +436,22 @@ class IAutoShape (IShape) :
 
     @Top.setter
     def Top(self, value:float):
+        """
+        Sets vertical position.
+        
+        Args:
+            value (float): New top position.
+        """
         GetDllLibPpt().IAutoShape_set_Top.argtypes=[c_void_p, c_float]
         CallCFunction(GetDllLibPpt().IAutoShape_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 shape width.
+        
+        Returns:
+            float: Width of the shape.
         """
         GetDllLibPpt().IAutoShape_get_Width.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_Width.restype=c_float
@@ -415,10 +466,10 @@ class IAutoShape (IShape) :
     @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 shape height.
+        
+        Returns:
+            float: Height of the shape.
         """
         GetDllLibPpt().IAutoShape_get_Height.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_Height.restype=c_float
@@ -427,6 +478,12 @@ class IAutoShape (IShape) :
 
     @Height.setter
     def Height(self, value:float):
+        """
+        Sets shape height.
+        
+        Args:
+            value (float): New height value.
+        """
         GetDllLibPpt().IAutoShape_set_Height.argtypes=[c_void_p, c_float]
         CallCFunction(GetDllLibPpt().IAutoShape_set_Height,self.Ptr, value)
 
@@ -434,10 +491,10 @@ class IAutoShape (IShape) :
 
     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 string.
         """
         GetDllLibPpt().IAutoShape_get_AlternativeText.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_AlternativeText.restype=c_void_p
@@ -447,6 +504,12 @@ class IAutoShape (IShape) :
 
     @AlternativeText.setter
     def AlternativeText(self, value:str):
+        """
+        Sets alternative text.
+        
+        Args:
+            value (str): New alternative text.
+        """
         valuePtr = StrToPtr(value)
         GetDllLibPpt().IAutoShape_set_AlternativeText.argtypes=[c_void_p, c_char_p]
         CallCFunction(GetDllLibPpt().IAutoShape_set_AlternativeText,self.Ptr,valuePtr)
@@ -455,10 +518,10 @@ class IAutoShape (IShape) :
 
     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().IAutoShape_get_Name.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_Name.restype=c_void_p
@@ -468,6 +531,12 @@ class IAutoShape (IShape) :
 
     @Name.setter
     def Name(self, value:str):
+        """
+        Sets shape name.
+        
+        Args:
+            value (str): New shape name.
+        """
         valuePtr = StrToPtr(value)
         GetDllLibPpt().IAutoShape_set_Name.argtypes=[c_void_p, c_char_p]
         CallCFunction(GetDllLibPpt().IAutoShape_set_Name,self.Ptr,valuePtr)
@@ -476,10 +545,10 @@ class IAutoShape (IShape) :
 
     def Slide(self)->'ActiveSlide':
         """
-    <summary>
-        Gets the parent slide of a shape.
-            Read-only <see cref="T:Spire.Presentation.ActiveSlide" />.
-    </summary>
+        Gets the parent slide.
+        
+        Returns:
+            ActiveSlide: Read-only parent slide.
         """
         from spire.presentation import ActiveSlide
         GetDllLibPpt().IAutoShape_get_Slide.argtypes=[c_void_p]
@@ -492,9 +561,7 @@ class IAutoShape (IShape) :
     @property
 
     def Presentation(self)->'Presentation':
-        """
-
-        """
+        """Gets parent presentation object."""
         from spire.presentation import Presentation
         GetDllLibPpt().IAutoShape_get_Presentation.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_Presentation.restype=c_void_p
@@ -506,9 +573,10 @@ class IAutoShape (IShape) :
     @property
     def ContainMathEquation(self)->bool:
         """
-    <summary>
-        if shape contains math equation.
-    </summary>
+        Checks if shape contains math equation.
+        
+        Returns:
+            bool: True if contains equation, False otherwise.
         """
         GetDllLibPpt().IAutoShape_get_ContainMathEquation.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_ContainMathEquation.restype=c_bool
@@ -518,11 +586,10 @@ class IAutoShape (IShape) :
 
     def AppendTextFrame(self ,text:str):
         """
-    <summary>
-        Adds a new TextFrame to a shape.
-            If shape already has TextFrame then simply changes its text.
-    </summary>
-    <param name="text">Default text for a new TextFrame.</param>
+        Adds a new TextFrame or sets existing text.
+        
+        Args:
+            text (str): Text content for the text frame.
         """
         
         textPtr = StrToPtr(text)
@@ -530,27 +597,22 @@ class IAutoShape (IShape) :
         CallCFunction(GetDllLibPpt().IAutoShape_AppendTextFrame,self.Ptr,textPtr)
 
     def RemovePlaceholder(self):
-        """
-    <summary>
-        Removes placeholder from the shape.
-    </summary>
-        """
+        """Removes placeholder from the shape."""
         GetDllLibPpt().IAutoShape_RemovePlaceholder.argtypes=[c_void_p]
         CallCFunction(GetDllLibPpt().IAutoShape_RemovePlaceholder,self.Ptr)
 
     def Dispose(self):
-        """
-    <summary>
-        Dispose object and free resources.
-    </summary>
-        """
+        """Releases resources associated with the object."""
         GetDllLibPpt().IAutoShape_Dispose.argtypes=[c_void_p]
         CallCFunction(GetDllLibPpt().IAutoShape_Dispose,self.Ptr)
 
     @property
     def Points(self)->List['PointF']:
         """
-
+        Gets shape points.
+        
+        Returns:
+            List[PointF]: Collection of shape points.
         """
         GetDllLibPpt().IAutoShape_get_Points.argtypes=[c_void_p]
         GetDllLibPpt().IAutoShape_get_Points.restype=IntPtrArray