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

spire/xls/interfaces/IHyperLink.py

@@ -0,0 +1,137 @@
+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 IHyperLink (  IExcelApplication) :
+    """
+    Interface for hyperlink objects in Excel.
+    
+    This interface provides properties and methods to manipulate hyperlinks
+    in Excel worksheets, including their addresses, display text, and tooltips.
+    """
+    @property
+    @abc.abstractmethod
+    def Address(self)->str:
+        """
+        Gets the address of the hyperlink.
+
+        Returns:
+            str: The address of the hyperlink.
+        """
+        pass
+
+    @Address.setter
+    @abc.abstractmethod
+    def Address(self, value:str):
+        """
+        Sets the address of the hyperlink.
+
+        Args:
+            value (str): The address to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def Name(self)->str:
+        """
+        Gets the name of the hyperlink.
+
+        Returns:
+            str: The name of the hyperlink.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def Range(self)->'IXLSRange':
+        """
+        Gets the range associated with the hyperlink.
+
+        Returns:
+            IXLSRange: The associated range.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def ScreenTip(self)->str:
+        """
+        Gets the screen tip of the hyperlink.
+
+        Returns:
+            str: The screen tip.
+        """
+        pass
+
+    @ScreenTip.setter
+    @abc.abstractmethod
+    def ScreenTip(self, value:str):
+        """
+        Sets the screen tip of the hyperlink.
+
+        Args:
+            value (str): The screen tip to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def SubAddress(self)->str:
+        """
+        Gets the sub-address of the hyperlink.
+
+        Returns:
+            str: The sub-address.
+        """
+        pass
+
+    @SubAddress.setter
+    @abc.abstractmethod
+    def SubAddress(self, value:str):
+        """
+        Sets the sub-address of the hyperlink.
+
+        Args:
+            value (str): The sub-address to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def TextToDisplay(self)->str:
+        """
+        Gets the text to display for the hyperlink.
+
+        Returns:
+            str: The text to display.
+        """
+        pass
+
+    @TextToDisplay.setter
+    @abc.abstractmethod
+    def TextToDisplay(self, value:str):
+        """
+        Sets the text to display for the hyperlink.
+
+        Args:
+            value (str): The text to display.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def Type(self)->'HyperLinkType':
+        """
+        Gets the type of the hyperlink.
+
+        Returns:
+            HyperLinkType: The type of the hyperlink.
+        """
+        pass
+
+

spire/xls/interfaces/IIconSet.py

@@ -0,0 +1,115 @@
+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 IIconSet (abc.ABC) :
+    """
+    Interface for icon set conditional formatting in Excel.
+    
+    This interface provides properties and methods to manipulate icon set conditional
+    formatting, which displays icons in cells based on their values.
+    """
+#    @property
+#    @abc.abstractmethod
+#    def IconCriteria(self)->'IList1':
+#        """
+#        Gets the icon criteria for the icon set.
+#
+#        Returns:
+#            IList1: The icon criteria collection.
+#        """
+#        pass
+#
+    @property
+    @abc.abstractmethod
+    def IconSet(self)->'IconSetType':
+        """
+        Gets the icon set type.
+
+        Returns:
+            IconSetType: The icon set type.
+        """
+        pass
+
+    @IconSet.setter
+    @abc.abstractmethod
+    def IconSet(self, value:'IconSetType'):
+        """
+        Sets the icon set type.
+
+        Args:
+            value (IconSetType): The icon set type to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def PercentileValues(self)->bool:
+        """
+        Gets whether percentile values are used.
+
+        Returns:
+            bool: True if percentile values are used, otherwise False.
+        """
+        pass
+
+    @PercentileValues.setter
+    @abc.abstractmethod
+    def PercentileValues(self, value:bool):
+        """
+        Sets whether percentile values are used.
+
+        Args:
+            value (bool): True to use percentile values, otherwise False.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def IsReverseOrder(self)->bool:
+        """
+        Gets whether the icon set is in reverse order.
+
+        Returns:
+            bool: True if in reverse order, otherwise False.
+        """
+        pass
+
+    @IsReverseOrder.setter
+    @abc.abstractmethod
+    def IsReverseOrder(self, value:bool):
+        """
+        Sets whether the icon set is in reverse order.
+
+        Args:
+            value (bool): True for reverse order, otherwise False.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def ShowIconOnly(self)->bool:
+        """
+        Gets whether only the icon is shown.
+
+        Returns:
+            bool: True if only the icon is shown, otherwise False.
+        """
+        pass
+
+    @ShowIconOnly.setter
+    @abc.abstractmethod
+    def ShowIconOnly(self, value:bool):
+        """
+        Sets whether only the icon is shown.
+
+        Args:
+            value (bool): True to show only the icon, otherwise False.
+        """
+        pass
+
+

spire/xls/interfaces/IInterior.py

@@ -0,0 +1,137 @@
+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 IInterior (abc.ABC) :
+    """
+    Interface for interior formatting in Excel.
+    
+    This interface provides properties and methods to manipulate the interior
+    formatting of Excel objects, including colors, patterns, and gradients.
+    """
+    @property
+    @abc.abstractmethod
+    def PatternKnownColor(self)->'ExcelColors':
+        """
+        Gets the known color of the pattern.
+
+        Returns:
+            ExcelColors: The known color of the pattern.
+        """
+        pass
+
+    @PatternKnownColor.setter
+    @abc.abstractmethod
+    def PatternKnownColor(self, value:'ExcelColors'):
+        """
+        Sets the known color of the pattern.
+
+        Args:
+            value (ExcelColors): The known color to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def PatternColor(self)->'Color':
+        """
+        Gets the color of the pattern.
+
+        Returns:
+            Color: The color of the pattern.
+        """
+        pass
+
+    @PatternColor.setter
+    @abc.abstractmethod
+    def PatternColor(self, value:'Color'):
+        """
+        Sets the color of the pattern.
+
+        Args:
+            value (Color): The color to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def KnownColor(self)->'ExcelColors':
+        """
+        Gets the known color of the interior.
+
+        Returns:
+            ExcelColors: The known color of the interior.
+        """
+        pass
+
+    @KnownColor.setter
+    @abc.abstractmethod
+    def KnownColor(self, value:'ExcelColors'):
+        """
+        Sets the known color of the interior.
+
+        Args:
+            value (ExcelColors): The known color to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def Color(self)->'Color':
+        """
+        Gets the color of the interior.
+
+        Returns:
+            Color: The color of the interior.
+        """
+        pass
+
+    @Color.setter
+    @abc.abstractmethod
+    def Color(self, value:'Color'):
+        """
+        Sets the color of the interior.
+
+        Args:
+            value (Color): The color to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def Gradient(self)->'ExcelGradient':
+        """
+        Gets the gradient of the interior.
+
+        Returns:
+            ExcelGradient: The gradient object.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def FillPattern(self)->'ExcelPatternType':
+        """
+        Gets the fill pattern type of the interior.
+
+        Returns:
+            ExcelPatternType: The fill pattern type.
+        """
+        pass
+
+    @FillPattern.setter
+    @abc.abstractmethod
+    def FillPattern(self, value:'ExcelPatternType'):
+        """
+        Sets the fill pattern type of the interior.
+
+        Args:
+            value (ExcelPatternType): The fill pattern type to set.
+        """
+        pass
+
+

spire/xls/interfaces/IInternalAddtionalFormat.py

@@ -0,0 +1,277 @@
+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 IInternalAddtionalFormat (  IExtendedFormat, IExcelApplication) :
+    """
+    Interface for internal additional formatting in Excel.
+    
+    This interface extends IExtendedFormat and IExcelApplication to provide
+    access to additional formatting properties used internally by Excel,
+    particularly for border styles and colors.
+    """
+    @property
+    @abc.abstractmethod
+    def BottomBorderColor(self)->'OColor':
+        """
+        Gets the bottom border color.
+
+        Returns:
+            OColor: The bottom border color.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def TopBorderColor(self)->'OColor':
+        """
+        Gets the top border color.
+
+        Returns:
+            OColor: The top border color.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def LeftBorderColor(self)->'OColor':
+        """
+        Gets the left border color.
+
+        Returns:
+            OColor: The left border color.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def RightBorderColor(self)->'OColor':
+        """
+        Gets the right border color.
+
+        Returns:
+            OColor: The right border color.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def DiagonalBorderColor(self)->'OColor':
+        """
+        Gets the diagonal border color.
+
+        Returns:
+            OColor: The diagonal border color.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def LeftBorderLineStyle(self)->'LineStyleType':
+        """
+        Gets the left border line style.
+
+        Returns:
+            LineStyleType: The left border line style.
+        """
+        pass
+
+    @LeftBorderLineStyle.setter
+    @abc.abstractmethod
+    def LeftBorderLineStyle(self, value:'LineStyleType'):
+        """
+        Sets the left border line style.
+
+        Args:
+            value (LineStyleType): The left border line style to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def RightBorderLineStyle(self)->'LineStyleType':
+        """
+        Gets the right border line style.
+
+        Returns:
+            LineStyleType: The right border line style.
+        """
+        pass
+
+    @RightBorderLineStyle.setter
+    @abc.abstractmethod
+    def RightBorderLineStyle(self, value:'LineStyleType'):
+        """
+        Sets the right border line style.
+
+        Args:
+            value (LineStyleType): The right border line style to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def TopBorderLineStyle(self)->'LineStyleType':
+        """
+        Gets the top border line style.
+
+        Returns:
+            LineStyleType: The top border line style.
+        """
+        pass
+
+    @TopBorderLineStyle.setter
+    @abc.abstractmethod
+    def TopBorderLineStyle(self, value:'LineStyleType'):
+        """
+        Sets the top border line style.
+
+        Args:
+            value (LineStyleType): The top border line style to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def BottomBorderLineStyle(self)->'LineStyleType':
+        """
+        Gets the bottom border line style.
+
+        Returns:
+            LineStyleType: The bottom border line style.
+        """
+        pass
+
+    @BottomBorderLineStyle.setter
+    @abc.abstractmethod
+    def BottomBorderLineStyle(self, value:'LineStyleType'):
+        """
+        Sets the bottom border line style.
+
+        Args:
+            value (LineStyleType): The bottom border line style to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def DiagonalUpBorderLineStyle(self)->'LineStyleType':
+        """
+        Gets the diagonal up border line style.
+
+        Returns:
+            LineStyleType: The diagonal up border line style.
+        """
+        pass
+
+    @DiagonalUpBorderLineStyle.setter
+    @abc.abstractmethod
+    def DiagonalUpBorderLineStyle(self, value:'LineStyleType'):
+        """
+        Sets the diagonal up border line style.
+
+        Args:
+            value (LineStyleType): The diagonal up border line style to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def DiagonalDownBorderLineStyle(self)->'LineStyleType':
+        """
+        Gets the diagonal down border line style.
+
+        Returns:
+            LineStyleType: The diagonal down border line style.
+        """
+        pass
+
+    @DiagonalDownBorderLineStyle.setter
+    @abc.abstractmethod
+    def DiagonalDownBorderLineStyle(self, value:'LineStyleType'):
+        """
+        Sets the diagonal down border line style.
+
+        Args:
+            value (LineStyleType): The diagonal down border line style to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def DiagonalUpVisible(self)->bool:
+        """
+        Gets whether the diagonal up border is visible.
+
+        Returns:
+            bool: True if visible, otherwise False.
+        """
+        pass
+
+    @DiagonalUpVisible.setter
+    @abc.abstractmethod
+    def DiagonalUpVisible(self, value:bool):
+        """
+        Sets whether the diagonal up border is visible.
+
+        Args:
+            value (bool): True to set visible, otherwise False.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def DiagonalDownVisible(self)->bool:
+        """
+        Gets whether the diagonal down border is visible.
+
+        Returns:
+            bool: True if visible, otherwise False.
+        """
+        pass
+
+    @DiagonalDownVisible.setter
+    @abc.abstractmethod
+    def DiagonalDownVisible(self, value:bool):
+        """
+        Sets whether the diagonal down border is visible.
+
+        Args:
+            value (bool): True to set visible, otherwise False.
+        """
+        pass
+
+    @abc.abstractmethod
+    def BeginUpdate(self):
+        """
+        Begins a batch update operation on the format.
+        
+        This method should be called before making multiple changes to the format properties.
+        """
+        pass
+
+    @abc.abstractmethod
+    def EndUpdate(self):
+        """
+        Ends a batch update operation on the format.
+        
+        This method should be called after making multiple changes to apply all changes at once.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def Workbook(self)->'XlsWorkbook':
+        """
+        Gets the workbook associated with this format.
+        
+        Returns:
+            XlsWorkbook: The workbook object.
+        """
+        pass
+
+

spire/xls/interfaces/IInternalFont.py

@@ -0,0 +1,38 @@
+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 IInternalFont (  IFont, IExcelApplication, IOptimizedUpdate) :
+    """
+    Interface for internal font objects in Excel.
+    
+    This interface extends IFont, IExcelApplication, and IOptimizedUpdate to provide
+    access to internal font properties and methods used by the Excel engine.
+    """
+    @property
+    @abc.abstractmethod
+    def Index(self)->int:
+        """
+        Gets the index of the internal font.
+
+        Returns:
+            int: The index of the internal font.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def Font(self)->'XlsFont':
+        """
+        Gets the XlsFont object of the internal font.
+
+        Returns:
+            XlsFont: The XlsFont object.
+        """
+        pass
+
+