spire-pdf 11.6.1__py3-none-macosx_10_7_universal.whl

spire/pdf/Pdf3DView.py

@@ -0,0 +1,213 @@
+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 Pdf3DView(SpireObject):
+    """
+    Represents a attributes to be applied to the virtual camera associated with a 3D annotation.
+    """
+    @dispatch
+    def __init__(self):
+        GetDllLibPdf().Pdf3DView_CreatePdf3DView.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().Pdf3DView_CreatePdf3DView)
+        super(Pdf3DView, self).__init__(intPtr)
+
+    @property
+    def Background(self) -> 'Pdf3DBackground':
+        """
+        Gets or sets the background for this view.
+        """
+        GetDllLibPdf().Pdf3DView_get_Background.argtypes = [c_void_p]
+        GetDllLibPdf().Pdf3DView_get_Background.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().Pdf3DView_get_Background,self.Ptr)
+        ret = None if intPtr == None else Pdf3DBackground(intPtr)
+        return ret
+
+    @Background.setter
+    def Background(self, value: 'Pdf3DBackground'):
+        GetDllLibPdf().Pdf3DView_set_Background.argtypes = [c_void_p, c_void_p]
+        CallCFunction(GetDllLibPdf().Pdf3DView_set_Background,self.Ptr, value.Ptr)
+
+    @property
+    def CameraToWorldMatrix(self) -> List[float]:
+        """
+        Gets or sets the 3D transformation matrix.
+        """
+        GetDllLibPdf().Pdf3DView_get_CameraToWorldMatrix.argtypes = [c_void_p]
+        GetDllLibPdf().Pdf3DView_get_CameraToWorldMatrix.restype = IntPtrArray
+        intPtrArray = CallCFunction(GetDllLibPdf().Pdf3DView_get_CameraToWorldMatrix,self.Ptr)
+        ret = GetVectorFromArray(intPtrArray, c_float)
+        return ret
+
+    @CameraToWorldMatrix.setter
+    def CameraToWorldMatrix(self, value: List[float]):
+        """
+        Sets the 3D transformation matrix.
+        """
+        vCount = len(value)
+        ArrayType = c_float * vCount
+        vArray = ArrayType()
+        for i in range(0, vCount):
+            vArray[i] = value[i]
+        GetDllLibPdf().Pdf3DView_set_CameraToWorldMatrix.argtypes = [c_void_p, ArrayType, c_int]
+        CallCFunction(GetDllLibPdf().Pdf3DView_set_CameraToWorldMatrix,self.Ptr, vArray, vCount)
+
+    @property
+    def CenterOfOrbit(self) -> float:
+        """
+        Gets or sets the center of orbit for 3D artwork.
+        """
+        GetDllLibPdf().Pdf3DView_get_CenterOfOrbit.argtypes = [c_void_p]
+        GetDllLibPdf().Pdf3DView_get_CenterOfOrbit.restype = c_float
+        ret = CallCFunction(GetDllLibPdf().Pdf3DView_get_CenterOfOrbit,self.Ptr)
+        return ret
+
+    @CenterOfOrbit.setter
+    def CenterOfOrbit(self, value: float):
+        GetDllLibPdf().Pdf3DView_set_CenterOfOrbit.argtypes = [c_void_p, c_float]
+        CallCFunction(GetDllLibPdf().Pdf3DView_set_CenterOfOrbit,self.Ptr, value)
+
+    @property
+    def CrossSections(self) -> 'Pdf3DCrossSectionCollection':
+        """
+        Gets the list of cross sections for this view.
+        """
+        GetDllLibPdf().Pdf3DView_get_CrossSections.argtypes = [c_void_p]
+        GetDllLibPdf().Pdf3DView_get_CrossSections.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().Pdf3DView_get_CrossSections,self.Ptr)
+        ret = None if intPtr == None else Pdf3DCrossSectionCollection(intPtr)
+        return ret
+
+    @property
+    def ExternalName(self) -> str:
+        """
+        Gets or sets the view's external name.
+        """
+        GetDllLibPdf().Pdf3DView_get_ExternalName.argtypes = [c_void_p]
+        GetDllLibPdf().Pdf3DView_get_ExternalName.restype = c_void_p
+        ret = PtrToStr(CallCFunction(GetDllLibPdf().Pdf3DView_get_ExternalName,self.Ptr))
+        return ret
+
+    @ExternalName.setter
+    def ExternalName(self, value: str):
+        GetDllLibPdf().Pdf3DView_set_ExternalName.argtypes = [c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibPdf().Pdf3DView_set_ExternalName,self.Ptr, value)
+
+    @property
+    def InternalName(self) -> str:
+        """
+        Gets or sets the view's internal name.
+        """
+        GetDllLibPdf().Pdf3DView_get_InternalName.argtypes = [c_void_p]
+        GetDllLibPdf().Pdf3DView_get_InternalName.restype = c_void_p
+        ret = PtrToStr(CallCFunction(GetDllLibPdf().Pdf3DView_get_InternalName,self.Ptr))
+        return ret
+
+    @InternalName.setter
+    def InternalName(self, value: str):
+        GetDllLibPdf().Pdf3DView_set_InternalName.argtypes = [c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibPdf().Pdf3DView_set_InternalName,self.Ptr, value)
+
+    @property
+    def LightingScheme(self) -> 'Pdf3DLighting':
+        """
+        Gets or sets the Creates a new page and adds it as the last page of the document scheme for this view.
+        """
+        GetDllLibPdf().Pdf3DView_get_LightingScheme.argtypes = [c_void_p]
+        GetDllLibPdf().Pdf3DView_get_LightingScheme.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().Pdf3DView_get_LightingScheme,self.Ptr)
+        ret = None if intPtr == None else Pdf3DLighting(intPtr)
+        return ret
+
+    @LightingScheme.setter
+    def LightingScheme(self, value: 'Pdf3DLighting'):
+        GetDllLibPdf().Pdf3DView_set_LightingScheme.argtypes = [c_void_p, c_void_p]
+        CallCFunction(GetDllLibPdf().Pdf3DView_set_LightingScheme,self.Ptr, value.Ptr)
+
+    @property
+    def Nodes(self) -> 'Pdf3DNodeCollection':
+        """
+        Gets the list of 3D nodes for this view.
+        """
+        GetDllLibPdf().Pdf3DView_get_Nodes.argtypes = [c_void_p]
+        GetDllLibPdf().Pdf3DView_get_Nodes.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().Pdf3DView_get_Nodes,self.Ptr)
+        ret = None if intPtr == None else Pdf3DNodeCollection(intPtr)
+        return ret
+
+    @property
+    def Projection(self) -> 'Pdf3DProjection':
+        """
+        Gets or sets the projection for this view.
+        """
+        GetDllLibPdf().Pdf3DView_get_Projection.argtypes = [c_void_p]
+        GetDllLibPdf().Pdf3DView_get_Projection.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().Pdf3DView_get_Projection,self.Ptr)
+        ret = None if intPtr == None else Pdf3DProjection(intPtr)
+        return ret
+
+    @Projection.setter
+    def Projection(self, value:'Pdf3DProjection'):
+        GetDllLibPdf().Pdf3DView_set_Projection.argtypes=[c_void_p, c_void_p]
+        CallCFunction(GetDllLibPdf().Pdf3DView_set_Projection,self.Ptr, value.Ptr)
+
+    @property
+
+    def RenderMode(self)->'Pdf3DRendermode':
+        """
+
+        Gets or sets the rendering mode for this view. 
+
+        """
+        GetDllLibPdf().Pdf3DView_get_RenderMode.argtypes=[c_void_p]
+        GetDllLibPdf().Pdf3DView_get_RenderMode.restype=c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().Pdf3DView_get_RenderMode,self.Ptr)
+        ret = None if intPtr==None else Pdf3DRendermode(intPtr)
+        return ret
+
+
+    @RenderMode.setter
+    def RenderMode(self, value:'Pdf3DRendermode'):
+        GetDllLibPdf().Pdf3DView_set_RenderMode.argtypes=[c_void_p, c_void_p]
+        CallCFunction(GetDllLibPdf().Pdf3DView_set_RenderMode,self.Ptr, value.Ptr)
+
+    @property
+    def ResetNodesState(self)->bool:
+        """
+
+        Gets or sets a value indicating whether nodes specified in the Nodes collection are returned to their original states (as specified in the 3D artwork) before applying transformation matrices and opacity settings specified in the node dictionaries. 
+
+        """
+        GetDllLibPdf().Pdf3DView_get_ResetNodesState.argtypes=[c_void_p]
+        GetDllLibPdf().Pdf3DView_get_ResetNodesState.restype=c_bool
+        ret = CallCFunction(GetDllLibPdf().Pdf3DView_get_ResetNodesState,self.Ptr)
+        return ret
+
+    @ResetNodesState.setter
+    def ResetNodesState(self, value:bool):
+        GetDllLibPdf().Pdf3DView_set_ResetNodesState.argtypes=[c_void_p, c_bool]
+        CallCFunction(GetDllLibPdf().Pdf3DView_set_ResetNodesState,self.Ptr, value)
+
+    @property
+
+    def ViewNodeName(self)->str:
+        """
+
+        Gets or sets the name of the view node.         
+
+        The view node in the content stream defines all the properties for viewing the 3D artwork. If both ViewNodeName and CameraToWorldMatrix are specified, then ViewNodeName takes precedence.</remarks>
+        """
+        GetDllLibPdf().Pdf3DView_get_ViewNodeName.argtypes=[c_void_p]
+        GetDllLibPdf().Pdf3DView_get_ViewNodeName.restype=c_void_p
+        ret = PtrToStr(CallCFunction(GetDllLibPdf().Pdf3DView_get_ViewNodeName,self.Ptr))
+        return ret
+
+
+    @ViewNodeName.setter
+    def ViewNodeName(self, value:str):
+        GetDllLibPdf().Pdf3DView_set_ViewNodeName.argtypes=[c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibPdf().Pdf3DView_set_ViewNodeName,self.Ptr, value)

spire/pdf/Pdf3DViewCollection.py

@@ -0,0 +1,124 @@
+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 Pdf3DViewCollection(SpireObject):
+    """
+    Represents a collection of Pdf3DView objects. 
+    """
+
+    def Add(self, value: 'Pdf3DView') -> int:
+        """
+        Adds the specified value.
+
+        Args:
+            value: The value to add.
+
+        Returns:
+            int: The result of the addition.
+        """
+        intPtrvalue: c_void_p = value.Ptr
+
+        GetDllLibPdf().Pdf3DViewCollection_Add.argtypes = [c_void_p, c_void_p]
+        GetDllLibPdf().Pdf3DViewCollection_Add.restype = c_int
+        ret = CallCFunction(GetDllLibPdf().Pdf3DViewCollection_Add,self.Ptr, intPtrvalue)
+        return ret
+
+
+    def Contains(self, value: 'Pdf3DView') -> bool:
+        """
+        Determines whether the collection contains the specified value.
+
+        Args:
+            value: The value to check.
+
+        Returns:
+            bool: True if the collection contains the specified value, False otherwise.
+        """
+        intPtrvalue: c_void_p = value.Ptr
+
+        GetDllLibPdf().Pdf3DViewCollection_Contains.argtypes = [c_void_p, c_void_p]
+        GetDllLibPdf().Pdf3DViewCollection_Contains.restype = c_bool
+        ret = CallCFunction(GetDllLibPdf().Pdf3DViewCollection_Contains,self.Ptr, intPtrvalue)
+        return ret
+
+
+    def IndexOf(self, value: 'Pdf3DView') -> int:
+        """
+        Returns the index of the specified Pdf3DView object.
+
+        Args:
+            value: The value to find.
+
+        Returns:
+            int: The index of the specified value.
+        """
+        intPtrvalue: c_void_p = value.Ptr
+
+        GetDllLibPdf().Pdf3DViewCollection_IndexOf.argtypes = [c_void_p, c_void_p]
+        GetDllLibPdf().Pdf3DViewCollection_IndexOf.restype = c_int
+        ret = CallCFunction(GetDllLibPdf().Pdf3DViewCollection_IndexOf,self.Ptr, intPtrvalue)
+        return ret
+
+
+    def Insert(self, index: int, value: 'Pdf3DView'):
+        """
+        Inserts the specified value at the specified index.
+
+        Args:
+            index: The index to insert the value at.
+            value: The value to insert.
+        """
+        intPtrvalue: c_void_p = value.Ptr
+
+        GetDllLibPdf().Pdf3DViewCollection_Insert.argtypes = [c_void_p, c_int, c_void_p]
+        CallCFunction(GetDllLibPdf().Pdf3DViewCollection_Insert,self.Ptr, index, intPtrvalue)
+
+
+    def Remove(self, value: 'Pdf3DView'):
+        """
+        Removes the specified value from the collection.
+
+        Args:
+            value: The Pdf3DView object to remove.
+        """
+        intPtrvalue: c_void_p = value.Ptr
+
+        GetDllLibPdf().Pdf3DViewCollection_Remove.argtypes = [c_void_p, c_void_p]
+        CallCFunction(GetDllLibPdf().Pdf3DViewCollection_Remove,self.Ptr, intPtrvalue)
+
+
+    def get_Item(self, index: int) -> 'Pdf3DView':
+        """
+        Gets the Pdf3DView object at the specified index.
+
+        Args:
+            index: The index of the Pdf3DView object.
+
+        Returns:
+            Pdf3DView: The Pdf3DView object at the specified index.
+        """
+        
+        GetDllLibPdf().Pdf3DViewCollection_get_Item.argtypes = [c_void_p, c_int]
+        GetDllLibPdf().Pdf3DViewCollection_get_Item.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().Pdf3DViewCollection_get_Item,self.Ptr, index)
+        ret = None if intPtr == None else Pdf3DView(intPtr)
+        return ret
+
+
+    def set_Item(self, index: int, value: 'Pdf3DView'):
+        """
+        Sets the Pdf3DView object at the specified index.
+
+        Args:
+            index: The index to set the value at.
+            value: The value to set.
+        """
+        intPtrvalue: c_void_p = value.Ptr
+
+        GetDllLibPdf().Pdf3DViewCollection_set_Item.argtypes = [c_void_p, c_int, c_void_p]
+        CallCFunction(GetDllLibPdf().Pdf3DViewCollection_set_Item,self.Ptr, index, intPtrvalue)

spire/pdf/PdfAction.py

@@ -0,0 +1,31 @@
+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 PdfAction(SpireObject):
+    """
+    Represents base class for all action types.
+    """
+
+    @property
+    def NextAction(self) -> 'PdfAction':
+        """
+        Gets or sets the next action to be performed after the action represented by this instance.
+        """
+        GetDllLibPdf().PdfAction_get_NextAction.argtypes = [c_void_p]
+        GetDllLibPdf().PdfAction_get_NextAction.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfAction_get_NextAction,self.Ptr)
+        ret = None if intPtr == None else PdfAction(intPtr)
+        return ret
+
+    @NextAction.setter
+    def NextAction(self, value: 'PdfAction'):
+        """
+        Sets the next action to be performed after the action represented by this instance.
+        """
+        GetDllLibPdf().PdfAction_set_NextAction.argtypes = [c_void_p, c_void_p]
+        CallCFunction(GetDllLibPdf().PdfAction_set_NextAction,self.Ptr, value.Ptr)

spire/pdf/PdfActionAnnotation.py

@@ -0,0 +1,28 @@
+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 PdfActionAnnotation(PdfActionLinkAnnotation):
+    @dispatch
+    def __init__(self, rectangle: RectangleF, action: PdfAction):
+        """
+        Initializes a new instance of the PdfActionAnnotation class.
+
+        Args:
+            rectangle (RectangleF): The rectangle of the annotation.
+            action (PdfAction): The action associated with the annotation.
+        """
+        ptrRec: c_void_p = rectangle.Ptr
+        ptrAction: c_void_p = action.Ptr
+
+        GetDllLibPdf().PdfActionAnnotation_CreatePdfActionAnnotationRA.argtypes = [c_void_p, c_void_p]
+        GetDllLibPdf().PdfActionAnnotation_CreatePdfActionAnnotationRA.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfActionAnnotation_CreatePdfActionAnnotationRA,ptrRec, ptrAction)
+        super(PdfActionAnnotation, self).__init__(intPtr)
+    """
+    Represents the annotation with associated action.
+    """

spire/pdf/PdfActionCollection.py

@@ -0,0 +1,110 @@
+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 PdfActionCollection(PdfCollection):
+    """
+    Represents collection of actions.
+    """
+
+    def Add(self, action: 'PdfAction') -> int:
+        """
+        Adds the specified action.
+
+        Args:
+            action: The action.
+
+        Returns:
+            The index of the added action.
+        """
+        intPtraction: c_void_p = action.Ptr
+
+        GetDllLibPdf().PdfActionCollection_Add.argtypes = [c_void_p, c_void_p]
+        GetDllLibPdf().PdfActionCollection_Add.restype = c_int
+        ret = CallCFunction(GetDllLibPdf().PdfActionCollection_Add,self.Ptr, intPtraction)
+        return ret
+
+
+    def Insert(self, index: int, action: 'PdfAction'):
+        """
+        Inserts the action at the specified position.
+
+        Args:
+            index: The index.
+            action: The action.
+        """
+        intPtraction: c_void_p = action.Ptr
+
+        GetDllLibPdf().PdfActionCollection_Insert.argtypes = [c_void_p, c_int, c_void_p]
+        CallCFunction(GetDllLibPdf().PdfActionCollection_Insert,self.Ptr, index, intPtraction)
+
+
+    def IndexOf(self, action: 'PdfAction') -> int:
+        """
+        Gets the index of the action.
+
+        Args:
+            action: The action.
+
+        Returns:
+            The index of the action.
+        """
+        intPtraction: c_void_p = action.Ptr
+
+        GetDllLibPdf().PdfActionCollection_IndexOf.argtypes = [c_void_p, c_void_p]
+        GetDllLibPdf().PdfActionCollection_IndexOf.restype = c_int
+        ret = CallCFunction(GetDllLibPdf().PdfActionCollection_IndexOf,self.Ptr, intPtraction)
+        return ret
+
+
+    def Contains(self, action: 'PdfAction') -> bool:
+        """
+        Determines whether the action is contained within collection.
+
+        Args:
+            action: The action.
+
+        Returns:
+            A boolean value indicating the presence of the action in the collection.
+        """
+        intPtraction: c_void_p = action.Ptr
+
+        GetDllLibPdf().PdfActionCollection_Contains.argtypes = [c_void_p, c_void_p]
+        GetDllLibPdf().PdfActionCollection_Contains.restype = c_bool
+        ret = CallCFunction(GetDllLibPdf().PdfActionCollection_Contains,self.Ptr, intPtraction)
+        return ret
+
+    def Clear(self):
+        """
+        Clears this collection.
+        """
+        GetDllLibPdf().PdfActionCollection_Clear.argtypes = [c_void_p]
+        CallCFunction(GetDllLibPdf().PdfActionCollection_Clear,self.Ptr)
+
+
+    def Remove(self, action: 'PdfAction'):
+        """
+        Removes the specified action.
+
+        Args:
+            action: The action.
+        """
+        intPtraction: c_void_p = action.Ptr
+
+        GetDllLibPdf().PdfActionCollection_Remove.argtypes = [c_void_p, c_void_p]
+        CallCFunction(GetDllLibPdf().PdfActionCollection_Remove,self.Ptr, intPtraction)
+
+
+    def RemoveAt(self, index: int):
+        """
+        Removes the action at the specified position.
+
+        Args:
+            index: The index.
+        """
+        GetDllLibPdf().PdfActionCollection_RemoveAt.argtypes = [c_void_p, c_int]
+        CallCFunction(GetDllLibPdf().PdfActionCollection_RemoveAt,self.Ptr, index)

spire/pdf/PdfActionDestination.py

@@ -0,0 +1,22 @@
+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 PdfActionDestination(Enum):
+    """
+    Specifies the available named actions supported by the viewer. 
+
+    Attributes:
+        FirstPage (int): Represents the first page action.
+        LastPage (int): Represents the last page action.
+        NextPage (int): Represents the next page action.
+        PrevPage (int): Represents the previous page action.
+    """
+    FirstPage = 0
+    LastPage = 1
+    NextPage = 2
+    PrevPage = 3

spire/pdf/PdfActionLinkAnnotation.py

@@ -0,0 +1,37 @@
+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 PdfActionLinkAnnotation(PdfLinkAnnotation):
+    """
+    Represents base class for link annotations with associated action.
+    """
+
+    @property
+    def Action(self) -> 'PdfAction':
+        """
+        Gets or sets the action for the link annotation.
+
+        Returns:
+            The action to be executed when the link is activated.
+        """
+        GetDllLibPdf().PdfActionLinkAnnotation_get_Action.argtypes = [c_void_p]
+        GetDllLibPdf().PdfActionLinkAnnotation_get_Action.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfActionLinkAnnotation_get_Action,self.Ptr)
+        ret = None if intPtr == None else PdfAction(intPtr)
+        return ret
+
+    @Action.setter
+    def Action(self, value: 'PdfAction'):
+        """
+        Sets the action for the link annotation.
+
+        Args:
+            value: The action to be executed when the link is activated.
+        """
+        GetDllLibPdf().PdfActionLinkAnnotation_set_Action.argtypes = [c_void_p, c_void_p]
+        CallCFunction(GetDllLibPdf().PdfActionLinkAnnotation_set_Action,self.Ptr, value.Ptr)

spire/pdf/PdfAlignmentStyle.py

@@ -0,0 +1,22 @@
+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 PdfAlignmentStyle(Enum):
+    """
+    Specifies how the page template is aligned relative to the template area.
+    """
+    none = 0
+    TopLeft = 1
+    TopCenter = 2
+    TopRight = 3
+    MiddleLeft = 4
+    MiddleCenter = 5
+    MiddleRight = 6
+    BottomLeft = 7
+    BottomCenter = 8
+    BottomRight = 9