spire-pdf 11.6.1__py3-none-macosx_10_7_universal.whl

spire/pdf/PdfRadioButtonListField.py

@@ -0,0 +1,102 @@
+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 PdfRadioButtonListField(PdfField):
+    """
+    Represents radio button field in the PDF form.
+    """
+    @dispatch
+    def __init__(self, page: PdfPageBase, name: str):
+        """
+        Initializes a new instance of the PdfRadioButtonListField class.
+
+        Args:
+            page (PdfPageBase): The PDF page.
+            name (str): The name of the field.
+        """
+        ptrPage: c_void_p = page.Ptr
+        GetDllLibPdf().PdfRadioButtonListField_CreatePdfRadioButtonListFieldPN.argtypes = [c_void_p, c_wchar_p]
+        GetDllLibPdf().PdfRadioButtonListField_CreatePdfRadioButtonListFieldPN.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfRadioButtonListField_CreatePdfRadioButtonListFieldPN,ptrPage, name)
+        super(PdfRadioButtonListField, self).__init__(intPtr)
+
+    @property
+    def SelectedIndex(self) -> int:
+        """
+        Gets or sets the first selected item in the list.
+
+        Returns:
+            int: The index of the selected item.
+        """
+        GetDllLibPdf().PdfRadioButtonListField_get_SelectedIndex.argtypes = [c_void_p]
+        GetDllLibPdf().PdfRadioButtonListField_get_SelectedIndex.restype = c_int
+        ret = CallCFunction(GetDllLibPdf().PdfRadioButtonListField_get_SelectedIndex,self.Ptr)
+        return ret
+
+    @SelectedIndex.setter
+    def SelectedIndex(self, value: int):
+        """
+        Sets the index of the selected item in the list.
+
+        Args:
+            value (int): The index of the selected item.
+        """
+        GetDllLibPdf().PdfRadioButtonListField_set_SelectedIndex.argtypes = [c_void_p, c_int]
+        CallCFunction(GetDllLibPdf().PdfRadioButtonListField_set_SelectedIndex,self.Ptr, value)
+
+    @property
+    def SelectedValue(self) -> str:
+        """
+        Gets or sets the value of the first selected item in the list.
+
+        Returns:
+            str: The selected value of the list field.
+        """
+        GetDllLibPdf().PdfRadioButtonListField_get_SelectedValue.argtypes = [c_void_p]
+        GetDllLibPdf().PdfRadioButtonListField_get_SelectedValue.restype = c_void_p
+        ret = PtrToStr(CallCFunction(GetDllLibPdf().PdfRadioButtonListField_get_SelectedValue,self.Ptr))
+        return ret
+
+    @SelectedValue.setter
+    def SelectedValue(self, value: str):
+        """
+        Sets the value of the first selected item in the list.
+
+        Args:
+            value (str): The selected value of the list field.
+        """
+        GetDllLibPdf().PdfRadioButtonListField_set_SelectedValue.argtypes = [c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibPdf().PdfRadioButtonListField_set_SelectedValue,self.Ptr, value)
+
+    @property
+    def SelectedItem(self) -> 'PdfRadioButtonListItem':
+        """
+        Gets the first selected item in the list.
+
+        Returns:
+            PdfRadioButtonListItem: The selected item of the field.
+        """
+        GetDllLibPdf().PdfRadioButtonListField_get_SelectedItem.argtypes = [c_void_p]
+        GetDllLibPdf().PdfRadioButtonListField_get_SelectedItem.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfRadioButtonListField_get_SelectedItem,self.Ptr)
+        ret = None if intPtr == None else PdfRadioButtonListItem(intPtr)
+        return ret
+
+    @property
+    def Items(self) -> 'PdfRadioButtonItemCollection':
+        """
+        Gets the items of the radio button field.
+
+        Returns:
+            PdfRadioButtonItemCollection: The radio button field item collection.
+        """
+        GetDllLibPdf().PdfRadioButtonListField_get_Items.argtypes = [c_void_p]
+        GetDllLibPdf().PdfRadioButtonListField_get_Items.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfRadioButtonListField_get_Items,self.Ptr)
+        ret = None if intPtr == None else PdfRadioButtonItemCollection(intPtr)
+        return ret

spire/pdf/PdfRadioButtonListFieldWidget.py

@@ -0,0 +1,114 @@
+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 PdfRadioButtonListFieldWidget(PdfStateFieldWidget):
+    """
+    Represents radio button field of an existing PDF document's form.
+    """
+
+    @property
+    def WidgetWidgetItems(self) -> 'PdfRadioButtonWidgetWidgetItemCollection':
+        """
+        Gets the collection of radio button items.
+
+        Returns:
+            A PdfRadioButtonWidgetWidgetItemCollection that represents the items within the list.
+        """
+        GetDllLibPdf().PdfRadioButtonListFieldWidget_get_WidgetWidgetItems.argtypes = [c_void_p]
+        GetDllLibPdf().PdfRadioButtonListFieldWidget_get_WidgetWidgetItems.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfRadioButtonListFieldWidget_get_WidgetWidgetItems,self.Ptr)
+        ret = None if intPtr == None else PdfRadioButtonWidgetWidgetItemCollection(intPtr)
+        return ret
+
+    @property
+    def SelectedIndex(self) -> int:
+        """
+        Gets or sets the index of the selected item in the list.
+
+        Returns:
+            The lowest ordinal index of the selected items in the list. The default is -1, which indicates that nothing is selected.
+        """
+        GetDllLibPdf().PdfRadioButtonListFieldWidget_get_SelectedIndex.argtypes = [c_void_p]
+        GetDllLibPdf().PdfRadioButtonListFieldWidget_get_SelectedIndex.restype = c_int
+        ret = CallCFunction(GetDllLibPdf().PdfRadioButtonListFieldWidget_get_SelectedIndex,self.Ptr)
+        return ret
+
+    @SelectedIndex.setter
+    def SelectedIndex(self, value: int):
+        GetDllLibPdf().PdfRadioButtonListFieldWidget_set_SelectedIndex.argtypes = [c_void_p, c_int]
+        CallCFunction(GetDllLibPdf().PdfRadioButtonListFieldWidget_set_SelectedIndex,self.Ptr, value)
+
+    @property
+    def SelectedValue(self) -> str:
+        """
+        Gets or sets the value of the first selected item in the list.
+
+        Returns:
+            A string value specifying the value of the first selected item, null (Nothing in VB.NET) if there is no selected item.
+        """
+        GetDllLibPdf().PdfRadioButtonListFieldWidget_get_SelectedValue.argtypes = [c_void_p]
+        GetDllLibPdf().PdfRadioButtonListFieldWidget_get_SelectedValue.restype = c_void_p
+        ret = PtrToStr(CallCFunction(GetDllLibPdf().PdfRadioButtonListFieldWidget_get_SelectedValue,self.Ptr))
+        return ret
+
+    @SelectedValue.setter
+    def SelectedValue(self, value: str):
+        GetDllLibPdf().PdfRadioButtonListFieldWidget_set_SelectedValue.argtypes = [c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibPdf().PdfRadioButtonListFieldWidget_set_SelectedValue,self.Ptr, value)
+
+    @property
+    def SelectedItem(self) -> 'PdfRadioButtonWidgetItem':
+        """
+        Gets the selected item.
+
+        Returns:
+            The item as PdfLoadedRadioButtonItem class.
+        """
+        GetDllLibPdf().PdfRadioButtonListFieldWidget_get_SelectedItem.argtypes = [c_void_p]
+        GetDllLibPdf().PdfRadioButtonListFieldWidget_get_SelectedItem.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfRadioButtonListFieldWidget_get_SelectedItem,self.Ptr)
+        ret = None if intPtr == None else PdfRadioButtonWidgetItem(intPtr)
+        return ret
+
+    @property
+    def ButtonStyle(self) -> 'PdfCheckBoxStyle':
+        """
+        Gets the button style.
+        """
+        GetDllLibPdf().PdfRadioButtonListFieldWidget_get_ButtonStyle.argtypes = [c_void_p]
+        GetDllLibPdf().PdfRadioButtonListFieldWidget_get_ButtonStyle.restype = c_int
+        ret = CallCFunction(GetDllLibPdf().PdfRadioButtonListFieldWidget_get_ButtonStyle,self.Ptr)
+        objwrapped = PdfCheckBoxStyle(ret)
+        return objwrapped
+
+    @property
+    def Value(self) -> str:
+        """
+        Gets or sets the value of specified item.
+
+        Returns:
+            A string value representing the value of the item.
+        """
+        GetDllLibPdf().PdfRadioButtonListFieldWidget_get_Value.argtypes = [c_void_p]
+        GetDllLibPdf().PdfRadioButtonListFieldWidget_get_Value.restype = c_void_p
+        ret = PtrToStr(CallCFunction(GetDllLibPdf().PdfRadioButtonListFieldWidget_get_Value,self.Ptr))
+        return ret
+
+    @Value.setter
+    def Value(self, value: str):
+        GetDllLibPdf().PdfRadioButtonListFieldWidget_set_Value.argtypes = [c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibPdf().PdfRadioButtonListFieldWidget_set_Value,self.Ptr, value)
+
+    def ObjectID(self) -> int:
+        """
+        Form field identifier.
+        """
+        GetDllLibPdf().PdfRadioButtonListFieldWidget_ObjectID.argtypes = [c_void_p]
+        GetDllLibPdf().PdfRadioButtonListFieldWidget_ObjectID.restype = c_int
+        ret = CallCFunction(GetDllLibPdf().PdfRadioButtonListFieldWidget_ObjectID,self.Ptr)
+        return ret

spire/pdf/PdfRadioButtonListItem.py

@@ -0,0 +1,91 @@
+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 PdfRadioButtonListItem(PdfCheckFieldBase):
+    """
+    Represents an item of a radio button list.
+    """
+
+    @dispatch
+    def __init__(self):
+        """
+        Initializes a new instance of the PdfRadioButtonListItem class.
+        """
+        GetDllLibPdf().PdfRadioButtonListItem_CreatePdfRadioButtonListItem.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfRadioButtonListItem_CreatePdfRadioButtonListItem)
+        super(PdfRadioButtonListItem, self).__init__(intPtr)
+
+    @dispatch
+    def __init__(self, value: str):
+        """
+        Initializes a new instance of the PdfRadioButtonListItem class with the specified value.
+
+        :param value: The value of the radio button item.
+        """
+        GetDllLibPdf().PdfRadioButtonListItem_CreatePdfRadioButtonListItemV.argtypes = [c_wchar_p]
+        GetDllLibPdf().PdfRadioButtonListItem_CreatePdfRadioButtonListItemV.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfRadioButtonListItem_CreatePdfRadioButtonListItemV,value)
+        super(PdfRadioButtonListItem, self).__init__(intPtr)
+
+    @property
+    def Form(self) -> 'PdfForm':
+        """
+        Gets the form of the field.
+
+        :return: The PdfForm object of the field.
+        """
+        GetDllLibPdf().PdfRadioButtonListItem_get_Form.argtypes = [c_void_p]
+        GetDllLibPdf().PdfRadioButtonListItem_get_Form.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfRadioButtonListItem_get_Form,self.Ptr)
+        ret = None if intPtr == None else PdfForm(intPtr)
+        return ret
+
+    @property
+    def Bounds(self) -> 'RectangleF':
+        """
+        Gets or sets the bounds.
+
+        :return: The bounds of the radio button item.
+        """
+        GetDllLibPdf().PdfRadioButtonListItem_get_Bounds.argtypes = [c_void_p]
+        GetDllLibPdf().PdfRadioButtonListItem_get_Bounds.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfRadioButtonListItem_get_Bounds,self.Ptr)
+        ret = None if intPtr == None else RectangleF(intPtr)
+        return ret
+
+    @Bounds.setter
+    def Bounds(self, value: 'RectangleF'):
+        """
+        Sets the bounds of the radio button item.
+
+        :param value: The bounds of the radio button item.
+        """
+        GetDllLibPdf().PdfRadioButtonListItem_set_Bounds.argtypes = [c_void_p, c_void_p]
+        CallCFunction(GetDllLibPdf().PdfRadioButtonListItem_set_Bounds,self.Ptr, value.Ptr)
+
+    @property
+    def Value(self) -> str:
+        """
+        Gets or sets the value of the radio button item.
+
+        :return: The value of the radio button item.
+        """
+        GetDllLibPdf().PdfRadioButtonListItem_get_Value.argtypes = [c_void_p]
+        GetDllLibPdf().PdfRadioButtonListItem_get_Value.restype = c_void_p
+        ret = PtrToStr(CallCFunction(GetDllLibPdf().PdfRadioButtonListItem_get_Value,self.Ptr))
+        return ret
+
+    @Value.setter
+    def Value(self, value: str):
+        """
+        Sets the value of the radio button item.
+
+        :param value: The value of the radio button item.
+        """
+        GetDllLibPdf().PdfRadioButtonListItem_set_Value.argtypes = [c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibPdf().PdfRadioButtonListItem_set_Value,self.Ptr, value)

spire/pdf/PdfRadioButtonWidgetItem.py

@@ -0,0 +1,60 @@
+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 PdfRadioButtonWidgetItem(PdfStateWidgetItem):
+    """
+    Represents radio button field of an existing PDF document's form.
+    """
+
+    @property
+    def Value(self) -> str:
+        """
+        Gets or sets the value.
+
+        Returns:
+            The value of the radio button item.
+        """
+        GetDllLibPdf().PdfRadioButtonWidgetItem_get_Value.argtypes = [c_void_p]
+        GetDllLibPdf().PdfRadioButtonWidgetItem_get_Value.restype = c_void_p
+        ret = PtrToStr(CallCFunction(GetDllLibPdf().PdfRadioButtonWidgetItem_get_Value,self.Ptr))
+        return ret
+
+    @Value.setter
+    def Value(self, value: str):
+        """
+        Sets the value of the radio button item.
+
+        Args:
+            value: The value to be set.
+        """
+        GetDllLibPdf().PdfRadioButtonWidgetItem_set_Value.argtypes = [c_void_p, c_wchar_p]
+        CallCFunction(GetDllLibPdf().PdfRadioButtonWidgetItem_set_Value,self.Ptr, value)
+
+    @property
+    def Selected(self) -> bool:
+        """
+        Gets or sets a value indicating whether this radio button item is selected.
+
+        Returns:
+            True if the radio button item is selected, False otherwise.
+        """
+        GetDllLibPdf().PdfRadioButtonWidgetItem_get_Selected.argtypes = [c_void_p]
+        GetDllLibPdf().PdfRadioButtonWidgetItem_get_Selected.restype = c_bool
+        ret = CallCFunction(GetDllLibPdf().PdfRadioButtonWidgetItem_get_Selected,self.Ptr)
+        return ret
+
+    @Selected.setter
+    def Selected(self, value: bool):
+        """
+        Sets the value indicating whether this radio button item is selected.
+
+        Args:
+            value: True if the radio button item is selected, False otherwise.
+        """
+        GetDllLibPdf().PdfRadioButtonWidgetItem_set_Selected.argtypes = [c_void_p, c_bool]
+        CallCFunction(GetDllLibPdf().PdfRadioButtonWidgetItem_set_Selected,self.Ptr, value)

spire/pdf/PdfRadioButtonWidgetWidgetItemCollection.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 PdfRadioButtonWidgetWidgetItemCollection(PdfStateWidgetItemCollection):
+    """
+    Represents collection of radio box group items.
+    """
+
+    def get_Item(self, index: int) -> 'PdfRadioButtonWidgetItem':
+        """
+        Gets the PdfRadioButtonWidgetItem at the specified index.
+
+        Args:
+            index: The index of the item to retrieve.
+
+        Returns:
+            The PdfRadioButtonWidgetItem object at the specified index.
+        """
+        
+        GetDllLibPdf().PdfRadioButtonWidgetWidgetItemCollection_get_Item.argtypes = [c_void_p, c_int]
+        GetDllLibPdf().PdfRadioButtonWidgetWidgetItemCollection_get_Item.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfRadioButtonWidgetWidgetItemCollection_get_Item,self.Ptr, index)
+        ret = None if intPtr == None else PdfRadioButtonWidgetItem(intPtr)
+        return ret

spire/pdf/PdfResetAction.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 PdfResetAction(PdfFormAction):
+    """
+    Represents a reset action for a PDF form.
+
+    This action allows a user to reset the form fields to their default values.
+    """
+
+    @property
+    def Include(self) -> bool:
+        """
+        Gets or sets a value indicating whether fields contained in the Fields collection will be included for resetting.
+
+        If Include property is true, only the fields in this collection will be reset.
+        If Include property is false, the fields in this collection are not reset and only the remaining form fields are reset.
+        If the collection is null or empty, then all the form fields are reset and the Include property is ignored.
+        """
+        GetDllLibPdf().PdfResetAction_get_Include.argtypes = [c_void_p]
+        GetDllLibPdf().PdfResetAction_get_Include.restype = c_bool
+        ret = CallCFunction(GetDllLibPdf().PdfResetAction_get_Include,self.Ptr)
+        return ret
+
+    @Include.setter
+    def Include(self, value: bool):
+        """
+        Sets a value indicating whether fields contained in the Fields collection will be included for resetting.
+
+        If Include property is true, only the fields in this collection will be reset.
+        If Include property is false, the fields in this collection are not reset and only the remaining form fields are reset.
+        If the collection is null or empty, then all the form fields are reset and the Include property is ignored.
+        """
+        GetDllLibPdf().PdfResetAction_set_Include.argtypes = [c_void_p, c_bool]
+        CallCFunction(GetDllLibPdf().PdfResetAction_set_Include,self.Ptr, value)

spire/pdf/PdfRow.py

@@ -0,0 +1,36 @@
+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 PdfRow(SpireObject):
+    """
+    Represents a single column of the table.
+    """
+
+    @property
+    def Values(self) -> List['SpireObject']:
+        """
+        The array of values that are used to create the new row.
+        """
+        GetDllLibPdf().PdfRow_get_Values.argtypes = [c_void_p]
+        GetDllLibPdf().PdfRow_get_Values.restype = IntPtrArray
+        intPtrArray = CallCFunction(GetDllLibPdf().PdfRow_get_Values,self.Ptr)
+        ret = GetVectorFromArray(intPtrArray, SpireObject)
+        return ret
+
+    @Values.setter
+    def Values(self, value: List['SpireObject']):
+        """
+        Sets the array of values that are used to create the new row.
+        """
+        vCount = len(value)
+        ArrayType = c_void_p * vCount
+        vArray = ArrayType()
+        for i in range(0, vCount):
+            vArray[i] = value[i].Ptr
+        GetDllLibPdf().PdfRow_set_Values.argtypes = [c_void_p, ArrayType, c_int]
+        CallCFunction(GetDllLibPdf().PdfRow_set_Values,self.Ptr, vArray, vCount)

spire/pdf/PdfRowCollection.py

@@ -0,0 +1,50 @@
+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 PdfRowCollection(PdfCollection):
+    """
+    Represents the collection of the columns.
+    """
+
+    def get_Item(self, index: int) -> 'PdfRow':
+        """
+        Gets the row at the specified index.
+        """
+
+        GetDllLibPdf().PdfRowCollection_get_Item.argtypes = [c_void_p, c_int]
+        GetDllLibPdf().PdfRowCollection_get_Item.restype = c_void_p
+        intPtr = CallCFunction(GetDllLibPdf().PdfRowCollection_get_Item,self.Ptr, index)
+        ret = None if intPtr == None else PdfRow(intPtr)
+        return ret
+
+
+    @dispatch
+    def Add(self, row: PdfRow):
+        """
+        Adds the specified row.
+        <param name="row">The row.</param>
+        """
+        intPtrrow: c_void_p = row.Ptr
+
+        GetDllLibPdf().PdfRowCollection_Add.argtypes = [c_void_p, c_void_p]
+        CallCFunction(GetDllLibPdf().PdfRowCollection_Add,self.Ptr, intPtrrow)
+
+    @dispatch
+    def Add(self, values: List[SpireObject]):
+        """
+        Adds a new row using the array of values.
+        """
+
+        countvalues = len(values)
+        ArrayTypevalues = c_void_p * countvalues
+        arrayvalues = ArrayTypevalues()
+        for i in range(0, countvalues):
+            arrayvalues[i] = values[i].Ptr
+
+        GetDllLibPdf().PdfRowCollection_AddV.argtypes = [c_void_p, ArrayTypevalues]
+        CallCFunction(GetDllLibPdf().PdfRowCollection_AddV,self.Ptr, arrayvalues)