Foxit PDF SDK

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

## Public 成员函数
| EmbeddedGotoAction (const Action &action)
| 构造函数，使用父类对象。 更多...
Destination | GetDestination ()
| 获取指定在最终目标文件中跳转位置的目标信息。 更多...
String | GetDestinationName ()
| 获取在最终目标PDF文件中定义的目标名称。 更多...
NewWindowFlag | GetNewWindowFlag ()
| 获取用于决定是否在新窗口中打开目标文档的标志。 更多...
FileSpec | GetRootFile ()
| 获取根文件的文件规范，该根文件是目标的根文件。 更多...
EmbeddedGotoTarget | GetTarget ()
| 获取目标。 更多...
void | SetDestination (const Destination &destination)
| 设置指定在最终目标文件中跳转位置的目标信息。 更多...
void | SetDestinationName (const String &dest_name)
| 设置目标名称。 更多...
void | SetNewWindowFlag (NewWindowFlag flag)
| 设置用于决定是否在新窗口中打开目标文档的标志。 更多...
void | SetRootFile (const FileSpec &file_specification)
| 设置根文件的文件规范，该根文件是目标的根文件。 更多...
void | SetTarget (const EmbeddedGotoTarget &target)
| 设置目标。 更多...
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
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 成员函数 继承自 foxit::pdf::actions::Action
static Action | Create (const foxit::pdf::PDFDoc &document, Type action_type)
| 为指定的动作类型创建新动作。 更多...

## 详细描述

嵌入转到动作类似于远程转到动作，但允许从嵌入在另一个PDF文件中的PDF文件中跳转或跳转到该文件。 类actions::EmbeddedGotoTarget派生自Action， 提供用于获取/设置嵌入转到动作数据的函数。

参见
  Action

## 构造及析构函数说明

## ◆ EmbeddedGotoAction()

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

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

参数

  [in] | action | 父类对象。

## 成员函数说明

## ◆ GetDestination()

Destination foxit::pdf::actions::EmbeddedGotoAction::GetDestination | ( |  | ) |

获取指定在最终目标文件中跳转位置的目标信息。

对于嵌入转到动作，目标信息可以存储为目标对象 或目标名称：

- 如果是目标对象，函数EmbeddedGotoAction::GetDestination将 返回有效的目标对象。
- 如果是目标名称，函数EmbeddedGotoAction::GetDestinationName将 返回有效的字符串，目标名称将在最终目标PDF文件中定义。

如果返回的目标对象的函数Destination::IsEmpty的返回值 为true，且函数EmbeddedGotoAction::GetDestinationName 返回空字符串，则表示嵌入转到动作没有任何目标信息。

返回
  目标对象。如果返回的目标对象的函数Destination::IsEmpty的返回值 为true，请尝试函数 EmbeddedGotoAction::GetDestinationName。

## ◆ GetDestinationName()

String foxit::pdf::actions::EmbeddedGotoAction::GetDestinationName | ( |  | ) |

获取在最终目标PDF文件中定义的目标名称。

对于远程转到动作，目标信息可以存储为目标对象 或目标名称：

- 如果是目标对象，函数EmbeddedGotoAction::GetDestination 将返回有效的目标对象。
- 如果是目标名称，函数EmbeddedGotoAction::GetDestinationName 将返回有效的字符串，目标名称将在目标PDF文件中定义。

如果返回的目标对象的函数Destination::IsEmpty的返回值 为true，且函数EmbeddedGotoAction::GetDestinationName 返回空字符串，则表示嵌入转到动作没有任何目标信息。

返回
  目标名称。如果此函数返回空字符串，请尝试函数 EmbeddedGotoAction::GetDestination。

## ◆ GetNewWindowFlag()

NewWindowFlag foxit::pdf::actions::EmbeddedGotoAction::GetNewWindowFlag | ( |  | ) |

获取用于决定是否在新窗口中打开目标文档的标志。

返回
  新窗口标志。将是以下值之一：
  - Action::e_NewWindowFlagTrue表示 在新窗口中打开目标文档。
  - Action::e_NewWindowFlagFalse表示 目标文档在同一窗口中替换当前文档。
  - Action::e_NewWindowFlagNone表示 没有此类标志，查看器应用程序应根据当前用户首选项行为。

## ◆ GetRootFile()

FileSpec foxit::pdf::actions::EmbeddedGotoAction::GetRootFile | ( |  | ) |

获取根文件的文件规范，该根文件是目标的根文件。

返回
  非嵌入的文件规范对象。如果返回的文件规范对象的函数FileSpec::IsEmpty 的返回值为true，则表示包含当前嵌入转到动作的PDF文件 就是目标对象的根文件。

## ◆ GetTarget()

EmbeddedGotoTarget foxit::pdf::actions::EmbeddedGotoAction::GetTarget | ( |  | ) |

获取目标。

返回
  嵌入转到目标对象。如果返回的嵌入转到目标对象的函数EmbeddedGotoTarget::IsEmpty 的返回值为true，则表示没有目标。

## ◆ SetDestination()

void foxit::pdf::actions::EmbeddedGotoAction::SetDestination | ( | const Destination & | destination | ) |

设置指定在最终目标文件中跳转位置的目标信息。

参数

  [in] | destination | 要设置的有效目标对象。

返回
  无。

## ◆ SetDestinationName()

void foxit::pdf::actions::EmbeddedGotoAction::SetDestinationName | ( | const String & | dest_name | ) |

设置目标名称。

目标名称应该已经在目标PDF文件的"Dests"名称树中。

参数

  [in] | dest_name | 要设置的目标名称。不应为空字符串。

返回
  无。

## ◆ SetNewWindowFlag()

void foxit::pdf::actions::EmbeddedGotoAction::SetNewWindowFlag | ( | NewWindowFlag | flag | ) |

设置用于决定是否在新窗口中打开目标文档的标志。

参数

  [in] | flag | 新窗口标志。应为以下值之一： Action::e_NewWindowFlagTrue表示 在新窗口中打开目标文档。 Action::e_NewWindowFlagFalse表示 目标文档在同一窗口中替换当前文档。 Action::e_NewWindowFlagNone表示 不需要此类标志，查看器应用程序应根据 当前用户首选项行为。

返回
  无。

## ◆ SetRootFile()

void foxit::pdf::actions::EmbeddedGotoAction::SetRootFile | ( | const FileSpec & | file_specification | ) |

设置根文件的文件规范，该根文件是目标的根文件。

参数

  [in] | file_specification | 文件规范对象： 可以通过默认构造函数构造且不设置任何值。 在这种情况下，表示包含当前嵌入转到动作的PDF文件 也是目标的根文件。 否则，这应该是有效的文件规范对象，应该表示 另一个文件，而不是嵌入文件。文件规范对象应该 与当前动作在同一个PDF文件中。

返回
  无。

## ◆ SetTarget()

void foxit::pdf::actions::EmbeddedGotoAction::SetTarget | ( | const EmbeddedGotoTarget & | target | ) |

设置目标。

参数

  [in] | target | 嵌入转到目标对象。如果这是通过默认构造函数构造的且 没有设置任何值，则表示没有目标。

返回
  无。