Foxit PDF SDK
foxit::addon::pageeditor::JoinSplit类 参考
类 foxit::addon::pageeditor::JoinSplit 继承关系图:
foxit::Base

Public 类型

enum  JoinSplitOperationType {
  e_JoinSplitOperationTypeJoin = 0, e_JoinSplitOperationTypeSpilt = 1, e_JoinSplitOperationTypeLink = 2, e_JoinSplitOperationTypeUnlink = 3,
  e_JoinSplitOperationTypeSelectNone = 4, e_JoinSplitOperationTypeClose = 5
}
 连接分割操作类型的枚举。 更多...
 

Public 成员函数

 JoinSplit (const JoinSplit &other)
 拷贝构造函数。 更多...
 
 ~JoinSplit ()
 析构函数。
 
bool Activate ()
 激活连接拆分编辑。 更多...
 
bool Deactivate ()
 停用连接拆分编辑。 更多...
 
void ExitJoinEditing ()
 退出连接拆分编辑。 更多...
 
bool GetEnableStatus (JoinSplit::JoinSplitOperationType type)
 获取连接拆分编辑操作状态。 更多...
 
bool IsEmpty () const
 检查当前对象是否为空。 更多...
 
void JoinBoxes ()
 调用此函数连接文本。 更多...
 
void LinkBoxes ()
 调用此函数链接文本。 更多...
 
bool OnLButtonDown (int page_index, const PointF &point)
 鼠标左键按下时调用此函数。 更多...
 
bool OnLButtonUp (int page_index, const PointF &point)
 鼠标左键抬起时调用此函数。 更多...
 
bool OnMouseMove (int page_index, const PointF &point)
 鼠标移动时调用此函数。 更多...
 
bool operator!= (const JoinSplit &other) const
 不等操作符。 更多...
 
JoinSplitoperator= (const JoinSplit &other)
 赋值操作符。 更多...
 
bool operator== (const JoinSplit &other) const
 相等操作符。 更多...
 
bool Render (Int32Array page_index_array, const common::Renderer &renderer)
 在渲染器上绘制当前连接拆分操作状态。 更多...
 
void SelectNone ()
 调用此函数清除所有选中的文本。 更多...
 
void SplitBoxes ()
 调用此函数拆分文本。 更多...
 
void UnlinkBoxes ()
 调用此函数取消链接文本。 更多...
 
- Public 成员函数 继承自 foxit::Base
FS_HANDLE Handle () const
 获取当前对象的句柄。 更多...
 

详细描述

此类表示连接拆分操作。 在使用连接拆分功能之前,请确保函数 JoinSplit::Activate 已成功调用。 当不需要使用任何连接拆分功能时,请调用函数 JoinSplit::Deactivate 来停用。

成员枚举类型说明

◆ JoinSplitOperationType

连接分割操作类型的枚举。

此枚举的值应单独使用。

枚举值
e_JoinSplitOperationTypeJoin 

连接分割操作类型:连接。

e_JoinSplitOperationTypeSpilt 

连接分割操作类型:分割。

e_JoinSplitOperationTypeLink 

连接分割操作类型:链接。

e_JoinSplitOperationTypeUnlink 

连接分割操作类型:取消链接。

e_JoinSplitOperationTypeSelectNone 

连接分割操作类型:不选择。

e_JoinSplitOperationTypeClose 

连接分割操作类型:关闭。

构造及析构函数说明

◆ JoinSplit()

foxit::addon::pageeditor::JoinSplit::JoinSplit ( const JoinSplit other)

拷贝构造函数。

参数
[in]other另一个连接拆分对象。

成员函数说明

◆ Activate()

bool foxit::addon::pageeditor::JoinSplit::Activate ( )

激活连接拆分编辑。

返回
true 表示成功,false 表示失败。

◆ Deactivate()

bool foxit::addon::pageeditor::JoinSplit::Deactivate ( )

停用连接拆分编辑。

返回
true 表示成功,false 表示失败。

◆ ExitJoinEditing()

void foxit::addon::pageeditor::JoinSplit::ExitJoinEditing ( )

退出连接拆分编辑。

返回
无。

◆ GetEnableStatus()

bool foxit::addon::pageeditor::JoinSplit::GetEnableStatus ( JoinSplit::JoinSplitOperationType  type)

获取连接拆分编辑操作状态。

返回
true 表示启用,false 表示未启用。

◆ IsEmpty()

bool foxit::addon::pageeditor::JoinSplit::IsEmpty ( ) const

检查当前对象是否为空。

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

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

◆ JoinBoxes()

void foxit::addon::pageeditor::JoinSplit::JoinBoxes ( )

调用此函数连接文本。

返回
无。

◆ LinkBoxes()

void foxit::addon::pageeditor::JoinSplit::LinkBoxes ( )

调用此函数链接文本。

返回
无。

◆ OnLButtonDown()

bool foxit::addon::pageeditor::JoinSplit::OnLButtonDown ( int  page_index,
const PointF point 
)

鼠标左键按下时调用此函数。

参数
[in]page_index页面索引。
[in]point鼠标左键在页面中按下的点,以设备坐标系表示。
返回
true 表示成功,false 表示失败。

◆ OnLButtonUp()

bool foxit::addon::pageeditor::JoinSplit::OnLButtonUp ( int  page_index,
const PointF point 
)

鼠标左键抬起时调用此函数。

参数
[in]page_index页面索引。
[in]point鼠标左键在页面中抬起的点,以设备坐标系表示。
返回
true 表示成功,false 表示失败。

◆ OnMouseMove()

bool foxit::addon::pageeditor::JoinSplit::OnMouseMove ( int  page_index,
const PointF point 
)

鼠标移动时调用此函数。

参数
[in]page_index页面索引。
[in]point鼠标在页面中移动的点,以设备坐标系表示。
返回
true 表示成功,false 表示失败。

◆ operator!=()

bool foxit::addon::pageeditor::JoinSplit::operator!= ( const JoinSplit other) const

不等操作符。

参数
[in]other另一个连接拆分对象。此函数将检查当前对象是否与此对象不相等。
返回
true 表示不相等,false 表示相等。

◆ operator=()

JoinSplit& foxit::addon::pageeditor::JoinSplit::operator= ( const JoinSplit other)

赋值操作符。

参数
[in]other另一个连接拆分对象,其值将被赋给当前对象。
返回
当前对象本身的引用。

◆ operator==()

bool foxit::addon::pageeditor::JoinSplit::operator== ( const JoinSplit other) const

相等操作符。

参数
[in]other另一个连接拆分对象。此函数将检查当前对象是否与此对象相等。
返回
true 表示相等,false 表示不相等。

◆ Render()

bool foxit::addon::pageeditor::JoinSplit::Render ( Int32Array  page_index_array,
const common::Renderer renderer 
)

在渲染器上绘制当前连接拆分操作状态。

渲染过程中使用的矩阵由 ParagraphEditingProviderCallback::GetRenderMatrix 返回。

参数
[in]page_index_array要渲染的页面索引数组。
[in]renderer用于渲染的有效渲染器对象。
返回
true 表示成功,false 表示失败。

◆ SelectNone()

void foxit::addon::pageeditor::JoinSplit::SelectNone ( )

调用此函数清除所有选中的文本。

返回
无。

◆ SplitBoxes()

void foxit::addon::pageeditor::JoinSplit::SplitBoxes ( )

调用此函数拆分文本。

返回
无。

◆ UnlinkBoxes()

void foxit::addon::pageeditor::JoinSplit::UnlinkBoxes ( )

调用此函数取消链接文本。

返回
无。