spire-pdf 11.6.1__py3-none-macosx_10_7_universal.whl

spire/pdf/PdfSoundAction.py

@@ -0,0 +1,176 @@
+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 PdfSoundAction(PdfAction):
+    """
+    Represents the sound action.
+    """
+    @dispatch
+    def __init__(self, fileName: str):
+        """
+        Initializes a new instance of the PdfSoundAction class.
+        
+        Args:
+            fileName: The name of the sound file.
+        """
+        GetDllLibPdf().PdfSoundAction_CreatePdfSoundActionF.argtypes = [c_wchar_p]
+        GetDllLibPdf().PdfSoundAction_CreatePdfSoundActionF.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfSoundAction_CreatePdfSoundActionF,fileName)
+        super(PdfSoundAction, self).__init__(intPtr)
+    
+    @property
+    def Volume(self) -> float:
+        """
+        Gets or sets the volume at which to play the sound, in the range -1.0 to 1.0.
+        
+        Returns:
+            The volume of the sound.
+        """
+        GetDllLibPdf().PdfSoundAction_get_Volume.argtypes = [c_void_p]
+        GetDllLibPdf().PdfSoundAction_get_Volume.restype = c_float
+        ret = CallCFunction(GetDllLibPdf().PdfSoundAction_get_Volume,self.Ptr)
+        return ret
+
+    @Volume.setter
+    def Volume(self, value: float):
+        """
+        Sets the volume at which to play the sound.
+        
+        Args:
+            value: The volume of the sound.
+        """
+        GetDllLibPdf().PdfSoundAction_set_Volume.argtypes = [c_void_p, c_float]
+        CallCFunction(GetDllLibPdf().PdfSoundAction_set_Volume,self.Ptr, value)
+
+    @property
+    def FileName(self) -> str:
+        """
+        Gets or sets the name of the sound file.
+        
+        Returns:
+            The name of the sound file.
+        """
+        GetDllLibPdf().PdfSoundAction_get_FileName.argtypes = [c_void_p]
+        GetDllLibPdf().PdfSoundAction_get_FileName.restype = c_void_p
+        ret = PtrToStr(CallCFunction(GetDllLibPdf().PdfSoundAction_get_FileName,self.Ptr))
+        return ret
+
+    @FileName.setter
+    def FileName(self, value: str):
+        """
+        Sets the name of the sound file.
+        
+        Args:
+            value: The name of the sound file.
+        """
+        GetDllLibPdf().PdfSoundAction_set_FileName.argtypes = [c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibPdf().PdfSoundAction_set_FileName,self.Ptr, value)
+
+    @property
+    def Sound(self) -> 'PdfSound':
+        """
+        Gets or sets the sound.
+        
+        Returns:
+            The sound.
+        """
+        GetDllLibPdf().PdfSoundAction_get_Sound.argtypes = [c_void_p]
+        GetDllLibPdf().PdfSoundAction_get_Sound.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfSoundAction_get_Sound,self.Ptr)
+        ret = None if intPtr == None else PdfSound(intPtr)
+        return ret
+
+    @Sound.setter
+    def Sound(self, value: 'PdfSound'):
+        """
+        Sets the sound.
+        
+        Args:
+            value: The sound.
+        """
+        GetDllLibPdf().PdfSoundAction_set_Sound.argtypes = [c_void_p, c_void_p]
+        CallCFunction(GetDllLibPdf().PdfSoundAction_set_Sound,self.Ptr, value.Ptr)
+
+    @property
+    def Synchronous(self) -> bool:
+        """
+        Gets or sets a value whether to play the sound synchronously or asynchronously.
+        If this flag is true, the viewer application retains control, allowing no further 
+        user interaction other than canceling the sound, until the sound has been 
+        completely played. Default value: false.
+        
+        Returns:
+            True if synchronous; otherwise, False.
+        """
+        GetDllLibPdf().PdfSoundAction_get_Synchronous.argtypes = [c_void_p]
+        GetDllLibPdf().PdfSoundAction_get_Synchronous.restype = c_bool
+        ret = CallCFunction(GetDllLibPdf().PdfSoundAction_get_Synchronous,self.Ptr)
+        return ret
+
+    @Synchronous.setter
+    def Synchronous(self, value: bool):
+        """
+        Sets a value whether to play the sound synchronously or asynchronously.
+        
+        Args:
+            value: True if synchronous; otherwise, False.
+        """
+        GetDllLibPdf().PdfSoundAction_set_Synchronous.argtypes = [c_void_p, c_bool]
+        CallCFunction(GetDllLibPdf().PdfSoundAction_set_Synchronous,self.Ptr, value)
+
+    @property
+    def Repeat(self) -> bool:
+        """
+        Gets or sets a value indicating whether to repeat the sound indefinitely. 
+        If this entry is present, the property is ignored. Default value: false.
+        
+        Returns:
+            True if repeat; otherwise, False.
+        """
+        GetDllLibPdf().PdfSoundAction_get_Repeat.argtypes = [c_void_p]
+        GetDllLibPdf().PdfSoundAction_get_Repeat.restype = c_bool
+        ret = CallCFunction(GetDllLibPdf().PdfSoundAction_get_Repeat,self.Ptr)
+        return ret
+
+    @Repeat.setter
+    def Repeat(self, value: bool):
+        """
+        Sets a value indicating whether to repeat the sound indefinitely.
+        
+        Args:
+            value: True if repeat; otherwise, False.
+        """
+        GetDllLibPdf().PdfSoundAction_set_Repeat.argtypes = [c_void_p, c_bool]
+        CallCFunction(GetDllLibPdf().PdfSoundAction_set_Repeat,self.Ptr, value)
+
+    @property
+    def Mix(self) -> bool:
+        """
+        Gets or sets a value indicating whether to mix this sound with any other 
+        sound already playing. If this flag is false, any previously playing sound is 
+        stopped before starting this sound; this can be used to stop a repeating 
+        sound. Default value: false.
+        
+        Returns:
+            True if mix; otherwise, False.
+        """
+        GetDllLibPdf().PdfSoundAction_get_Mix.argtypes = [c_void_p]
+        GetDllLibPdf().PdfSoundAction_get_Mix.restype = c_bool
+        ret = CallCFunction(GetDllLibPdf().PdfSoundAction_get_Mix,self.Ptr)
+        return ret
+
+    @Mix.setter
+    def Mix(self, value: bool):
+        """
+        Sets a value indicating whether to mix this sound with any other sound already playing.
+        
+        Args:
+            value: True if mix; otherwise, False.
+        """
+        GetDllLibPdf().PdfSoundAction_set_Mix.argtypes = [c_void_p, c_bool]
+        CallCFunction(GetDllLibPdf().PdfSoundAction_set_Mix,self.Ptr, value)

spire/pdf/PdfSoundAnnotation.py

@@ -0,0 +1,86 @@
+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 PdfSoundAnnotation(PdfFileAnnotation):
+    """
+    Represents the sound annotation.
+    """
+
+    @property
+    def Icon(self) -> 'PdfSoundIcon':
+        """
+        Gets or sets the icon to be used in displaying the annotation.
+        
+        Returns:
+            The enumeration member specifying the icon for the annotation.
+        """
+        GetDllLibPdf().PdfSoundAnnotation_get_Icon.argtypes = [c_void_p]
+        GetDllLibPdf().PdfSoundAnnotation_get_Icon.restype = c_int
+        ret = CallCFunction(GetDllLibPdf().PdfSoundAnnotation_get_Icon,self.Ptr)
+        objwrapped = PdfSoundIcon(ret)
+        return objwrapped
+
+    @Icon.setter
+    def Icon(self, value: 'PdfSoundIcon'):
+        """
+        Sets the icon to be used in displaying the annotation.
+        
+        Args:
+            value: The enumeration member specifying the icon for the annotation.
+        """
+        GetDllLibPdf().PdfSoundAnnotation_set_Icon.argtypes = [c_void_p, c_int]
+        CallCFunction(GetDllLibPdf().PdfSoundAnnotation_set_Icon,self.Ptr, value.value)
+
+    @property
+    def Sound(self) -> 'PdfSound':
+        """
+        Gets or sets the sound.
+        
+        Returns:
+            The object specified a sound for the annotation.
+        """
+        GetDllLibPdf().PdfSoundAnnotation_get_Sound.argtypes = [c_void_p]
+        GetDllLibPdf().PdfSoundAnnotation_get_Sound.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfSoundAnnotation_get_Sound,self.Ptr)
+        ret = None if intPtr == None else PdfSound(intPtr)
+        return ret
+
+    @Sound.setter
+    def Sound(self, value: 'PdfSound'):
+        """
+        Sets the sound.
+        
+        Args:
+            value: The object specifying a sound for the annotation.
+        """
+        GetDllLibPdf().PdfSoundAnnotation_set_Sound.argtypes = [c_void_p, c_void_p]
+        CallCFunction(GetDllLibPdf().PdfSoundAnnotation_set_Sound,self.Ptr, value.Ptr)
+
+    @property
+    def FileName(self) -> str:
+        """
+        Gets or sets the file name of the sound annotation.
+        
+        Returns:
+            The string specifying the file name of the sound annotation.
+        """
+        GetDllLibPdf().PdfSoundAnnotation_get_FileName.argtypes = [c_void_p]
+        GetDllLibPdf().PdfSoundAnnotation_get_FileName.restype = c_void_p
+        ret = PtrToStr(CallCFunction(GetDllLibPdf().PdfSoundAnnotation_get_FileName,self.Ptr))
+        return ret
+
+    @FileName.setter
+    def FileName(self, value: str):
+        """
+        Sets the file name of the sound annotation.
+        
+        Args:
+            value: The string specifying the file name of the sound annotation.
+        """
+        GetDllLibPdf().PdfSoundAnnotation_set_FileName.argtypes = [c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibPdf().PdfSoundAnnotation_set_FileName,self.Ptr, value)

spire/pdf/PdfSoundAnnotationWidget.py

@@ -0,0 +1,69 @@
+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 PdfSoundAnnotationWidget(PdfStyledAnnotationWidget):
+    """
+    Represents the loaded sound annotation class.
+    """
+
+    @property
+    def Sound(self) -> 'PdfSound':
+        """
+        Gets or sets the sound of the annotation.
+        """
+        GetDllLibPdf().PdfSoundAnnotationWidget_get_Sound.argtypes = [c_void_p]
+        GetDllLibPdf().PdfSoundAnnotationWidget_get_Sound.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfSoundAnnotationWidget_get_Sound,self.Ptr)
+        ret = None if intPtr == None else PdfSound(intPtr)
+        return ret
+
+    @Sound.setter
+    def Sound(self, value: 'PdfSound'):
+        """
+        Sets the sound of the annotation.
+        """
+        GetDllLibPdf().PdfSoundAnnotationWidget_set_Sound.argtypes = [c_void_p, c_void_p]
+        CallCFunction(GetDllLibPdf().PdfSoundAnnotationWidget_set_Sound,self.Ptr, value.Ptr)
+
+    @property
+    def FileName(self) -> str:
+        """
+        Gets the filename of the annotation.
+        """
+        GetDllLibPdf().PdfSoundAnnotationWidget_get_FileName.argtypes = [c_void_p]
+        GetDllLibPdf().PdfSoundAnnotationWidget_get_FileName.restype = c_void_p
+        ret = PtrToStr(CallCFunction(GetDllLibPdf().PdfSoundAnnotationWidget_get_FileName,self.Ptr))
+        return ret
+
+    @property
+    def Icon(self) -> 'PdfSoundIcon':
+        """
+        Gets or sets the icon of the annotation.
+        """
+        GetDllLibPdf().PdfSoundAnnotationWidget_get_Icon.argtypes = [c_void_p]
+        GetDllLibPdf().PdfSoundAnnotationWidget_get_Icon.restype = c_int
+        ret = CallCFunction(GetDllLibPdf().PdfSoundAnnotationWidget_get_Icon,self.Ptr)
+        objwrapped = PdfSoundIcon(ret)
+        return objwrapped
+
+    @Icon.setter
+    def Icon(self, value: 'PdfSoundIcon'):
+        """
+        Sets the icon of the annotation.
+        """
+        GetDllLibPdf().PdfSoundAnnotationWidget_set_Icon.argtypes = [c_void_p, c_int]
+        CallCFunction(GetDllLibPdf().PdfSoundAnnotationWidget_set_Icon,self.Ptr, value.value)
+
+    def ObjectID(self) -> int:
+        """
+        Represents the Form field identifier.
+        """
+        GetDllLibPdf().PdfSoundAnnotationWidget_ObjectID.argtypes = [c_void_p]
+        GetDllLibPdf().PdfSoundAnnotationWidget_ObjectID.restype = c_int
+        ret = CallCFunction(GetDllLibPdf().PdfSoundAnnotationWidget_ObjectID,self.Ptr)
+        return ret

spire/pdf/PdfSoundChannels.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 PdfSoundChannels(Enum):
+    """
+    Enum class representing the number of sound channels.
+
+    Attributes:
+        Mono: Represents a mono sound channel.
+        Stereo: Represents a stereo sound channel.
+    """
+    Mono = 1
+    Stereo = 2

spire/pdf/PdfSoundEncoding.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 PdfSoundEncoding(Enum):
+    """
+    Enum class representing the encoding format for the sample data.
+    
+    Attributes:
+        Raw: The raw encoding format.
+        Signed: The signed encoding format.
+        MuLaw: The Mu-Law encoding format.
+        ALaw: The A-Law encoding format.
+    """
+    Raw = 0
+    Signed = 1
+    MuLaw = 2
+    ALaw = 3

spire/pdf/PdfSoundIcon.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 PdfSoundIcon(Enum):
+    """
+    Specifies the name of an icon to be used in displaying the sound annotation.
+    """
+
+    Speaker = 0
+    Mic = 1

spire/pdf/PdfSquareAnnotationWidget.py

@@ -0,0 +1,45 @@
+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 PdfSquareAnnotationWidget(PdfMarkUpAnnotationWidget):
+    """
+    Represents a square annotation widget in a PDF document.
+    """
+
+    @property
+    def RectangularDifferenceArray(self) -> List[float]:
+        """
+        Gets or sets the rectangular differences array of the square annotation widget.
+        """
+        GetDllLibPdf().PdfSquareAnnotationWidget_get_RectangularDifferenceArray.argtypes = [c_void_p]
+        GetDllLibPdf().PdfSquareAnnotationWidget_get_RectangularDifferenceArray.restype = IntPtrArray
+        intPtrArray = CallCFunction(GetDllLibPdf().PdfSquareAnnotationWidget_get_RectangularDifferenceArray,self.Ptr)
+        ret = GetVectorFromArray(intPtrArray, c_float)
+        return ret
+
+    @RectangularDifferenceArray.setter
+    def RectangularDifferenceArray(self, value: List[float]):
+        """
+        Sets the rectangular differences array of the square annotation widget.
+        """
+        vCount = len(value)
+        ArrayType = c_float * vCount
+        vArray = ArrayType()
+        for i in range(0, vCount):
+            vArray[i] = value[i]
+        GetDllLibPdf().PdfSquareAnnotationWidget_set_RectangularDifferenceArray.argtypes = [c_void_p, ArrayType, c_int]
+        CallCFunction(GetDllLibPdf().PdfSquareAnnotationWidget_set_RectangularDifferenceArray,self.Ptr, vArray, vCount)
+
+    def ObjectID(self) -> int:
+        """
+        Gets the object ID of the square annotation widget.
+        """
+        GetDllLibPdf().PdfSquareAnnotationWidget_ObjectID.argtypes = [c_void_p]
+        GetDllLibPdf().PdfSquareAnnotationWidget_ObjectID.restype = c_int
+        ret = CallCFunction(GetDllLibPdf().PdfSquareAnnotationWidget_ObjectID,self.Ptr)
+        return ret

spire/pdf/PdfStampCollection.py

@@ -0,0 +1,115 @@
+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 PdfStampCollection(PdfCollection):
+    """
+    A collection of stamps that are applied to the page templates.
+    """
+
+    def get_Item(self, index: int) -> 'PdfPageTemplateElement':
+        """
+        Gets a stamp element by its index.
+        """
+        GetDllLibPdf().PdfStampCollection_get_Item.argtypes = [c_void_p, c_int]
+        GetDllLibPdf().PdfStampCollection_get_Item.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfStampCollection_get_Item,self.Ptr, index)
+        ret = None if intPtr == None else PdfPageTemplateElement(intPtr)
+        return ret
+
+    @dispatch
+    def Add(self, template: PdfPageTemplateElement) -> int:
+        """
+        Adds a stamp element to the collection.
+        Args:
+            template: The stamp element.
+        Returns:
+            The index of the stamp element.
+        """
+        intPtrtemplate: c_void_p = template.Ptr
+        GetDllLibPdf().PdfStampCollection_Add.argtypes = [c_void_p, c_void_p]
+        GetDllLibPdf().PdfStampCollection_Add.restype = c_int
+        ret = CallCFunction(GetDllLibPdf().PdfStampCollection_Add,self.Ptr, intPtrtemplate)
+        return ret
+
+    @dispatch
+    def Add(self, x: float, y: float, width: float, height: float) -> PdfPageTemplateElement:
+        """
+        Creates a stamp element and adds it to the collection.
+        Args:
+            x: X co-ordinate of the stamp.
+            y: Y co-ordinate of the stamp.
+            width: Width of the stamp.
+            height: Height of the stamp.
+        Returns:
+            The created stamp element.
+        """
+        GetDllLibPdf().PdfStampCollection_AddXYWH.argtypes = [c_void_p, c_float, c_float, c_float, c_float]
+        GetDllLibPdf().PdfStampCollection_AddXYWH.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfStampCollection_AddXYWH,self.Ptr, x, y, width, height)
+        ret = None if intPtr == None else PdfPageTemplateElement(intPtr)
+        return ret
+
+    def Contains(self, template: 'PdfPageTemplateElement') -> bool:
+        """
+        Checks whether the stamp element exists in the collection.
+        Args:
+            template: Stamp element.
+        Returns:
+            True - if stamp element exists in the collection, False otherwise.
+        """
+        intPtrtemplate: c_void_p = template.Ptr
+        GetDllLibPdf().PdfStampCollection_Contains.argtypes = [c_void_p, c_void_p]
+        GetDllLibPdf().PdfStampCollection_Contains.restype = c_bool
+        ret = CallCFunction(GetDllLibPdf().PdfStampCollection_Contains,self.Ptr, intPtrtemplate)
+        return ret
+
+    def Insert(self, index: int, template: 'PdfPageTemplateElement'):
+        """
+        Inserts a stamp element to the collection at the specified position.
+        Args:
+            index: The index of the stamp in the collection.
+            template: The stamp element.
+        """
+        intPtrtemplate: c_void_p = template.Ptr
+        GetDllLibPdf().PdfStampCollection_Insert.argtypes = [c_void_p, c_int, c_void_p]
+        CallCFunction(GetDllLibPdf().PdfStampCollection_Insert,self.Ptr, index, intPtrtemplate)
+
+    def Remove(self, template: 'PdfPageTemplateElement'):
+        """
+        Removes the stamp element from the collection.
+        Args:
+            template: The stamp element.
+        """
+        intPtrtemplate: c_void_p = template.Ptr
+        GetDllLibPdf().PdfStampCollection_Remove.argtypes = [c_void_p, c_void_p]
+        CallCFunction(GetDllLibPdf().PdfStampCollection_Remove,self.Ptr, intPtrtemplate)
+
+    def RemoveAt(self, index: int):
+        """
+        Removes a stamp element from the specified position in the collection.
+        Args:
+            index: The index of the stamp in the collection.
+        """
+        GetDllLibPdf().PdfStampCollection_RemoveAt.argtypes = [c_void_p, c_int]
+        CallCFunction(GetDllLibPdf().PdfStampCollection_RemoveAt,self.Ptr, index)
+
+    def Clear(self):
+        """
+        Cleares the collection.
+        """
+        GetDllLibPdf().PdfStampCollection_Clear.argtypes = [c_void_p]
+        CallCFunction(GetDllLibPdf().PdfStampCollection_Clear,self.Ptr)
+
+    def GetEnumerator(self) -> 'IEnumerator':
+        """
+        """
+        GetDllLibPdf().PdfStampCollection_GetEnumerator.argtypes = [c_void_p]
+        GetDllLibPdf().PdfStampCollection_GetEnumerator.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfStampCollection_GetEnumerator,self.Ptr)
+        ret = None if intPtr == None else IEnumerator(intPtr)
+        return ret