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

spire/xls/interfaces/IGeomPathInfo.py

@@ -0,0 +1,141 @@
+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 IGeomPathInfo (abc.ABC) :
+    """
+    Interface for geometric path information in Excel shapes.
+    
+    This interface provides properties and methods to manipulate geometric paths
+    that define custom shapes, including their fill mode, dimensions, and path segments.
+    """
+    @property
+    @abc.abstractmethod
+    def ShowStroke(self)->bool:
+        """
+        Gets whether the stroke is shown for the path.
+
+        Returns:
+            bool: True if the stroke is shown, otherwise False.
+        """
+        pass
+
+    @ShowStroke.setter
+    @abc.abstractmethod
+    def ShowStroke(self, value:bool):
+        """
+        Sets whether the stroke is shown for the path.
+
+        Args:
+            value (bool): True to show the stroke, otherwise False.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def ExtrusionOk(self)->bool:
+        """
+        Gets whether extrusion is allowed for the path.
+
+        Returns:
+            bool: True if extrusion is allowed, otherwise False.
+        """
+        pass
+
+    @ExtrusionOk.setter
+    @abc.abstractmethod
+    def ExtrusionOk(self, value:bool):
+        """
+        Sets whether extrusion is allowed for the path.
+
+        Args:
+            value (bool): True to allow extrusion, otherwise False.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def Height(self)->int:
+        """
+        Gets the height of the path.
+
+        Returns:
+            int: The height value.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def Width(self)->int:
+        """
+        Gets the width of the path.
+
+        Returns:
+            int: The width value.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def FillMode(self)->'PathFillMode':
+        """
+        Gets the fill mode of the path.
+
+        Returns:
+            PathFillMode: The fill mode.
+        """
+        pass
+
+    @FillMode.setter
+    @abc.abstractmethod
+    def FillMode(self, value:'PathFillMode'):
+        """
+        Sets the fill mode of the path.
+
+        Args:
+            value (PathFillMode): The fill mode to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def MsoLstCount(self)->int:
+        """
+        Gets the count of Mso list items in the path.
+
+        Returns:
+            int: The count of Mso list items.
+        """
+        pass
+
+    @abc.abstractmethod
+    def get_Item(self ,index:int)->'MsoPathInfo':
+        """
+        Gets the MsoPathInfo item by index.
+
+        Args:
+            index (int): The index of the item.
+
+        Returns:
+            MsoPathInfo: The MsoPathInfo item at the specified index.
+        """
+        pass
+
+    @abc.abstractmethod
+    def AddMso(self ,type:'MsoPathType')->'MsoPathInfo':
+        """
+        Adds a new MsoPathInfo item of the specified type.
+
+        Args:
+            type (MsoPathType): The type of Mso path to add.
+
+        Returns:
+            MsoPathInfo: The added MsoPathInfo item.
+        """
+        pass
+
+

spire/xls/interfaces/IGeomPathShape.py

@@ -0,0 +1,40 @@
+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 IGeomPathShape (  IPrstGeomShape, IShape, IExcelApplication) :
+    """
+    Interface for geometric path shape objects in Excel.
+    
+    This interface extends IPrstGeomShape, IShape, and IExcelApplication to provide
+    functionality for shapes that are defined by geometric paths.
+    """
+
+    @abc.abstractmethod
+    def AddPath(self)->'IGeomPathInfo':
+        """
+        Adds a new geometric path info to the shape.
+
+        Returns:
+            IGeomPathInfo: The added geometric path info.
+        """
+        pass
+
+    @abc.abstractmethod
+    def get_Item(self ,index:int)->'IGeomPathInfo':
+        """
+        Gets the geometric path info by index.
+
+        Args:
+            index (int): The index of the geometric path info.
+
+        Returns:
+            IGeomPathInfo: The geometric path info at the specified index.
+        """
+        pass
+
+

spire/xls/interfaces/IGlow.py

@@ -0,0 +1,104 @@
+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 IGlow (abc.ABC) :
+    """
+    Interface for glow effect formatting in Excel.
+    
+    This interface provides properties and methods to manipulate glow effects
+    for shapes and objects in Excel, including color, radius, and transparency.
+    """
+    @property
+    @abc.abstractmethod
+    def Color(self)->'Color':
+        """
+        Gets the color of the glow effect.
+
+        Returns:
+            Color: The color of the glow.
+        """
+        pass
+
+    @Color.setter
+    @abc.abstractmethod
+    def Color(self, value:'Color'):
+        """
+        Sets the color of the glow effect.
+
+        Args:
+            value (Color): The color to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def SoftEdge(self)->int:
+        """
+        Gets the soft edge value of the glow effect.
+
+        Returns:
+            int: The soft edge value.
+        """
+        pass
+
+    @SoftEdge.setter
+    @abc.abstractmethod
+    def SoftEdge(self, value:int):
+        """
+        Sets the soft edge value of the glow effect.
+
+        Args:
+            value (int): The soft edge value to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def Transparency(self)->int:
+        """
+        Gets the transparency value of the glow effect.
+
+        Returns:
+            int: The transparency value.
+        """
+        pass
+
+    @Transparency.setter
+    @abc.abstractmethod
+    def Transparency(self, value:int):
+        """
+        Sets the transparency value of the glow effect.
+
+        Args:
+            value (int): The transparency value to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def Radius(self)->int:
+        """
+        Gets the radius of the glow effect.
+
+        Returns:
+            int: The radius value.
+        """
+        pass
+
+    @Radius.setter
+    @abc.abstractmethod
+    def Radius(self, value:int):
+        """
+        Sets the radius of the glow effect.
+
+        Args:
+            value (int): The radius value to set.
+        """
+        pass
+
+

spire/xls/interfaces/IGradient.py

@@ -0,0 +1,203 @@
+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 IGradient (abc.ABC) :
+    """
+    Interface for gradient fill formatting in Excel.
+    
+    This interface provides properties and methods to manipulate gradient fills
+    in Excel objects, including colors, styles, and variants.
+    """
+    @property
+    @abc.abstractmethod
+    def BackColorObject(self)->'OColor':
+        """
+        Gets the background color object of the gradient.
+
+        Returns:
+            OColor: The background color object.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def ForeColorObject(self)->'OColor':
+        """
+        Gets the foreground color object of the gradient.
+
+        Returns:
+            OColor: The foreground color object.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def BackColor(self)->'Color':
+        """
+        Gets the background color of the gradient.
+
+        Returns:
+            Color: The background color.
+        """
+        pass
+
+    @BackColor.setter
+    @abc.abstractmethod
+    def BackColor(self, value:'Color'):
+        """
+        Sets the background color of the gradient.
+
+        Args:
+            value (Color): The background color to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def BackKnownColor(self)->'ExcelColors':
+        """
+        Gets the known background color of the gradient.
+
+        Returns:
+            ExcelColors: The known background color.
+        """
+        pass
+
+    @BackKnownColor.setter
+    @abc.abstractmethod
+    def BackKnownColor(self, value:'ExcelColors'):
+        """
+        Sets the known background color of the gradient.
+
+        Args:
+            value (ExcelColors): The known background color to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def ForeColor(self)->'Color':
+        """
+        Gets the foreground color of the gradient.
+
+        Returns:
+            Color: The foreground color.
+        """
+        pass
+
+    @ForeColor.setter
+    @abc.abstractmethod
+    def ForeColor(self, value:'Color'):
+        """
+        Sets the foreground color of the gradient.
+
+        Args:
+            value (Color): The foreground color to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def ForeKnownColor(self)->'ExcelColors':
+        """
+        Gets the known foreground color of the gradient.
+
+        Returns:
+            ExcelColors: The known foreground color.
+        """
+        pass
+
+    @ForeKnownColor.setter
+    @abc.abstractmethod
+    def ForeKnownColor(self, value:'ExcelColors'):
+        """
+        Sets the known foreground color of the gradient.
+
+        Args:
+            value (ExcelColors): The known foreground color to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def GradientStyle(self)->'GradientStyleType':
+        """
+        Gets the gradient style type.
+
+        Returns:
+            GradientStyleType: The gradient style type.
+        """
+        pass
+
+    @GradientStyle.setter
+    @abc.abstractmethod
+    def GradientStyle(self, value:'GradientStyleType'):
+        """
+        Sets the gradient style type.
+
+        Args:
+            value (GradientStyleType): The gradient style type to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def GradientVariant(self)->'GradientVariantsType':
+        """
+        Gets the gradient variant type.
+
+        Returns:
+            GradientVariantsType: The gradient variant type.
+        """
+        pass
+
+    @GradientVariant.setter
+    @abc.abstractmethod
+    def GradientVariant(self, value:'GradientVariantsType'):
+        """
+        Sets the gradient variant type.
+
+        Args:
+            value (GradientVariantsType): The gradient variant type to set.
+        """
+        pass
+
+    @abc.abstractmethod
+    def CompareTo(self ,gradient:'IGradient')->int:
+        """
+        Compares this gradient with another gradient.
+
+        Args:
+            gradient (IGradient): The gradient to compare with.
+
+        Returns:
+            int: The comparison result.
+        """
+        pass
+
+    @dispatch
+    @abc.abstractmethod
+    def TwoColorGradient(self):
+        """
+        Applies a two-color gradient.
+        """
+        pass
+
+    @dispatch
+    @abc.abstractmethod
+    def TwoColorGradient(self ,style:GradientStyleType,variant:GradientVariantsType):
+        """
+        Applies a two-color gradient with the specified style and variant.
+
+        Args:
+            style (GradientStyleType): The gradient style type.
+            variant (GradientVariantsType): The gradient variant type.
+        """
+        pass
+
+

spire/xls/interfaces/IGroupBox.py

@@ -0,0 +1,82 @@
+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 IGroupBox (  IShape, IExcelApplication) :
+    """
+    Interface for group box shape objects in Excel.
+    
+    This interface provides properties and methods to manipulate group box shapes
+    in Excel worksheets, which are container controls that can group related controls.
+    """
+    @property
+    @abc.abstractmethod
+    def Display3DShading(self)->bool:
+        """
+        Gets whether the group box displays 3D shading.
+
+        Returns:
+            bool: True if 3D shading is displayed, otherwise False.
+        """
+        pass
+
+    @Display3DShading.setter
+    @abc.abstractmethod
+    def Display3DShading(self, value:bool):
+        """
+        Sets whether the group box displays 3D shading.
+
+        Args:
+            value (bool): True to display 3D shading, otherwise False.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def Text(self)->str:
+        """
+        Gets the text of the group box.
+
+        Returns:
+            str: The text of the group box.
+        """
+        pass
+
+    @Text.setter
+    @abc.abstractmethod
+    def Text(self, value:str):
+        """
+        Sets the text of the group box.
+
+        Args:
+            value (str): The text to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def IsTextLocked(self)->bool:
+        """
+        Gets whether the text of the group box is locked.
+
+        Returns:
+            bool: True if the text is locked, otherwise False.
+        """
+        pass
+
+    @IsTextLocked.setter
+    @abc.abstractmethod
+    def IsTextLocked(self, value:bool):
+        """
+        Sets whether the text of the group box is locked.
+
+        Args:
+            value (bool): True to lock the text, otherwise False.
+        """
+        pass
+
+

spire/xls/interfaces/IHPageBreak.py

@@ -0,0 +1,26 @@
+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 IHPageBreak (abc.ABC) :
+    """Horizontal page break interface.
+    
+    This interface represents a horizontal page break in an Excel worksheet.
+    Horizontal page breaks are used to control where a page ends when printing
+    a worksheet, creating a manual break in the horizontal direction (between rows).
+    """
+    @property
+    @abc.abstractmethod
+    def Parent(self)->'SpireObject':
+        """Gets the parent object of the horizontal page break.
+        
+        Returns:
+            SpireObject: The parent object that contains this page break.
+        """
+        pass
+
+