Foxit PDF SDK
foxit::ofd::GoToAction类 参考
类 foxit::ofd::GoToAction 继承关系图:
foxit::ofd::Action foxit::Base

Public 成员函数

 GoToAction ()
 构造函数。
 
 GoToAction (Action object)
 构造函数,从现有foxit::ofd::Action对象。 更多...
 
 GoToAction (const GoToAction &other)
 构造函数,通过另一个跳转动作对象。 更多...
 
 ~GoToAction ()
 析构函数。
 
foxit::ofd::ActionDestinationInfo GetDestination ()
 获取跳转目标信息。 更多...
 
bool IsEmpty () const
 检查当前对象是否为空。 更多...
 
bool operator != (const GoToAction &other) const
 不相等操作符。 更多...
 
GoToActionoperator= (const GoToAction &other)
 赋值操作符。 更多...
 
bool operator== (const GoToAction &other) const
 相等操作符。 更多...
 
void SetDestination (float x, float y, foxit::uint32 page_id)
 设置跳转目标信息。 更多...
 
- Public 成员函数 继承自 foxit::ofd::Action
 Action (const Action &other)
 用另一个动作对象构造当前动作对象。 更多...
 
 ~Action ()
 析构函数。
 
ActionEventTriggerType GetEventTrigger ()
 获取事件触发器。 更多...
 
foxit::ofd::Action::ActionType GetType ()
 获取动作类型。 更多...
 
bool IsEmpty () const
 检查当前对象是否为空。 更多...
 
bool operator != (const Action &other) const
 不等操作符。 更多...
 
Actionoperator= (const Action &other)
 赋值操作符。 更多...
 
bool operator== (const Action &other) const
 相等操作符。 更多...
 
void SetEventTrigger (ActionEventTriggerType event_trigger)
 设置事件触发器。 更多...
 
- Public 成员函数 继承自 foxit::Base
FS_HANDLE Handle () const
 获取当前对象的句柄。 更多...
 

额外继承的成员函数

- Public 类型 继承自 foxit::ofd::Action
enum  ActionEventTriggerType { e_ActionEventTriggerTypeDocumentOpen = 0, e_ActionEventTriggerTypePageOpen = 1, e_ActionEventTriggerTypeClick = 2 }
 OFD动作触发事件枚举类型。 更多...
 
enum  ActionType {
  e_ActionTypeUnknown = 0, e_ActionTypeGoto = 1, e_ActionTypeUri = 2, e_ActionTypeSound = 3,
  e_ActionTypeMovie = 4, e_ActionTypeGotoA = 5
}
 OFD动作类型定义枚举类型。 更多...
 

详细描述

此类表示和OFD跳转动作相关的操作。

构造及析构函数说明

◆ GoToAction() [1/2]

foxit::ofd::GoToAction::GoToAction ( Action  object)
explicit

构造函数,从现有foxit::ofd::Action对象。

参数
[in]objectAction对象。 此对象必须是一个有效的对象,并且其类型必须是foxit::ofd::Action::ActionType::e_ActionTypeGoto,否则构造函数将抛出异常。

◆ GoToAction() [2/2]

foxit::ofd::GoToAction::GoToAction ( const GoToAction other)

构造函数,通过另一个跳转动作对象。

参数
[in]other另一个跳转动作对象。

成员函数说明

◆ GetDestination()

foxit::ofd::ActionDestinationInfo foxit::ofd::GoToAction::GetDestination ( )

获取跳转目标信息。

返回
跳转目标信息。请参考 foxit::ofd::ActionDestinationInfo

◆ IsEmpty()

bool foxit::ofd::GoToAction::IsEmpty ( ) const

检查当前对象是否为空。

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

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

◆ operator !=()

bool foxit::ofd::GoToAction::operator != ( const GoToAction other) const

不相等操作符。

参数
[in]other另一个跳转动作对象。此函数将检查当前对象是否不等于这个对象。
返回
true 表示不相等,false 表示相等。

◆ operator=()

GoToAction& foxit::ofd::GoToAction::operator= ( const GoToAction other)

赋值操作符。

参数
[in]other另一个跳转动作对象,其值将被赋给当前对象。
返回
当前对象自身的引用。

◆ operator==()

bool foxit::ofd::GoToAction::operator== ( const GoToAction other) const

相等操作符。

参数
[in]other另一个跳转动作对象。此函数将检查当前对象是否等于这个对象。
返回
true 表示相等,false 表示不相等。

◆ SetDestination()

void foxit::ofd::GoToAction::SetDestination ( float  x,
float  y,
foxit::uint32  page_id 
)

设置跳转目标信息。

参数
[in]x目标位置的X坐标,单位为毫米。
[in]y目标位置的Y坐标,单位为毫米。
[in]page_id目标页面ID。
返回
无。