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

spire/xls/interfaces/ITabSheet.py

@@ -0,0 +1,364 @@
+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 ITabSheet (  IExcelApplication) :
+    """Interface for Excel worksheet tabs.
+    
+    This interface represents a worksheet tab in an Excel workbook and provides properties
+    and methods to access and modify tab attributes such as color, name, visibility, and protection.
+    """
+    @property
+
+    @abc.abstractmethod
+    def TabKnownColor(self)->'ExcelColors':
+        """Gets the predefined color of the worksheet tab.
+        
+        Returns:
+            ExcelColors: An enumeration value representing the predefined color of the tab.
+        """
+        pass
+
+
+    @TabKnownColor.setter
+    @abc.abstractmethod
+    def TabKnownColor(self, value:'ExcelColors'):
+        """Sets the predefined color of the worksheet tab.
+        
+        Args:
+            value (ExcelColors): An enumeration value representing the predefined color to set.
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def TabColor(self)->'Color':
+        """Gets the custom color of the worksheet tab.
+        
+        Returns:
+            Color: A Color object representing the custom color of the tab.
+        """
+        pass
+
+
+    @TabColor.setter
+    @abc.abstractmethod
+    def TabColor(self, value:'Color'):
+        """Sets the custom color of the worksheet tab.
+        
+        Args:
+            value (Color): A Color object representing the custom color to set.
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def Pictures(self)->'IPictures':
+        """Gets the collection of pictures in the worksheet.
+        
+        Returns:
+            IPictures: A collection of picture objects in the worksheet.
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def Workbook(self)->'IWorkbook':
+        """Gets the parent workbook of the worksheet.
+        
+        Returns:
+            IWorkbook: The parent workbook object.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def IsRightToLeft(self)->bool:
+        """Gets whether the worksheet is displayed from right to left.
+        
+        Returns:
+            bool: True if the worksheet is displayed from right to left; otherwise, False.
+        """
+        pass
+
+
+    @IsRightToLeft.setter
+    @abc.abstractmethod
+    def IsRightToLeft(self, value:bool):
+        """Sets whether the worksheet is displayed from right to left.
+        
+        Args:
+            value (bool): True to display the worksheet from right to left; otherwise, False.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def IsSelected(self)->bool:
+        """Gets whether the worksheet is selected.
+        
+        Returns:
+            bool: True if the worksheet is selected; otherwise, False.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def TabIndex(self)->int:
+        """Gets the index of the worksheet tab.
+        
+        Returns:
+            int: The zero-based index of the worksheet tab.
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def Name(self)->str:
+        """Gets the name of the worksheet.
+        
+        Returns:
+            str: The name of the worksheet.
+        """
+        pass
+
+
+    @Name.setter
+    @abc.abstractmethod
+    def Name(self, value:str):
+        """Sets the name of the worksheet.
+        
+        Args:
+            value (str): The name to set for the worksheet.
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def Visibility(self)->'WorksheetVisibility':
+        """Gets the visibility state of the worksheet.
+        
+        Returns:
+            WorksheetVisibility: An enumeration value representing the visibility state.
+        """
+        pass
+
+
+    @Visibility.setter
+    @abc.abstractmethod
+    def Visibility(self, value:'WorksheetVisibility'):
+        """Sets the visibility state of the worksheet.
+        
+        Args:
+            value (WorksheetVisibility): An enumeration value representing the visibility state to set.
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def TextBoxes(self)->'ITextBoxes':
+        """Gets the collection of text boxes in the worksheet.
+        
+        Returns:
+            ITextBoxes: A collection of text box objects in the worksheet.
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def CheckBoxes(self)->'ICheckBoxes':
+        """Gets the collection of check boxes in the worksheet.
+        
+        Returns:
+            ICheckBoxes: A collection of check box objects in the worksheet.
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def ComboBoxes(self)->'IComboBoxes':
+        """Gets the collection of combo boxes in the worksheet.
+        
+        Returns:
+            IComboBoxes: A collection of combo box objects in the worksheet.
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def RadioButtons(self)->'IRadioButtons':
+        """Gets the collection of radio buttons in the worksheet.
+        
+        Returns:
+            IRadioButtons: A collection of radio button objects in the worksheet.
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def CodeName(self)->str:
+        """Gets the code name of the worksheet.
+        
+        Returns:
+            str: The code name of the worksheet.
+        """
+        pass
+
+
+    @CodeName.setter
+    @abc.abstractmethod
+    def CodeName(self, value:str):
+        """Sets the code name of the worksheet.
+        
+        Args:
+            value (str): The code name to set for the worksheet.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def ProtectContents(self)->bool:
+        """Gets whether the contents of the worksheet are protected.
+        
+        Returns:
+            bool: True if the contents are protected; otherwise, False.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def ProtectDrawingObjects(self)->bool:
+        """Gets whether the drawing objects in the worksheet are protected.
+        
+        Returns:
+            bool: True if the drawing objects are protected; otherwise, False.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def ProtectScenarios(self)->bool:
+        """Gets whether the scenarios in the worksheet are protected.
+        
+        Returns:
+            bool: True if the scenarios are protected; otherwise, False.
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def Protection(self)->'SheetProtectionType':
+        """Gets the protection type of the worksheet.
+        
+        Returns:
+            SheetProtectionType: An enumeration value representing the protection type.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def IsPasswordProtected(self)->bool:
+        """Gets whether the worksheet is protected with a password.
+        
+        Returns:
+            bool: True if the worksheet is password protected; otherwise, False.
+        """
+        pass
+
+
+    @abc.abstractmethod
+    def Activate(self):
+        """Activates the worksheet.
+        
+        Makes this worksheet the active sheet in the workbook.
+        """
+        pass
+
+
+    @abc.abstractmethod
+    def Select(self):
+        """Selects the worksheet.
+        
+        Selects this worksheet in the workbook.
+        """
+        pass
+
+
+    @abc.abstractmethod
+    def Unselect(self):
+        """Unselects the worksheet.
+        
+        Removes the selection from this worksheet in the workbook.
+        """
+        pass
+
+
+    @dispatch
+
+    @abc.abstractmethod
+    def Protect(self ,password:str):
+        """Protects the worksheet with a password.
+        
+        Args:
+            password (str): The password to use for protection.
+        """
+        pass
+
+
+    @dispatch
+
+    @abc.abstractmethod
+    def Protect(self ,password:str,options:SheetProtectionType):
+        """Protects the worksheet with a password and specific protection options.
+        
+        Args:
+            password (str): The password to use for protection.
+            options (SheetProtectionType): The protection options to apply.
+        """
+        pass
+
+
+
+    @abc.abstractmethod
+    def Unprotect(self ,password:str):
+        """Removes protection from the worksheet.
+        
+        Args:
+            password (str): The password used to protect the worksheet.
+        """
+        pass
+
+

spire/xls/interfaces/ITextBox.py

@@ -0,0 +1,140 @@
+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 ITextBox (  IExcelApplication) :
+    """Interface for text box objects in Excel worksheets.
+    
+    This interface represents a text box in an Excel worksheet and provides properties
+    to access and modify text box attributes such as alignment, text rotation, and content.
+    """
+    @property
+
+    @abc.abstractmethod
+    def HAlignment(self)->'CommentHAlignType':
+        """Gets the horizontal alignment of text in the text box.
+        
+        Returns:
+            CommentHAlignType: An enumeration value representing the horizontal alignment.
+        """
+        pass
+
+
+    @HAlignment.setter
+    @abc.abstractmethod
+    def HAlignment(self, value:'CommentHAlignType'):
+        """Sets the horizontal alignment of text in the text box.
+        
+        Args:
+            value (CommentHAlignType): An enumeration value representing the horizontal alignment to set.
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def VAlignment(self)->'CommentVAlignType':
+        """Gets the vertical alignment of text in the text box.
+        
+        Returns:
+            CommentVAlignType: An enumeration value representing the vertical alignment.
+        """
+        pass
+
+
+    @VAlignment.setter
+    @abc.abstractmethod
+    def VAlignment(self, value:'CommentVAlignType'):
+        """Sets the vertical alignment of text in the text box.
+        
+        Args:
+            value (CommentVAlignType): An enumeration value representing the vertical alignment to set.
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def TextRotation(self)->'TextRotationType':
+        """Gets the rotation of text in the text box.
+        
+        Returns:
+            TextRotationType: An enumeration value representing the text rotation.
+        """
+        pass
+
+
+    @TextRotation.setter
+    @abc.abstractmethod
+    def TextRotation(self, value:'TextRotationType'):
+        """Sets the rotation of text in the text box.
+        
+        Args:
+            value (TextRotationType): An enumeration value representing the text rotation to set.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def IsTextLocked(self)->bool:
+        """Gets whether the text in the text 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 in the text box is locked.
+        
+        Args:
+            value (bool): True to lock the text; otherwise, False.
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def RichText(self)->'IRichTextString':
+        """Gets the rich text formatting of the text box content.
+        
+        Returns:
+            IRichTextString: An object that represents the rich text formatting.
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def Text(self)->str:
+        """Gets the text content of the text box.
+        
+        Returns:
+            str: The text content of the text box.
+        """
+        pass
+
+
+    @Text.setter
+    @abc.abstractmethod
+    def Text(self, value:str):
+        """Sets the text content of the text box.
+        
+        Args:
+            value (str): The text content to set for the text box.
+        """
+        pass
+
+

spire/xls/interfaces/ITextBoxLinkShape.py

@@ -0,0 +1,48 @@
+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 ITextBoxLinkShape (  ITextBoxShape) :
+    """Interface for linked text box shapes in Excel worksheets.
+    
+    This interface represents a text box shape that is linked to another object
+    and provides properties to access and modify its rotation and hyperlink attributes.
+    """
+    @property
+    @abc.abstractmethod
+    def Rotation(self)->int:
+        """Gets the rotation angle of the linked text box shape in degrees.
+        
+        Returns:
+            int: The rotation angle in degrees.
+        """
+        pass
+
+
+    @Rotation.setter
+    @abc.abstractmethod
+    def Rotation(self, value:int):
+        """Sets the rotation angle of the linked text box shape in degrees.
+        
+        Args:
+            value (int): The rotation angle in degrees to set.
+        """
+        pass
+
+
+    @property
+
+    @abc.abstractmethod
+    def HyLink(self)->'IHyperLink':
+        """Gets the hyperlink associated with the linked text box shape.
+        
+        Returns:
+            IHyperLink: An object that represents the hyperlink associated with the text box.
+        """
+        pass
+
+

spire/xls/interfaces/ITextBoxShape.py

@@ -0,0 +1,27 @@
+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 ITextBoxShape (  ITextBox, IShape) :
+    """Interface for text box shapes in Excel worksheets.
+    
+    This interface combines the functionality of text boxes and shapes,
+    representing a text box that also has shape properties. It provides
+    access to line formatting for the text box border.
+    """
+    @property
+
+    @abc.abstractmethod
+    def Line(self)->'IShapeLineFormat':
+        """Gets the line formatting of the text box shape border.
+        
+        Returns:
+            IShapeLineFormat: An object that represents the line formatting of the text box border.
+        """
+        pass
+
+