ColorConvertParams Class Documentation
class ColorConvertParamsNamespace:datalogics_interface
Detailed Description
Holds parameters to be passed to a color convert method. This includes the actions to take in case of a match. Each object is compared against the selection criteria for each of the actions, in order, until a matching action is found.
Uses types
Constructor & Destructor Documentation
ColorConvertParams
ColorConvertParams(ColorConvertParams && )Parameters
ColorConvertParams
ColorConvertParams(const ColorConvertParams & other)Parameters
other: const ColorConvertParams &
Copy constructor.
ColorConvertParams
ColorConvertParams(std::vector< ColorConvertActions > actions)Parameters
actions: std::vector< ColorConvertActions >The list of ColorConvertActions to apply during color conversion.
Constructs a ColorConvertParams with the specified color conversion actions.
Initializes AllowLossyCompression to false, all default color profiles to null, and all render intents to Perceptual.
~ColorConvertParams
~ColorConvertParams()Member Function Documentation
get_actions
std::vector< ColorConvertActions > get_actions()Returns:
std::vector< ColorConvertActions >The list of conversion actions applied to matching objects.
get_allow_lossy_compression
bool get_allow_lossy_compression()Returns:
boolIf true, DCT or JPX encoding will be used resulting in a smaller PDF. If false, FlateDecoding will be used instead.
get_default_cmyk
ColorProfile get_default_cmyk()Returns:
ColorProfileThe default CMYK ColorProfile used when a document object has no embedded CMYK profile.
Initially set to the null color profile.
get_default_gray
ColorProfile get_default_gray()Returns:
ColorProfileThe default Gray ColorProfile used when a document object has no embedded Gray profile.
Initially set to the null color profile.
get_default_rgb
ColorProfile get_default_rgb()Returns:
ColorProfileThe default RGB ColorProfile used when a document object has no embedded RGB profile.
Initially set to the null color profile.
operator=
ColorConvertParams & operator=(ColorConvertParams && )Parameters
Returns:
ColorConvertParams &operator=
ColorConvertParams & operator=(const ColorConvertParams & other)Parameters
other: const ColorConvertParams &
Returns:
ColorConvertParams &Copy assignment.
set_actions
void set_actions(std::vector< ColorConvertActions > actions)Parameters
actions: std::vector< ColorConvertActions >
Returns:
voidThe list of conversion actions applied to matching objects.
set_allow_lossy_compression
void set_allow_lossy_compression(bool allow)Parameters
allow: bool
Returns:
voidIf true, DCT or JPX encoding will be used resulting in a smaller PDF. If false, FlateDecoding will be used instead.
set_default_cmyk
void set_default_cmyk(ColorProfile profile)Parameters
profile: ColorProfile
Returns:
voidThe default CMYK ColorProfile used when a document object has no embedded CMYK profile.
Initially set to the null color profile.
set_default_gray
void set_default_gray(ColorProfile profile)Parameters
profile: ColorProfile
Returns:
voidThe default Gray ColorProfile used when a document object has no embedded Gray profile.
Initially set to the null color profile.
set_default_rgb
void set_default_rgb(ColorProfile profile)Parameters
profile: ColorProfile
Returns:
voidThe default RGB ColorProfile used when a document object has no embedded RGB profile.
Initially set to the null color profile.