spire-pdf 11.6.1__py3-none-macosx_10_7_universal.whl

spire/pdf/ArtifactPropertyList.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 ArtifactPropertyList(SpireObject):
+    """
+    Represents the Pdf Artifact property list.
+    """
+    pass

spire/pdf/AspectRatio.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 AspectRatio(Enum):
+    """
+    Enumeration for aspect ratio options.
+    """
+    none = 0
+    KeepWidth = 1
+    KeepHeight = 2
+    FitPageSize = 3

spire/pdf/BookletOptions.py

@@ -0,0 +1,40 @@
+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 BookletOptions(SpireObject):
+    """
+    The booklet options.
+    """
+
+    @dispatch
+    def __init__(self):
+        """
+        Initializes a new instance of the BookletOptions class.
+        """
+        GetDllLibPdf().BookletOptions_CreateBookletOptions.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().BookletOptions_CreateBookletOptions)
+        super(BookletOptions, self).__init__(intPtr)
+
+    @property
+    def BookletBinding(self) -> 'PdfBookletBindingMode':
+        """
+        Gets or sets the booklet binding mode. The default value is Left.
+        """
+        GetDllLibPdf().BookletOptions_get_BookletBinding.argtypes = [c_void_p]
+        GetDllLibPdf().BookletOptions_get_BookletBinding.restype = c_int
+        ret = CallCFunction(GetDllLibPdf().BookletOptions_get_BookletBinding,self.Ptr)
+        objwrapped = PdfBookletBindingMode(ret)
+        return objwrapped
+
+    @BookletBinding.setter
+    def BookletBinding(self, value: 'PdfBookletBindingMode'):
+        """
+        Sets the booklet binding mode.
+        """
+        GetDllLibPdf().BookletOptions_set_BookletBinding.argtypes = [c_void_p, c_int]
+        CallCFunction(GetDllLibPdf().BookletOptions_set_BookletBinding,self.Ptr, value.value)

spire/pdf/Clip.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 Clip(Enum):
+    """
+    Options of converting html to pdf
+    """
+    none = 0
+    Width = 1
+    Height = 2
+    Both = 4

spire/pdf/Collections_PdfCollection.py

@@ -0,0 +1,121 @@
+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 Collections_PdfCollection(SpireObject):
+    """
+    A collection specifies the viewing and organizational characteristics
+    of portable collections. The intent of portable collections is to present,
+    sort, and search collections of related documents, such as email archives,
+    photo collections, and engineering bidsets.
+    """
+
+    @property
+    def Folders(self) -> 'PdfFolder':
+        """
+        (Required if the collection has folders; ExtensionLevel3)
+        An indirect reference to the folder dictionary that is the
+        single common ancestor of all other folders in a portable
+        collection.
+        """
+        GetDllLibPdf().Collections_PdfCollection_get_Folders.argtypes = [c_void_p]
+        GetDllLibPdf().Collections_PdfCollection_get_Folders.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().Collections_PdfCollection_get_Folders,self.Ptr)
+        ret = None if intPtr == None else PdfFolder(intPtr)
+        return ret
+
+    @property
+    def AssociatedFiles(self) -> List['PdfAttachment']:
+        """
+        Get the document collection associated files
+        """
+        GetDllLibPdf().Collections_PdfCollection_get_AssociatedFiles.argtypes = [c_void_p]
+        GetDllLibPdf().Collections_PdfCollection_get_AssociatedFiles.restype = IntPtrArray
+        intPtrArr = CallCFunction(GetDllLibPdf().Collections_PdfCollection_get_AssociatedFiles,self.Ptr)
+        ret = None if intPtrArr == None else GetObjVectorFromArray(intPtrArr, PdfAttachment)
+        return ret
+
+    @dispatch
+    def AddFile(self, filePath: str):
+        """
+        Add a local file.
+        :param filePath: The local file path.
+        """
+        GetDllLibPdf().Collections_PdfCollection_AddFile.argtypes = [c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibPdf().Collections_PdfCollection_AddFile,self.Ptr, filePath)
+
+    @dispatch
+    def AddFile(self, fileName: str, stream: Stream):
+        """
+        Add a stream.
+        :param fileName: The file name of the stream.
+        :param stream: The stream.
+        """
+        intPtrstream: c_void_p = stream.Ptr
+        GetDllLibPdf().Collections_PdfCollection_AddFileFS.argtypes = [c_void_p, c_wchar_p, c_void_p]
+        CallCFunction(GetDllLibPdf().Collections_PdfCollection_AddFileFS,self.Ptr, fileName, intPtrstream)
+
+    def AddAttachment(self, attachment: 'PdfAttachment'):
+        """
+        Add an attachment.
+        :param attachment: The attachment.
+        """
+        intPtrattachment: c_void_p = attachment.Ptr
+        GetDllLibPdf().Collections_PdfCollection_AddAttachment.argtypes = [c_void_p, c_void_p]
+        CallCFunction(GetDllLibPdf().Collections_PdfCollection_AddAttachment,self.Ptr, intPtrattachment)
+
+    def AddCustomField(self, fieldName: str, displayText: str, fieldType: 'CustomFieldType'):
+        """
+        Add a custom field.
+        :param fieldName: Custom field name.
+        :param displayText: Custom field display name.
+        :param fieldType: Custom field type.
+        """
+        enumfieldType: c_int = fieldType.value
+        GetDllLibPdf().Collections_PdfCollection_AddCustomField.argtypes = [c_void_p, c_wchar_p, c_wchar_p, c_int]
+        CallCFunction(GetDllLibPdf().Collections_PdfCollection_AddCustomField,self.Ptr, fieldName, displayText, enumfieldType)
+
+    def AddFileRelatedField(self, fieldName: str, displayText: str, fieldType: 'FileRelatedFieldType'):
+        """
+        Add a file related field.
+        :param fieldName: File related field name.
+        :param displayText: File related field display name.
+        :param fieldType: File related field type.
+        """
+        enumfieldType: c_int = fieldType.value
+        GetDllLibPdf().Collections_PdfCollection_AddFileRelatedField.argtypes = [c_void_p, c_wchar_p, c_wchar_p, c_int]
+        CallCFunction(GetDllLibPdf().Collections_PdfCollection_AddFileRelatedField,self.Ptr, fieldName, displayText, enumfieldType)
+
+    def Sort(self, fieldNames: List[str], order: List[bool]):
+        """
+        Sort embedded files with field names.
+        :param fieldNames: The names of fields that the PDF viewer application
+        uses to sort the items in the collection.
+        :param order: Specifies whether the items in the collection are sorted
+        in ascending order.
+        """
+        countfieldNames = len(fieldNames)
+        ArrayTypefieldNames = c_wchar_p * countfieldNames
+        arrayfieldNames = ArrayTypefieldNames()
+        for i in range(0, countfieldNames):
+            arrayfieldNames[i] = fieldNames[i]
+
+        countorder = len(order)
+        ArrayTypeorder = c_int * countorder
+        arrayorder = ArrayTypeorder()
+        for i in range(0, countorder):
+            arrayorder[i] = 1 if order[i] else 0
+
+        GetDllLibPdf().Collections_PdfCollection_Sort.argtypes = [c_void_p, ArrayTypefieldNames, c_int, ArrayTypeorder, c_int]
+        CallCFunction(GetDllLibPdf().Collections_PdfCollection_Sort,self.Ptr, arrayfieldNames, countfieldNames, arrayorder, countorder)
+
+    def Clear(self):
+        """
+        Clear all files and folders.
+        """
+        GetDllLibPdf().Collections_PdfCollection_Clear.argtypes = [c_void_p]
+        CallCFunction(GetDllLibPdf().Collections_PdfCollection_Clear,self.Ptr)

spire/pdf/CompressionLevel.py

@@ -0,0 +1,26 @@
+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 CompressionLevel(Enum):
+    """
+    Enum class representing compression levels.
+
+    Attributes:
+        NoCompression: No compression.
+        BestSpeed: Best speed compression.
+        BelowNormal: Below normal compression.
+        Normal: Normal compression.
+        AboveNormal: Above normal compression.
+        Best: Best compression.
+    """
+    NoCompression = 0
+    BestSpeed = 1
+    BelowNormal = 3
+    Normal = 5
+    AboveNormal = 7
+    Best = 9

spire/pdf/ConfiguerGraphicType.py

@@ -0,0 +1,18 @@
+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 ConfiguerGraphicType(Enum):
+    """
+    Enum for Signature Configuer Graphic type
+    """
+    No = 0
+    Picture = 1
+    Text = 2
+    PictureSignInformation = 3
+    TextSignInformation = 4
+    SignInformationPicture = 5

spire/pdf/CustomFieldType.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 CustomFieldType(Enum):
+    """
+    Enum class representing custom field types.
+
+    Attributes:
+        TextField: Represents a text field.
+        DateField: Represents a date field.
+        NumberField: Represents a number field.
+    """
+    TextField = 0
+    DateField = 1
+    NumberField = 2

spire/pdf/DataFormat.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 DataFormat(Enum):
+    """
+    Specifies the format of Export or Import data.
+    """
+
+    Xml = 0
+    Fdf = 1
+    XFdf = 2

spire/pdf/DocxOptions.py

@@ -0,0 +1,228 @@
+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 DocxOptions(SpireObject):
+    """
+    Class representing options for converting a PDF document to a DOCX document.
+    """
+
+    @property
+    def Title(self) -> str:
+        """
+        Get the title of the document.
+        """
+        GetDllLibPdf().DocxOptions_get_Title.argtypes = [c_void_p]
+        GetDllLibPdf().DocxOptions_get_Title.restype = c_void_p
+        ret = PtrToStr(CallCFunction(GetDllLibPdf().DocxOptions_get_Title,self.Ptr))
+        return ret
+
+    @Title.setter
+    def Title(self, value: str):
+        """
+        Set the title of the document.
+        """
+        GetDllLibPdf().DocxOptions_set_Title.argtypes = [c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibPdf().DocxOptions_set_Title,self.Ptr, value)
+
+    @property
+    def Subject(self) -> str:
+        """
+        Get the subject of the document.
+        """
+        GetDllLibPdf().DocxOptions_get_Subject.argtypes = [c_void_p]
+        GetDllLibPdf().DocxOptions_get_Subject.restype = c_void_p
+        ret = PtrToStr(CallCFunction(GetDllLibPdf().DocxOptions_get_Subject,self.Ptr))
+        return ret
+
+    @Subject.setter
+    def Subject(self, value: str):
+        """
+        Set the subject of the document.
+        """
+        GetDllLibPdf().DocxOptions_set_Subject.argtypes = [c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibPdf().DocxOptions_set_Subject,self.Ptr, value)
+
+    @property
+    def Tags(self) -> str:
+        """
+        Get the tags of the document.
+        """
+        GetDllLibPdf().DocxOptions_get_Tags.argtypes = [c_void_p]
+        GetDllLibPdf().DocxOptions_get_Tags.restype = c_void_p
+        ret = PtrToStr(CallCFunction(GetDllLibPdf().DocxOptions_get_Tags,self.Ptr))
+        return ret
+
+    @Tags.setter
+    def Tags(self, value: str):
+        """
+        Set the tags of the document.
+        """
+        GetDllLibPdf().DocxOptions_set_Tags.argtypes = [c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibPdf().DocxOptions_set_Tags,self.Ptr, value)
+
+    @property
+    def Categories(self) -> str:
+        """
+        Get the categories of the document.
+        """
+        GetDllLibPdf().DocxOptions_get_Categories.argtypes = [c_void_p]
+        GetDllLibPdf().DocxOptions_get_Categories.restype = c_void_p
+        ret = PtrToStr(CallCFunction(GetDllLibPdf().DocxOptions_get_Categories,self.Ptr))
+        return ret
+
+    @Categories.setter
+    def Categories(self, value: str):
+        """
+        Set the categories of the document.
+        """
+        GetDllLibPdf().DocxOptions_set_Categories.argtypes = [c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibPdf().DocxOptions_set_Categories,self.Ptr, value)
+
+    @property
+    def Commments(self) -> str:
+        """
+        Get the comments of the document.
+        """
+        GetDllLibPdf().DocxOptions_get_Commments.argtypes = [c_void_p]
+        GetDllLibPdf().DocxOptions_get_Commments.restype = c_void_p
+        ret = PtrToStr(CallCFunction(GetDllLibPdf().DocxOptions_get_Commments,self.Ptr))
+        return ret
+
+    @Commments.setter
+    def Commments(self, value: str):
+        """
+        Set the comments of the document.
+        """
+        GetDllLibPdf().DocxOptions_set_Commments.argtypes = [c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibPdf().DocxOptions_set_Commments,self.Ptr, value)
+
+    @property
+    def Authors(self) -> str:
+        """
+        Get the authors of the document.
+        """
+        GetDllLibPdf().DocxOptions_get_Authors.argtypes = [c_void_p]
+        GetDllLibPdf().DocxOptions_get_Authors.restype = c_void_p
+        ret = PtrToStr(CallCFunction(GetDllLibPdf().DocxOptions_get_Authors,self.Ptr))
+        return ret
+
+    @Authors.setter
+    def Authors(self, value: str):
+        """
+        Set the authors of the document.
+        """
+        GetDllLibPdf().DocxOptions_set_Authors.argtypes = [c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibPdf().DocxOptions_set_Authors,self.Ptr, value)
+
+    @property
+    def LastSavedBy(self) -> str:
+        """
+        Get the last saved by information of the document.
+        """
+        GetDllLibPdf().DocxOptions_get_LastSavedBy.argtypes = [c_void_p]
+        GetDllLibPdf().DocxOptions_get_LastSavedBy.restype = c_void_p
+        ret = PtrToStr(CallCFunction(GetDllLibPdf().DocxOptions_get_LastSavedBy,self.Ptr))
+        return ret
+
+    @LastSavedBy.setter
+    def LastSavedBy(self, value: str):
+        """
+        Set the last saved by information of the document.
+        """
+        GetDllLibPdf().DocxOptions_set_LastSavedBy.argtypes = [c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibPdf().DocxOptions_set_LastSavedBy,self.Ptr, value)
+
+    @property
+    def Revision(self) -> int:
+        """
+        Get the revision number of the document.
+        """
+        GetDllLibPdf().DocxOptions_get_Revision.argtypes = [c_void_p]
+        GetDllLibPdf().DocxOptions_get_Revision.restype = c_int
+        ret = CallCFunction(GetDllLibPdf().DocxOptions_get_Revision,self.Ptr)
+        return ret
+
+    @Revision.setter
+    def Revision(self, value: int):
+        """
+        Set the revision number of the document.
+        """
+        GetDllLibPdf().DocxOptions_set_Revision.argtypes = [c_void_p, c_int]
+        CallCFunction(GetDllLibPdf().DocxOptions_set_Revision,self.Ptr, value)
+
+    @property
+    def Version(self) -> str:
+        """
+        Get the version of the document.
+        """
+        GetDllLibPdf().DocxOptions_get_Version.argtypes = [c_void_p]
+        GetDllLibPdf().DocxOptions_get_Version.restype = c_void_p
+        ret = PtrToStr(CallCFunction(GetDllLibPdf().DocxOptions_get_Version,self.Ptr))
+        return ret
+
+    @Version.setter
+    def Version(self, value: str):
+        """
+        Set the version of the document.
+        """
+        GetDllLibPdf().DocxOptions_set_Version.argtypes = [c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibPdf().DocxOptions_set_Version,self.Ptr, value)
+
+    @property
+    def ProgramName(self) -> str:
+        """
+        Get the program name of the document.
+        """
+        GetDllLibPdf().DocxOptions_get_ProgramName.argtypes = [c_void_p]
+        GetDllLibPdf().DocxOptions_get_ProgramName.restype = c_void_p
+        ret = PtrToStr(CallCFunction(GetDllLibPdf().DocxOptions_get_ProgramName,self.Ptr))
+        return ret
+
+    @ProgramName.setter
+    def ProgramName(self, value: str):
+        """
+        Set the program name of the document.
+        """
+        GetDllLibPdf().DocxOptions_set_ProgramName.argtypes = [c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibPdf().DocxOptions_set_ProgramName,self.Ptr, value)
+
+    @property
+    def Company(self) -> str:
+        """
+        Get the company of the document.
+        """
+        GetDllLibPdf().DocxOptions_get_Company.argtypes = [c_void_p]
+        GetDllLibPdf().DocxOptions_get_Company.restype = c_void_p
+        ret = PtrToStr(CallCFunction(GetDllLibPdf().DocxOptions_get_Company,self.Ptr))
+        return ret
+
+    @Company.setter
+    def Company(self, value: str):
+        """
+        Set the company of the document.
+        """
+        GetDllLibPdf().DocxOptions_set_Company.argtypes = [c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibPdf().DocxOptions_set_Company,self.Ptr, value)
+
+    @property
+    def Manager(self) -> str:
+        """
+        Get the manager of the document.
+        """
+        GetDllLibPdf().DocxOptions_get_Manager.argtypes = [c_void_p]
+        GetDllLibPdf().DocxOptions_get_Manager.restype = c_void_p
+        ret = PtrToStr(CallCFunction(GetDllLibPdf().DocxOptions_get_Manager,self.Ptr))
+        return ret
+
+    @Manager.setter
+    def Manager(self, value: str):
+        """
+        Set the manager of the document.
+        """
+        GetDllLibPdf().DocxOptions_set_Manager.argtypes = [c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibPdf().DocxOptions_set_Manager,self.Ptr, value)

spire/pdf/FileFormat.py

@@ -0,0 +1,26 @@
+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 FileFormat(Enum):
+    """
+    Enum class that specifies the type of file format.
+    """
+
+    PDF = 0
+    XPS = 1
+    DOC = 2
+    DOCX = 3
+    HTML = 4
+    SVG = 5
+    PCL = 6
+    XLSX = 7
+    POSTSCRIPT = 8
+    OFD = 9
+    PPTX = 10
+    Bin = 11
+    Markdown = 12

spire/pdf/FileRelatedFieldType.py

@@ -0,0 +1,24 @@
+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 FileRelatedFieldType(Enum):
+    """
+    Enum class for file related field types.
+
+    Attributes:
+        FileName: Represents the file name field.
+        Desc: Represents the description field.
+        ModDate: Represents the modification date field.
+        CreationDate: Represents the creation date field.
+        Size: Represents the size field.
+    """
+    FileName = 0
+    Desc = 1
+    ModDate = 2
+    CreationDate = 3
+    Size = 4

spire/pdf/Find_TextFindParameter.py

@@ -0,0 +1,17 @@
+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 Find_TextFindParameter(Enum):
+    """
+    Enum class for setting find text parameters.
+    """
+    none = 1
+    WholeWord = 16
+    IgnoreCase = 256
+    CrossLine = 4096
+    Regex = 65536

spire/pdf/GraphicMode.py

@@ -0,0 +1,17 @@
+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 GraphicMode(Enum):
+    """
+    Modes to determine what and how to display the signature information.
+    """
+    SignDetail = 0
+    SignImageOnly = 1
+    SignNameOnly = 2
+    SignNameAndSignDetail = 3
+    SignImageAndSignDetail = 4