Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	Safe-Inferred
Language	Haskell2010

GI.Poppler.Structs.SigningData

Contents

Exported types
Methods

Description

No description available in the introspection data.

Synopsis

newtype SigningData = SigningData (ManagedPtr SigningData)
signingDataCopy :: (HasCallStack, MonadIO m) => SigningData -> m SigningData
signingDataFree :: (HasCallStack, MonadIO m) => Maybe SigningData -> m ()
signingDataGetBackgroundColor :: (HasCallStack, MonadIO m) => SigningData -> m Color
signingDataGetBorderColor :: (HasCallStack, MonadIO m) => SigningData -> m Color
signingDataGetBorderWidth :: (HasCallStack, MonadIO m) => SigningData -> m Double
signingDataGetCertificateInfo :: (HasCallStack, MonadIO m) => SigningData -> m CertificateInfo
signingDataGetDestinationFilename :: (HasCallStack, MonadIO m) => SigningData -> m Text
signingDataGetDocumentOwnerPassword :: (HasCallStack, MonadIO m) => SigningData -> m Text
signingDataGetDocumentUserPassword :: (HasCallStack, MonadIO m) => SigningData -> m Text
signingDataGetFieldPartialName :: (HasCallStack, MonadIO m) => SigningData -> m Text
signingDataGetFontColor :: (HasCallStack, MonadIO m) => SigningData -> m Color
signingDataGetFontSize :: (HasCallStack, MonadIO m) => SigningData -> m Double
signingDataGetImagePath :: (HasCallStack, MonadIO m) => SigningData -> m Text
signingDataGetLeftFontSize :: (HasCallStack, MonadIO m) => SigningData -> m Double
signingDataGetLocation :: (HasCallStack, MonadIO m) => SigningData -> m Text
signingDataGetPage :: (HasCallStack, MonadIO m) => SigningData -> m Int32
signingDataGetPassword :: (HasCallStack, MonadIO m) => SigningData -> m Text
signingDataGetReason :: (HasCallStack, MonadIO m) => SigningData -> m Text
signingDataGetSignatureRectangle :: (HasCallStack, MonadIO m) => SigningData -> m Rectangle
signingDataGetSignatureText :: (HasCallStack, MonadIO m) => SigningData -> m Text
signingDataGetSignatureTextLeft :: (HasCallStack, MonadIO m) => SigningData -> m Text
signingDataNew :: (HasCallStack, MonadIO m) => m SigningData
signingDataSetBackgroundColor :: (HasCallStack, MonadIO m) => SigningData -> Color -> m ()
signingDataSetBorderColor :: (HasCallStack, MonadIO m) => SigningData -> Color -> m ()
signingDataSetBorderWidth :: (HasCallStack, MonadIO m) => SigningData -> Double -> m ()
signingDataSetCertificateInfo :: (HasCallStack, MonadIO m) => SigningData -> CertificateInfo -> m ()
signingDataSetDestinationFilename :: (HasCallStack, MonadIO m) => SigningData -> Text -> m ()
signingDataSetDocumentOwnerPassword :: (HasCallStack, MonadIO m) => SigningData -> Text -> m ()
signingDataSetDocumentUserPassword :: (HasCallStack, MonadIO m) => SigningData -> Text -> m ()
signingDataSetFieldPartialName :: (HasCallStack, MonadIO m) => SigningData -> Text -> m ()
signingDataSetFontColor :: (HasCallStack, MonadIO m) => SigningData -> Color -> m ()
signingDataSetFontSize :: (HasCallStack, MonadIO m) => SigningData -> Double -> m ()
signingDataSetImagePath :: (HasCallStack, MonadIO m) => SigningData -> Text -> m ()
signingDataSetLeftFontSize :: (HasCallStack, MonadIO m) => SigningData -> Double -> m ()
signingDataSetLocation :: (HasCallStack, MonadIO m) => SigningData -> Text -> m ()
signingDataSetPage :: (HasCallStack, MonadIO m) => SigningData -> Int32 -> m ()
signingDataSetPassword :: (HasCallStack, MonadIO m) => SigningData -> Text -> m ()
signingDataSetReason :: (HasCallStack, MonadIO m) => SigningData -> Text -> m ()
signingDataSetSignatureRectangle :: (HasCallStack, MonadIO m) => SigningData -> Rectangle -> m ()
signingDataSetSignatureText :: (HasCallStack, MonadIO m) => SigningData -> Text -> m ()
signingDataSetSignatureTextLeft :: (HasCallStack, MonadIO m) => SigningData -> Text -> m ()

Exported types

newtype SigningData Source #

Memory-managed wrapper type.

Constructors

SigningData (ManagedPtr SigningData)

Instances

Instances details

Eq SigningData Source #
Instance details Defined in GI.Poppler.Structs.SigningData Methods (==) :: SigningData -> SigningData -> Bool # (/=) :: SigningData -> SigningData -> Bool #
GBoxed SigningData Source #
Instance details Defined in GI.Poppler.Structs.SigningData
ManagedPtrNewtype SigningData Source #
Instance details Defined in GI.Poppler.Structs.SigningData Methods toManagedPtr :: SigningData -> ManagedPtr SigningData
TypedObject SigningData Source #
Instance details Defined in GI.Poppler.Structs.SigningData Methods glibType :: IO GType
HasParentTypes SigningData Source #
Instance details Defined in GI.Poppler.Structs.SigningData
IsGValue (Maybe SigningData) Source #	Convert `SigningData` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Poppler.Structs.SigningData Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe SigningData -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe SigningData)
type ParentTypes SigningData Source #
Instance details Defined in GI.Poppler.Structs.SigningData type ParentTypes SigningData = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Expand

copy

signingDataCopy Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> m SigningData	Returns: a new `SigningData` structure identical to `signingData`

Copies signingData, creating an identical SigningData.

Since: 23.07.0

free

signingDataFree Source #

Arguments

:: (HasCallStack, MonadIO m)
=> Maybe SigningData	`signingData`: a `SigningData` structure containing signing data
-> m ()

Frees signingData

Since: 23.07.0

getBackgroundColor

signingDataGetBackgroundColor Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> m Color	Returns: a `Color`

Get signature background color.

Since: 23.07.0

getBorderColor

signingDataGetBorderColor Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> m Color	Returns: a `Color`

Get signature border color.

Since: 23.07.0

getBorderWidth

signingDataGetBorderWidth Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> m Double	Returns: border width

Get signature border width.

Since: 23.07.0

getCertificateInfo

signingDataGetCertificateInfo Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> m CertificateInfo	Returns: a `CertificateInfo`

Get certification information.

Since: 23.07.0

getDestinationFilename

signingDataGetDestinationFilename Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> m Text	Returns: destination filename

Get destination file name.

Since: 23.07.0

getDocumentOwnerPassword

signingDataGetDocumentOwnerPassword Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> m Text	Returns: document owner password (for encrypted files)

Get document owner password.

Since: 23.07.0

getDocumentUserPassword

signingDataGetDocumentUserPassword Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> m Text	Returns: document user password (for encrypted files)

Get document user password.

Since: 23.07.0

getFieldPartialName

signingDataGetFieldPartialName Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> m Text	Returns: field partial name

Get field partial name.

Since: 23.07.0

getFontColor

signingDataGetFontColor Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> m Color	Returns: a `Color`

Get signature font color.

Since: 23.07.0

getFontSize

signingDataGetFontSize Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> m Double	Returns: font size

Get signature font size.

Since: 23.07.0

getImagePath

signingDataGetImagePath Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> m Text	Returns: image path

Get image path.

Since: 23.07.0

getLeftFontSize

signingDataGetLeftFontSize Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> m Double	Returns: left font size

Get signature left font size.

Since: 23.07.0

getLocation

signingDataGetLocation Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> m Text	Returns: location

Get location.

Since: 23.07.0

getPage

signingDataGetPage Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> m Int32	Returns: page number

Get page.

Since: 23.07.0

getPassword

signingDataGetPassword Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> m Text	Returns: password

Get signing key password.

Since: 23.07.0

getReason

signingDataGetReason Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> m Text	Returns: reason

Get reason.

Since: 23.07.0

getSignatureRectangle

signingDataGetSignatureRectangle Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> m Rectangle	Returns: a `Rectangle`

Get signature rectangle.

Since: 23.07.0

getSignatureText

signingDataGetSignatureText Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> m Text	Returns: signature text

Get signature text.

Since: 23.07.0

getSignatureTextLeft

signingDataGetSignatureTextLeft Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> m Text	Returns: signature text left

Get signature text left.

Since: 23.07.0

new

signingDataNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> m SigningData	Returns: a new `SigningData`. It must be freed with `signingDataFree` when done.

Creates a new SigningData with default content.

Since: 23.07.0

setBackgroundColor

signingDataSetBackgroundColor Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> Color	`backgroundColor`: a `Color` to be used for signature background
-> m ()

Set signature background color.

Since: 23.07.0

setBorderColor

signingDataSetBorderColor Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> Color	`borderColor`: a `Color` to be used for signature border
-> m ()

Set signature border color.

Since: 23.07.0

setBorderWidth

signingDataSetBorderWidth Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> Double	`borderWidth`: border width
-> m ()

Set signature border width.

Since: 23.07.0

setCertificateInfo

signingDataSetCertificateInfo Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> CertificateInfo	`certificateInfo`: a `CertificateInfo`
-> m ()

Set certification information.

Since: 23.07.0

setDestinationFilename

signingDataSetDestinationFilename Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> Text	`filename`: destination filename
-> m ()

Set destination file name.

Since: 23.07.0

setDocumentOwnerPassword

signingDataSetDocumentOwnerPassword Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> Text	`documentOwnerPassword`: document owner password
-> m ()

Set document owner password (for encrypted files).

Since: 23.07.0

setDocumentUserPassword

signingDataSetDocumentUserPassword Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> Text	`documentUserPassword`: document user password
-> m ()

Set document user password (for encrypted files).

Since: 23.07.0

setFieldPartialName

signingDataSetFieldPartialName Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> Text	`fieldPartialName`: a field partial name
-> m ()

Set field partial name (existing field id or a new one) where signature is placed.

Since: 23.07.0

setFontColor

signingDataSetFontColor Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> Color	`fontColor`: a `Color` to be used as signature font color
-> m ()

Set signature font color.

Since: 23.07.0

setFontSize

signingDataSetFontSize Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> Double	`fontSize`: signature font size
-> m ()

Set signature font size (>0).

Since: 23.07.0

setImagePath

signingDataSetImagePath Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> Text	`imagePath`: signature image path
-> m ()

Set signature background (watermark) image path.

Since: 23.07.0

setLeftFontSize

signingDataSetLeftFontSize Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> Double	`fontSize`: signature font size
-> m ()

Set signature left font size (> 0).

Since: 23.07.0

setLocation

signingDataSetLocation Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> Text	`location`: a location
-> m ()

Set signature location (e.g. "At my desk").

Since: 23.07.0

setPage

signingDataSetPage Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> Int32	`page`: a page number
-> m ()

Set page (>=0).

Since: 23.07.0

setPassword

signingDataSetPassword Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> Text	`password`: a password
-> m ()

Set password for the signing key.

Since: 23.07.0

setReason

signingDataSetReason Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> Text	`reason`: a reason
-> m ()

Set reason for signature (e.g. I'm approver).

Since: 23.07.0

setSignatureRectangle

signingDataSetSignatureRectangle Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> Rectangle	`signatureRect`: a `Rectangle` where signature should be shown
-> m ()

Set signature rectangle.

Since: 23.07.0

setSignatureText

signingDataSetSignatureText Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> Text	`signatureText`: text to show as main signature
-> m ()

Set signature text.

Since: 23.07.0

setSignatureTextLeft

signingDataSetSignatureTextLeft Source #

Arguments

:: (HasCallStack, MonadIO m)
=> SigningData	`signingData`: a `SigningData` structure containing signing data
-> Text	`signatureTextLeft`: text to show as small left signature
-> m ()

Set small signature text on the left hand.

Since: 23.07.0

Exported types

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

copy

free

getBackgroundColor

getBorderColor

getBorderWidth

getCertificateInfo

getDestinationFilename

getDocumentOwnerPassword

getDocumentUserPassword

getFieldPartialName

getFontColor

getFontSize

getImagePath

getLeftFontSize

getLocation

getPage

getPassword

getReason

getSignatureRectangle

getSignatureText

getSignatureTextLeft

new

setBackgroundColor

setBorderColor

setBorderWidth

setCertificateInfo

setDestinationFilename

setDocumentOwnerPassword

setDocumentUserPassword

setFieldPartialName

setFontColor

setFontSize

setImagePath

setLeftFontSize

setLocation

setPage

setPassword

setReason

setSignatureRectangle

setSignatureText

setSignatureTextLeft