Foxit PDF SDK

Public 类型 | Public 成员函数 | 所有成员列表
foxit::common::OFDRender类 参考
类 foxit::common::OFDRender 继承关系图:

## Public 类型
enum | ContentFlag { e_RenderPage = 0x01, e_RenderStampAnnot = 0x02, e_RenderHighlightAnnot = 0x04, e_RenderExceptHighlightAnnot = 0x08, e_RenderSealAnnot = 0x10, e_RenderSealAnnotGray = 0x20 }
| OFD渲染内容标识枚举类型. 更多...

## Public 成员函数
| OFDRender (const Bitmap &bitmap)
| 构造函数。 更多...
| OFDRender (const OFDRender &other)
| 构造函数，通过另一个OFDRender对象。 更多...
| ~OFDRender ()
| 析构函数。
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | operator != (const OFDRender &other) const
| 不相等操作符 更多...
OFDRender & | operator= (const OFDRender &other)
| 赋值操作符。 更多...
bool | operator== (const OFDRender &other) const
| 相等操作符 更多...
void | SetRenderContentFlags (uint32 render_content_flags)
| 设置渲染内容标识。 更多...
void | SetRenderOption (const OFDRenderOption &render_option)
| 设置渲染选项。 更多...
Progressive | StartRender (const foxit::ofd::OFDPage &page, const Matrix &matrix, PauseCallback *pause=0)
| 渲染OFD页面。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 详细描述

此类表示和OFD渲染相关的方法。

## 成员枚举类型说明

## ◆ ContentFlag

enum foxit::common::OFDRender::ContentFlag

OFD渲染内容标识枚举类型.

该枚举值应单独使用或组合使用.

枚举值
e_RenderPage | 只渲染页面内容，不渲染标注.
e_RenderStampAnnot | 渲染Stamp类型的标注（不是Seal）.
e_RenderHighlightAnnot | 渲染高亮类型的标注(与e_RenderExceptHighlightAnnot互斥）.
e_RenderExceptHighlightAnnot | 渲染非高亮类型的标注(与e_RenderHighlightAnnot互斥）.
e_RenderSealAnnot | 渲染Seal类型的标注(与e_RenderSealAnnotGray互斥).
e_RenderSealAnnotGray | 以灰度模式渲染Seal类型的标注(与e_RenderSealAnnot互斥).

## 构造及析构函数说明

## ◆ OFDRender() [1/2]

foxit::common::OFDRender::OFDRender | ( | const Bitmap & | bitmap | ) |
| explicit

构造函数。

参数

  [in] | bitmap | 用于渲染的位图。用户应确保该位图在当前渲染对象的整个生命周期内保持有效。

## ◆ OFDRender() [2/2]

foxit::common::OFDRender::OFDRender | ( | const OFDRender & | other | ) |

构造函数，通过另一个OFDRender对象。

参数

  [in] | other | 另一个OFDRender对象。

## 成员函数说明

## ◆ IsEmpty()

bool foxit::common::OFDRender::IsEmpty | ( |  | ) | const

检查当前对象是否为空。

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

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

## ◆ operator !=()

bool foxit::common::OFDRender::operator != | ( | const OFDRender & | other | ) | const

不相等操作符

参数

  [in] | other | 另一个OFDRender对象。此函数将检查当前对象是否不等于这个对象。

返回
  true 表示不相等，false 表示相等

## ◆ operator=()

OFDRender& foxit::common::OFDRender::operator= | ( | const OFDRender & | other | ) |

赋值操作符。

参数

  [in] | other | 另一个OFDRender对象，其值将被赋给当前对象。

返回
  当前对象自身的引用。

## ◆ operator==()

bool foxit::common::OFDRender::operator== | ( | const OFDRender & | other | ) | const

相等操作符

参数

  [in] | other | 另一个OFDRender对象。此函数将检查当前对象是否等于这个对象。

返回
  true 表示相等，false 表示不相等

## ◆ SetRenderContentFlags()

void foxit::common::OFDRender::SetRenderContentFlags | ( | uint32 | render_content_flags | ) |

设置渲染内容标识。

渲染内容标识用于指定在渲染过程中需要渲染的内容类型。用户可以通过设置不同的标识来控制渲染的内容，例如只渲染页面内容、只渲染特定类型的标注等。

参数

  [in] | render_content_flags | 渲染内容标识，默认为0。请参考从 foxit::common::OFDRender::e_RenderPage 开始的值， 应该是这些值的组合。

返回
  无。

## ◆ SetRenderOption()

void foxit::common::OFDRender::SetRenderOption | ( | const OFDRenderOption & | render_option | ) |

设置渲染选项。

参数

  [in] | render_option | 渲染选项对象。

返回
  无。

## ◆ StartRender()

Progressive foxit::common::OFDRender::StartRender | ( | const foxit::ofd::OFDPage & | page,
|  | const Matrix & | matrix,
|  | PauseCallback * | pause = `0`
| ) |  |

渲染OFD页面。

参数

  [in] | page | 需要渲染的OFD页面。
  [in] | matrix | 用于渲染的矩阵。
  [in] | pause | 渲染过程中用于暂停的回调函数指针。用户可以通过实现该回调函数来控制渲染过程中的暂停和继续。

返回
  Progressive对象，用户可以通过该对象来检查渲染的进度，并在需要时暂停或继续渲染。