Inherits Object.
This class represents paging seal configuration. This configuration can be set by function PagingSealSignature::SetPagingSealConfig.
◆ PagingSealPosition
Enumeration for paging seal position.
Values of this enumeration should be used alone.
Enumerator |
---|
e_PagingSealPositionLeft | Left Paging Seal.
|
e_PagingSealPositionRight | Right Paging Seal.
|
e_PagingSealPositionTop | Top Paging Seal.
|
e_PagingSealPositionBottom | Bottom Paging Seal.
|
◆ PagingSealStyle
Enumeration for paging seal signature style.
Values of this enumeration should be used alone.
Enumerator |
---|
e_PagingSealStyleMultipleSignatures | Add multiple signatures. Use the Signature to display the appearance of paging seal signature, and these signatures share the same signature data.
|
e_PagingSealStyleOneSignature | Only add one signature. This signature is used for signature and verification and will be hidden in the PDF document. Use the annots::PagingSeal annotation to display the appearance of paging seal signature.
|
◆ PagingSealConfig()
Constructor, with parameter.
- Parameters
-
[in] | paging_seal_position | The position of paging seal. Please refer to values starting from PagingSealConfig::e_PagingSealPositionLeft and this would be one of these values. |
[in] | offset | The offset of paging seal. This value should not be a negative number. |
[in] | first_page_percent | The percent of the first paging seal. This parameter should larger than 0.0, less than 1.0. |
[in] | is_on_perforation | Decide whether to chop a seal that covering the margin of each two pages. |
[in] | paging_seal_style | The paging seal signature style. Please refer to values starting from PagingSealConfig::e_PagingSealStyleMultipleSignatures and this would be one of these values. |
◆ operator !=()
bool foxit::pdf::PagingSealConfig::operator != |
( |
const PagingSealConfig & |
paging_seal_config | ) |
const |
|
inline |
Not equal operator.
- Parameters
-
[in] | paging_seal_config | Another paging seal configuration object. This function will check if current object is not equal to this one. |
- Returns
- true means not equal, while false means equal.
◆ operator=()
Assign operator.
- Parameters
-
[in] | paging_seal_config | Another paging seal configuration object, whose value would be assigned to current object. |
- Returns
- Reference to current object itself.
◆ operator==()
bool foxit::pdf::PagingSealConfig::operator== |
( |
const PagingSealConfig & |
paging_seal_config | ) |
const |
|
inline |
Equal operator.
- Parameters
-
[in] | paging_seal_config | Another paging seal configuration object. This function will check if current object is equal to this one. |
- Returns
- true means equal, while false means not equal.
◆ Set()
void foxit::pdf::PagingSealConfig::Set |
( |
PagingSealPosition |
paging_seal_position, |
|
|
float |
offset, |
|
|
float |
first_page_percent, |
|
|
bool |
is_on_perforation, |
|
|
PagingSealStyle |
paging_seal_style |
|
) |
| |
Set value.
- Parameters
-
[in] | paging_seal_position | The position of paging seal. Please refer to values starting from PagingSealConfig::e_PagingSealPositionLeft and this would be one of these values. |
[in] | offset | The offset of paging seal. This value should not be a negative number. |
[in] | first_page_percent | The percent of the first paging seal. This parameter should larger than 0.0, less than 1.0. |
[in] | is_on_perforation | Decide whether to chop a seal that covering the margin of each two pages. |
[in] | paging_seal_style | The paging seal signature style. Please refer to values starting from PagingSealConfig::e_PagingSealStyleMultipleSignatures and this would be one of these values. |
@ return None.
◆ offset
float foxit::pdf::PagingSealConfig::offset |
The offset of paging seal signature.
This value should not be a negative number. The maximum value of offset is the value of page width or page height minus the width or height of rectangle of paging seal signature. If offset bigger than the maximum value, the maximum will be used.
-
For top paging seal and bottom paging seal, this value will be the horizontal offset of the left of signature rectangle.
-
For right paging seal,left paging seal, this value will be the vertical offset of the bottom of signature rectangle.
-
For the parameter is_on_perforation is true, this value will be the vertical offset of the bottom of signature rectangle.
◆ paging_seal_style