Go to the documentation of this file.
15 #ifndef FS_PDFOPTIMIZATION_H_
16 #define FS_PDFOPTIMIZATION_H_
35 namespace optimization {
104 typedef enum _ImageCompressMode {
120 typedef enum _ImageCompressQuality {
138 typedef enum _StretchMode {
342 typedef enum _MonoImageCompressMode {
362 typedef enum _MonoImageCompressQuality {
374 typedef enum _StretchMode {
612 typedef enum _OptimizerOptions {
630 typedef enum _CleanUpOptions {
646 typedef enum _DiscardObjectsOptions {
683 typedef enum _DiscardUserDataOptions {
When this is set, that means not to do any interpolation for stretching.
Definition: fs_optimization.h:150
void SetCompressionMode(ImageCompressMode mode)
Set compression mode used for optimizing color/gray images in a PDF document.
void SetImageDPI(int32 dpi)
Set the DPI value as the target compressed value for compressing color/gray images in a PDF document.
~MonoImageSettings()
Destructor.
StretchMode
Enumeration for stretch mode.
Definition: fs_optimization.h:138
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:214
Compression quality: Low.
Definition: fs_optimization.h:124
Compression quality: Maximum.
Definition: fs_optimization.h:130
When this is set, that means to do default stretching.
Definition: fs_optimization.h:376
When this is set, that means to do bicubic interpolation for zooming.
Definition: fs_optimization.h:384
Discard embedded print settings.
Definition: fs_optimization.h:660
bool operator!=(const MonoImageSettings &other) const
Not equal operator.
Remove invalid links.
Definition: fs_optimization.h:638
bool operator==(const ImageSettings &other) const
Equal operator.
Discard all form submission, import and reset actions.
Definition: fs_optimization.h:648
void SetStretchMode(StretchMode mode)
Set stretch mode used for optimizing color/gray images in a PDF document.
Discard hidden layer content and flatten visible layers.
Definition: fs_optimization.h:695
Optimize PDF document by discarding objects.
Definition: fs_optimization.h:618
OptimizerOptions
Enumeration for optimizer options.
Definition: fs_optimization.h:612
In streams that use LZW encoding, use Flate instead.
Definition: fs_optimization.h:634
~ImageSettings()
Destructor.
When this is set, that means to do without stretching.
Definition: fs_optimization.h:142
Definition: fs_optimization.h:97
Discard document information and metadata.
Definition: fs_optimization.h:689
Definition: fs_optimization.h:335
Definition: fs_common.h:346
Discard embedded search index.
Definition: fs_optimization.h:675
void SetImageDPI(int32 dpi)
Set the DPI value as the target compressed value for compressing monochrome images in a PDF document.
bool operator==(const OptimizerSettings &other) const
Equal operator.
void SetQuality(MonoImageCompressQuality quality)
Set compression quality, used for optimizing monochrome images in a PDF document.
void SetImageDPILimit(int dpi_limit)
Set the lower limit DPI value for the color/gray image to decide if the image is to be compressed in ...
~OptimizerSettings()
Destructor.
Header file for common definitions and classes.
Compression quality: Minimum.
Definition: fs_optimization.h:122
Definition: fs_optimization.h:47
StretchMode
Enumeration for stretch mode.
Definition: fs_optimization.h:374
OptimizerSettings()
Constructor.
void SetQuality(ImageCompressQuality quality)
Set the quality for lossy compression modes, used for optimizing color/gray images in a PDF document.
When this is set, that means to do interpolation for zooming.
Definition: fs_optimization.h:144
bool IsEmpty() const
Check whether current object is empty or not.
When this is set, that means not to do halftone for shrinking or rotating.
Definition: fs_optimization.h:382
Compression mode: retain, which means no compression.
Definition: fs_optimization.h:112
void SetForegroundDownScale(int32 down_scale)
Set the foreground downscale value for lossy compression modes, used for optimizing color images in a...
Use Flate to encode streams that are not encoded.
Definition: fs_optimization.h:632
void SetUnembeddedFontSettings(const UnembeddedFontSettings &settings)
Set optimization related settings for unembedding fonts.
Compression mode: high.
Definition: fs_optimization.h:348
void SetCleanUpOptions(foxit::uint32 clean_up_options)
Set optimization related options for cleaning up.
Remove invalid bookmarks.
Definition: fs_optimization.h:636
Compression mode: CCITT Group 4.
Definition: fs_optimization.h:346
void SetImageDPILimit(int dpi_limit)
Set the lower limit DPI value for the monochrome image to decide if the image is to be compressed in ...
UnembeddedFontSettings()
Constructor.
~UnembeddedFontSettings()
Destructor.
Compression quality: Lossy.
Definition: fs_optimization.h:366
void SetTextSensitivity(int32 text_sensitivity)
Set the text sensitivity for lossy compression modes, used for optimizing color images in a PDF docum...
void SetColorGrayImageSettings(const ImageSettings &settings)
Set optimization related settings for color/gray image.
bool operator!=(const ImageSettings &other) const
Not equal operator.
Discard document tags.
Definition: fs_optimization.h:673
bool operator!=(const UnembeddedFontSettings &other) const
Not equal operator.
Compression mode: CCITT Group 3.
Definition: fs_optimization.h:344
void SetBackgroundDownScale(int32 down_scale)
Set the background downscale value for lossy compression modes, used for optimizing color images in a...
UnembeddedFontSettings & operator=(const UnembeddedFontSettings &other)
Assign operator.
Compression mode: run-length.
Definition: fs_optimization.h:354
Compression mode: jpeg2000.
Definition: fs_optimization.h:110
Discard file attachments.
Definition: fs_optimization.h:691
void SetGrayscaleImageSettings(const ImageSettings &settings)
Set optimization related settings for grayscale image.
Discard all alternate images.
Definition: fs_optimization.h:671
Definition: fs_optimization.h:527
void SetOptimizerOptions(uint32 optimize_options)
Set options to decide which kind of optimizer setting will be used for optimizing PDF document.
Optimize PDF document by unembedding some embedded fonts.
Definition: fs_optimization.h:620
MonoImageSettings & operator=(const MonoImageSettings &other)
Assign operator.
void SetUnembeddedFontNameArray(const WStringArray &font_name_array)
Set a font name array to specify which fonts are to be unembeded.
MonoImageSettings()
Constructor.
static common::Progressive StartSubsetEmbedFont(const pdf::PDFDoc &doc, common::PauseCallback *pause)
Start to make subsets for embedded fonts in the given PDF document.
When this is set, that means to do without stretching.
Definition: fs_optimization.h:378
Compression mode: high.
Definition: fs_optimization.h:106
Flatten form fields.
Definition: fs_optimization.h:650
Discard all JavaScript actions.
Definition: fs_optimization.h:656
void SetDiscardObjectsOptions(foxit::uint32 discard_objects_options)
Set optimization related options for discarding objects.
Compression quality: Lossless.
Definition: fs_optimization.h:364
bool IsEmpty() const
Check whether current object is empty or not.
static common::Progressive Optimize(const pdf::PDFDoc &doc, const OptimizerSettings &settings, common::PauseCallback *pause)
Optimize the given PDF document with specified optimizer settings.
Compression mode: retain, which means no compression.
Definition: fs_optimization.h:352
Header file for PDF page related definitions and classes.
When this is set, that means not to do any interpolation for stretching.
Definition: fs_optimization.h:386
When this is set, that means not to do halftone for shrinking or rotating.
Definition: fs_optimization.h:146
When this is set, that means to do bicubic interpolation for zooming.
Definition: fs_optimization.h:148
Foxit namespace.
Definition: fs_taggedpdf.h:27
MonoImageCompressMode
Enumeration for compression mode used for monochrome image.
Definition: fs_optimization.h:342
DiscardObjectsOptions
Enumeration for discarding objects options.
Definition: fs_optimization.h:646
Discard bookmarks.
Definition: fs_optimization.h:662
Definition: fx_basic.h:3761
bool operator!=(const OptimizerSettings &other) const
Not equal operator.
Compression quality: High.
Definition: fs_optimization.h:128
Header file for PDF document related definitions and classes.
Optimize PDF document by cleaning up.
Definition: fs_optimization.h:616
void SetColorImageSettings(const ImageSettings &settings)
Set optimization related settings for color image.
Compression mode: jpeg.
Definition: fs_optimization.h:108
When this is set, that means to do default stretching.
Definition: fs_optimization.h:140
void SetCompressionMode(MonoImageCompressMode mode)
Set compression mode used for optimizing monochrome images in a PDF document.
Compression quality: Medium.
Definition: fs_optimization.h:126
DiscardUserDataOptions
Enumeration for discarding user data options.
Definition: fs_optimization.h:683
Definition: fs_pdfdoc.h:610
Discard all annotations, forms and multimedia.
Definition: fs_optimization.h:685
Compression mode: jbig2.
Definition: fs_optimization.h:350
FX_INT32 int32
32-bit signed integer.
Definition: fs_basictypes.h:194
Discard private data of other applications.
Definition: fs_optimization.h:693
void SetMonoImageSettings(const MonoImageSettings &settings)
Set optimization related settings for monochrome image.
ImageCompressMode
Enumeration for compression mode used for color or gray image.
Definition: fs_optimization.h:104
Definition: fs_basictypes.h:228
ImageSettings()
Constructor.
Optimize PDF document by compressing images.
Definition: fs_optimization.h:614
bool operator==(const UnembeddedFontSettings &other) const
Equal operator.
MonoImageCompressQuality
Enumeration for compression quality used for monochrome image.
Definition: fs_optimization.h:362
bool IsEmpty() const
Check whether current object is empty or not.
When this is set, that means to do interpolation for zooming.
Definition: fs_optimization.h:380
Definition: fs_optimization.h:605
Discard embedded page thumbnails.
Definition: fs_optimization.h:658
void SetDiscardUserDataOptions(foxit::uint32 discard_userdata_options)
Set optimization related options for discarding user data.
ImageSettings & operator=(const ImageSettings &other)
Assign operator.
ImageCompressQuality
Enumeration for loss compression quality used for color or gray image.
Definition: fs_optimization.h:120
bool operator==(const MonoImageSettings &other) const
Equal operator.
OptimizerSettings & operator=(const OptimizerSettings &other)
Assign operator.
FX_UINT32 uint32
32-bit unsigned integer.
Definition: fs_basictypes.h:196
bool IsEmpty() const
Check whether current object is empty or not.
Definition: fs_basictypes.h:427
Optimize PDF document by discarding user data.
Definition: fs_optimization.h:622
CleanUpOptions
Enumeration for cleaning up options.
Definition: fs_optimization.h:630
void SetStretchMode(StretchMode mode)
Set stretch mode used for optimizing monochrome images in a PDF document.
Discard external cross references.
Definition: fs_optimization.h:687
@2024 Foxit Software Incorporated. All rights reserved.