Foxit PDF SDK

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

## Public 类型
enum | OperationType { e_OpTypeNone = -1, e_OpTypeAssociate = 0, e_OpTypeStop = 1, e_OpTypePause = 2, e_OpTypeResume = 3, e_OpTypePlay = 4 }
| 触发再现动作时要执行的操作类型的枚举。 更多...
Public 类型 继承自 foxit::pdf::actions::Action
enum | NewWindowFlag { e_NewWindowFlagFalse = 0, e_NewWindowFlagTrue = 1, e_NewWindowFlagNone = 2 }
| 新窗口标志枚举。 更多...
enum | Type { e_TypeUnknown = 0, e_TypeGoto = 1, e_TypeGoToR = 2, e_TypeGoToE = 3, e_TypeLaunch = 4, e_TypeThread = 5, e_TypeURI = 6, e_TypeSound = 7, e_TypeMovie = 8, e_TypeHide = 9, e_TypeNamed = 10, e_TypeSubmitForm = 11, e_TypeResetForm = 12, e_TypeImportData = 13, e_TypeJavaScript = 14, e_TypeSetOCGState = 15, e_TypeRendition = 16, e_TypeTrans = 17, e_TypeGoTo3DView = 18 }
| 动作类型枚举。 更多...

## Public 成员函数
| RenditionAction (const Action &action)
| 构造函数，使用父类对象。 更多...
WString | GetJavaScript ()
| 获取要执行的JavaScript脚本。 更多...
OperationType | GetOperationType ()
| 获取当前再现动作在被触发时的操作类型。 更多...
Rendition | GetRendition (int index)
| 通过索引获取再现。 更多...
int | GetRenditionCount () const
| 获取再现对象的数量。 更多...
annots::Screen | GetScreenAnnot ()
| 获取相关的屏幕注释。 更多...
void | InsertRendition (const Rendition &rendition, int index=-1)
| 在索引指定的位置将再现插入到当前再现动作中。 更多...
void | RemoveRendition (const Rendition &rendition)
| 从当前再现动作中移除再现对象。 更多...
void | SetJavaScript (const WString &script)
| 设置要执行的JavaScript脚本。 更多...
void | SetOperationType (OperationType op_type)
| 设置当前再现动作在被触发时的操作类型。 更多...
void | SetScreenAnnot (const annots::Screen &screen_annot)
| 设置相关的屏幕注释。 更多...
Public 成员函数 继承自 foxit::pdf::actions::Action
| Action (const PDFDoc &document, objects::PDFDictionary *action_dict)
| 构造函数，带参数。 更多...
| Action (const Action &action)
| 构造函数，使用另一个动作对象。 更多...
| ~Action ()
| 析构函数。
objects::PDFDictionary * | GetDict () const
| 获取当前对象的PDF字典。 更多...
PDFDoc | GetDocument ()
| 获取当前动作所属的PDF文档。 更多...
Action | GetSubAction (int index)
| 按索引获取子动作。 更多...
int | GetSubActionCount ()
| 获取子动作的数量。 更多...
Type | GetType ()
| 获取动作类型。 更多...
void | InsertSubAction (int index, const Action &sub_action)
| 在指定索引位置插入新的子动作。 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | operator != (const Action &other) const
| 不等于操作符。 更多...
Action & | operator= (const Action &other)
| 赋值操作符。 更多...
bool | operator== (const Action &other) const
| 等于操作符。 更多...
void | RemoveAllSubActions ()
| 移除所有子动作。 更多...
void | RemoveSubAction (int index)
| 移除指定索引的子动作。 更多...
void | SetSubAction (int index, const Action &sub_action)
| 按索引设置子动作。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 额外继承的成员函数
静态 Public 成员函数 继承自 foxit::pdf::actions::Action
static Action | Create (const foxit::pdf::PDFDoc &document, Type action_type)
| 为指定的动作类型创建新动作。 更多...

## 详细描述

再现动作是控制多媒体内容的播放。(更多详情，请参考 <PDF参考1.7> P668 "再现动作") 类actions::RenditionAction派生自Action，提供用于 获取/设置再现动作数据的函数。

参见
  Action

## 成员枚举类型说明

## ◆ OperationType

enum foxit::pdf::actions::RenditionAction::OperationType

触发再现动作时要执行的操作类型的枚举。

此枚举的值应单独使用。

枚举值
e_OpTypeNone | 未指定操作。
e_OpTypeAssociate | 将再现关联到相关的屏幕注释。 如果没有再现与相关屏幕注释关联， 播放再现（在再现动作中指定），将其与注释关联。 如果再现已经与相关屏幕注释关联，停止它，并且 新的再现（在再现动作中指定）与注释关联。
e_OpTypeStop | 停止与相关屏幕注释关联播放的任何再现并移除关联。 如果没有再现正在播放，则没有效果。
e_OpTypePause | 暂停与相关屏幕注释关联播放的任何再现。 如果没有再现正在播放，则没有效果。
e_OpTypeResume | 恢复与相关屏幕注释关联播放的任何再现。 如果没有再现正在播放或再现未暂停，则没有效果。
e_OpTypePlay | 播放再现（在再现动作中指定），将其与相关屏幕注释关联。 如果再现已经与注释关联，如果它被暂停则恢复该再现； 否则，什么都不做。

## 构造及析构函数说明

## ◆ RenditionAction()

foxit::pdf::actions::RenditionAction::RenditionAction | ( | const Action & | action | ) |
| explicit

构造函数，使用父类对象。

参数

  [in] | action | 父类对象。

## 成员函数说明

## ◆ GetJavaScript()

WString foxit::pdf::actions::RenditionAction::GetJavaScript | ( |  | ) |

获取要执行的JavaScript脚本。

作为一个有用的再现动作，它应该包含要执行的JavaScript脚本或 在被触发时指定要执行的操作类型。如果JavaScript脚本和 操作类型都存在，应用程序应该执行JavaScript；如果应用程序无法 执行JavaScript脚本，则按操作类型定义执行。如果没有JavaScript脚本且 操作类型无效，那意味着动作无效。

返回
  JavaScript脚本。

## ◆ GetOperationType()

OperationType foxit::pdf::actions::RenditionAction::GetOperationType | ( |  | ) |

获取当前再现动作在被触发时的操作类型。

作为一个有用的再现动作，它应该包含要执行的JavaScript脚本或 在被触发时指定要执行的操作类型。如果JavaScript脚本和 操作类型都存在，应用程序应该执行JavaScript；如果应用程序无法 执行JavaScript脚本，则按操作类型定义执行。如果没有JavaScript脚本且 操作类型无效，那意味着动作无效。

返回
  操作类型。请参考RenditionAction::e_OpTypeNone开始的值， 这将是这些值中的一个。

## ◆ GetRendition()

Rendition foxit::pdf::actions::RenditionAction::GetRendition | ( | int | index | ) |

通过索引获取再现。

参数

  [in] | index | 要检索的再现对象的索引。有效范围：从0到(count-1)。 count由函数RenditionAction::GetRenditionCount返回。

返回
  再现对象。

## ◆ GetRenditionCount()

int foxit::pdf::actions::RenditionAction::GetRenditionCount | ( |  | ) | const

获取再现对象的数量。

返回
  再现对象的数量。

## ◆ GetScreenAnnot()

annots::Screen foxit::pdf::actions::RenditionAction::GetScreenAnnot | ( |  | ) |

获取相关的屏幕注释。

返回
  屏幕注释对象。

## ◆ InsertRendition()

void foxit::pdf::actions::RenditionAction::InsertRendition | ( | const Rendition & | rendition,
|  | int | index = `-1`
| ) |  |

在索引指定的位置将再现插入到当前再现动作中。

当操作类型为RenditionAction::e_OpTypeAssociate或 RenditionAction::e_OpTypeAssociate时，再现对象对于再现动作是必需的。

参数

  [in] | rendition | 要插入的再现对象。
  [in] | index | 指定插入再现对象位置的索引。 如果索引小于0或大于(count-1)，输入的再现将被 插入到末尾。count由函数 RenditionAction::GetRenditionCount返回。

返回
  无。

## ◆ RemoveRendition()

void foxit::pdf::actions::RenditionAction::RemoveRendition | ( | const Rendition & | rendition | ) |

从当前再现动作中移除再现对象。

参数

  [in] | rendition | 要从当前再现动作中移除的再现对象。

返回
  无。

## ◆ SetJavaScript()

void foxit::pdf::actions::RenditionAction::SetJavaScript | ( | const WString & | script | ) |

设置要执行的JavaScript脚本。

作为一个有用的再现动作，它应该包含要执行的JavaScript脚本或 在被触发时指定要执行的操作类型。如果JavaScript脚本和 操作类型都存在，应用程序应该执行JavaScript；如果应用程序无法 执行JavaScript脚本，则按操作类型定义执行。如果没有JavaScript脚本且 操作类型无效，那意味着动作无效。

参数

  [in] | script | 要设置的JavaScript脚本。

返回
  无。

## ◆ SetOperationType()

void foxit::pdf::actions::RenditionAction::SetOperationType | ( | OperationType | op_type | ) |

设置当前再现动作在被触发时的操作类型。

作为一个有用的再现动作，它应该包含要执行的JavaScript脚本或 在被触发时指定要执行的操作类型。如果JavaScript脚本和 操作类型都存在，应用程序应该执行JavaScript；如果应用程序无法 执行JavaScript脚本，则按操作类型定义执行。如果没有JavaScript脚本且 操作类型无效，那意味着动作无效。

参数

  [in] | op_type | 操作类型。请参考RenditionAction::e_OpTypeAssociate开始的值， 这应该是这些值中的一个。如果设置值RenditionAction::e_OpTypeNone， 那意味着没有指定操作类型。

返回
  无。

## ◆ SetScreenAnnot()

void foxit::pdf::actions::RenditionAction::SetScreenAnnot | ( | const annots::Screen & | screen_annot | ) |

设置相关的屏幕注释。

当操作类型设置为有效值时，此属性是必需的。

参数

  [in] | screen_annot | 要设置为相关屏幕注释的屏幕注释对象。

返回
  无。