Foxit PDF SDK
Public 类型 | Public 成员函数 | 所有成员列表
foxit::addon::ofd::OFDRenderer类 参考
类 foxit::addon::ofd::OFDRenderer 继承关系图:
foxit::Base

Public 类型

enum  ColorMode { e_ColorModeNormal = 0, e_ColorModeMappingGray = 1, e_ColorModeMapping = 2 }
 渲染颜色模式的枚举。 更多...
 
enum  ContentFlag {
  e_ContentFlagAllContent = 0x00, e_ContentFlagPage = 0x01, e_ContentFlagAnnot = 0x02, e_ContentFlagHighLightAnnots = 0x04,
  e_ContentFlagStampAnnots = 0x08
}
 OFD渲染内容标志的枚举。 更多...
 

Public 成员函数

 OFDRenderer ()
 构造函数。
 
 OFDRenderer (const common::Bitmap &bitmap)
 构造函数，使用位图对象。 更多...
 
 OFDRenderer (const OFDRenderer &other)
 构造函数，使用另一个渲染器对象。 更多...
 
 ~OFDRenderer ()
 析构函数。
 
bool IsEmpty () const
 检查当前对象是否为空。 更多...
 
bool operator != (const OFDRenderer &other) const
 不等于操作符。 更多...
 
OFDRenderer & operator= (const OFDRenderer &other)
 赋值操作符。 更多...
 
bool operator== (const OFDRenderer &other) const
 等于操作符。 更多...
 
void SetColorMode (ColorMode color_mode)
 设置颜色模式。 更多...
 
void SetContentFlag (uint32 content_flag)
 设置内容标志。 更多...
 
common::Progressive StartRender (const OFDPage &page, const Matrix &matrix)
 开始渲染OFD页面。 更多...
 
- Public 成员函数 继承自 foxit::Base
FS_HANDLE Handle () const
 获取当前对象的句柄。 更多...
 

详细描述

此类用于将OFD页面渲染到位图。 请确保在使用此类之前已成功调用 common::Library::InitializeOFDEngine。

参见
common::Library

成员枚举类型说明

◆ ColorMode

enum foxit::addon::ofd::OFDRenderer::ColorMode

渲染颜色模式的枚举。

此枚举的值应单独使用。

枚举值
e_ColorModeNormal 

正常颜色模式。

e_ColorModeMappingGray 

将灰色/白色/黑色值映射到背景/前景；对于其他颜色，不作更改。

e_ColorModeMapping 

将颜色值映射到由背景色和前景色定义的颜色范围。

◆ ContentFlag

enum foxit::addon::ofd::OFDRenderer::ContentFlag

OFD渲染内容标志的枚举。

此枚举的值可以单独使用或组合使用。

枚举值
e_ContentFlagAllContent 

如果设置，将渲染所有内容。此值应单独使用。

e_ContentFlagPage 

如果设置，将渲染页面内容。

e_ContentFlagAnnot 

如果设置，将渲染注释。（不包括高亮注释和印章）

e_ContentFlagHighLightAnnots 

如果设置，将渲染高亮注释。

e_ContentFlagStampAnnots 

如果设置，将渲染印章注释。

构造及析构函数说明

◆ OFDRenderer() [1/2]

foxit::addon::ofd::OFDRenderer::OFDRenderer ( const common::Bitmap &  bitmap)

构造函数，使用位图对象。

参数
[in]bitmap位图对象。它不应该是空位图。

◆ OFDRenderer() [2/2]

foxit::addon::ofd::OFDRenderer::OFDRenderer ( const OFDRenderer &  other)

构造函数，使用另一个渲染器对象。

参数
[in]other另一个渲染器对象。

成员函数说明

◆ IsEmpty()

bool foxit::addon::ofd::OFDRenderer::IsEmpty ( ) const

检查当前对象是否为空。

当当前对象为空时，意味着当前对象无用。

返回
true 表示当前对象为空，而 false 表示不为空。

◆ operator !=()

bool foxit::addon::ofd::OFDRenderer::operator != ( const OFDRenderer &  other) const

不等于操作符。

参数
[in]other另一个OFD渲染器对象。此函数将检查当前对象是否不等于此对象。
返回
true 表示不相等，而 false 表示相等。

◆ operator=()

OFDRenderer& foxit::addon::ofd::OFDRenderer::operator= ( const OFDRenderer &  other)

赋值操作符。

参数
[in]other另一个OFD渲染器对象，其值将被分配给当前对象。
返回
对当前对象本身的引用。

◆ operator==()

bool foxit::addon::ofd::OFDRenderer::operator== ( const OFDRenderer &  other) const

等于操作符。

参数
[in]other另一个OFD渲染器对象。此函数将检查当前对象是否等于此对象。
返回
true 表示相等，而 false 表示不相等。

◆ SetColorMode()

void foxit::addon::ofd::OFDRenderer::SetColorMode ( ColorMode  color_mode)

设置颜色模式。

参数
[in]color_mode颜色模式。请参考从 OFDRenderer::e_ColorModeNormal 开始的值， 这应该是这些值中的一个。 默认值是 OFDRenderer::e_ColorModeNormal。
返回
无返回值。

◆ SetContentFlag()

void foxit::addon::ofd::OFDRenderer::SetContentFlag ( uint32  content_flag)

设置内容标志。

参数
[in]content_flag内容标志。请参考从 OFDRenderer::e_ContentFlagAllContent 开始的值， 这可以是这些值中的一个或它们的组合。 默认值是 OFDRenderer::e_ContentFlagAllContent。
返回
无返回值。

◆ StartRender()

common::Progressive foxit::addon::ofd::OFDRenderer::StartRender ( const OFDPage &  page,
const Matrix &  matrix 
)

开始渲染OFD页面。

此函数用于开始渲染OFD页面。

参数
[in]pageOFD页面对象。它不应该是空对象。
[in]matrix用于渲染页面的矩阵，通常由函数 OFDPage::GetDisplayMatrix 返回。
返回
进度对象。请通过函数 common::Progressive::GetRateOfProgress 检查当前进度的比率。 如果比率还不是100，调用函数 common::Progressive::Continue 继续进度， 直到进度完成。