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

spire/presentation/{ITable.py → table/ITable.py}

@@ -7,9 +7,24 @@ from ctypes import *
 import abc
 
 class ITable (IShape) :
+    """
+    Represents a table shape on a slide.
+    Provides comprehensive control over table structure, formatting, and contents.
+    """
 
     @dispatch
     def __getitem__(self, index):
+        """
+        Dual-index accessor for table elements:
+        - Single index: Returns a row collection
+        - Double index: Returns a specific cell
+
+        Args:
+            index: Single int or tuple of (column, row)
+
+        Returns:
+            TableRowCollection or Cell: Requested table component.
+        """
         if(len(index) ==1):
             return self.TableRows[index[0]]
         if(len(index) ==2):
@@ -24,6 +39,16 @@ class ITable (IShape) :
     @dispatch
     def get_Item(self ,column:int,row:int)->'Cell':
   
+        """
+        Retrieves a cell by column and row indexes.
+
+        Args:
+            column (int): Column index (0-based)
+            row (int): Row index (0-based)
+
+        Returns:
+            Cell: The cell at the specified position.
+        """
         GetDllLibPpt().ITable_get_Item.argtypes=[c_void_p ,c_int,c_int]
         GetDllLibPpt().ITable_get_Item.restype=c_void_p
         intPtr = CallCFunction(GetDllLibPpt().ITable_get_Item,self.Ptr, column,row)
@@ -31,12 +56,12 @@ class ITable (IShape) :
 
     def MergeCells(self ,cell1:'Cell',cell2:'Cell',allowSplitting:bool):
         """
-    <summary>
-        Merges neighbour cells.
-    </summary>
-    <param name="cell1">Cell to merge.</param>
-    <param name="cell2">Cell to merge.</param>
-    <param name="allowSplitting">True to allow cells splitting.</param>
+        Merges adjacent table cells.
+
+        Args:
+            cell1 (Cell): First cell to merge.
+            cell2 (Cell): Second cell to merge.
+            allowSplitting (bool): Whether to permit cell splitting during merge.
         """
         intPtrcell1:c_void_p = cell1.Ptr
         intPtrcell2:c_void_p = cell2.Ptr
@@ -47,12 +72,12 @@ class ITable (IShape) :
 
     def SetTableBorder(self ,borderType:'TableBorderType',borderWidth:float,borderColor:'Color'):
         """
-    <summary>
-        Setting up the table border
-    </summary>
-    <param name="borderType">border type</param>
-    <param name="borderWidth">border width.</param>
-    <param name="borderColor">border color.</param>
+        Configures border styles for the entire table.
+
+        Args:
+            borderType (TableBorderType): Border style to apply.
+            borderWidth (float): Thickness of the border lines.
+            borderColor (Color): Color of the border lines.
         """
         enumborderType:c_int = borderType.value
         intPtrborderColor:c_void_p = borderColor.Ptr
@@ -64,10 +89,10 @@ class ITable (IShape) :
 
     def StylePreset(self)->'TableStylePreset':
         """
-    <summary>
-        Get's or sets builtin table style.
-            Read/write <see cref="T:Spire.Presentation.TableStylePreset" />.
-    </summary>
+        Gets or sets the predefined table style.
+
+        Returns:
+            TableStylePreset: Current built-in table style.
         """
         GetDllLibPpt().ITable_get_StylePreset.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_StylePreset.restype=c_int
@@ -84,10 +109,10 @@ class ITable (IShape) :
 
     def TableRows(self)->'TableRowCollection':
         """
-    <summary>
-        Gets the collectoin of rows.
-            Read-only <see cref="T:Spire.Presentation.Collections.TableRowCollection" />.
-    </summary>
+        Gets the collection of rows in the table.
+
+        Returns:
+            TableRowCollection: All rows in the table.
         """
         GetDllLibPpt().ITable_get_TableRows.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_TableRows.restype=c_void_p
@@ -100,10 +125,10 @@ class ITable (IShape) :
 
     def ColumnsList(self)->'ColumnCollection':
         """
-    <summary>
-        Gets the collectoin of columns.
-            Read-only <see cref="T:Spire.Presentation.Collections.ColumnCollection" />.
-    </summary>
+        Gets the collection of columns in the table.
+
+        Returns:
+            ColumnCollection: All columns in the table.
         """
         GetDllLibPpt().ITable_get_ColumnsList.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_ColumnsList.restype=c_void_p
@@ -115,10 +140,10 @@ class ITable (IShape) :
     @property
     def RightToLeft(self)->bool:
         """
-    <summary>
-        Indicates whether the table has right to left reading order.
-            Read-write <see cref="T:System.Boolean" />.
-    </summary>
+        Indicates right-to-left reading order.
+
+        Returns:
+            bool: True for RTL layout, False for LTR.
         """
         GetDllLibPpt().ITable_get_RightToLeft.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_RightToLeft.restype=c_bool
@@ -133,10 +158,10 @@ class ITable (IShape) :
     @property
     def FirstRow(self)->bool:
         """
-    <summary>
-        Indicates whether the first row of a table has to be drawn with a special formatting.
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+        Sets right-to-left reading order.
+
+        Args:
+            value (bool): True for RTL layout, False for LTR.
         """
         GetDllLibPpt().ITable_get_FirstRow.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_FirstRow.restype=c_bool
@@ -151,10 +176,9 @@ class ITable (IShape) :
     @property
     def FirstCol(self)->bool:
         """
-    <summary>
         Indicates whether the first column of a table has to be drawn with a special formatting.
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+        Read/write .
+   
         """
         GetDllLibPpt().ITable_get_FirstCol.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_FirstCol.restype=c_bool
@@ -169,10 +193,9 @@ class ITable (IShape) :
     @property
     def LastRow(self)->bool:
         """
-    <summary>
         Indicates whether the last row of a table has to be drawn with a special formatting.
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+        Read/write>.
+    
         """
         GetDllLibPpt().ITable_get_LastRow.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_LastRow.restype=c_bool
@@ -187,10 +210,9 @@ class ITable (IShape) :
     @property
     def LastCol(self)->bool:
         """
-    <summary>
         Indicates whether the last column of a table has to be drawn with a special formatting.
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+        Read/write 
+  
         """
         GetDllLibPpt().ITable_get_LastCol.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_LastCol.restype=c_bool
@@ -205,10 +227,8 @@ class ITable (IShape) :
     @property
     def HorizontalBanding(self)->bool:
         """
-    <summary>
         Indicates whether the even rows has to be drawn with a different formatting.
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+        Read/write 
         """
         GetDllLibPpt().ITable_get_HorizontalBanding.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_HorizontalBanding.restype=c_bool
@@ -223,10 +243,9 @@ class ITable (IShape) :
     @property
     def VerticalBanding(self)->bool:
         """
-    <summary>
         Indicates whether the even columns has to be drawn with a different formatting.
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+        Read/write <see cref="T:System.Boolean" />.
+    
         """
         GetDllLibPpt().ITable_get_VerticalBanding.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_VerticalBanding.restype=c_bool
@@ -242,10 +261,8 @@ class ITable (IShape) :
 
     def ShapeLocking(self)->'GraphicalNodeLocking':
         """
-    <summary>
         Gets lock type of shape.
-            Read-only <see cref="T:Spire.Presentation.Drawing.GraphicalNodeLocking" />.
-    </summary>
+        Read-only 
         """
         GetDllLibPpt().ITable_get_ShapeLocking.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_ShapeLocking.restype=c_void_p
@@ -257,10 +274,8 @@ class ITable (IShape) :
     @property
     def IsPlaceholder(self)->bool:
         """
-    <summary>
         Indicates whether the shape is Placeholder.
-            Read-only <see cref="T:System.Boolean" />.
-    </summary>
+        Read-only 
         """
         GetDllLibPpt().ITable_get_IsPlaceholder.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_IsPlaceholder.restype=c_bool
@@ -271,10 +286,8 @@ class ITable (IShape) :
 
     def Placeholder(self)->'Placeholder':
         """
-    <summary>
         Gets the placeholder for a shape.
-            Read-only <see cref="P:Spire.Presentation.ITable.Placeholder" />.
-    </summary>
+        Read-only 
         """
         GetDllLibPpt().ITable_get_Placeholder.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_Placeholder.restype=c_void_p
@@ -287,10 +300,8 @@ class ITable (IShape) :
 
     def TagsList(self)->'TagCollection':
         """
-    <summary>
         Gets the shape's tags collection.
-            Read-only <see cref="T:Spire.Presentation.Collections.TagCollection" />.
-    </summary>
+        Read-only 
         """
         GetDllLibPpt().ITable_get_TagsList.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_TagsList.restype=c_void_p
@@ -303,10 +314,8 @@ class ITable (IShape) :
 
     def Frame(self)->'GraphicFrame':
         """
-    <summary>
         Gets or sets the shape frame's properties.
-            Read/write <see cref="T:Spire.Presentation.Drawing.GraphicFrame" />.
-    </summary>
+        Read/write 
         """
         GetDllLibPpt().ITable_get_Frame.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_Frame.restype=c_void_p
@@ -324,11 +333,8 @@ class ITable (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.ITable.Line" />.
-            Note: can return null for certain types of shapes which don't have line properties.
-    </summary>
+        Read-only
         """
         GetDllLibPpt().ITable_get_Line.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_Line.restype=c_void_p
@@ -341,11 +347,10 @@ class ITable (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" />.
-            Note: can return null for certain types of shapes which don't have 3d properties.
-    </summary>
+            
+        Note: can return null for certain types of shapes which don't have 3d properties.
+   
         """
         GetDllLibPpt().ITable_get_ThreeD.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_ThreeD.restype=c_void_p
@@ -358,11 +363,10 @@ class ITable (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.ITable.EffectDag" />
-            Note: can return null for certain types of shapes which don't have effect properties.
-    </summary>
+            
+        Note: can return null for certain types of shapes which don't have effect properties.
+   
         """
         GetDllLibPpt().ITable_get_EffectDag.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_EffectDag.restype=c_void_p
@@ -375,11 +379,10 @@ class ITable (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.ITable.Fill" />.
-            Note: can return null for certain types of shapes which don't have fill properties.
-    </summary>
+        Read-only.
+        Note: can return null for certain types of shapes which don't have fill properties.
+    
         """
         GetDllLibPpt().ITable_get_Fill.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_Fill.restype=c_void_p
@@ -392,10 +395,8 @@ class ITable (IShape) :
 
     def Click(self)->'ClickHyperlink':
         """
-    <summary>
         Gets or sets the hyperlink defined for mouse click.
-            Read/write <see cref="T:Spire.Presentation.ClickHyperlink" />.
-    </summary>
+        Read/write 
         """
         GetDllLibPpt().ITable_get_Click.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_Click.restype=c_void_p
@@ -413,10 +414,8 @@ class ITable (IShape) :
 
     def MouseOver(self)->'ClickHyperlink':
         """
-    <summary>
         Gets or sets the hyperlink defined for mouse over.
-            Read/write <see cref="T:Spire.Presentation.ClickHyperlink" />.
-    </summary>
+        Read/write 
         """
         GetDllLibPpt().ITable_get_MouseOver.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_MouseOver.restype=c_void_p
@@ -433,10 +432,8 @@ class ITable (IShape) :
     @property
     def IsHidden(self)->bool:
         """
-    <summary>
         Indicates whether the shape is hidden.
-            Read/write <see cref="T:System.Boolean" />.
-    </summary>
+        Read/write 
         """
         GetDllLibPpt().ITable_get_IsHidden.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_IsHidden.restype=c_bool
@@ -452,10 +449,8 @@ class ITable (IShape) :
 
     def Parent(self)->'ActiveSlide':
         """
-    <summary>
         Gets the parent slide of a shape.
-            Read-only <see cref="T:Spire.Presentation.ActiveSlide" />.
-    </summary>
+        Read-only .
         """
         GetDllLibPpt().ITable_get_Parent.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_Parent.restype=c_void_p
@@ -467,12 +462,11 @@ class ITable (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>
+        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.
+  
         """
         GetDllLibPpt().ITable_get_ZOrderPosition.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_ZOrderPosition.restype=c_int
@@ -487,12 +481,11 @@ class ITable (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>
+        the z-axis. A positive value indicates clockwise rotation; a negative value
+        indicates counterclockwise rotation.
+        Read/write .
+   
         """
         GetDllLibPpt().ITable_get_Rotation.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_Rotation.restype=c_float
@@ -507,10 +500,9 @@ class ITable (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>
+        Read/write.
+    
         """
         GetDllLibPpt().ITable_get_Left.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_Left.restype=c_float
@@ -525,10 +517,8 @@ class ITable (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>
+        Read/write 
         """
         GetDllLibPpt().ITable_get_Top.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_Top.restype=c_float
@@ -543,10 +533,9 @@ class ITable (IShape) :
     @property
     def Width(self)->float:
         """
-    <summary>
         Gets or sets the width of the shape.
-            Read/write <see cref="T:System.Int32" />.
-    </summary>
+        Read/write .
+    
         """
         GetDllLibPpt().ITable_get_Width.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_Width.restype=c_float
@@ -561,10 +550,9 @@ class ITable (IShape) :
     @property
     def Height(self)->float:
         """
-    <summary>
         Gets or sets the height of the shape.
-            Read/write <see cref="T:System.Int32" />.
-    </summary>
+        Read/write.
+    
         """
         GetDllLibPpt().ITable_get_Height.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_Height.restype=c_float
@@ -580,10 +568,9 @@ class ITable (IShape) :
 
     def AlternativeText(self)->str:
         """
-    <summary>
         Gets or sets the alternative text associated with a shape.
-            Read/write <see cref="T:System.String" />.
-    </summary>
+        Read/write.
+    
         """
         GetDllLibPpt().ITable_get_AlternativeText.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_AlternativeText.restype=c_void_p
@@ -601,10 +588,9 @@ class ITable (IShape) :
 
     def Name(self)->str:
         """
-    <summary>
         Gets or sets the name of a shape.
-            Read/write <see cref="T:System.String" />.
-    </summary>
+        Read/write.
+   
         """
         GetDllLibPpt().ITable_get_Name.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_Name.restype=c_void_p
@@ -622,10 +608,9 @@ class ITable (IShape) :
 
     def Slide(self)->'ActiveSlide':
         """
-    <summary>
         Gets the parent slide of a shape.
-            Read-only <see cref="T:Spire.Presentation.ActiveSlide" />.
-    </summary>
+        Read-only.
+    
         """
         GetDllLibPpt().ITable_get_Slide.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_Slide.restype=c_void_p
@@ -638,7 +623,8 @@ class ITable (IShape) :
 
     def Presentation(self)->'Presentation':
         """
-
+        Gets the parent Presentation of the table.
+        Read-only.
         """
         GetDllLibPpt().ITable_get_Presentation.argtypes=[c_void_p]
         GetDllLibPpt().ITable_get_Presentation.restype=c_void_p
@@ -650,10 +636,8 @@ class ITable (IShape) :
 
     def get_Item(self ,columnIndex:int,rowIndex:int)->'Cell':
         """
-    <summary>
         Gets the cell at the specified column and row indexes.
-            Read-only <see cref="T:Spire.Presentation.Cell" />.
-    </summary>
+        Read-only 
         """
         
         GetDllLibPpt().ITable_get_Item.argtypes=[c_void_p ,c_int,c_int]
@@ -665,18 +649,16 @@ class ITable (IShape) :
 
     def RemovePlaceholder(self):
         """
-    <summary>
         Removes placeholder from the shape.
-    </summary>
+    
         """
         GetDllLibPpt().ITable_RemovePlaceholder.argtypes=[c_void_p]
         CallCFunction(GetDllLibPpt().ITable_RemovePlaceholder,self.Ptr)
 
     def Dispose(self):
         """
-    <summary>
         Dispose object and free resources.
-    </summary>
+   
         """
         GetDllLibPpt().ITable_Dispose.argtypes=[c_void_p]
         CallCFunction(GetDllLibPpt().ITable_Dispose,self.Ptr)
@@ -684,11 +666,10 @@ class ITable (IShape) :
 
     def DistributeRows(self ,startRowIndex:int,endRowIndex:int):
         """
-    <summary>
         distribute rows.
-    </summary>
-    <param name="startRowIndex">start row index.</param>
-    <param name="endRowIndex">end row index.</param>
+        Args:
+            startRowIndex:start row index.
+            endRowIndex:end row index.
         """
         
         GetDllLibPpt().ITable_DistributeRows.argtypes=[c_void_p ,c_int,c_int]
@@ -697,11 +678,10 @@ class ITable (IShape) :
 
     def DistributeColumns(self ,startColumnIndex:int,endColumnIndex:int):
         """
-    <summary>
         distribute columns.
-    </summary>
-    <param name="startColumnIndex">start column index.</param>
-    <param name="endColumnIndex">end column index.</param>
+        Args:
+            startColumnIndex:start column index.
+            endColumnIndex:end column index.
         """
         
         GetDllLibPpt().ITable_DistributeColumns.argtypes=[c_void_p ,c_int,c_int]