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

spire/xls/interfaces/ISortColumns.py

@@ -0,0 +1,106 @@
+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 ISortColumns (  SpireObject) :
+    """Collection of sort columns for Excel sorting operations.
+    
+    This interface represents a collection of sort columns and provides methods
+    to add, remove, and access sort columns in a sort operation. It allows configuring
+    multi-column sort operations with different sort criteria for each column.
+    """
+    @property
+    @abc.abstractmethod
+    def Count(self)->int:
+        """Gets the number of sort columns in the collection.
+        
+        This property returns the count of sort columns currently in the collection.
+        
+        Returns:
+            int: The number of sort columns.
+        """
+        pass
+
+
+    @dispatch
+    @abc.abstractmethod
+    def Add(self, key:int, sortComparsionType:SortComparsionType, orderBy:OrderBy)->ISortColumn:
+        """Adds a new sort column with specified comparison type and order.
+        
+        This method adds a new sort column to the collection with the specified key,
+        comparison type, and sort order.
+        
+        Args:
+            key (int): The column index to sort by.
+            sortComparsionType (SortComparsionType): The comparison type to use for sorting.
+            orderBy (OrderBy): The sort order (ascending or descending).
+            
+        Returns:
+            ISortColumn: The newly created sort column object.
+        """
+        pass
+
+
+    @dispatch
+    @abc.abstractmethod
+    def Add(self, key:int, orderBy:OrderBy)->ISortColumn:
+        """Adds a new sort column with default comparison type and specified order.
+        
+        This method adds a new sort column to the collection with the specified key
+        and sort order, using the default comparison type.
+        
+        Args:
+            key (int): The column index to sort by.
+            orderBy (OrderBy): The sort order (ascending or descending).
+            
+        Returns:
+            ISortColumn: The newly created sort column object.
+        """
+        pass
+
+
+    @dispatch
+    @abc.abstractmethod
+    def Remove(self, key:int):
+        """Removes a sort column by its key (column index).
+        
+        This method removes the sort column with the specified key from the collection.
+        
+        Args:
+            key (int): The column index of the sort column to remove.
+        """
+        pass
+
+
+    @dispatch
+    @abc.abstractmethod
+    def Remove(self, sortField:ISortColumn):
+        """Removes a specific sort column object.
+        
+        This method removes the specified sort column object from the collection.
+        
+        Args:
+            sortField (ISortColumn): The sort column object to remove.
+        """
+        pass
+
+
+    @abc.abstractmethod
+    def get_Item(self, index:int)->'ISortColumn':
+        """Gets the sort column at the specified index.
+        
+        This method returns the sort column at the specified position in the collection.
+        
+        Args:
+            index (int): The zero-based index of the sort column to retrieve.
+            
+        Returns:
+            ISortColumn: The sort column at the specified index.
+        """
+        pass
+
+

spire/xls/interfaces/ISortedRule.py

@@ -0,0 +1,154 @@
+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 ISortedRule (abc.ABC) :
+    """Interface for defining sorting rules in Excel worksheets.
+    
+    This abstract class provides methods for sorting Excel ranges based on different
+    data types and criteria.
+    """
+    @property
+
+    @abc.abstractmethod
+    def Range(self)->'IXLSRange':
+        """Gets the Excel range to which the sorting rule applies.
+        
+        Returns:
+            IXLSRange: The Excel range object associated with this sorting rule.
+        """
+        pass
+
+
+    @Range.setter
+    @abc.abstractmethod
+    def Range(self, value:'IXLSRange'):
+        """Sets the Excel range to which the sorting rule applies.
+        
+        Args:
+            value (IXLSRange): The Excel range object to associate with this sorting rule.
+        """
+        pass
+
+
+
+    @abc.abstractmethod
+    def SortInt(self ,left:int,right:int,columnIndex:int):
+        """Sorts integer values in ascending order within the specified range.
+        
+        Args:
+            left (int): The left boundary index of the range to sort.
+            right (int): The right boundary index of the range to sort.
+            columnIndex (int): The index of the column to sort by.
+        """
+        pass
+
+
+
+    @abc.abstractmethod
+    def SortFloat(self ,left:int,right:int,columnIndex:int):
+        """Sorts floating-point values in ascending order within the specified range.
+        
+        Args:
+            left (int): The left boundary index of the range to sort.
+            right (int): The right boundary index of the range to sort.
+            columnIndex (int): The index of the column to sort by.
+        """
+        pass
+
+
+
+    @abc.abstractmethod
+    def SortDate(self ,left:int,right:int,columnIndex:int):
+        """Sorts date values in ascending order within the specified range.
+        
+        Args:
+            left (int): The left boundary index of the range to sort.
+            right (int): The right boundary index of the range to sort.
+            columnIndex (int): The index of the column to sort by.
+        """
+        pass
+
+
+
+    @abc.abstractmethod
+    def SortString(self ,left:int,right:int,columnIndex:int):
+        """Sorts string values in ascending order within the specified range.
+        
+        Args:
+            left (int): The left boundary index of the range to sort.
+            right (int): The right boundary index of the range to sort.
+            columnIndex (int): The index of the column to sort by.
+        """
+        pass
+
+
+
+    @abc.abstractmethod
+    def SortOnTypes(self ,left:int,right:int,columnIndex:int):
+        """Sorts values based on their data types within the specified range.
+        
+        Args:
+            left (int): The left boundary index of the range to sort.
+            right (int): The right boundary index of the range to sort.
+            columnIndex (int): The index of the column to sort by.
+        """
+        pass
+
+
+
+    @abc.abstractmethod
+    def SortIntDesc(self ,left:int,right:int,columnIndex:int):
+        """Sorts integer values in descending order within the specified range.
+        
+        Args:
+            left (int): The left boundary index of the range to sort.
+            right (int): The right boundary index of the range to sort.
+            columnIndex (int): The index of the column to sort by.
+        """
+        pass
+
+
+
+    @abc.abstractmethod
+    def SortFloatDesc(self ,left:int,right:int,columnIndex:int):
+        """Sorts floating-point values in descending order within the specified range.
+        
+        Args:
+            left (int): The left boundary index of the range to sort.
+            right (int): The right boundary index of the range to sort.
+            columnIndex (int): The index of the column to sort by.
+        """
+        pass
+
+
+
+    @abc.abstractmethod
+    def SortDateDesc(self ,left:int,right:int,columnIndex:int):
+        """Sorts date values in descending order within the specified range.
+        
+        Args:
+            left (int): The left boundary index of the range to sort.
+            right (int): The right boundary index of the range to sort.
+            columnIndex (int): The index of the column to sort by.
+        """
+        pass
+
+
+
+    @abc.abstractmethod
+    def SortStringDesc(self ,left:int,right:int,columnIndex:int):
+        """Sorts string values in descending order within the specified range.
+        
+        Args:
+            left (int): The left boundary index of the range to sort.
+            right (int): The right boundary index of the range to sort.
+            columnIndex (int): The index of the column to sort by.
+        """
+        pass
+
+

spire/xls/interfaces/ISpinnerShape.py

@@ -0,0 +1,124 @@
+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 ISpinnerShape (  IShape, IExcelApplication) :
+    """Interface for spinner control shapes in Excel worksheets.
+    
+    This interface represents a spinner control shape that allows users to 
+    increment or decrement numeric values within a specified range.
+    """
+    @property
+    @abc.abstractmethod
+    def Display3DShading(self)->bool:
+        """Gets whether 3D shading is displayed for the spinner.
+        
+        Returns:
+            bool: True if 3D shading is displayed; otherwise, False.
+        """
+        pass
+
+
+    @Display3DShading.setter
+    @abc.abstractmethod
+    def Display3DShading(self, value:bool):
+        """Sets whether 3D shading is displayed for the spinner.
+        
+        Args:
+            value (bool): True to display 3D shading; otherwise, False.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def CurrentValue(self)->int:
+        """Gets the current value of the spinner.
+        
+        Returns:
+            int: The current value of the spinner.
+        """
+        pass
+
+
+    @CurrentValue.setter
+    @abc.abstractmethod
+    def CurrentValue(self, value:int):
+        """Sets the current value of the spinner.
+        
+        Args:
+            value (int): The value to set for the spinner.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def Min(self)->int:
+        """Gets the minimum value allowed for the spinner.
+        
+        Returns:
+            int: The minimum value of the spinner.
+        """
+        pass
+
+
+    @Min.setter
+    @abc.abstractmethod
+    def Min(self, value:int):
+        """Sets the minimum value allowed for the spinner.
+        
+        Args:
+            value (int): The minimum value to set for the spinner.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def Max(self)->int:
+        """Gets the maximum value allowed for the spinner.
+        
+        Returns:
+            int: The maximum value of the spinner.
+        """
+        pass
+
+
+    @Max.setter
+    @abc.abstractmethod
+    def Max(self, value:int):
+        """Sets the maximum value allowed for the spinner.
+        
+        Args:
+            value (int): The maximum value to set for the spinner.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def IncrementalChange(self)->int:
+        """Gets the amount to change the spinner value with each increment.
+        
+        Returns:
+            int: The incremental change value.
+        """
+        pass
+
+
+    @IncrementalChange.setter
+    @abc.abstractmethod
+    def IncrementalChange(self, value:int):
+        """Sets the amount to change the spinner value with each increment.
+        
+        Args:
+            value (int): The incremental change value to set.
+        """
+        pass
+
+

spire/xls/interfaces/IStyle.py

@@ -0,0 +1,60 @@
+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 IStyle (  IExtendedFormat, IExcelApplication, IOptimizedUpdate) :
+    """Interface for Excel cell styles.
+    
+    This interface represents a style in an Excel workbook and provides properties
+    to access and modify style attributes such as name, built-in status, and interior formatting.
+    """
+    @property
+    @abc.abstractmethod
+    def BuiltIn(self)->bool:
+        """Gets whether the style is a built-in Excel style.
+        
+        Returns:
+            bool: True if the style is built-in; otherwise, False.
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def Name(self)->str:
+        """Gets the name of the style.
+        
+        Returns:
+            str: The name of the style.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def IsInitialized(self)->bool:
+        """Gets whether the style has been initialized.
+        
+        Returns:
+            bool: True if the style has been initialized; otherwise, False.
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def Interior(self)->'IInterior':
+        """Gets the interior formatting of the style.
+        
+        Returns:
+            IInterior: An object that represents the interior formatting of the style.
+        """
+        pass
+
+