spire-pdf 11.6.1__py3-none-win_amd64.whl

spire/pdf/IPdfTextBoxField.py

@@ -0,0 +1,305 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar, Union, Generic, List, Tuple
+from spire.pdf.common import *
+from spire.pdf import *
+from ctypes import *
+import abc
+
+class IPdfTextBoxField(abc.ABC):
+    """
+    Interface for a PDF text box field.
+    """
+
+    @property
+    @abc.abstractmethod
+    def BackColor(self) -> 'PdfRGBColor':
+        """
+        Get or Set the background color of the field.
+
+        Returns:
+            A PdfRGBColor object specifying the background color of the field.
+        """
+        pass
+
+    @BackColor.setter
+    @abc.abstractmethod
+    def BackColor(self, value: 'PdfRGBColor'):
+        """
+        Set the background color of the field.
+
+        Args:
+            value: A PdfRGBColor object specifying the background color of the field.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def ForeColor(self) -> 'PdfRGBColor':
+        """
+        Get or Set the fore color of the field.
+
+        Returns:
+            A PdfRGBColor object specifying the foreground color of the field.
+        """
+        pass
+
+    @ForeColor.setter
+    @abc.abstractmethod
+    def ForeColor(self, value: 'PdfRGBColor'):
+        """
+        Set the fore color of the field.
+
+        Args:
+            value: A PdfRGBColor object specifying the foreground color of the field.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def TextAlignment(self) -> 'PdfTextAlignment':
+        """
+        Get or Set the text alignment in a text box.
+
+        Returns:
+            A PdfTextAlignment enumeration member specifying the text alignment in a text box.
+        """
+        pass
+
+    @TextAlignment.setter
+    @abc.abstractmethod
+    def TextAlignment(self, value: 'PdfTextAlignment'):
+        """
+        Set the text alignment in a text box.
+
+        Args:
+            value: A PdfTextAlignment enumeration member specifying the text alignment in a text box.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def HighlightMode(self) -> 'PdfHighlightMode':
+        """
+        Get or Set the HighLightMode of the Field.
+
+        Returns:
+            A PdfHighlightMode enumeration member specifying the highlight mode in a text box.
+        """
+        pass
+
+    @HighlightMode.setter
+    @abc.abstractmethod
+    def HighlightMode(self, value: 'PdfHighlightMode'):
+        """
+        Set the HighLightMode of the Field.
+
+        Args:
+            value: A PdfHighlightMode enumeration member specifying the highlight mode in a text box.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def Text(self) -> str:
+        """
+        Get or Set value of the text box field.
+
+        Returns:
+            A string value representing the value of the item.
+        """
+        pass
+
+    @Text.setter
+    @abc.abstractmethod
+    def Text(self, value: str):
+        """
+        Set value of the text box field.
+
+        Args:
+            value: A string value representing the value of the item.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def DefaultValue(self) -> str:
+        """
+        Get or set the default value of the field.
+
+        Returns:
+            A string value representing the default value of the item.
+        """
+        pass
+
+    @DefaultValue.setter
+    @abc.abstractmethod
+    def DefaultValue(self, value: str):
+        """
+        Set the default value of the field.
+
+        Args:
+            value: A string value representing the default value of the item.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def SpellCheck(self) -> bool:
+        """
+        Get or sets a value indicating whether to check spelling.
+
+        Returns:
+            True if the field content should be checked for spelling errors, false otherwise. Default is true.
+        """
+        pass
+
+    @SpellCheck.setter
+    @abc.abstractmethod
+    def SpellCheck(self, value: bool):
+        """
+        Set a value indicating whether to check spelling.
+
+        Args:
+            value: True if the field content should be checked for spelling errors, false otherwise.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def InsertSpaces(self) -> bool:
+        """
+        Meaningful only if the MaxLength property is set and the Multiline, Password properties are false.
+        If set, the field is automatically divided into as many equally spaced positions, or combs,
+        as the value of MaxLength, and the text is laid out into those combs.
+        """
+        pass
+
+    @InsertSpaces.setter
+    @abc.abstractmethod
+    def InsertSpaces(self, value: bool):
+        """
+        Set a value indicating whether to insert spaces.
+
+        Args:
+            value: True if the field should be divided into equally spaced positions, false otherwise.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def Multiline(self) -> bool:
+        """
+        Get or sets a value indicating whether this is multiline.
+
+        Returns:
+            True if the field is multiline, false otherwise. Default is false.
+        """
+        pass
+
+    @Multiline.setter
+    @abc.abstractmethod
+    def Multiline(self, value: bool):
+        """
+        Set a value indicating whether this is multiline.
+
+        Args:
+            value: True if the field is multiline, false otherwise.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def Password(self) -> bool:
+        """
+        Get or sets a value indicating whether this is password field.
+
+        Returns:
+            True if the field is a password field, false otherwise. Default is false.
+        """
+        pass
+
+    @Password.setter
+    @abc.abstractmethod
+    def Password(self, value: bool):
+        """
+        Set a value indicating whether this is password field.
+
+        Args:
+            value: True if the field is a password field, false otherwise.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def Scrollable(self) -> bool:
+        """
+        Get or sets a value indicating whether this is scrollable.
+
+        Returns:
+            True if the field content can be scrolled, false otherwise. Default is true.
+        """
+        pass
+
+    @Scrollable.setter
+    @abc.abstractmethod
+    def Scrollable(self, value: bool):
+        """
+        Set a value indicating whether this is scrollable.
+
+        Args:
+            value: True if the field content can be scrolled, false otherwise.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def MaxLength(self) -> int:
+        """
+        Get or sets the maximum length of the field, in characters.
+
+        Returns:
+            A positive integer value specifying the maximum number of characters that can be entered in the text edit field.
+        """
+        pass
+
+    @MaxLength.setter
+    @abc.abstractmethod
+    def MaxLength(self, value: int):
+        """
+        Set the maximum length of the field, in characters.
+
+        Args:
+            value: A positive integer value specifying the maximum number of characters that can be entered in the text edit field.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def Actions(self) -> 'PdfFieldActions':
+        """
+        Get the actions of the field.
+
+        Returns:
+            The actions.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def Bounds(self) -> 'RectangleF':
+        """
+        Get or sets the bounds.
+        """
+        pass
+
+    @Bounds.setter
+    @abc.abstractmethod
+    def Bounds(self, value: 'RectangleF'):
+        """
+        Set the bounds.
+
+        Args:
+            value: The bounds of the field.
+        """
+       

spire/pdf/IStructureNode.py

@@ -0,0 +1,12 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar,Union,Generic,List,Tuple
+from spire.pdf.common import *
+from spire.pdf import *
+from ctypes import *
+import abc
+
+class IStructureNode (abc.ABC) :
+    """
+    Represents the pdf structure node.
+    """

spire/pdf/ITSAService.py

@@ -0,0 +1,27 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar, Union, Generic, List, Tuple
+from spire.pdf.common import *
+from spire.pdf import *
+from ctypes import *
+import abc
+
+class ITSAService(abc.ABC):
+    """
+    Timestamp provider interface.
+    """
+
+    @abc.abstractmethod
+    def Generate(self, signature: 'Byte[]') -> List['Byte']:
+        """
+        Generate timestamp token.
+
+        Args:
+            signature: The value of signature field within SignerInfo.
+                       The value of messageImprint field within TimeStampToken shall be the hash of signature.
+                       Refrence RFC 3161 APPENDIX A.
+
+        Returns:
+            timestamp which must conform to RFC 3161
+        """
+        pass

spire/pdf/ImageFormatType.py

@@ -0,0 +1,16 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar, Union, Generic, List, Tuple
+from spire.pdf.common import *
+from spire.pdf import *
+from ctypes import *
+import abc
+
+class ImageFormatType(Enum):
+    """
+    Enum class for different image formats.
+    """
+    Original = 0
+    Png = 1
+    Jpeg = 2
+    Bmp = 3

spire/pdf/ImageQuality.py

@@ -0,0 +1,15 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar, Union, Generic, List, Tuple
+from spire.pdf.common import *
+from spire.pdf import *
+from ctypes import *
+import abc
+
+class ImageQuality(Enum):
+    """
+    Enum class for ImageQuality.
+    """
+    High = 0
+    Medium = 1
+    Low = 2

spire/pdf/ImageType.py

@@ -0,0 +1,14 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar, Union, Generic, List, Tuple
+from spire.pdf.common import *
+from spire.pdf import *
+from ctypes import *
+import abc
+
+class ImageType(Enum):
+    """
+    Enum class representing different types of images.
+    """
+    Bitmap = 0
+    Metafile = 1

spire/pdf/ImgData.py

@@ -0,0 +1,208 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar, Union, Generic, List, Tuple
+from spire.pdf.common import *
+from spire.pdf import *
+from ctypes import *
+import abc
+
+class ImgData(abc.ABC):
+    """
+    Abstract base class for image data.
+    """
+
+    @property
+    @abc.abstractmethod
+    def TileWidth(self) -> int:
+        """
+        Returns the width of the tile.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def TileHeight(self) -> int:
+        """
+        Returns the height of the tile.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def NomTileWidth(self) -> int:
+        """
+        Returns the nominal width of the tile.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def NomTileHeight(self) -> int:
+        """
+        Returns the nominal height of the tile.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def ImgWidth(self) -> int:
+        """
+        Returns the width of the image.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def ImgHeight(self) -> int:
+        """
+        Returns the height of the image.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def NumComps(self) -> int:
+        """
+        Returns the number of components in the image.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def TileIdx(self) -> int:
+        """
+        Returns the index of the current tile.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def TilePartULX(self) -> int:
+        """
+        Returns the upper-left x-coordinate of the current tile part.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def TilePartULY(self) -> int:
+        """
+        Returns the upper-left y-coordinate of the current tile part.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def ImgULX(self) -> int:
+        """
+        Returns the upper-left x-coordinate of the image.
+        """
+        pass
+
+    @property
+    @abc.abstractmethod
+    def ImgULY(self) -> int:
+        """
+        Returns the upper-left y-coordinate of the image.
+        """
+        pass
+
+    @abc.abstractmethod
+    def getCompSubsX(self, c: int) -> int:
+        """
+        Returns the horizontal subsampling factor for the specified component.
+        """
+        pass
+
+    @abc.abstractmethod
+    def getCompSubsY(self, c: int) -> int:
+        """
+        Returns the vertical subsampling factor for the specified component.
+        """
+        pass
+
+    @abc.abstractmethod
+    def getTileCompWidth(self, t: int, c: int) -> int:
+        """
+        Returns the width of the specified component in the specified tile.
+        """
+        pass
+
+    @abc.abstractmethod
+    def getTileCompHeight(self, t: int, c: int) -> int:
+        """
+        Returns the height of the specified component in the specified tile.
+        """
+        pass
+
+    @abc.abstractmethod
+    def getCompImgWidth(self, c: int) -> int:
+        """
+        Returns the width of the specified component in the image.
+        """
+        pass
+
+    @abc.abstractmethod
+    def getCompImgHeight(self, c: int) -> int:
+        """
+        Returns the height of the specified component in the image.
+        """
+        pass
+
+    @abc.abstractmethod
+    def getNomRangeBits(self, c: int) -> int:
+        """
+        Returns the number of bits in the nominal range for the specified component.
+        """
+        pass
+
+    @abc.abstractmethod
+    def setTile(self, x: int, y: int):
+        """
+        Sets the current tile to the tile at the specified coordinates.
+        """
+        pass
+
+    @abc.abstractmethod
+    def nextTile(self):
+        """
+        Moves to the next tile.
+        """
+        pass
+
+    @abc.abstractmethod
+    def getTile(self, co: 'Coord') -> 'Coord':
+        """
+        Returns the tile at the specified coordinates.
+        """
+        pass
+
+    @abc.abstractmethod
+    def getCompULX(self, c: int) -> int:
+        """
+        Returns the upper-left x-coordinate of the specified component.
+        """
+        pass
+
+    @abc.abstractmethod
+    def getCompULY(self, c: int) -> int:
+        """
+        Returns the upper-left y-coordinate of the specified component.
+        """
+        pass
+
+    @dispatch
+    @abc.abstractmethod
+    def getNumTiles(self, co: Coord) -> Coord:
+        """
+        Returns the number of tiles in the specified coordinates.
+        """
+        pass
+
+    @dispatch
+    @abc.abstractmethod
+    def getNumTiles(self) -> int:
+        """
+        Returns the total number of tiles.
+        """
+        pass

spire/pdf/LayerExportState.py

@@ -0,0 +1,15 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar, Union, Generic, List, Tuple
+from spire.pdf.common import *
+from spire.pdf import *
+from ctypes import *
+import abc
+
+class LayerExportState(Enum):
+    """
+    Specifies the export state of the Layer
+    """
+    Allways = 0
+    Nerver = 1
+    ExportWhenVisible = 2

spire/pdf/LayerPrintState.py

@@ -0,0 +1,20 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar, Union, Generic, List, Tuple
+from spire.pdf.common import *
+from spire.pdf import *
+from ctypes import *
+import abc
+
+class LayerPrintState(Enum):
+    """
+    Enum class that specifies the print state of the Layer.
+    
+    Attributes:
+        Allways: The layer should always be printed.
+        Nerver: The layer should never be printed.
+        PrintWhenVisible: The layer should be printed when it is visible.
+    """
+    Allways = 0
+    Nerver = 1
+    PrintWhenVisible = 2

spire/pdf/LayerViewState.py

@@ -0,0 +1,20 @@
+from enum import Enum
+from plum import dispatch
+from typing import TypeVar, Union, Generic, List, Tuple
+from spire.pdf.common import *
+from spire.pdf import *
+from ctypes import *
+import abc
+
+class LayerViewState(Enum):
+    """
+    Enum class that specifies the view state of the Layer.
+    
+    Attributes:
+        Allways: The layer is always visible.
+        Nerver: The layer is never visible.
+        ViewWhenOpen: The layer is visible when the document is opened.
+    """
+    Allways = 0
+    Nerver = 1
+    ViewWhenOpen = 2