spire-pdf 11.6.1__py3-none-macosx_10_7_universal.whl

spire/pdf/PdfComboBoxWidgetItemCollection.py

@@ -0,0 +1,29 @@
+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 PdfComboBoxWidgetItemCollection(PdfCollection):
+    """
+    Represents a collection of Combo box items.
+    """
+
+    def get_Item(self, index: int) -> 'PdfComboBoxWidgetWidgetItem':
+        """
+        Gets the item at the specified index.
+
+        Args:
+            index (int): The index of the item.
+
+        Returns:
+            PdfComboBoxWidgetWidgetItem: The item at the specified index.
+        """
+        
+        GetDllLibPdf().PdfComboBoxWidgetItemCollection_get_Item.argtypes = [c_void_p, c_int]
+        GetDllLibPdf().PdfComboBoxWidgetItemCollection_get_Item.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfComboBoxWidgetItemCollection_get_Item,self.Ptr, index)
+        ret = None if intPtr == None else PdfComboBoxWidgetWidgetItem(intPtr)
+        return ret

spire/pdf/PdfComboBoxWidgetWidgetItem.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 PdfComboBoxWidgetWidgetItem(PdfFieldWidgetItem):
+    """
+    Represents a group for a combo box field.
+
+    Attributes:
+        PdfFieldWidgetItem (class): The base class for all PDF field widget items.
+    """
+    pass

spire/pdf/PdfCompareOptions.py

@@ -0,0 +1,82 @@
+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 PdfCompareOptions(SpireObject):
+    @property
+    def OldPageStartIndex(self)->int:
+        """
+        <summary>
+        The start index of old document range.
+        </summary>
+        """
+        GetDllLibPdf().PdfCompareOptions_get_OldPageStartIndex.argtypes=[c_void_p]
+        GetDllLibPdf().PdfCompareOptions_get_OldPageStartIndex.restype=c_long
+        ret = GetDllLibPdf().PdfCompareOptions_get_OldPageStartIndex(self.Ptr)
+        return ret
+
+    @property
+    def OldPageEndIndex(self)->int:
+        """
+        <summary>
+        The end index of old document range.
+        </summary>
+        """
+        GetDllLibPdf().PdfCompareOptions_get_OldPageEndIndex.argtypes=[c_void_p]
+        GetDllLibPdf().PdfCompareOptions_get_OldPageEndIndex.restype=c_long
+        ret = GetDllLibPdf().PdfCompareOptions_get_OldPageEndIndex(self.Ptr)
+        return ret
+
+    @property
+    def NewPageStartIndex(self)->int:
+        """
+        <summary>
+        The start index of new document range.
+        </summary>
+        """
+        GetDllLibPdf().PdfCompareOptions_get_NewPageStartIndex.argtypes=[c_void_p]
+        GetDllLibPdf().PdfCompareOptions_get_NewPageStartIndex.restype=c_long
+        ret = GetDllLibPdf().PdfCompareOptions_get_NewPageStartIndex(self.Ptr)
+        return ret
+
+    @property
+    def NewPageEndIndex(self)->int:
+        """
+        <summary>
+        The end index of new document range.
+        </summary>
+        """
+        GetDllLibPdf().PdfCompareOptions_get_NewPageEndIndex.argtypes=[c_void_p]
+        GetDllLibPdf().PdfCompareOptions_get_NewPageEndIndex.restype=c_long
+        ret = GetDllLibPdf().PdfCompareOptions_get_NewPageEndIndex(self.Ptr)
+        return ret
+
+    @property
+    def OnlyCompareText(self)->bool:
+        """
+        Whether is only compare text.
+        """
+        GetDllLibPdf().PdfCompareOptions_get_OnlyCompareText.argtypes=[c_void_p]
+        GetDllLibPdf().PdfCompareOptions_get_OnlyCompareText.restype=c_bool
+        ret = CallCFunction(GetDllLibPdf().PdfCompareOptions_get_OnlyCompareText,self.Ptr)
+        return ret
+
+    @dispatch
+    def SetPageRanges(self ,oldStartIndex:int,oldEndIndex:int,newStartIndex:int,newEndIndex:int):
+        """
+        Set the compared documents page ranges.
+
+        Args:
+            oldStartIndex(int):The old document page start index.
+            oldEndIndex(int):The old document page end index.
+            newStartIndex(int):The new document page start index.
+            newEndIndex(int):The new document page end index.
+        """         
+        GetDllLibPdf().PdfCompareOptions_set_SetPageRanges.argtypes=[c_void_p,c_int,c_int,c_int,c_int]
+        CallCFunction(GetDllLibPdf().PdfCompareOptions_set_SetPageRanges,self.Ptr, oldStartIndex,oldEndIndex,newStartIndex,newEndIndex)
+
+

spire/pdf/PdfComparer.py

@@ -0,0 +1,63 @@
+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 PdfComparer(SpireObject):
+    @dispatch
+    def __init__(self, oldDocument: PdfDocument, newDocument: PdfDocument):
+        """
+        Initializes a new instance of the PdfComparer class with the PdfDocument.
+
+        Args:
+            oldDocument (PdfDocument): The old pdf document.
+            newDocument (PdfDocument): The new pdf document.
+        """
+        ptroldpdf: c_void_p = oldDocument.Ptr
+        ptrnewpdf: c_void_p = newDocument.Ptr
+        GetDllLibPdf().PdfComparer_CreatePdfComparer.argtypes = [c_void_p,c_void_p]
+        GetDllLibPdf().PdfComparer_CreatePdfComparer.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfComparer_CreatePdfComparer,ptroldpdf,ptrnewpdf)
+        super(PdfComparer, self).__init__(intPtr)
+
+    @property
+    def PdfCompareOptions(self) -> 'PdfCompareOptions':
+        """
+        The compare options.
+
+        Returns:
+            PdfCompareOptions: The options for compare PdfDocument.
+        """
+        GetDllLibPdf().PdfComparer_get_CompareOptions.argtypes = [c_void_p]
+        GetDllLibPdf().PdfComparer_get_CompareOptions.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfComparer_get_CompareOptions,self.Ptr)
+        ret = None if intPtr == None else PdfCompareOptions(intPtr)
+        return ret
+
+    @dispatch
+    def Compare(self, filename: str):
+        """
+        Compare the old/new pdf docments,generate diff pdf document.
+
+        Args:
+            filename (str): The output file name.
+        """
+        GetDllLibPdf().PdfComparer_CompareToFile.argtypes = [c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibPdf().PdfComparer_CompareToFile,self.Ptr, filename)
+
+    @dispatch
+    def Compare(self, fileStream: Stream):
+        """
+        Compare the old/new pdf docments,generate diff pdf document.
+
+        Args:
+            fileStream (Stream): The output file stream.
+        """
+        intPtrfileStream: c_void_p = fileStream.Ptr
+
+        GetDllLibPdf().PdfComparer_CompareToStream.argtypes = [c_void_p, c_void_p]
+        CallCFunction(GetDllLibPdf().PdfComparer_CompareToStream,self.Ptr, intPtrfileStream)
+

spire/pdf/PdfComplexColor.py

@@ -0,0 +1,23 @@
+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 PdfComplexColor(SpireObject):
+    """
+    Represents the extended color, based on a complex colorspace.
+    """
+
+    @property
+    def ColorSpace(self) -> 'PdfColorSpaces':
+        """
+        Gets the Colorspace.
+        """
+        GetDllLibPdf().PdfComplexColor_get_ColorSpace.argtypes = [c_void_p]
+        GetDllLibPdf().PdfComplexColor_get_ColorSpace.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfComplexColor_get_ColorSpace,self.Ptr)
+        ret = None if intPtr == None else PdfColorSpaces(intPtr)
+        return ret

spire/pdf/PdfCompositeField.py

@@ -0,0 +1,205 @@
+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 PdfCompositeField(PdfMultipleValueField):
+    """
+    Represents class which can concatenate multiple automatic fields into single string.
+    """
+
+    @dispatch
+    def __init__(self):
+        """
+        Initializes a new instance of the PdfCompositeField class.
+        """
+        GetDllLibPdf().PdfCompositeField_CreatePdfCompositeField.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfCompositeField_CreatePdfCompositeField)
+        super(PdfCompositeField, self).__init__(intPtr)
+
+    @dispatch
+    def __init__(self, font: PdfFontBase, brush: PdfBrush, text: str, listAf: List[PdfAutomaticField]):
+        """
+        Initializes a new instance of the PdfCompositeField class with the specified font, brush, text, and list of automatic fields.
+        
+        Args:
+            font (PdfFontBase): The font to be used.
+            brush (PdfBrush): The brush to be used.
+            text (str): The text to be drawn.
+            listAf (List[PdfAutomaticField]): The list of automatic fields.
+        """
+        ptrFont: c_void_p = font.Ptr
+        ptrBrush: c_void_p = brush.Ptr
+
+        countnewValues = len(listAf)
+        ArrayTypenewValues = c_void_p * countnewValues
+        arraynewValues = ArrayTypenewValues()
+        for i in range(0, countnewValues):
+            arraynewValues[i] = listAf[i].Ptr
+
+        GetDllLibPdf().PdfCompositeField_CreatePdfCompositeFieldFBTL.argtypes = [c_void_p, c_void_p, c_wchar_p, ArrayTypenewValues, c_int]
+        GetDllLibPdf().PdfCompositeField_CreatePdfCompositeFieldFBTL.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfCompositeField_CreatePdfCompositeFieldFBTL,ptrFont, ptrBrush, text, arraynewValues, countnewValues)
+        super(PdfCompositeField, self).__init__(intPtr)
+
+    @dispatch
+    def __init__(self, font: PdfFontBase):
+        """
+        Initializes a new instance of the PdfCompositeField class with the specified font.
+        
+        Args:
+            font (PdfFontBase): The font to be used.
+        """
+        ptrFont: c_void_p = font.Ptr
+        GetDllLibPdf().PdfCompositeField_CreatePdfCompositeFieldF.argtypes = [c_void_p]
+        GetDllLibPdf().PdfCompositeField_CreatePdfCompositeFieldF.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfCompositeField_CreatePdfCompositeFieldF,ptrFont)
+        super(PdfCompositeField, self).__init__(intPtr)
+
+    @dispatch
+    def __init__(self, font: PdfFontBase, brush: PdfBrush):
+        """
+        Initializes a new instance of the PdfCompositeField class with the specified font and brush.
+        
+        Args:
+            font (PdfFontBase): The font to be used.
+            brush (PdfBrush): The brush to be used.
+        """
+        ptrFont: c_void_p = font.Ptr
+        ptrBrush: c_void_p = brush.Ptr
+        GetDllLibPdf().PdfCompositeField_CreatePdfCompositeFieldFB.argtypes = [c_void_p, c_void_p]
+        GetDllLibPdf().PdfCompositeField_CreatePdfCompositeFieldFB.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfCompositeField_CreatePdfCompositeFieldFB,ptrFont, ptrBrush)
+        super(PdfCompositeField, self).__init__(intPtr)
+
+    @dispatch
+    def __init__(self, font: PdfFontBase, text: str):
+        """
+        Initializes a new instance of the PdfCompositeField class with the specified font and text.
+        
+        Args:
+            font (PdfFontBase): The font to be used.
+            text (str): The text to be drawn.
+        """
+        ptrFont: c_void_p = font.Ptr
+        GetDllLibPdf().PdfCompositeField_CreatePdfCompositeFieldFT.argtypes = [c_void_p, c_wchar_p]
+        GetDllLibPdf().PdfCompositeField_CreatePdfCompositeFieldFT.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfCompositeField_CreatePdfCompositeFieldFT,ptrFont, text)
+        super(PdfCompositeField, self).__init__(intPtr)
+
+    @dispatch
+    def __init__(self, font: PdfFontBase, brush: PdfBrush, text: str):
+        """
+        Initializes a new instance of the PdfCompositeField class with the specified font, brush, and text.
+        
+        Args:
+            font (PdfFontBase): The font to be used.
+            brush (PdfBrush): The brush to be used.
+            text (str): The text to be drawn.
+        """
+        ptrFont: c_void_p = font.Ptr
+        ptrBrush: c_void_p = brush.Ptr
+        GetDllLibPdf().PdfCompositeField_CreatePdfCompositeFieldFBT.argtypes = [c_void_p, c_void_p, c_wchar_p]
+        GetDllLibPdf().PdfCompositeField_CreatePdfCompositeFieldFBT.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfCompositeField_CreatePdfCompositeFieldFBT,ptrFont, ptrBrush, text)
+        super(PdfCompositeField, self).__init__(intPtr)
+
+    @dispatch
+    def __init__(self, text: str, listAf: List[PdfAutomaticField]):
+        """
+        Initializes a new instance of the PdfCompositeField class with the specified text and list of automatic fields.
+        
+        Args:
+            text (str): The text to be drawn.
+            listAf (List[PdfAutomaticField]): The list of automatic fields.
+        """
+        countnewValues = len(listAf)
+        ArrayTypenewValues = c_void_p * countnewValues
+        arraynewValues = ArrayTypenewValues()
+        for i in range(0, countnewValues):
+            arraynewValues[i] = listAf[i].Ptr
+
+        GetDllLibPdf().PdfCompositeField_CreatePdfCompositeFieldTL.argtypes = [c_wchar_p, ArrayTypenewValues, c_int]
+        GetDllLibPdf().PdfCompositeField_CreatePdfCompositeFieldTL.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfCompositeField_CreatePdfCompositeFieldTL,text, arraynewValues, countnewValues)
+        super(PdfCompositeField, self).__init__(intPtr)
+
+    @dispatch
+    def __init__(self, font: PdfFontBase, text: str, listAf: List[PdfAutomaticField]):
+        """
+        Initializes a new instance of the PdfCompositeField class with the specified font, text, and list of automatic fields.
+        
+        Args:
+            font (PdfFontBase): The font to be used.
+            text (str): The text to be drawn.
+            listAf (List[PdfAutomaticField]): The list of automatic fields.
+        """
+        ptrFont: c_void_p = font.Ptr
+
+        countnewValues = len(listAf)
+        ArrayTypenewValues = c_void_p * countnewValues
+        arraynewValues = ArrayTypenewValues()
+        for i in range(0, countnewValues):
+            arraynewValues[i] = listAf[i].Ptr
+
+        GetDllLibPdf().PdfCompositeField_CreatePdfCompositeFieldFTL.argtypes = [c_void_p, c_wchar_p, ArrayTypenewValues, c_int]
+        GetDllLibPdf().PdfCompositeField_CreatePdfCompositeFieldFTL.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfCompositeField_CreatePdfCompositeFieldFTL,ptrFont, text, arraynewValues, countnewValues)
+        super(PdfCompositeField, self).__init__(intPtr)
+
+    @property
+    def Text(self) -> str:
+        """
+        Gets or sets the text.
+        
+        Returns:
+            str: The wide-character string to be drawn.
+        """
+        GetDllLibPdf().PdfCompositeField_get_Text.argtypes = [c_void_p]
+        GetDllLibPdf().PdfCompositeField_get_Text.restype = c_void_p
+        ret = PtrToStr(CallCFunction(GetDllLibPdf().PdfCompositeField_get_Text,self.Ptr))
+        return ret
+
+    @Text.setter
+    def Text(self, value: str):
+        """
+        Sets the text.
+        
+        Args:
+            value (str): The wide-character string to be drawn.
+        """
+        GetDllLibPdf().PdfCompositeField_set_Text.argtypes = [c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibPdf().PdfCompositeField_set_Text,self.Ptr, value)
+
+    @property
+    def AutomaticFields(self) -> List['PdfAutomaticField']:
+        """
+        Gets or sets the automatic fields.
+        
+        Returns:
+            List['PdfAutomaticField']: The automatic fields.
+        """
+        GetDllLibPdf().PdfCompositeField_get_AutomaticFields.argtypes = [c_void_p]
+        GetDllLibPdf().PdfCompositeField_get_AutomaticFields.restype = IntPtrArray
+        intPtrArray = CallCFunction(GetDllLibPdf().PdfCompositeField_get_AutomaticFields,self.Ptr)
+        ret = GetVectorFromArray(intPtrArray, PdfAutomaticField)
+        return ret
+
+    @AutomaticFields.setter
+    def AutomaticFields(self, value: List['PdfAutomaticField']):
+        """
+        Sets the automatic fields.
+        
+        Args:
+            value (List['PdfAutomaticField']): The automatic fields.
+        """
+        vCount = len(value)
+        ArrayType = c_void_p * vCount
+        vArray = ArrayType()
+        for i in range(0, vCount):
+            vArray[i] = value[i].Ptr
+        GetDllLibPdf().PdfCompositeField_set_AutomaticFields.argtypes = [c_void_p, ArrayType, c_int]
+        CallCFunction(GetDllLibPdf().PdfCompositeField_set_AutomaticFields,self.Ptr, vArray, vCount)

spire/pdf/PdfCompressionLevel.py

@@ -0,0 +1,42 @@
+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 PdfCompressionLevel(Enum):
+    """
+    Enum class that defines data compression levels.
+    """
+
+    none = 0
+    """
+    No compression.
+    """
+
+    BestSpeed = 1
+    """
+    Compression level for best speed.
+    """
+
+    BelowNormal = 3
+    """
+    Compression level below normal.
+    """
+
+    Normal = 5
+    """
+    Normal compression level.
+    """
+
+    AboveNormal = 7
+    """
+    Compression level above normal.
+    """
+
+    Best = 9
+    """
+    Best compression level.
+    """

spire/pdf/PdfCompressor.py

@@ -0,0 +1,79 @@
+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 PdfCompressor(SpireObject):
+    """
+    The pdf document compressor.
+    """
+    @dispatch
+    def __init__(self, filePath: str):
+        """
+        Construct a new converter.
+
+        Args:
+            filePath (str): The path of the PDF file.
+        """
+        GetDllLibPdf().PdfCompressor_CreatePdfCompressorF.argtypes = [c_wchar_p]
+        GetDllLibPdf().PdfCompressor_CreatePdfCompressorF.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfCompressor_CreatePdfCompressorF,filePath)
+        super(PdfCompressor, self).__init__(intPtr)
+
+    @dispatch
+    def __init__(self, stream: Stream):
+        """
+         Initializes a new instance of the class.
+
+        Args:
+            stream (Stream): The stream containing the PDF data.
+        """
+        ptrStream: c_void_p = stream.Ptr
+        GetDllLibPdf().PdfCompressor_CreatePdfCompressorS.argtypes = [c_void_p]
+        GetDllLibPdf().PdfCompressor_CreatePdfCompressorS.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfCompressor_CreatePdfCompressorS,ptrStream)
+        super(PdfCompressor, self).__init__(intPtr)
+
+    @dispatch
+    def CompressToStream(self, fileStream: Stream):
+        """
+        Compress the document to the specified stream.
+
+        Args:
+            fileStream (Stream): The output file stream.
+        """
+        intPtrfileStream: c_void_p = fileStream.Ptr
+
+        GetDllLibPdf().PdfCompressor_CompressToFileS.argtypes = [c_void_p, c_void_p]
+        CallCFunction(GetDllLibPdf().PdfCompressor_CompressToFileS,self.Ptr, intPtrfileStream)
+
+    @dispatch
+    def CompressToFile(self, filename: str):
+        """
+        Compress document.
+
+        Args:
+            filename (str): The output file name.
+        """
+        GetDllLibPdf().PdfCompressor_CompressToFileF.argtypes = [c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibPdf().PdfCompressor_CompressToFileF,self.Ptr, filename)
+
+    @property
+    def OptimizationOptions(self)->OptimizationOptions:
+        """
+        The compression options.
+        """
+        GetDllLibPdf().PdfCompressor_get_OptimizationOptions.argtypes=[c_void_p]
+        GetDllLibPdf().PdfCompressor_get_OptimizationOptions.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfCompressor_get_OptimizationOptions,self.Ptr)
+        ret = None if intPtr==None else OptimizationOptions(intPtr)
+        return ret
+
+
+    @OptimizationOptions.setter
+    def OptimizationOptions(self, value:OptimizationOptions):
+        GetDllLibPdf().PdfCompressor_set_OptimizationOptions.argtypes=[c_void_p, c_void_p]
+        CallCFunction(GetDllLibPdf().PdfCompressor_set_OptimizationOptions,self.Ptr, value.Ptr)

spire/pdf/PdfConformanceException.py

@@ -0,0 +1,13 @@
+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 PdfConformanceException(PdfDocumentException):
+    """
+    Exception of this type is raised when the document contains objects which are not supported by the current document standard.
+    """
+    pass

spire/pdf/PdfConformanceLevel.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 PdfConformanceLevel(Enum):
+    """
+    Enum class that specifies the Pdf document's Conformance-level.
+    """
+    none = 0
+    Pdf_A1B = 1
+    Pdf_X1A2001 = 2
+    Pdf_A1A = 3
+    Pdf_A2A = 4
+    Pdf_A2B = 5
+    Pdf_A3A = 6
+    Pdf_A3B = 7