spire-xls 15.5.0__py3-none-win_amd64.whl → 15.7.1__py3-none-win_amd64.whl

spire/xls/interfaces/collections/IListObjects.py

@@ -0,0 +1,34 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar,Union,Generic,List,Tuple
+from spire.xls.common import *
+from spire.xls import *
+from ctypes import *
+import abc
+
+class IListObjects (  IList[IListObject]) :
+    """
+
+    """
+
+    def Create(self ,name:str,range:'IXLSRange')->'IListObject':
+        """
+        Creates new list object and adds it to the collection.
+
+        Args:
+            name: Name of the new list object.
+            range: Destination range.
+
+        Returns:
+            Newly created object.
+
+        """
+        intPtrrange:c_void_p = range.Ptr
+
+        GetDllLibXls().IListObjects_Create.argtypes=[c_void_p ,c_void_p,c_void_p]
+        GetDllLibXls().IListObjects_Create.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().IListObjects_Create, self.Ptr, name,intPtrrange)
+        ret = None if intPtr==None else IListObject(intPtr)
+        return ret
+
+

spire/xls/interfaces/collections/IOleObjects.py

@@ -0,0 +1,44 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar,Union,Generic,List,Tuple
+from spire.xls.common import *
+from spire.xls import *
+from ctypes import *
+import abc
+
+class IOleObjects (  CollectionBase[IOleObject]) :
+    """Collection of OLE objects in an Excel worksheet.
+    
+    This interface represents a collection of OLE (Object Linking and Embedding) objects
+    within an Excel worksheet. It provides methods to access existing OLE objects and
+    add new ones to the worksheet.
+    
+    Inherits from:
+        CollectionBase[IOleObject]: Base collection class for OLE objects
+    """
+
+    def Add(self ,fileName:str,stream:'Stream',linkType:'OleLinkType')->'IOleObject':
+        """Adds a new OLE object to the collection.
+        
+        This method creates a new OLE object in the worksheet using the specified file
+        and stream data, with the specified linking behavior.
+        
+        Args:
+            fileName (str): The name of the file associated with the OLE object.
+            stream (Stream): The stream containing the binary data of the OLE object.
+            linkType (OleLinkType): The type of linking to use for the OLE object.
+                This determines whether the object is embedded or linked.
+        
+        Returns:
+            IOleObject: The newly created OLE object.
+        """
+        intPtrimage:c_void_p = stream.Ptr
+        enumlinkType:c_int = linkType.value
+
+        GetDllLibXls().IOleObjects_Add.argtypes=[c_void_p ,c_void_p,c_void_p,c_int]
+        GetDllLibXls().IOleObjects_Add.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().IOleObjects_Add, self.Ptr, fileName,intPtrimage,enumlinkType)
+        ret = None if intPtr==None else IOleObject(intPtr)
+        return ret
+
+

spire/xls/interfaces/collections/IPrstGeomShapes.py

@@ -0,0 +1,87 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar,Union,Generic,List,Tuple
+from spire.xls.common import *
+from spire.xls import *
+from ctypes import *
+import abc
+
+class IPrstGeomShapes (abc.ABC) :
+    """
+
+    """
+    @property
+    @abc.abstractmethod
+    def Count(self)->int:
+        """
+
+        """
+        pass
+
+
+    @dispatch
+
+    @abc.abstractmethod
+    def get_Item(self ,index:int)->IPrstGeomShape:
+        """
+        Returns single item from the collection.
+
+        Args:
+            index: Item's index to get.
+
+        Returns:
+            Single item from the collection.
+
+        """
+        pass
+
+
+    @dispatch
+
+    @abc.abstractmethod
+    def get_Item(self ,name:str)->IPrstGeomShape:
+        """
+
+        """
+        pass
+
+
+
+    @abc.abstractmethod
+    def AddPrstGeomShape(self ,row:int,column:int,height:int,width:int,shapeType:'PrstGeomShapeType')->'IPrstGeomShape':
+        """
+        Adds new item to the collection.
+
+        Args:
+            row: One-based row index of the top-left corner of the new item.
+            column: One-based column index of the top-left corner of the new item.
+            height: Height in pixels of the new item.
+            width: Width in pixels of the new item.
+
+        Returns:
+            Newly added item.
+
+        """
+        pass
+
+
+
+    @abc.abstractmethod
+    def AddNotPrimitiveShape(self ,row:int,column:int,width:int,height:int)->'IGeomPathShape':
+        """
+
+        """
+        pass
+
+
+    @dispatch
+
+    @abc.abstractmethod
+    def get_Item(self ,shapeType:PrstGeomShapeType)->List[IPrstGeomShape]:
+        """
+
+        """
+        pass
+
+
+

spire/xls/interfaces/collections/IShapes.py

@@ -0,0 +1,273 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar,Union,Generic,List,Tuple
+from spire.xls.common import *
+from spire.xls import *
+from ctypes import *
+import abc
+
+class IShapes (  IEnumerable[XlsShape]) :
+    """
+
+    """
+
+    def Add(self)->'IChartShape':
+        """
+
+        """
+        GetDllLibXls().IShapes_Add.argtypes=[c_void_p]
+        GetDllLibXls().IShapes_Add.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().IShapes_Add, self.Ptr)
+        ret = None if intPtr==None else XlsChartShape(intPtr)
+        return ret
+
+
+
+    def AddLine(self ,startPoint:'Point',endPoint:'Point',lineShapeType:'LineShapeType')->'ILineShape':
+        """
+        Adds new text line to the collection.
+
+        Args:
+            startPoint: startPoint
+            endPoint: endPoint
+            lineShapeType: lineShapeType
+
+        Returns:
+            Newly created line.
+
+        """
+        intPtrstartPoint:c_void_p = startPoint.Ptr
+        intPtrendPoint:c_void_p = endPoint.Ptr
+        enumlineShapeType:c_int = lineShapeType.value
+
+        GetDllLibXls().IShapes_AddLine.argtypes=[c_void_p ,c_void_p,c_void_p,c_int]
+        GetDllLibXls().IShapes_AddLine.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().IShapes_AddLine, self.Ptr, intPtrstartPoint,intPtrendPoint,enumlineShapeType)
+        ret = None if intPtr==None else XlsLineShape(intPtr)
+        return ret
+
+
+    @dispatch
+
+    def AddPicture(self ,image:Stream,pictureName:str,imageFormat:ImageFormatType)->IPictureShape:
+        """
+
+        """
+        intPtrimage:c_void_p = image.Ptr
+        enumimageFormat:c_int = imageFormat.value
+
+        GetDllLibXls().IShapes_AddPicture.argtypes=[c_void_p ,c_void_p,c_void_p,c_int]
+        GetDllLibXls().IShapes_AddPicture.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().IShapes_AddPicture, self.Ptr, intPtrimage,pictureName,enumimageFormat)
+        ret = None if intPtr==None else XlsBitmapShape(intPtr)
+        return ret
+
+
+    @dispatch
+
+    def AddPicture(self ,fileName:str)->IPictureShape:
+        """
+
+        """
+        
+        GetDllLibXls().IShapes_AddPictureF.argtypes=[c_void_p ,c_void_p]
+        GetDllLibXls().IShapes_AddPictureF.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().IShapes_AddPictureF, self.Ptr, fileName)
+        ret = None if intPtr==None else XlsBitmapShape(intPtr)
+        return ret
+
+
+    @dispatch
+
+    def AddComment(self ,commentText:str,bIsParseOptions:bool)->ICommentShape:
+        """
+
+        """
+        
+        GetDllLibXls().IShapes_AddComment.argtypes=[c_void_p ,c_void_p,c_bool]
+        GetDllLibXls().IShapes_AddComment.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().IShapes_AddComment, self.Ptr, commentText,bIsParseOptions)
+        ret = None if intPtr==None else XlsComment(intPtr)
+        return ret
+
+
+    @dispatch
+
+    def AddComment(self ,commentText:str)->ICommentShape:
+        """
+
+        """
+        
+        GetDllLibXls().IShapes_AddCommentC.argtypes=[c_void_p ,c_void_p]
+        GetDllLibXls().IShapes_AddCommentC.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().IShapes_AddCommentC, self.Ptr, commentText)
+        ret = None if intPtr==None else XlsComment(intPtr)
+        return ret
+
+
+    @dispatch
+
+    def AddComment(self)->ICommentShape:
+        """
+
+        """
+        GetDllLibXls().IShapes_AddComment1.argtypes=[c_void_p]
+        GetDllLibXls().IShapes_AddComment1.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().IShapes_AddComment1, self.Ptr)
+        ret = None if intPtr==None else XlsComment(intPtr)
+        return ret
+
+
+    @dispatch
+
+    def AddCopy(self ,sourceShape:IShape)->IShape:
+        """
+
+        """
+        intPtrsourceShape:c_void_p = sourceShape.Ptr
+
+        GetDllLibXls().IShapes_AddCopy.argtypes=[c_void_p ,c_void_p]
+        GetDllLibXls().IShapes_AddCopy.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().IShapes_AddCopy, self.Ptr, intPtrsourceShape)
+        ret = None if intPtr==None else IShape(intPtr)
+        return ret
+
+
+#    @dispatch
+#
+#    def AddCopy(self ,sourceShape:IShape,hashNewNames:'Dictionary2',arrFontIndexes:'List1')->IShape:
+#        """
+#
+#        """
+#        intPtrsourceShape:c_void_p = sourceShape.Ptr
+#        intPtrhashNewNames:c_void_p = hashNewNames.Ptr
+#        intPtrarrFontIndexes:c_void_p = arrFontIndexes.Ptr
+#
+#        GetDllLibXls().IShapes_AddCopySHA.argtypes=[c_void_p ,c_void_p,c_void_p,c_void_p]
+#        GetDllLibXls().IShapes_AddCopySHA.restype=c_void_p
+#        intPtr = CallCFunction(GetDllLibXls().IShapes_AddCopySHA, self.Ptr, intPtrsourceShape,intPtrhashNewNames,intPtrarrFontIndexes)
+#        ret = None if intPtr==None else IShape(intPtr)
+#        return ret
+#
+
+
+
+    def AddTextBox(self)->'ITextBoxLinkShape':
+        """
+
+        """
+        GetDllLibXls().IShapes_AddTextBox.argtypes=[c_void_p]
+        GetDllLibXls().IShapes_AddTextBox.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().IShapes_AddTextBox, self.Ptr)
+        ret = None if intPtr==None else XlsTextBoxShape(intPtr)
+        return ret
+
+
+
+    def AddOval(self ,row:int,column:int,height:int,width:int)->'IOvalShape':
+        """
+        Add new oval shape in the collection.
+
+        Args:
+            leftcolumn: 0-1000
+            toprow: 0-1000
+            rightcolumn: 0-1000
+            bottowrow: 0-1000
+
+        """
+        
+        GetDllLibXls().IShapes_AddOval.argtypes=[c_void_p ,c_int,c_int,c_int,c_int]
+        GetDllLibXls().IShapes_AddOval.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().IShapes_AddOval, self.Ptr, row,column,height,width)
+        ret = None if intPtr==None else XlsOvalShape(intPtr)
+        return ret
+
+
+
+    def AddPrstGeomShape(self ,shapeType:'PrstGeomShapeType')->'IPrstGeomShape':
+        """
+
+        """
+        enumshapeType:c_int = shapeType.value
+
+        GetDllLibXls().IShapes_AddPrstGeomShape.argtypes=[c_void_p ,c_int]
+        GetDllLibXls().IShapes_AddPrstGeomShape.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().IShapes_AddPrstGeomShape, self.Ptr, enumshapeType)
+        ret = None if intPtr==None else XlsPrstGeomShape(intPtr)
+        return ret
+
+
+
+    def AddCheckBox(self)->'ICheckBox':
+        """
+
+        """
+        GetDllLibXls().IShapes_AddCheckBox.argtypes=[c_void_p]
+        GetDllLibXls().IShapes_AddCheckBox.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().IShapes_AddCheckBox, self.Ptr)
+        ret = None if intPtr==None else XlsCheckBoxShape(intPtr)
+        return ret
+
+
+
+    def AddComboBox(self)->'IComboBoxShape':
+        """
+
+        """
+        GetDllLibXls().IShapes_AddComboBox.argtypes=[c_void_p]
+        GetDllLibXls().IShapes_AddComboBox.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().IShapes_AddComboBox, self.Ptr)
+        ret = None if intPtr==None else XlsComboBoxShape(intPtr)
+        return ret
+
+
+
+    def AddRadioButton(self)->'IRadioButton':
+        """
+
+        """
+        GetDllLibXls().IShapes_AddRadioButton.argtypes=[c_void_p]
+        GetDllLibXls().IShapes_AddRadioButton.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().IShapes_AddRadioButton, self.Ptr)
+        ret = None if intPtr==None else XlsRadioButtonShape(intPtr)
+        return ret
+
+
+    @property
+    def Count(self)->int:
+        """
+
+        """
+        GetDllLibXls().IShapes_get_Count.argtypes=[c_void_p]
+        GetDllLibXls().IShapes_get_Count.restype=c_int
+        ret = CallCFunction(GetDllLibXls().IShapes_get_Count, self.Ptr)
+        return ret
+
+    @dispatch
+
+    def get_Item(self ,index:int)->IShape:
+        """
+
+        """
+        
+        GetDllLibXls().IShapes_get_Item.argtypes=[c_void_p ,c_int]
+        GetDllLibXls().IShapes_get_Item.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().IShapes_get_Item, self.Ptr, index)
+        ret = None if intPtr==None else XlsShape(intPtr)
+        return ret
+
+
+    @dispatch
+
+    def get_Item(self ,strShapeName:str)->IShape:
+        """
+
+        """
+        
+        GetDllLibXls().IShapes_get_ItemS.argtypes=[c_void_p ,c_void_p]
+        GetDllLibXls().IShapes_get_ItemS.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibXls().IShapes_get_ItemS, self.Ptr, strShapeName)
+        ret = None if intPtr==None else XlsShape(intPtr)
+        return ret
+
+

spire/xls/interfaces/collections/ITextBoxes.py

@@ -0,0 +1,67 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar,Union,Generic,List,Tuple
+from spire.xls.common import *
+from spire.xls import *
+from ctypes import *
+import abc
+
+class ITextBoxes (abc.ABC) :
+    """
+
+    """
+    @property
+    @abc.abstractmethod
+    def Count(self)->int:
+        """
+
+        """
+        pass
+
+
+    @dispatch
+
+    @abc.abstractmethod
+    def get_Item(self ,index:int)->ITextBoxLinkShape:
+        """
+        Returns single item from the collection.
+
+        Args:
+            index: Item's index to get.
+
+        Returns:
+            Single item from the collection.
+
+        """
+        pass
+
+
+    @dispatch
+
+    @abc.abstractmethod
+    def get_Item(self ,name:str)->ITextBoxLinkShape:
+        """
+
+        """
+        pass
+
+
+
+    @abc.abstractmethod
+    def AddTextBox(self ,row:int,column:int,height:int,width:int)->'ITextBoxLinkShape':
+        """
+        Adds new item to the collection.
+
+        Args:
+            row: One-based row index of the top-left corner of the new item.
+            column: One-based column index of the top-left corner of the new item.
+            height: Height in pixels of the new item.
+            width: Width in pixels of the new item.
+
+        Returns:
+            Newly added item.
+
+        """
+        pass
+
+

spire/xls/interfaces/collections/IVPageBreaks.py

@@ -0,0 +1,37 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar,Union,Generic,List,Tuple
+from spire.xls.common import *
+from spire.xls import *
+from ctypes import *
+import abc
+
+class IVPageBreaks (  abc.ABC) :
+    """Collection of vertical page breaks in a worksheet.
+    
+    This interface represents a collection of vertical page breaks in an Excel worksheet.
+    It provides access to the count of vertical page breaks and methods to manage them.
+    """
+    @property
+    @abc.abstractmethod
+    def Count(self)->int:
+        """Gets the number of vertical page breaks in the collection.
+        
+        Returns:
+            int: The number of vertical page breaks.
+        """
+        pass
+
+
+    #@property
+
+    #@abc.abstractmethod
+    #def Parent(self)->'SpireObject':
+    #    """Gets the parent object of the vertical page breaks collection.
+    #    
+    #    Returns:
+    #        SpireObject: The parent object that contains this collection.
+    #    """
+    #    pass
+
+

spire/xls/interfaces/pivot_table/IPivotCache.py

@@ -0,0 +1,50 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar,Union,Generic,List,Tuple
+from spire.xls.common import *
+from spire.xls import *
+from ctypes import *
+import abc
+
+class IPivotCache (abc.ABC) :
+    """
+    Represents a single PivotCache object in a PivotTable collection.
+    """
+    @property
+    @abc.abstractmethod
+    def Index(self)->int:
+        """
+        Gets the index of the PivotCache in the collection.
+
+        Returns:
+            int: The index of the PivotCache.
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def SourceType(self)->'DataSourceType':
+        """
+        Gets the type of the data source for the PivotCache.
+
+        Returns:
+            DataSourceType: The type of the data source.
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def SourceRange(self)->'IXLSRange':
+        """
+        Gets the source range for the PivotCache.
+
+        Returns:
+            IXLSRange: The source range.
+        """
+        pass
+
+

spire/xls/interfaces/pivot_table/IPivotCaches.py

@@ -0,0 +1,52 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar,Union,Generic,List,Tuple
+from spire.xls.common import *
+from spire.xls import *
+from ctypes import *
+import abc
+
+class IPivotCaches (abc.ABC) :
+    """
+    Represents a collection of PivotCache objects in a PivotTable.
+    """
+    @property
+    @abc.abstractmethod
+    def Count(self)->int:
+        """
+        Gets the number of PivotCache objects in the collection.
+
+        Returns:
+            int: The number of PivotCache objects.
+        """
+        pass
+
+
+
+    @abc.abstractmethod
+    def get_Item(self ,index:int)->'IPivotCache':
+        """
+        Gets the PivotCache at the specified index.
+
+        Args:
+            index (int): The index of the PivotCache to retrieve.
+        Returns:
+            IPivotCache: The PivotCache object at the specified index.
+        """
+        pass
+
+
+
+    @abc.abstractmethod
+    def Add(self ,range:'CellRange')->'PivotCache':
+        """
+        Adds a new PivotCache to the collection based on the specified range.
+
+        Args:
+            range (CellRange): The cell range to use as the data source.
+        Returns:
+            PivotCache: The newly added PivotCache object.
+        """
+        pass
+
+