Foxit PDF SDK
|
Public Types | |
enum | CleanUpOptions { e_CleanUpUseFlateForNonEncodedStream = 0x01, e_CleanUpUseFlateInsteadOfLZW = 0x02, e_CleanUpRemoveInvalidBookmarks = 0x04, e_CleanUpRemoveInvalidLinks = 0x08 } |
Enumeration for cleaning up options. More... | |
enum | DiscardObjectsOptions { e_DiscardObjectsFormActions = 0x01, e_DiscardObjectsFlattenFormFields = 0x02, e_DiscardObjectsJavaScriptActions = 0x04, e_DiscardObjectsEmbeddedPageThumbnails = 0x08, e_DiscardObjectsEmbeddedPrintSettings = 0x10, e_DiscardObjectsBookmarks = 0x20 } |
Enumeration for discarding objects options. More... | |
enum | OptimizerOptions { e_OptimizerCompressImages = 0x01, e_OptimizerCleanUp = 0x02, e_OptimizerDiscardObjects = 0x04 } |
Enumeration for optimizer options. More... | |
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... | |
OptimizerSettings & | operator= (const OptimizerSettings &other) |
Assign operator. More... | |
bool | operator== (const OptimizerSettings &other) const |
Equal operator. More... | |
void | SetCleanUpOptions (foxit::uint32 clean_up_options) |
Set optimization related options for cleaning up. More... | |
void | SetColorGrayImageSettings (const ImageSettings &settings) |
Set optimization related settings for color/gray image. More... | |
void | SetDiscardObjectsOptions (foxit::uint32 discard_objects_options) |
Set optimization related options for discarding objects. More... | |
void | SetMonoImageSettings (const MonoImageSettings &settings) |
Set optimization related settings for monochrome image. More... | |
void | SetOptimizerOptions (uint32 optimize_options) |
Set options to decide which kind of optimizer setting will be used for optimizing PDF document. More... | |
![]() | |
FS_HANDLE | Handle () const |
Get the handle of current object. More... | |
This class represents settings for optimizing a PDF document. It would be used in class Optimizer.
Enumeration for cleaning up options.
Values of this enumeration can be used alone or in a combination.
Enumeration for discarding objects options.
Values of this enumeration can be used alone or in a combination.
Enumeration for optimizer options.
Values of this enumeration can be used alone or in a combination.
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.
foxit::addon::optimization::OptimizerSettings::OptimizerSettings | ( | const OptimizerSettings & | other | ) |
Constructor, with another result information object.
[in] | other | Another optimizer settings object. |
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.
bool foxit::addon::optimization::OptimizerSettings::operator!= | ( | const OptimizerSettings & | other | ) | const |
Not equal operator.
[in] | other | Another result optimizer settings object. This function will check if current object is not equal to this one. |
OptimizerSettings& foxit::addon::optimization::OptimizerSettings::operator= | ( | const OptimizerSettings & | other | ) |
Assign operator.
[in] | other | Another result optimizer settings object, whose value would be assigned to current object. |
bool foxit::addon::optimization::OptimizerSettings::operator== | ( | const OptimizerSettings & | other | ) | const |
Equal operator.
[in] | other | Another result optimizer settings object. This function will check if current object is equal to this one. |
void foxit::addon::optimization::OptimizerSettings::SetCleanUpOptions | ( | foxit::uint32 | clean_up_options | ) |
Set optimization related options for cleaning up.
For a newly constructed object, if this function is not called to set any clean-up options, that means not to do clean-up optimization. Clean-up options set by this function are useful only when option value OptimizerSettings::e_OptimizerCleanUp is set by function OptimizerSettings::SetOptimizerOptions.
[in] | clean_up_options | Optimization related options for cleaning up. 0 means not to do clean-up optimization. Please refer to values starting from OptimizerSettings::e_CleanUpUseFlateForNonEncodedStream and this can be one or a combination of these values. |
void foxit::addon::optimization::OptimizerSettings::SetColorGrayImageSettings | ( | const ImageSettings & | settings | ) |
Set optimization 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 default values.
ImageSettings set by this function is useful only when option value OptimizerSettings::e_OptimizerCompressImages is set by function OptimizerSettings::SetOptimizerOptions.
[in] | settings | Optimization related settings for color and grayscale images. |
void foxit::addon::optimization::OptimizerSettings::SetDiscardObjectsOptions | ( | foxit::uint32 | discard_objects_options | ) |
Set optimization related options for discarding objects.
For a newly constructed object, if this function is not called to set any discard-objects options, that means not to do discard-objects optimization. Discard-objects options set by this function are useful only when option value OptimizerSettings::e_OptimizerDiscardObjects is set by function OptimizerSettings::SetOptimizerOptions.
[in] | discard_objects_options | Optimization related options for discarding objects. 0 means not to do discarding-objects optimization. Please refer to values starting from OptimizerSettings::e_DiscardObjectsFormActions and this can be one or a combination of these values. |
void foxit::addon::optimization::OptimizerSettings::SetMonoImageSettings | ( | const MonoImageSettings & | settings | ) |
Set optimization 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.
MonoImageSettings set by this function is useful only when option value OptimizerSettings::e_OptimizerCompressImages is set by function OptimizerSettings::SetOptimizerOptions.
[in] | settings | Optimization related settings for monochrome images. |
void foxit::addon::optimization::OptimizerSettings::SetOptimizerOptions | ( | uint32 | optimize_options | ) |
Set options to decide which kind of optimizer setting will be used for optimizing PDF document.
For a newly constructed object, if this function is not called to set any optimizer options, that means no optimizer setting is useful.
[in] | optimize_options | The options to decide which kind of optimizer setting will be used for optimizing PDF document. 0 means no optimizer setting of any kind is useful. Please refer to values starting from OptimizerSettings::e_OptimizerCompressImages and this can be one or a combination of these values. |