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

Public Types

enum  MonoImageCompressMode {
  e_ImageCompressCCITT3 = 10001, e_ImageCompressCCITT4 = 10002, e_ImageCompressHigh = 10003, e_ImageCompressjpeg2 = 10004,
  e_ImageCompressRetain = 10007, e_ImageCompressRunLength = 10008
}
 Enumeration for compression mode used for monochrome image. More...
 
enum  StretchMode {
  e_StretchOff = 0x00, e_StretchInterpol = 0x20, e_StretchDownsample = 0x04, e_StretchBicubic = 0x80,
  e_StretchNoSmooth = 0x100
}
 Enumeration for stretch mode. More...
 

Public Member Functions

 MonoImageSettings ()
 Constructor. More...
 
 MonoImageSettings (const MonoImageSettings &other)
 Constructor, with another result information object. More...
 
 ~MonoImageSettings ()
 Destructor.
 
bool IsEmpty () const
 Check whether current object is empty or not. More...
 
bool operator!= (const MonoImageSettings &other) const
 Not equal operator. More...
 
MonoImageSettingsoperator= (const MonoImageSettings &other)
 Assign operator. More...
 
bool operator== (const MonoImageSettings &other) const
 Equal operator. More...
 
void SetCompressionMode (MonoImageCompressMode mode)
 Set compression mode used for optimizing monochrome images in a PDF document. More...
 
void SetImageDPI (int32 dpi)
 Set the image DPI used for optimizing monochrome images in a PDF document. More...
 
void SetStretchMode (StretchMode mode)
 Set stretch mode used for optimizing monochrome images in a PDF document. More...
 
- Public Member Functions inherited from foxit::Base
FS_HANDLE Handle () const
 Get the handle of current object. More...
 

Detailed Description

This class represents downsampling/recompression settings for monochrome images. This class object can be set to class OptimizerSettings and then be used to optimize a PDF document.

See also
OptimizerSettings

Member Enumeration Documentation

◆ MonoImageCompressMode

Enumeration for compression mode used for monochrome image.

Values of this enumeration should be used alone.

Enumerator
e_ImageCompressCCITT3 

Compression mode: CCITT Group 3.

e_ImageCompressCCITT4 

Compression mode: CCITT Group 4.

e_ImageCompressHigh 

Compression mode: high.

e_ImageCompressjpeg2 

Compression mode: jpeg2.

e_ImageCompressRetain 

Compression mode: retain, which means no compression.

e_ImageCompressRunLength 

Compression mode: run-length.

◆ StretchMode

Enumeration for stretch mode.

Values of this enumeration should be used alone.

Enumerator
e_StretchOff 

When this is set, that means do without stretching.

e_StretchInterpol 

When this is set, that means to do interpolation for zooming.

e_StretchDownsample 

When this is set, that means not to do halftone for shrinking or rotating.

e_StretchBicubic 

When this is set, that means to do bicubic interpolation for zooming.

e_StretchNoSmooth 

When this is set, that means not to do any interpolation for stretching.

Constructor & Destructor Documentation

◆ MonoImageSettings() [1/2]

foxit::addon::optimization::MonoImageSettings::MonoImageSettings ( )

Constructor.

This constructor is to construct a monochrome image settings object with default setting options. User can also calling "set" methods in this class to change these setting options. Please refer to comment of these "set" methods for more details about default values.

◆ MonoImageSettings() [2/2]

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

Constructor, with another result information object.

Parameters
[in]otherAnother monochrome image settings object.

Member Function Documentation

◆ IsEmpty()

bool foxit::addon::optimization::MonoImageSettings::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::MonoImageSettings::operator!= ( const MonoImageSettings other) const

Not equal operator.

Parameters
[in]otherAnother monochrome image 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=()

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

Assign operator.

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

◆ operator==()

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

Equal operator.

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

◆ SetCompressionMode()

void foxit::addon::optimization::MonoImageSettings::SetCompressionMode ( MonoImageCompressMode  mode)

Set compression mode used for optimizing monochrome images in a PDF document.

For a newly constructed object, if this function is not called to set option, that means to use MonoImageSettings::e_ImageCompressCCITT4 as the deault value of this option.

Parameters
[in]modeImage compression mode. Please refer to values starting from MonoImageSettings::e_ImageCompressHigh and this should be one of these values.
Returns
None.

◆ SetImageDPI()

void foxit::addon::optimization::MonoImageSettings::SetImageDPI ( int32  dpi)

Set the image DPI used for optimizing monochrome images in a PDF document.

For a newly constructed object, if this function is not called to set option, that means to use 250 as the deault value of this option.

Parameters
[in]dpiDPI value.
Returns
None.

◆ SetStretchMode()

void foxit::addon::optimization::MonoImageSettings::SetStretchMode ( StretchMode  mode)

Set stretch mode used for optimizing monochrome images in a PDF document.

For a newly constructed object, if this function is not called to set this option, that means to use MonoImageSettings::e_StretchBicubic as the deault value of this option.

Parameters
[in]modeStretch mode. Please refer to values starting from ImageSettings::e_StretchOff and this should be one of these values.
Returns
None.