Foxit PDF SDK
foxit::pdf::PagingSealConfig Class Reference

Inherits Object.

Public Types

enum  PagingSealPosition { e_PagingSealPositionLeft = 1, e_PagingSealPositionRight = 2, e_PagingSealPositionTop = 3, e_PagingSealPositionBottom = 4 }
 Enumeration for paging seal position. More...
 

Public Member Functions

 PagingSealConfig (PagingSealPosition paging_seal_position, float offset, float first_page_percent, bool is_on_perforation)
 Constructor, with parameter. More...
 
 ~PagingSealConfig ()
 Destructor.
 
bool operator != (const PagingSealConfig &paging_seal_config) const
 Not equal operator. More...
 
PagingSealConfigoperator= (const PagingSealConfig &paging_seal_config)
 Assign operator. More...
 
bool operator== (const PagingSealConfig &paging_seal_config) const
 Equal operator. More...
 
void Set (PagingSealPosition paging_seal_position, float offset, float first_page_percent, bool is_on_perforation)
 Set value. More...
 

Public Attributes

float first_page_percent
 The percent of the first paging seal. The rest percent will be divided equally by the other paging seals. This parameter should bigger than 0.0, less than 1.0.
 
bool is_on_perforation
 Decide whether to chop a seal that covering the margin of each two pages. true means the paging seal signatures will be added to pages in pairs, and the parameter paging_seal_position and the parameter first_page_percent will have no effect. false means not.
 
float offset
 The offset of paging seal signature. For top paging seal and bottom paging seal, the value will be the horizontal offset of the left of signature rectangle. For right paging seal,left paging seal and middle paging seal, the value will be the vertical offset of the bottom of signature rectangle. 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.
 
PagingSealPosition paging_seal_position
 The position of paging seal. Please refer to values starting from PagingSealSignature::e_PagingSealPositionLeft and this would be one of these values.
 

Detailed Description

This class represents paging seal configuration. This configuration can be set by function PagingSealSignature::SetPagingSealConfig.

Member Enumeration Documentation

◆ 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.

Constructor & Destructor Documentation

◆ PagingSealConfig()

foxit::pdf::PagingSealConfig::PagingSealConfig ( PagingSealPosition  paging_seal_position,
float  offset,
float  first_page_percent,
bool  is_on_perforation 
)

Constructor, with parameter.

Parameters
[in]paging_seal_positionThe position of paging seal. Please refer to values starting from PagingSealSignature::e_PagingSealPositionLeft and this would be one of these values.
[in]offsetThe offset of paging seal. This value should not be a negative number.
[in]first_page_percentThe percent of the first paging seal. This parameter should larger than 0.0, less than 1.0.
[in]is_on_perforationDecide whether to chop a seal that covering the margin of each two pages.

Member Function Documentation

◆ operator !=()

bool foxit::pdf::PagingSealConfig::operator != ( const PagingSealConfig paging_seal_config) const
inline

Not equal operator.

Parameters
[in]paging_seal_configAnother 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=()

PagingSealConfig& foxit::pdf::PagingSealConfig::operator= ( const PagingSealConfig paging_seal_config)
inline

Assign operator.

Parameters
[in]paging_seal_configAnother 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_configAnother 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 
)

Set value.

Parameters
[in]paging_seal_positionThe position of paging seal. Please refer to values starting from PagingSealSignature::e_PagingSealPositionLeft and this would be one of these values.
[in]offsetThe offset of paging seal. This value should not be a negative number.
[in]first_page_percentThe percent of the first paging seal. This parameter should larger than 0.0, less than 1.0.
[in]is_on_perforationDecide whether to chop a seal that covering the margin of each two pages.

@ return None.