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

spire/presentation/Shape.py

@@ -8,18 +8,18 @@ import abc
 
 class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
     """
-    <summary>
-         Represents a shape on a slide.
-    </summary>
+    Represents a shape on a slide. Provides properties and methods to manipulate 
+    visual elements within presentation slides, including positioning, formatting, 
+    and content insertion capabilities.
     """
     @property
 
     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 containing this shape.
+        
+        Returns:
+            ActiveSlide: Parent slide object.
         """
         from spire.presentation import ActiveSlide
         GetDllLibPpt().Shape_get_Slide.argtypes=[c_void_p]
@@ -33,7 +33,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
 
     def Presentation(self)->'Presentation':
         """
-
+        Gets the parent presentation containing this shape.
+        
+        Returns:
+            Presentation: Parent presentation object.
         """
         GetDllLibPpt().Shape_get_Presentation.argtypes=[c_void_p]
         GetDllLibPpt().Shape_get_Presentation.restype=c_void_p
@@ -58,10 +61,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
 
     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().Shape_SaveAsImage.argtypes=[c_void_p]
         GetDllLibPpt().Shape_SaveAsImage.restype=c_void_p
@@ -73,7 +76,13 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
-
+        Determines if this shape equals another object.
+        
+        Args:
+            obj: Object to compare with.
+            
+        Returns:
+            bool: True if objects are equal, False otherwise.
         """
         intPtrobj:c_void_p = obj.Ptr
 
@@ -85,10 +94,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
     @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().Shape_get_IsPlaceholder.argtypes=[c_void_p]
         GetDllLibPpt().Shape_get_IsPlaceholder.restype=c_bool
@@ -98,10 +107,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
     @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().Shape_get_IsTextBox.argtypes=[c_void_p]
         GetDllLibPpt().Shape_get_IsTextBox.restype=c_bool
@@ -112,10 +121,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
 
     def Placeholder(self)->'Placeholder':
         """
-    <summary>
-        Gets the placeholder for a shape.
-            Read-only <see cref="P:Spire.Presentation.Shape.Placeholder" />.
-    </summary>
+        Gets placeholder properties if shape is a placeholder.
+        
+        Returns:
+            Placeholder: Placeholder object or None.
         """
         GetDllLibPpt().Shape_get_Placeholder.argtypes=[c_void_p]
         GetDllLibPpt().Shape_get_Placeholder.restype=c_void_p
@@ -126,9 +135,7 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
 
     def RemovePlaceholder(self):
         """
-    <summary>
-        Removes placeholder from the shape.
-    </summary>
+        Converts placeholder shape to regular shape by removing placeholder properties.
         """
         GetDllLibPpt().Shape_RemovePlaceholder.argtypes=[c_void_p]
         CallCFunction(GetDllLibPpt().Shape_RemovePlaceholder,self.Ptr)
@@ -136,10 +143,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
 
     def InsertVideo(self ,filepath:str):
         """
-    <summary>
-        Insert a video into placeholder shape.
-    </summary>
-    <param name="filepath">Video file path</param>
+        Inserts video content into placeholder shape.
+        
+        Args:
+            filepath: Path to video file.
         """
         
         filepathPtr = StrToPtr(filepath)
@@ -149,10 +156,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
 
     def InsertSmartArt(self ,smartArtLayoutType:'SmartArtLayoutType'):
         """
-    <summary>
-        Insert a smartArt into placeholder shape.
-    </summary>
-    <param name="type">smartArt Type</param>
+        Inserts SmartArt diagram into placeholder shape.
+        
+        Args:
+            smartArtLayoutType: Type of SmartArt layout.
         """
         enumsmartArtLayoutType:c_int = smartArtLayoutType.value
 
@@ -162,10 +169,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
 
     def InsertChart(self ,type:'ChartType'):
         """
-    <summary>
-        Insert a chart into placeholder shape.
-    </summary>
-    <param name="type">Chart Type</param>
+        Inserts chart into placeholder shape.
+        
+        Args:
+            type: Type of chart to insert.
         """
         enumtype:c_int = type.value
 
@@ -175,11 +182,11 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
 
     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>
+        Inserts table into placeholder shape.
+        
+        Args:
+            tableColumnCount: Number of table columns.
+            tableRowCount: Number of table rows.
         """
         
         GetDllLibPpt().Shape_InsertTable.argtypes=[c_void_p ,c_int,c_int]
@@ -189,7 +196,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
 
     def InsertPicture(self ,stream:Stream):
         """
-
+        Inserts picture from stream into placeholder shape.
+        
+        Args:
+            stream: Image data stream.
         """
         intPtrstream:c_void_p = stream.Ptr
 
@@ -200,10 +210,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
 
     def InsertPicture(self ,filepath:str):
         """
-    <summary>
-        Insert a picture into placeholder shape.
-    </summary>
-    <param name="filepath">Picture file path</param>
+        Inserts picture from file into placeholder shape.
+        
+        Args:
+            filepath: Path to image file.
         """
         
         filepathPtr = StrToPtr(filepath)
@@ -214,10 +224,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
 
     def TagsList(self)->'TagCollection':
         """
-    <summary>
-        Gets the shape's tags collection.
-            Read-only <see cref="T:Spire.Presentation.Collections.TagCollection" />.
-    </summary>
+        Gets collection of metadata tags associated with shape.
+        
+        Returns:
+            TagCollection: Shape metadata tags.
         """
         GetDllLibPpt().Shape_get_TagsList.argtypes=[c_void_p]
         GetDllLibPpt().Shape_get_TagsList.restype=c_void_p
@@ -231,7 +241,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
     @property
     def DrawIndicatedShape(self)->bool:
         """
-
+        Gets/sets whether to display the shape indicator.
+        
+        Returns:
+            bool: True to show indicator, False to hide.
         """
         GetDllLibPpt().Shape_get_DrawIndicatedShape.argtypes=[c_void_p]
         GetDllLibPpt().Shape_get_DrawIndicatedShape.restype=c_bool
@@ -247,10 +260,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
 
     def Frame(self)->'GraphicFrame':
         """
-    <summary>
-        Gets or sets the shape frame's properties.
-            Read/write <see cref="T:Spire.Presentation.Drawing.GraphicFrame" />.
-    </summary>
+        Gets/sets positioning and sizing properties.
+        
+        Returns:
+            GraphicFrame: Position and size properties.
         """
         GetDllLibPpt().Shape_get_Frame.argtypes=[c_void_p]
         GetDllLibPpt().Shape_get_Frame.restype=c_void_p
@@ -268,10 +281,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, 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.Shape.Line" />.
-    </summary>
+        Gets line formatting properties.
+        
+        Returns:
+            TextLineFormat: Line style properties.
         """
         GetDllLibPpt().Shape_get_Line.argtypes=[c_void_p]
         GetDllLibPpt().Shape_get_Line.restype=c_void_p
@@ -284,10 +297,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
 
     def ThreeD(self)->'FormatThreeD':
         """
-    <summary>
-        Gets the FormatThreeD object that 3d effect properties for a shape.
-            Read-only <see cref="T:Spire.Presentation.Drawing.FormatThreeD" />.
-    </summary>
+        Gets 3D effect properties.
+        
+        Returns:
+            FormatThreeD: 3D formatting properties.
         """
         GetDllLibPpt().Shape_get_ThreeD.argtypes=[c_void_p]
         GetDllLibPpt().Shape_get_ThreeD.restype=c_void_p
@@ -300,9 +313,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
 
     def EffectDag(self)->'EffectDag':
         """
-    <summary>
-        Gets the EffectDag object which contains pixel effects applied to a shape.
-            Read-only <see cref="P:Spire.Presentation.Shape.EffectDag" /></summary>
+        Gets special visual effect properties.
+        
+        Returns:
+            EffectDag: Visual effects properties.
         """
         GetDllLibPpt().Shape_get_EffectDag.argtypes=[c_void_p]
         GetDllLibPpt().Shape_get_EffectDag.restype=c_void_p
@@ -315,11 +329,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, 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.Shape.Fill" />.
-            Note: can return null for certain types of shapes which don't have fill properties.
-    </summary>
+        Gets fill formatting properties.
+        
+        Returns:
+            FillFormat: Fill style properties.
         """
         GetDllLibPpt().Shape_get_Fill.argtypes=[c_void_p]
         GetDllLibPpt().Shape_get_Fill.restype=c_void_p
@@ -332,10 +345,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
 
     def Click(self)->'ClickHyperlink':
         """
-    <summary>
-        Gets or sets the hyperlink defined for mouse click.
-            Read/write <see cref="T:Spire.Presentation.ClickHyperlink" />.
-    </summary>
+        Gets/sets hyperlink for mouse click interaction.
+        
+        Returns:
+            ClickHyperlink: Click action hyperlink.
         """
         GetDllLibPpt().Shape_get_Click.argtypes=[c_void_p]
         GetDllLibPpt().Shape_get_Click.restype=c_void_p
@@ -353,10 +366,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
 
     def MouseOver(self)->'ClickHyperlink':
         """
-    <summary>
-        Gets or sets the hyperlink defined for mouse over.
-            Read/write <see cref="T:Spire.Presentation.ClickHyperlink" />.
-    </summary>
+        Gets/sets hyperlink for mouse hover interaction.
+        
+        Returns:
+            ClickHyperlink: Mouseover action hyperlink.
         """
         GetDllLibPpt().Shape_get_MouseOver.argtypes=[c_void_p]
         GetDllLibPpt().Shape_get_MouseOver.restype=c_void_p
@@ -373,10 +386,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
     @property
     def IsHidden(self)->bool:
         """
-    <summary>
-        Indicates whether the shape is hidden.
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+        Gets/sets shape visibility.
+        
+        Returns:
+            bool: True if hidden, False if visible.
         """
         GetDllLibPpt().Shape_get_IsHidden.argtypes=[c_void_p]
         GetDllLibPpt().Shape_get_IsHidden.restype=c_bool
@@ -392,10 +405,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
 
     def Parent(self)->'ActiveSlide':
         """
-    <summary>
-        Gets the parent slide of a shape.
-            Read-only <see cref="T:Spire.Presentation.ActiveSlide" />.
-    </summary>
+        Gets parent slide containing this shape.
+        
+        Returns:
+            ActiveSlide: Parent slide object.
         """
         GetDllLibPpt().Shape_get_Parent.argtypes=[c_void_p]
         GetDllLibPpt().Shape_get_Parent.restype=c_void_p
@@ -407,12 +420,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
     @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/sets stacking order position (0=back, highest=front).
+        
+        Returns:
+            int: Current z-order position.
         """
         GetDllLibPpt().Shape_get_ZOrderPosition.argtypes=[c_void_p]
         GetDllLibPpt().Shape_get_ZOrderPosition.restype=c_int
@@ -427,12 +438,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
     @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/sets rotation angle in degrees.
+        
+        Returns:
+            float: Current rotation angle.
         """
         GetDllLibPpt().Shape_get_Rotation.argtypes=[c_void_p]
         GetDllLibPpt().Shape_get_Rotation.restype=c_float
@@ -447,10 +456,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
     @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/sets horizontal position from left edge.
+        
+        Returns:
+            float: X-coordinate position.
         """
         GetDllLibPpt().Shape_get_Left.argtypes=[c_void_p]
         GetDllLibPpt().Shape_get_Left.restype=c_float
@@ -465,10 +474,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
     @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/sets vertical position from top edge.
+        
+        Returns:
+            float: Y-coordinate position.
         """
         GetDllLibPpt().Shape_get_Top.argtypes=[c_void_p]
         GetDllLibPpt().Shape_get_Top.restype=c_float
@@ -483,10 +492,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
     @property
     def Width(self)->float:
         """
-    <summary>
-        Gets or sets the width of the shape.
-            Read/write <see cref="T:System.Int32" />.
-    </summary>
+        Gets/sets shape width.
+        
+        Returns:
+            float: Current width.
         """
         GetDllLibPpt().Shape_get_Width.argtypes=[c_void_p]
         GetDllLibPpt().Shape_get_Width.restype=c_float
@@ -501,10 +510,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
     @property
     def Height(self)->float:
         """
-    <summary>
-        Gets or sets the height of the shape.
-            Read/write <see cref="T:System.Int32" />.
-    </summary>
+        Gets/sets shape height.
+        
+        Returns:
+            float: Current height.
         """
         GetDllLibPpt().Shape_get_Height.argtypes=[c_void_p]
         GetDllLibPpt().Shape_get_Height.restype=c_float
@@ -520,7 +529,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
 
     def Id(self)->'int':
         """
-
+        Gets unique identifier for shape.
+        
+        Returns:
+            int: Unique shape ID.
         """
         GetDllLibPpt().Shape_get_Id.argtypes=[c_void_p]
         GetDllLibPpt().Shape_get_Id.restype=c_int
@@ -531,9 +543,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
 
     def SetShapeAlignment(self ,shapeAlignment:'ShapeAlignment'):
         """
-    <summary>
-        Sets the alignment with a shape.
-    </summary>
+        Sets alignment relative to other shapes.
+        
+        Args:
+            shapeAlignment: Alignment type to apply.
         """
         enumshapeAlignment:c_int = shapeAlignment.value
 
@@ -543,9 +556,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
 
     def SetShapeArrange(self ,shapeArrange:'ShapeArrange'):
         """
-    <summary>
-        Sets the arrangement with a shape.
-    </summary>
+        Sets arrangement relative to other shapes.
+        
+        Args:
+            shapeArrange: Arrangement type to apply.
         """
         enumshapeArrange:c_int = shapeArrange.value
 
@@ -556,10 +570,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, 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/sets accessibility description text.
+        
+        Returns:
+            str: Alternative text description.
         """
         GetDllLibPpt().Shape_get_AlternativeText.argtypes=[c_void_p]
         GetDllLibPpt().Shape_get_AlternativeText.restype=c_void_p
@@ -577,9 +591,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
 
     def AlternativeTitle(self)->str:
         """
-    <summary>
-        Gets or sets the alternative title associated with a shape.
-            Read/write <see cref="T:System.String" /></summary>
+        Gets/sets accessibility title text.
+        
+        Returns:
+            str: Alternative title text.
         """
         GetDllLibPpt().Shape_get_AlternativeTitle.argtypes=[c_void_p]
         GetDllLibPpt().Shape_get_AlternativeTitle.restype=c_void_p
@@ -597,10 +612,10 @@ class Shape (  PptObject, IActiveSlide, IActivePresentation, IShape) :
 
     def Name(self)->str:
         """
-    <summary>
-        Gets or sets the name of a shape.
-            Read/write <see cref="T:System.String" />.
-    </summary>
+        Gets/sets display name for shape.
+        
+        Returns:
+            str: Current shape name.
         """
         GetDllLibPpt().Shape_get_Name.argtypes=[c_void_p]
         GetDllLibPpt().Shape_get_Name.restype=c_void_p

spire/presentation/ShapeAdjust.py

@@ -8,17 +8,17 @@ import abc
 
 class ShapeAdjust (SpireObject) :
     """
-    <summary>
-        Represents a shape's adjustment value.
-    </summary>
+    Represents an adjustment value for a shape in a presentation.
+    This class encapsulates both the numeric value and metadata of a shape adjustment.
     """
     @property
     def Value(self)->float:
         """
-    <summary>
-        Gets or sets adjustment value.
-            Read/write <see cref="T:System.Single" />.
-    </summary>
+        Gets or sets the adjustment value.
+        Represents the numeric value of the shape adjustment.
+
+        Returns:
+            float: The current adjustment value
         """
         GetDllLibPpt().ShapeAdjust_get_Value.argtypes=[c_void_p]
         GetDllLibPpt().ShapeAdjust_get_Value.restype=c_float
@@ -34,9 +34,11 @@ class ShapeAdjust (SpireObject) :
 
     def Name(self)->str:
         """
-    <summary>
-        Gets a name of this adjustment value.
-    </summary>
+        Gets the name of this adjustment value.
+        Provides identifier information for the adjustment.
+
+        Returns:
+            str: The name of the adjustment
         """
         GetDllLibPpt().ShapeAdjust_get_Name.argtypes=[c_void_p]
         GetDllLibPpt().ShapeAdjust_get_Name.restype=c_void_p
@@ -47,7 +49,12 @@ class ShapeAdjust (SpireObject) :
 
     def Equals(self ,obj:'SpireObject')->bool:
         """
+        Determines if this adjustment is equal to another object.
 
+        Args:
+            obj (SpireObject): The object to compare with
+        Returns:
+            bool: True if the objects are equal, False otherwise
         """
         intPtrobj:c_void_p = obj.Ptr
 

spire/presentation/ShapeAlignment.py

@@ -8,9 +8,20 @@ import abc
 
 class ShapeAlignment(Enum):
     """
-    <summary>
-        Represents alignment of shape.
-    </summary>
+    Represents different alignment options for shapes.
+
+    This enumeration provides options for aligning and distributing shapes 
+    within a slide or container.
+
+    Values:
+        AlignLeft: Align shapes to the leftmost position.
+        AlignCenter: Align shapes to the horizontal center.
+        AlignRight: Align shapes to the rightmost position.
+        AlignTop: Align shapes to the topmost position.
+        AlignMiddle: Align shapes to the vertical middle.
+        AlignBottom: Align shapes to the bottom position.
+        DistributeVertically: Distribute shapes evenly along the vertical axis.
+        DistributeHorizontally: Distribute shapes evenly along the horizontal axis.
     """
     AlignLeft = 0
     AlignCenter = 1

spire/presentation/ShapeArrange.py

@@ -8,9 +8,16 @@ import abc
 
 class ShapeArrange(Enum):
     """
-    <summary>
-        Represents the arrangement of shape
-    </summary>
+    Represents arrangement operations for shapes in a z-order stack.
+
+    This enumeration provides options for changing the stacking order
+    of overlapping shapes.
+
+    Attributes:
+        BringToFront: Bring the shape to the front of all other shapes.
+        SendToBack: Send the shape behind all other shapes.
+        BringForward: Move the shape one level forward in the z-order.
+        SendBackward: Move the shape one level backward in the z-order.
     """
     BringToFront = 0
     SendToBack = 1