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

spire/xls/interfaces/IPictureShape.py

@@ -0,0 +1,118 @@
+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 IPictureShape (  IShape, IExcelApplication) :
+    """Picture shape interface for Excel.
+    
+    This interface represents a picture or image shape in an Excel worksheet.
+    It provides properties and methods to manipulate the picture's appearance,
+    including file information, color settings, fill and line formatting.
+    
+    Inherits from:
+        IShape: Base shape interface
+        IExcelApplication: Excel application interface
+    """
+    @property
+    @abc.abstractmethod
+    def FileName(self)->str:
+        """Gets the filename of the picture.
+        
+        Returns:
+            str: The filename of the picture, including path information if available.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def Picture(self)->'Stream':
+        """Gets the picture data as a stream.
+        
+        Returns:
+            Stream: A stream containing the binary data of the picture.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def ColorFrom(self)->'Color':
+        """Gets the starting color for gradient effects applied to the picture.
+        
+        Returns:
+            Color: The starting color of the gradient effect.
+        """
+        pass
+
+
+    @ColorFrom.setter
+    @abc.abstractmethod
+    def ColorFrom(self, value:'Color'):
+        """Sets the starting color for gradient effects applied to the picture.
+        
+        Args:
+            value (Color): The starting color to be used for gradient effects.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def ColorTo(self)->'Color':
+        """Gets the ending color for gradient effects applied to the picture.
+        
+        Returns:
+            Color: The ending color of the gradient effect.
+        """
+        pass
+
+
+    @ColorTo.setter
+    @abc.abstractmethod
+    def ColorTo(self, value:'Color'):
+        """Sets the ending color for gradient effects applied to the picture.
+        
+        Args:
+            value (Color): The ending color to be used for gradient effects.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def Fill(self)->'IShapeFill':
+        """Gets the fill formatting properties for the picture shape.
+        
+        Returns:
+            IShapeFill: An interface for accessing and modifying the fill formatting.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def Line(self)->'IShapeLineFormat':
+        """Gets the line formatting properties for the picture shape border.
+        
+        Returns:
+            IShapeLineFormat: An interface for accessing and modifying the line formatting.
+        """
+        pass
+
+
+    @abc.abstractmethod
+    def Remove(self, removeImage:bool):
+        """Removes the picture shape from the worksheet.
+        
+        Args:
+            removeImage (bool): When True, removes the image data as well as the shape;
+                               when False, removes only the shape container while preserving the image data.
+        """
+        pass
+
+

spire/xls/interfaces/IPropertyData.py

@@ -0,0 +1,100 @@
+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 IPropertyData (abc.ABC) :
+    """Property data interface for Excel document properties.
+    
+    This interface represents a single property in a document property collection,
+    providing access to its value, name, and identifier. Property data can be
+    used to store custom metadata about a document.
+    """
+    @property
+    @abc.abstractmethod
+    def Value(self)->'SpireObject':
+        """Gets the value of the property.
+        
+        This property returns the current value stored in the property.
+        The returned object can be of various types depending on the property.
+        
+        Returns:
+            SpireObject: The value of the property.
+        """
+        pass
+
+
+#    @property
+#
+#    @abc.abstractmethod
+#    def Type(self)->'VarEnum':
+#        """Gets the data type of the property value.
+#        
+#        This property returns an enumeration value indicating the data type
+#        of the property value (such as string, integer, date, etc.).
+#        
+#        Returns:
+#            VarEnum: The data type of the property value.
+#        """
+#        pass
+#
+
+
+    @property
+    @abc.abstractmethod
+    def Name(self)->str:
+        """Gets the name of the property.
+        
+        This property returns the name that identifies the property in the collection.
+        
+        Returns:
+            str: The name of the property.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def Id(self)->int:
+        """Gets the identifier of the property.
+        
+        This property returns a numeric identifier for the property.
+        
+        Returns:
+            int: The identifier of the property.
+        """
+        pass
+
+
+    @Id.setter
+    @abc.abstractmethod
+    def Id(self, value:int):
+        """Sets the identifier of the property.
+        
+        This property sets a numeric identifier for the property.
+        
+        Args:
+            value (int): The new identifier for the property.
+        """
+        pass
+
+
+    @abc.abstractmethod
+    def SetValue(self, value:'SpireObject', type:'PropertyType')->bool:
+        """Sets the value and type of the property.
+        
+        This method sets the value of the property with the specified type.
+        
+        Args:
+            value (SpireObject): The new value to set for the property.
+            type (PropertyType): The type of the property value.
+            
+        Returns:
+            bool: True if the value was successfully set, otherwise False.
+        """
+        pass
+
+

spire/xls/interfaces/IPrstGeomShape.py

@@ -0,0 +1,103 @@
+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 IPrstGeomShape (  IShape, IExcelApplication) :
+    """Preset geometry shape interface for Excel.
+    
+    This interface represents a shape with preset geometry in an Excel worksheet.
+    Preset geometry shapes are predefined shapes like rectangles, circles, arrows, stars, etc.
+    This interface provides properties to control the shape type, text content, and text alignment.
+    
+    Inherits from:
+        IShape: Base shape interface
+        IExcelApplication: Excel application interface
+    """
+    @property
+    @abc.abstractmethod
+    def PrstShapeType(self)->'PrstGeomShapeType':
+        """Gets the preset shape type.
+        
+        This property returns an enumeration value indicating the type of preset geometry
+        shape, such as rectangle, circle, arrow, star, etc.
+        
+        Returns:
+            PrstGeomShapeType: The preset geometry shape type.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def Text(self)->str:
+        """Gets the text displayed in the shape.
+        
+        This property returns the text content that is displayed inside the shape.
+        
+        Returns:
+            str: The text content of the shape.
+        """
+        pass
+
+
+    @Text.setter
+    @abc.abstractmethod
+    def Text(self, value:str):
+        """Sets the text displayed in the shape.
+        
+        This property sets the text content that is displayed inside the shape.
+        
+        Args:
+            value (str): The new text content for the shape.
+        """
+        pass
+
+
+#    @property
+#
+#    @abc.abstractmethod
+#    def GeomPaths(self)->'CollectionExtended1':
+#        """Gets the geometric paths that define the shape.
+#        
+#        This property returns a collection of geometric paths that define the
+#        outline and structure of the shape.
+#        
+#        Returns:
+#            CollectionExtended1: A collection of geometric paths.
+#        """
+#        pass
+#
+
+
+    @property
+    @abc.abstractmethod
+    def TextVerticalAlignment(self)->'ExcelVerticalAlignment':
+        """Gets the vertical alignment of text within the shape.
+        
+        This property returns an enumeration value indicating how text is vertically
+        aligned within the shape (top, middle, bottom, etc.).
+        
+        Returns:
+            ExcelVerticalAlignment: The vertical alignment of text within the shape.
+        """
+        pass
+
+
+    @TextVerticalAlignment.setter
+    @abc.abstractmethod
+    def TextVerticalAlignment(self, value:'ExcelVerticalAlignment'):
+        """Sets the vertical alignment of text within the shape.
+        
+        This property sets how text is vertically aligned within the shape
+        (top, middle, bottom, etc.).
+        
+        Args:
+            value (ExcelVerticalAlignment): The vertical alignment to set for the text.
+        """
+        pass
+
+

spire/xls/interfaces/IRadioButton.py

@@ -0,0 +1,159 @@
+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 IRadioButton (  IShape, IExcelApplication) :
+    """Radio button control interface for Excel.
+    
+    This interface represents a radio button form control in an Excel worksheet.
+    Radio buttons are used to present a set of mutually exclusive options, where
+    only one option can be selected at a time. This interface provides properties
+    to control the appearance and behavior of radio buttons.
+    
+    Inherits from:
+        IShape: Base shape interface
+        IExcelApplication: Excel application interface
+    """
+    @property
+    @abc.abstractmethod
+    def CheckState(self)->'CheckState':
+        """Gets the check state of the radio button.
+        
+        This property returns an enumeration value indicating whether the radio button
+        is checked, unchecked, or in a mixed state.
+        
+        Returns:
+            CheckState: The current check state of the radio button.
+        """
+        pass
+
+
+    @CheckState.setter
+    @abc.abstractmethod
+    def CheckState(self, value:'CheckState'):
+        """Sets the check state of the radio button.
+        
+        This property sets whether the radio button is checked, unchecked, or in a mixed state.
+        Note that setting one radio button in a group to checked will automatically
+        uncheck other radio buttons in the same group.
+        
+        Args:
+            value (CheckState): The check state to set for the radio button.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def IsFirstButton(self)->bool:
+        """Gets whether this radio button is the first button in its group.
+        
+        Radio buttons are organized in groups where only one can be selected at a time.
+        This property returns whether this radio button is the first one in its group.
+        
+        Returns:
+            bool: True if this is the first radio button in the group, otherwise False.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def Display3DShading(self)->bool:
+        """Gets whether the radio button displays with a 3D shading effect.
+        
+        This property returns whether the radio button has a three-dimensional
+        shading effect applied to its appearance.
+        
+        Returns:
+            bool: True if the radio button displays with 3D shading, otherwise False.
+        """
+        pass
+
+
+    @Display3DShading.setter
+    @abc.abstractmethod
+    def Display3DShading(self, value:bool):
+        """Sets whether the radio button displays with a 3D shading effect.
+        
+        This property sets whether the radio button has a three-dimensional
+        shading effect applied to its appearance.
+        
+        Args:
+            value (bool): True to display the radio button with 3D shading, otherwise False.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def Line(self)->'IShapeLineFormat':
+        """Gets the line formatting for the radio button's border.
+        
+        This property returns an interface that provides access to line formatting properties
+        such as color, style, weight, etc. for the border of the radio button.
+        
+        Returns:
+            IShapeLineFormat: An interface for accessing and modifying the line formatting.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def Text(self)->str:
+        """Gets the text label displayed next to the radio button.
+        
+        This property returns the text that appears as a label for the radio button.
+        
+        Returns:
+            str: The text label of the radio button.
+        """
+        pass
+
+
+    @Text.setter
+    @abc.abstractmethod
+    def Text(self, value:str):
+        """Sets the text label displayed next to the radio button.
+        
+        This property sets the text that appears as a label for the radio button.
+        
+        Args:
+            value (str): The new text label for the radio button.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def IsTextLocked(self)->bool:
+        """Gets whether the text label of the radio button is locked for editing.
+        
+        When true, the text label cannot be edited by the user in Excel.
+        When false, the user can edit the text label.
+        
+        Returns:
+            bool: True if the text label is locked, otherwise False.
+        """
+        pass
+
+
+    @IsTextLocked.setter
+    @abc.abstractmethod
+    def IsTextLocked(self, value:bool):
+        """Sets whether the text label of the radio button is locked for editing.
+        
+        When set to true, the text label cannot be edited by the user in Excel.
+        When set to false, the user can edit the text label.
+        
+        Args:
+            value (bool): True to lock the text label, otherwise False.
+        """
+        pass
+
+

spire/xls/interfaces/IRectangleShape.py

@@ -0,0 +1,90 @@
+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 IRectangleShape (  ITextBox, IPrstGeomShape) :
+    """Rectangle shape interface for Excel.
+    
+    This interface represents a rectangle shape in an Excel worksheet.
+    It provides properties to control the rectangle type, rotation, line formatting,
+    and hyperlink settings. Rectangle shapes can be used for highlighting areas,
+    creating containers, or adding decorative elements to a worksheet.
+    
+    Inherits from:
+        ITextBox: Text box interface for handling text within the shape
+        IPrstGeomShape: Preset geometry shape interface
+    """
+    @property
+    @abc.abstractmethod
+    def RectShapeType(self)->'RectangleShapeType':
+        """Gets the rectangle shape type.
+        
+        This property returns an enumeration value indicating the specific type of
+        rectangle shape, such as standard rectangle, rounded rectangle, snip corner, etc.
+        
+        Returns:
+            RectangleShapeType: The type of the rectangle shape.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def Rotation(self)->int:
+        """Gets the rotation angle of the rectangle shape in degrees.
+        
+        This property returns the rotation angle of the rectangle shape in degrees,
+        where 0 represents no rotation and positive values represent clockwise rotation.
+        
+        Returns:
+            int: The rotation angle in degrees.
+        """
+        pass
+
+
+    @Rotation.setter
+    @abc.abstractmethod
+    def Rotation(self, value:int):
+        """Sets the rotation angle of the rectangle shape in degrees.
+        
+        This property sets the rotation angle of the rectangle shape in degrees,
+        where 0 represents no rotation and positive values represent clockwise rotation.
+        
+        Args:
+            value (int): The rotation angle in degrees.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def Line(self)->'IShapeLineFormat':
+        """Gets the line formatting for the rectangle's border.
+        
+        This property returns an interface that provides access to line formatting properties
+        such as color, style, weight, etc. for the border of the rectangle shape.
+        
+        Returns:
+            IShapeLineFormat: An interface for accessing and modifying the line formatting.
+        """
+        pass
+
+
+    @property
+    @abc.abstractmethod
+    def HyLink(self)->'IHyperLink':
+        """Gets the hyperlink associated with the rectangle shape.
+        
+        This property returns an interface that provides access to the hyperlink properties
+        of the rectangle shape, allowing the shape to act as a clickable link.
+        
+        Returns:
+            IHyperLink: An interface for accessing and modifying the hyperlink properties.
+        """
+        pass
+
+