Foxit PDF SDK
FSOutputPreview类 参考

此类可用于进行输出预览。输出预览是预览分色和测试不同色彩配置文件。 在使用此类之前,请确保函数 FSLibrary::setDefaultICCProfilesPath: 已被成功调用; 否则在使用此类进行输出预览时可能会出现意外错误或结果。 目前,此功能在Linux ARM和Mac ARM平台上不受支持。
更多...

类 FSOutputPreview 继承关系图:
FSBase

构造函数

(void) - enableSimulateOverprint:
 设置是否启用仿真叠印的标志。
更多...
 
(FSBitmap *) - generatePreviewBitmap:matrix:renderer:
 为PDF页面生成输出预览位图。
更多...
 
(NSArray< NSString * > *) - getPlates:
 获取分色版。
更多...
 
(unsigned int) - getSpotPlateColor:
 获取版的颜色值。
更多...
 
(id) - initWithOther:
 构造函数,通过另一个输出预览对象。
更多...
 
(id) - initWithPdf_doc:
 构造函数,带参数。
更多...
 
(BOOL) - isChecked:
 检查版是否被选中。
更多...
 
(BOOL) - isEmpty
 检查当前对象是否为空。
更多...
 
(void) - setCheckStatus:to_check:
 设置版的检查状态。
更多...
 
(void) - setShowType:
 设置显示类型。
更多...
 
(void) - setSimulationProfile:
 设置仿真ICC配置文件路径。
更多...
 

详细描述

此类可用于进行输出预览。输出预览是预览分色和测试不同色彩配置文件。 在使用此类之前,请确保函数 FSLibrary::setDefaultICCProfilesPath: 已被成功调用; 否则在使用此类进行输出预览时可能会出现意外错误或结果。 目前,此功能在Linux ARM和Mac ARM平台上不受支持。

函数文档

◆ enableSimulateOverprint:()

- (void) enableSimulateOverprint: (BOOL)  is_to_simulate_overprint

设置是否启用仿真叠印的标志。

如果不调用此函数,将使用默认值 YES。

参数
[in]is_to_simulate_overprintYES 表示仿真叠印。 NO 表示不仿真叠印。
返回
无。

◆ generatePreviewBitmap:matrix:renderer:()

- (FSBitmap *) generatePreviewBitmap: (FSPDFPage*)  page
matrix: (FSMatrix2D*)  matrix
renderer: (FSRenderer*)  renderer 

为PDF页面生成输出预览位图。

此函数将使用输入的 renderer 中指定的标志和选项以及当前输出预览对象的设置来渲染目标PDF页面, 然后返回最终的输出预览位图。此函数中的渲染过程不会影响输入的 renderer。
请确保函数 FSOutputPreview::setSimulationProfile: 已被成功调用;否则此函数将抛出 FSErrUnsupported 。

参数
[in]page有效的PDF页面对象。此PDF页面应该已被解析。
[in]matrix用于渲染的变换矩阵,通常由函数 FSPDFPage::getDisplayMatrix:top:width:height:rotate: 返回。
[in]renderer有效的渲染器对象。
返回
代表输出预览结果的位图。

◆ getPlates:()

- (NSArray< NSString * > *) getPlates: (FSOutputPreviewColorantType)  colorant_type

获取分色版。

如果要获取印刷色着色剂类型的版,请确保函数 FSOutputPreview::setSimulationProfile: 已被成功调用; 否则不会检索到印刷色着色剂类型的版。

参数
[in]colorant_type着色剂类型。请参考从 FSOutputPreviewColorantTypeProcess 开始的值,这应该是其中的一个值。
返回
代表版名称的字符串数组。

◆ getSpotPlateColor:()

- (unsigned int) getSpotPlateColor: (NSString *)  plate_name

获取版的颜色值。

此函数仅对专色着色剂类型的版有用。

参数
[in]plate_name版名称。这可以从函数 FSOutputPreview::getPlates: 返回的字符串数组中检索。
返回
指定版的RGB颜色。

◆ initWithOther:()

- (id) initWithOther: (FSOutputPreview*)  other

构造函数,通过另一个输出预览对象。

参数
[in]other另一个输出预览对象。

◆ initWithPdf_doc:()

- (id) initWithPdf_doc: (FSPDFDoc*)  pdf_doc

构造函数,带参数。

参数
[in]pdf_doc有效的PDF文档对象。

◆ isChecked:()

- (BOOL) isChecked: (NSString *)  plate_name

检查版是否被选中。

对于新构造的输出预览对象,所有版都不被选中。

参数
[in]plate_name版名称。这可以从函数 FSOutputPreview::getPlates: 返回的字符串数组中检索。
返回
YES 表示该版被选中,NO 表示该版未被选中。

◆ isEmpty()

- (BOOL) isEmpty

检查当前对象是否为空。

当前对象为空时,表示当前对象是无用的。

返回
YES 表示当前对象为空,NO 表示不为空。

◆ setCheckStatus:to_check:()

- (void) setCheckStatus: (NSString *)  plate_name
to_check: (BOOL)  to_check 

设置版的检查状态。

参数
[in]plate_name版名称。这可以从函数 FSOutputPreview::getPlates: 返回的字符串数组中检索。
[in]to_check检查状态:YES 表示检查该版,NO 表示不检查该版。
返回
无。

◆ setShowType:()

- (void) setShowType: (FSOutputPreviewShowType)  show_type

设置显示类型。

如果没有为当前对象设置显示类型,在调用函数 FSOutputPreview::generatePreviewBitmap:matrix:renderer: 时, 默认将使用值 FSOutputPreviewShowAll 。

参数
[in]show_type显示类型。请参考从 FSOutputPreviewShowAll 开始的值,这应该是其中的一个值。
返回
无。

◆ setSimulationProfile:()

- (void) setSimulationProfile: (NSString *)  icc_profile_path

设置仿真ICC配置文件路径。

如果输入ICC配置文件的色彩空间不是RGB/Gray/CMYK之一,此函数将抛出 FSErrUnsupported 。
在调用函数 FSOutputPreview::generatePreviewBitmap:matrix:renderer: 之前,应成功调用此函数。

参数
[in]icc_profile_path用于输出预览仿真配置文件的ICC配置文件的文件路径。
返回
无。