Foxit PDF SDK
foxit::addon::optimization::OptimizerSettings Class Reference
Inheritance diagram for foxit::addon::optimization::OptimizerSettings:
foxit::Base

Public Member Functions

 OptimizerSettings ()
 Constructor. More...
 
 OptimizerSettings (const OptimizerSettings &other)
 Constructor, with another result information object. More...
 
 ~OptimizerSettings ()
 Destructor.
 
bool IsEmpty () const
 Check whether current object is empty or not. More...
 
bool operator!= (const OptimizerSettings &other) const
 Not equal operator. More...
 
OptimizerSettingsoperator= (const OptimizerSettings &other)
 Assign operator. More...
 
bool operator== (const OptimizerSettings &other) const
 Equal operator. More...
 
void SetColorGrayImageSettings (const ImageSettings &settings)
 Set optimazion related settings for color/gray image. More...
 
void SetMonoImageSettings (const MonoImageSettings &settings)
 Set optimazion related settings for monochrome image. More...
 
- Public Member Functions inherited from foxit::Base
FS_HANDLE Handle () const
 Get the handle of current object. More...
 

Detailed Description

This class represents settings for optimizing a PDF document. It would be used in class Optimizer.

See also
Optimizer

Constructor & Destructor Documentation

◆ OptimizerSettings() [1/2]

foxit::addon::optimization::OptimizerSettings::OptimizerSettings ( )

Constructor.

This constructor is to construct a optimizer settings object with default setting options. User can also calling "set" methods in this class to change setting options. Please refer to comment in other settings class (which can be set to current object) for more details about what default setting options are.

◆ OptimizerSettings() [2/2]

foxit::addon::optimization::OptimizerSettings::OptimizerSettings ( const OptimizerSettings other)

Constructor, with another result information object.

Parameters
[in]otherAnother optimizer settings object.

Member Function Documentation

◆ IsEmpty()

bool foxit::addon::optimization::OptimizerSettings::IsEmpty ( ) const

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.

◆ operator!=()

bool foxit::addon::optimization::OptimizerSettings::operator!= ( const OptimizerSettings other) const

Not equal operator.

Parameters
[in]otherAnother result optimizer settings object. This function will check if current object is not equal to this one.
Returns
true means not equal, while false means equal.

◆ operator=()

OptimizerSettings& foxit::addon::optimization::OptimizerSettings::operator= ( const OptimizerSettings other)

Assign operator.

Parameters
[in]otherAnother result optimizer settings object, whose value would be assigned to current object.
Returns
Reference to current object itself.

◆ operator==()

bool foxit::addon::optimization::OptimizerSettings::operator== ( const OptimizerSettings other) const

Equal operator.

Parameters
[in]otherAnother result optimizer settings object. This function will check if current object is equal to this one.
Returns
true means equal, while false means not equal.

◆ SetColorGrayImageSettings()

void foxit::addon::optimization::OptimizerSettings::SetColorGrayImageSettings ( const ImageSettings settings)

Set optimazion related settings for color/gray image.

For a newly constructed object, if this function is not called to set any color/gray image settings, that means to use default color/gray image settings. Please refer to comment in class ImageSettings for detail values.

Parameters
[in]settingsOptimization related settings for color and grayscale images
Returns
None.

◆ SetMonoImageSettings()

void foxit::addon::optimization::OptimizerSettings::SetMonoImageSettings ( const MonoImageSettings settings)

Set optimazion related settings for monochrome image.

For a newly constructed object, if this function is not called to set any monochrome image settings, that means to use default monochrome image settings. Please refer to comment in class MonoImageSettings for detail values.

Parameters
[in]settingsOptimization related settings for monochrome images.
Returns
None.