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

spire/xls/interfaces/ICheckBox.py

@@ -0,0 +1,120 @@
+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 ICheckBox (  IShape, IExcelApplication) :
+    """Checkbox interface.
+    
+    This interface provides functionality for creating and managing checkbox form controls
+    in Excel worksheets. Checkboxes allow users to make binary choices (checked or unchecked)
+    and can be linked to cell values. The interface provides methods to set the check state,
+    appearance properties like 3D shading, text display, and line formatting.
+    
+    Inherits from:
+        IShape: Shape interface
+        IExcelApplication: Excel application interface
+    """
+    @property
+    @abc.abstractmethod
+    def CheckState(self)->'CheckState':
+        """
+        Gets the check state of the checkbox.
+
+        Returns:
+            CheckState: The check state of the checkbox.
+        """
+        pass
+
+    @CheckState.setter
+    @abc.abstractmethod
+    def CheckState(self, value:'CheckState'):
+        """
+        Sets the check state of the checkbox.
+
+        Args:
+            value (CheckState): The check state to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def Line(self)->'IShapeLineFormat':
+        """
+        Gets the line format of the checkbox.
+
+        Returns:
+            IShapeLineFormat: The line format object.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def Text(self)->str:
+        """
+        Gets the text of the checkbox.
+
+        Returns:
+            str: The text of the checkbox.
+        """
+        pass
+
+    @Text.setter
+    @abc.abstractmethod
+    def Text(self, value:str):
+        """
+        Sets the text of the checkbox.
+
+        Args:
+            value (str): The text to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def IsTextLocked(self)->bool:
+        """
+        Gets whether the text of the checkbox 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 checkbox is locked.
+
+        Args:
+            value (bool): True to lock the text, otherwise False.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def Display3DShading(self)->bool:
+        """
+        Gets whether the checkbox 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 checkbox displays 3D shading.
+
+        Args:
+            value (bool): True to display 3D shading, otherwise False.
+        """
+        pass
+
+

spire/xls/interfaces/ICloneParent.py

@@ -0,0 +1,29 @@
+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 ICloneParent (abc.ABC) :
+    """
+    Supports cloning, which creates a new instance of a class with the same value as an existing instance.
+
+    """
+
+    @abc.abstractmethod
+    def Clone(self ,parent:'SpireObject')->'SpireObject':
+        """
+        Creates a new object that is a copy of the current instance.
+
+        Args:
+            parent: Parent object for a copy of this instance.
+
+        Returns:
+            A new object that is a copy of this instance.
+
+        """
+        pass
+
+

spire/xls/interfaces/IColorConditionValue.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 IColorConditionValue (  IConditionValue) :
+    """Color condition value interface.
+    
+    This interface extends the condition value interface to include color formatting
+    capabilities. It is used in conditional formatting rules that apply color-based
+    formatting, such as color scales and icon sets, allowing the specification of
+    colors to be applied when conditions are met.
+    
+    Inherits from:
+        IConditionValue: Condition value interface
+    """
+    @property
+
+    @abc.abstractmethod
+    def FormatColor(self)->'Color':
+        """
+        Gets the format color for the condition value.
+
+        Returns:
+            Color: The format color.
+        """
+        pass
+
+
+    @FormatColor.setter
+    @abc.abstractmethod
+    def FormatColor(self, value:'Color'):
+        """
+        Sets the format color for the condition value.
+
+        Args:
+            value (Color): The format color to set.
+        """
+        pass
+
+

spire/xls/interfaces/IColorScale.py

@@ -0,0 +1,39 @@
+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 IColorScale (abc.ABC) :
+    """Color scale interface.
+    
+    This interface provides functionality for creating and managing color scales in Excel
+    conditional formatting. Color scales are visual tools that apply graduated colors to a
+    range of cells based on their values. The interface allows setting the number of conditions
+    for the color scale.
+    """
+#    @property
+#
+#    @abc.abstractmethod
+#    def Criteria(self)->'IList1':
+#        """
+#
+#        """
+#        pass
+#
+
+
+
+    @abc.abstractmethod
+    def SetConditionCount(self ,count:int):
+        """
+        Sets the number of conditions for the color scale.
+
+        Args:
+            count (int): The number of conditions to set.
+        """
+        pass
+
+

spire/xls/interfaces/ICombinedRange.py

@@ -0,0 +1,109 @@
+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 ICombinedRange (  IXLSRange) :
+    """Combined range interface.
+    
+    This interface represents a range that consists of multiple non-contiguous cell ranges
+    combined together. It provides functionality for working with these combined ranges as
+    a single entity, including clearing conditional formats, getting the component rectangles,
+    and accessing range properties like address and cell count.
+    
+    Inherits from:
+        IXLSRange: Excel range interface
+    """
+#
+#    @abc.abstractmethod
+#    def GetNewRangeLocation(self ,names:'Dictionary2',strSheetName:'String&')->str:
+#        """
+#
+#        """
+#        pass
+#
+
+
+#
+#    @abc.abstractmethod
+#    def Clone(self ,parent:'SpireObject',hashNewNames:'Dictionary2',book:'XlsWorkbook')->'IXLSRange':
+#        """
+#
+#        """
+#        pass
+#
+
+
+    @abc.abstractmethod
+    def ClearConditionalFormats(self):
+        """
+        Clears all conditional formats in the combined range.
+        """
+        pass
+
+
+
+    @abc.abstractmethod
+    def GetRectangles(self)->List['Rectangle']:
+        """
+        Gets a list of rectangles that make up the combined range.
+
+        Returns:
+            List[Rectangle]: A list of rectangle objects.
+        """
+        pass
+
+
+
+    @abc.abstractmethod
+    def GetRectanglesCount(self)->int:
+        """
+        Gets the number of rectangles in the combined range.
+
+        Returns:
+            int: The number of rectangles.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def CellsCount(self)->int:
+        """
+        Gets the number of cells in the combined range.
+
+        Returns:
+            int: The number of cells.
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def RangeGlobalAddress2007(self)->str:
+        """
+        Gets the global address of the range in Excel 2007 format.
+
+        Returns:
+            str: The global address string.
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def WorksheetName(self)->str:
+        """
+        Gets the name of the worksheet containing the combined range.
+
+        Returns:
+            str: The worksheet name.
+        """
+        pass
+
+

spire/xls/interfaces/IComboBoxShape.py

@@ -0,0 +1,120 @@
+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 IComboBoxShape (  IShape, IExcelApplication) :
+    """Combo box shape interface.
+    
+    This interface provides functionality for creating and managing combo box controls
+    in Excel worksheets. A combo box allows users to select a value from a predefined list.
+    The interface provides functionality for setting the list fill range, selected index,
+    dropdown lines, 3D shading effects, and retrieving the selected value.
+    
+    Inherits from:
+        IShape: Shape interface
+        IExcelApplication: Excel application interface
+    """
+    @property
+    @abc.abstractmethod
+    def ListFillRange(self)->'IXLSRange':
+        """
+        Gets the range used to fill the combo box list.
+
+        Returns:
+            IXLSRange: The range used to fill the list.
+        """
+        pass
+
+    @ListFillRange.setter
+    @abc.abstractmethod
+    def ListFillRange(self, value:'IXLSRange'):
+        """
+        Sets the range used to fill the combo box list.
+
+        Args:
+            value (IXLSRange): The range to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def SelectedIndex(self)->int:
+        """
+        Gets the selected index of the combo box.
+
+        Returns:
+            int: The selected index.
+        """
+        pass
+
+    @SelectedIndex.setter
+    @abc.abstractmethod
+    def SelectedIndex(self, value:int):
+        """
+        Sets the selected index of the combo box.
+
+        Args:
+            value (int): The selected index to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def DropDownLines(self)->int:
+        """
+        Gets the number of lines displayed in the drop-down list.
+
+        Returns:
+            int: The number of lines.
+        """
+        pass
+
+    @DropDownLines.setter
+    @abc.abstractmethod
+    def DropDownLines(self, value:int):
+        """
+        Sets the number of lines displayed in the drop-down list.
+
+        Args:
+            value (int): The number of lines to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def Display3DShading(self)->bool:
+        """
+        Gets whether the combo 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 combo box displays 3D shading.
+
+        Args:
+            value (bool): True to display 3D shading, otherwise False.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def SelectedValue(self)->str:
+        """
+        Gets the selected value of the combo box.
+
+        Returns:
+            str: The selected value.
+        """
+        pass
+
+

spire/xls/interfaces/IComment.py

@@ -0,0 +1,110 @@
+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 IComment (  ITextBoxShape, ITextBox, IShape) :
+    """Comment interface.
+    
+    This interface provides functionality for creating and managing comments in Excel worksheets.
+    Comments are notes or explanations that can be attached to cells to provide additional
+    information. The interface allows setting the author, visibility, position, and auto-sizing
+    properties of comments.
+    
+    Inherits from:
+        ITextBoxShape: Text box shape interface
+        ITextBox: Text box interface
+        IShape: Shape interface
+    """
+    @property
+    @abc.abstractmethod
+    def Author(self)->str:
+        """
+        Gets the author of the comment.
+
+        Returns:
+            str: The author name.
+        """
+        pass
+
+    @Author.setter
+    @abc.abstractmethod
+    def Author(self, value:str):
+        """
+        Sets the author of the comment.
+
+        Args:
+            value (str): The author name.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def IsVisible(self)->bool:
+        """
+        Gets whether the comment is visible.
+
+        Returns:
+            bool: True if visible, otherwise False.
+        """
+        pass
+
+    @IsVisible.setter
+    @abc.abstractmethod
+    def IsVisible(self, value:bool):
+        """
+        Sets whether the comment is visible.
+
+        Args:
+            value (bool): True to make visible, otherwise False.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def Row(self)->int:
+        """
+        Gets the row index of the comment.
+
+        Returns:
+            int: The row index.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def Column(self)->int:
+        """
+        Gets the column index of the comment.
+
+        Returns:
+            int: The column index.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def AutoSize(self)->bool:
+        """
+        Gets whether the comment is auto-sized.
+
+        Returns:
+            bool: True if auto-sized, otherwise False.
+        """
+        pass
+
+    @AutoSize.setter
+    @abc.abstractmethod
+    def AutoSize(self, value:bool):
+        """
+        Sets whether the comment is auto-sized.
+
+        Args:
+            value (bool): True to auto-size, otherwise False.
+        """
+        pass
+
+

spire/xls/interfaces/ICommentShape.py

@@ -0,0 +1,20 @@
+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 ICommentShape (  IComment, ITextBoxShape, ITextBox) :
+    """Comment shape interface.
+    
+    This interface represents a comment shape in Excel worksheets, combining the functionality
+    of comments, text boxes, and text formatting. Comment shapes are used to add notes or
+    explanations to cells that can be viewed by hovering over the cell or displaying all comments.
+    
+    Inherits from:
+        IComment: Comment interface
+        ITextBoxShape: Text box shape interface
+        ITextBox: Text box interface
+    """

spire/xls/interfaces/IConditionValue.py

@@ -0,0 +1,83 @@
+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 IConditionValue (abc.ABC) :
+    """Condition value interface.
+    
+    This interface provides functionality for defining and managing condition values used in Excel
+    conditional formatting rules. Condition values specify the criteria that determine when a
+    formatting rule should be applied. The interface allows setting the condition type, value,
+    and comparison operators.
+    """
+    @property
+    @abc.abstractmethod
+    def Type(self)->'ConditionValueType':
+        """
+        Gets the type of the condition value.
+
+        Returns:
+            ConditionValueType: The type of the condition value.
+        """
+        pass
+
+    @Type.setter
+    @abc.abstractmethod
+    def Type(self, value:'ConditionValueType'):
+        """
+        Sets the type of the condition value.
+
+        Args:
+            value (ConditionValueType): The type to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def Value(self)->'SpireObject':
+        """
+        Gets the value of the condition.
+
+        Returns:
+            SpireObject: The value of the condition.
+        """
+        pass
+
+    @Value.setter
+    @abc.abstractmethod
+    def Value(self, value:'SpireObject'):
+        """
+        Sets the value of the condition.
+
+        Args:
+            value (SpireObject): The value to set.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def IsGTE(self)->bool:
+        """
+        Gets whether the condition is greater than or equal to.
+
+        Returns:
+            bool: True if greater than or equal to, otherwise False.
+        """
+        pass
+
+    @IsGTE.setter
+    @abc.abstractmethod
+    def IsGTE(self, value:bool):
+        """
+        Sets whether the condition is greater than or equal to.
+
+        Args:
+            value (bool): True if greater than or equal to, otherwise False.
+        """
+        pass
+
+