类 foxit::addon::pageeditor::ParagraphEditing 继承关系图:

Public 类型
enum	BulletType { e_BulletTypeNone = 0, e_BulletTypeSolidCircle = 1, e_BulletTypeSolidRectangle = 2, e_BulletTypeSolidDiamond = 3, e_BulletTypeCheck = 4, e_BulletTypeRightArrow = 5, e_BulletTypeInverseTangentCircle = 6, e_BulletTypeDiagonalUpRightArrow = 7, e_BulletTypeBlackDiamondMinusWhite = 8 }
	项目符号类型的枚举。更多...

enum	NumberingType { e_NumberingTypeNone = 0, e_NumberingTypeDecimalDot = 1, e_NumberingTypeDecimalRParen = 2, e_NumberingTypeUpperLatinDot = 3, e_NumberingTypeLowerLatinRParen = 4, e_NumberingTypeLowerLatinDot = 5 }
	编号类型的枚举。更多...

Public 成员函数
	ParagraphEditing (const ParagraphEditing &other)
	构造函数，使用另一个段落编辑对象。更多...

	~ParagraphEditing ()
	析构函数。

bool	Activate ()
	激活段落编辑。更多...

bool	CanCopy ()
	检查是否可以复制文本。更多...

bool	CanCut ()
	检查是否可以剪切文本。更多...

bool	CanDelete ()
	检查是否可以删除文本。更多...

bool	CanDeselectAll ()
	检查是否可以取消选择所有文本。更多...

bool	CanPaste ()
	检查是否可以粘贴文本。更多...

bool	CanSelectAll ()
	检查是否可以全选文本。更多...

bool	CopySelected ()
	复制选中的文本。更多...

bool	CutSelected ()
	剪切选中的文本。更多...

bool	Deactivate ()
	停用段落编辑。更多...

void	Dedent ()
	减少文本缩进。更多...

bool	DeleteSelected ()
	删除选中的文本。更多...

bool	DeselectAll ()
	取消选择所有文本。更多...

void	ExitEditing (bool is_end_directly=false)
	退出段落编辑。更多...

void	Indent ()
	增加文本缩进。更多...

bool	InsertText (const WString &text)
	在页面中插入文本时调用此函数。更多...

bool	IsEmpty () const
	检查当前对象是否为空。更多...

bool	OnChar (uint32 char_code)
	输入字符代码时调用此函数。更多...

bool	OnKeyDown (uint32 key_code)
	键盘按键按下时调用此函数。更多...

bool	OnKeyUp (uint32 key_code)
	键盘按键抬起时调用此函数。更多...

bool	OnLButtonDoubleClick (int page_index, const PointF &point)
	鼠标左键双击时调用此函数。更多...

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	OnMouseWheel (int page_index, const PointF &point, int32 delta)
	鼠标滚轮滚动时调用此函数。更多...

bool	operator!= (const ParagraphEditing &other) const
	不等操作符。更多...

ParagraphEditing &	operator= (const ParagraphEditing &other)
	赋值操作符。更多...

bool	operator== (const ParagraphEditing &other) const
	相等操作符。更多...

bool	PasteSelected ()
	粘贴复制的文本。更多...

bool	Render (const Int32Array page_index_array, const common::Renderer &renderer)
	在渲染器上绘制当前段落编辑操作状态。更多...

bool	SelectAll ()
	全选文本。更多...

void	SetAlignment (foxit::common::Alignment alignment)
	为文本设置文本对齐方式。更多...

void	SetBold (bool is_bold)
	为文本设置粗体状态。更多...

void	SetBulletedList (BulletType bullet_type)
	为文本设置项目符号列表。更多...

void	SetCharHorizontalScale (int scale)
	为文本设置字符水平缩放。更多...

void	SetCharSpace (float char_space)
	为文本设置字符间距。更多...

void	SetFontName (const WString &font_name)
	为文本设置字体名称。更多...

void	SetFontSize (float font_size)
	为文本设置字体大小。更多...

void	SetItalic (bool is_italic)
	为文本设置斜体状态。更多...

void	SetLineSpace (float line_space)
	为文本设置行间距。更多...

void	SetNumberedList (NumberingType numbering_type)
	为文本设置编号列表的外观。更多...

void	SetParagraphSpacing (float paragraph_space)
	为文本设置段落间距。更多...

void	SetStrikethrough (bool is_striketrough)
	为文本设置删除线样式。更多...

void	SetSubscript (bool is_subscript)
	为文本设置下标属性。更多...

void	SetSuperscript (bool is_superscript)
	为文本设置上标属性。更多...

void	SetTextColor (RGB text_color)
	为文本设置文本颜色。更多...

void	SetUnderline (bool is_underline)
	为文本设置下划线。更多...

void	StartEditing (int page_index, const PointF &start_point, const PointF &end_point)
	开始段落编辑。更多...

Public 成员函数继承自 foxit::Base
FS_HANDLE	Handle () const
	获取当前对象的句柄。更多...

详细描述

此类表示段落编辑操作。在使用段落编辑功能的任何方法之前，请确保已调用函数 ParagraphEditing::Activate。不需要使用任何段落编辑功能时，请调用函数 ParagraphEditing::Deactivate 来停用。

成员枚举类型说明

◆ BulletType

enum foxit::addon::pageeditor::ParagraphEditing::BulletType

项目符号类型的枚举。

此枚举的值应单独使用。

枚举值
e_BulletTypeNone	项目符号类型：无。
e_BulletTypeSolidCircle	项目符号类型：实心圆。
e_BulletTypeSolidRectangle	项目符号类型：实心矩形。
e_BulletTypeSolidDiamond	项目符号类型：实心菱形。
e_BulletTypeCheck	项目符号类型：对勾。
e_BulletTypeRightArrow	项目符号类型：右箭头（上白下黑）。
e_BulletTypeInverseTangentCircle	项目符号类型：反切圆。
e_BulletTypeDiagonalUpRightArrow	项目符号类型：右上对角箭头。
e_BulletTypeBlackDiamondMinusWhite	项目符号类型：黑菱形减去白色。

◆ NumberingType

enum foxit::addon::pageeditor::ParagraphEditing::NumberingType

编号类型的枚举。

此枚举的值应单独使用。

枚举值
e_NumberingTypeNone	编号类型：无。
e_NumberingTypeDecimalDot	编号类型：1. 2. 3.
e_NumberingTypeDecimalRParen	编号类型：1) 2) 3)
e_NumberingTypeUpperLatinDot	编号类型：A. B. C.
e_NumberingTypeLowerLatinRParen	编号类型：a) b) c)
e_NumberingTypeLowerLatinDot	编号类型：a. b. c.

构造及析构函数说明

◆ ParagraphEditing()

foxit::addon::pageeditor::ParagraphEditing::ParagraphEditing ( const ParagraphEditing & other )

构造函数，使用另一个段落编辑对象。

参数

[in] other 另一个段落编辑对象。

成员函数说明

◆ Activate()

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

激活段落编辑。

返回: true 表示成功，false 表示失败。

◆ CanCopy()

bool foxit::addon::pageeditor::ParagraphEditing::CanCopy ( )

检查是否可以复制文本。

返回: true 表示当前选中的文本对象可以被复制，false 表示不可以。

◆ CanCut()

bool foxit::addon::pageeditor::ParagraphEditing::CanCut ( )

检查是否可以剪切文本。

返回: true 表示当前选中的文本可以被剪切，false 表示不可以。

◆ CanDelete()

bool foxit::addon::pageeditor::ParagraphEditing::CanDelete ( )

检查是否可以删除文本。

返回: true 表示当前选中的文本可以被删除，false 表示不可以。

◆ CanDeselectAll()

bool foxit::addon::pageeditor::ParagraphEditing::CanDeselectAll ( )

检查是否可以取消选择所有文本。

返回: true 表示当前选中的文本可以被取消选择，false 表示不可以。

◆ CanPaste()

bool foxit::addon::pageeditor::ParagraphEditing::CanPaste ( )

检查是否可以粘贴文本。

返回: true 表示当前选中的文本可以被粘贴，false 表示不可以。

◆ CanSelectAll()

bool foxit::addon::pageeditor::ParagraphEditing::CanSelectAll ( )

检查是否可以全选文本。

返回: true 表示当前所有文本可以被选择，false 表示不可以。

◆ CopySelected()

bool foxit::addon::pageeditor::ParagraphEditing::CopySelected ( )

复制选中的文本。

返回: true 表示成功，false 表示失败。

◆ CutSelected()

bool foxit::addon::pageeditor::ParagraphEditing::CutSelected ( )

剪切选中的文本。

返回: true 表示成功，false 表示失败。

◆ Deactivate()

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

停用段落编辑。

返回: true 表示成功，false 表示失败。

◆ Dedent()

void foxit::addon::pageeditor::ParagraphEditing::Dedent ( )

减少文本缩进。

返回: 无。

◆ DeleteSelected()

bool foxit::addon::pageeditor::ParagraphEditing::DeleteSelected ( )

删除选中的文本。

返回: true 表示成功，false 表示失败。

◆ DeselectAll()

bool foxit::addon::pageeditor::ParagraphEditing::DeselectAll ( )

取消选择所有文本。

返回: true 表示成功，false 表示失败。

◆ ExitEditing()

void foxit::addon::pageeditor::ParagraphEditing::ExitEditing ( bool is_end_directly = false )

退出段落编辑。

参数

[in] is_end_directly 是否直接结束编辑。

返回: 无。

◆ Indent()

void foxit::addon::pageeditor::ParagraphEditing::Indent ( )

增加文本缩进。

返回: 无。

◆ InsertText()

bool foxit::addon::pageeditor::ParagraphEditing::InsertText ( const WString & text )

在页面中插入文本时调用此函数。

参数

[in] text 要插入的文本。

返回: true 表示成功，false 表示失败。

◆ IsEmpty()

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

检查当前对象是否为空。

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

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

◆ OnChar()

bool foxit::addon::pageeditor::ParagraphEditing::OnChar ( uint32 char_code )

输入字符代码时调用此函数。

参数

[in] char_code 字符代码，采用 UTF16-LE 编码。

返回: true 表示成功，false 表示失败。

◆ OnKeyDown()

bool foxit::addon::pageeditor::ParagraphEditing::OnKeyDown ( uint32 key_code )

键盘按键按下时调用此函数。

参数

[in] key_code 键代码。请参考从 pdf::interform::Filler::e_VkeyUnknown 开始的值，应该是这些值中的一个。

返回: true 表示成功，false 表示失败。

◆ OnKeyUp()

bool foxit::addon::pageeditor::ParagraphEditing::OnKeyUp ( uint32 key_code )

键盘按键抬起时调用此函数。

参数

[in] key_code 键代码。请参考从 pdf::interform::Filler::e_VkeyUnknown 开始的值，应该是这些值中的一个。

返回: true 表示成功，false 表示失败。

◆ OnLButtonDoubleClick()

bool foxit::addon::pageeditor::ParagraphEditing::OnLButtonDoubleClick	(	int	page_index,
		const PointF &	point
	)

鼠标左键双击时调用此函数。

参数

[in]	page_index	页面索引。
[in]	point	鼠标左键在页面中双击的点，以设备坐标系表示。

返回: true 表示成功，false 表示失败。

◆ OnLButtonDown()

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

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

参数

[in]	page_index	页面索引。
[in]	point	鼠标左键在页面中按下的点，以设备坐标系表示。

返回: true 表示成功，false 表示失败。

◆ OnLButtonUp()

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

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

参数

[in]	page_index	页面索引。
[in]	point	鼠标左键在页面中抬起的点，以设备坐标系表示。

返回: true 表示成功，false 表示失败。

◆ OnMouseMove()

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

鼠标移动时调用此函数。

参数

[in]	page_index	页面索引。
[in]	point	鼠标在页面中的点，以设备坐标系表示。

返回: true 表示成功，false 表示失败。

◆ OnMouseWheel()

bool foxit::addon::pageeditor::ParagraphEditing::OnMouseWheel	(	int	page_index,
		const PointF &	point,
		int32	delta
	)

鼠标滚轮滚动时调用此函数。

参数

[in]	page_index	页面索引。
[in]	point	鼠标在页面中的点，以设备坐标系表示。
[in]	delta	指示鼠标滚轮移动的量。正值表示向前移动，负值表示向后移动。

返回: true 表示成功，false 表示失败。

◆ operator!=()

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

不等操作符。

参数

[in] other 另一个段落编辑对象。此函数将检查当前对象是否不等于此对象。

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

◆ operator=()

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

赋值操作符。

参数

[in] other 另一个段落编辑对象，其值将赋给当前对象。

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

◆ operator==()

bool foxit::addon::pageeditor::ParagraphEditing::operator== ( const ParagraphEditing & other ) const

相等操作符。

参数

[in] other 另一个段落编辑对象。此函数将检查当前对象是否等于此对象。

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

◆ PasteSelected()

bool foxit::addon::pageeditor::ParagraphEditing::PasteSelected ( )

粘贴复制的文本。

返回: true 表示成功，false 表示失败。

◆ Render()

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

在渲染器上绘制当前段落编辑操作状态。

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

参数

[in]	page_index_array	要渲染的页面索引数组。
[in]	renderer	用于渲染的有效渲染器对象。

返回: true 表示成功，false 表示失败。

◆ SelectAll()

bool foxit::addon::pageeditor::ParagraphEditing::SelectAll ( )

全选文本。

返回: true 表示成功，false 表示失败。

◆ SetAlignment()

void foxit::addon::pageeditor::ParagraphEditing::SetAlignment ( foxit::common::Alignment alignment )

为文本设置文本对齐方式。

参数

[in] alignment 对齐值。请参考从 common::e_AlignmentLeft 开始的值，应该是这些值中的一个。

返回: 无。

◆ SetBold()

void foxit::addon::pageeditor::ParagraphEditing::SetBold ( bool is_bold )

为文本设置粗体状态。

参数

[in] is_bold 是否将选中的文本设置为粗体。true 表示当前选中的文本将被设置为粗体，false 表示不设置。

返回: 无。

◆ SetBulletedList()

void foxit::addon::pageeditor::ParagraphEditing::SetBulletedList ( BulletType bullet_type )

为文本设置项目符号列表。

在设置项目符号列表之前，请确保已安装 "wingding.ttf" 字体。

参数

[in] bullet_type 项目符号类型。请参考从 foxit::addon::pageeditor::e_BulletTypeNone 开始的值，应该是这些值中的一个。

返回: 无。

◆ SetCharHorizontalScale()

void foxit::addon::pageeditor::ParagraphEditing::SetCharHorizontalScale ( int scale )

为文本设置字符水平缩放。

参数

[in] scale 缩放比例。应该大于 0。

返回: 无。

◆ SetCharSpace()

void foxit::addon::pageeditor::ParagraphEditing::SetCharSpace ( float char_space )

为文本设置字符间距。

参数

[in] char_space 字符间距（单位为 1/72 英寸）。

返回: 无。

◆ SetFontName()

void foxit::addon::pageeditor::ParagraphEditing::SetFontName ( const WString & font_name )

为文本设置字体名称。

参数

[in] font_name 字体名称。

返回: 无。

◆ SetFontSize()

void foxit::addon::pageeditor::ParagraphEditing::SetFontSize ( float font_size )

为文本设置字体大小。

参数

[in] font_size 字体大小。

返回: 无。

◆ SetItalic()

void foxit::addon::pageeditor::ParagraphEditing::SetItalic ( bool is_italic )

为文本设置斜体状态。

参数

[in] is_italic 是否将选中的文本设置为斜体。true 表示当前选中的文本将被设置为斜体，false 表示不设置。

返回: 无。

◆ SetLineSpace()

void foxit::addon::pageeditor::ParagraphEditing::SetLineSpace ( float line_space )

为文本设置行间距。

参数

[in] line_space 行间距（单位为 1/72 英寸）。

返回: 无。

◆ SetNumberedList()

void foxit::addon::pageeditor::ParagraphEditing::SetNumberedList ( NumberingType numbering_type )

为文本设置编号列表的外观。

参数

[in] numbering_type 编号类型。请参考从 foxit::addon::pageeditor::e_NumberingTypeNone 开始的值，应该是这些值中的一个。

返回: 无。

◆ SetParagraphSpacing()

void foxit::addon::pageeditor::ParagraphEditing::SetParagraphSpacing ( float paragraph_space )

为文本设置段落间距。

参数

[in] paragraph_space 段落间距。

返回: 无。

◆ SetStrikethrough()

void foxit::addon::pageeditor::ParagraphEditing::SetStrikethrough ( bool is_striketrough )

为文本设置删除线样式。

参数

[in] is_striketrough true 表示设置删除线样式，false 表示不设置。

返回: 无。

◆ SetSubscript()

void foxit::addon::pageeditor::ParagraphEditing::SetSubscript ( bool is_subscript )

为文本设置下标属性。

参数

[in] is_sub_script true 表示设置下标属性，false 表示不设置。

返回: 无。

◆ SetSuperscript()

void foxit::addon::pageeditor::ParagraphEditing::SetSuperscript ( bool is_superscript )

为文本设置上标属性。

参数

[in] is_super_set true 表示设置上标属性，false 表示不设置。

返回: 无。

◆ SetTextColor()

void foxit::addon::pageeditor::ParagraphEditing::SetTextColor ( RGB text_color )

为文本设置文本颜色。

参数

[in] text_color 文本颜色。

返回: 无。

◆ SetUnderline()

void foxit::addon::pageeditor::ParagraphEditing::SetUnderline ( bool is_underline )

为文本设置下划线。

参数

[in] is_underline true 表示给文本加下划线，false 表示不加。

返回: 无。

◆ StartEditing()

void foxit::addon::pageeditor::ParagraphEditing::StartEditing	(	int	page_index,
		const PointF &	start_point,
		const PointF &	end_point
	)

开始段落编辑。

参数

[in]	page_index	页面索引。
[in]	start_point	在页面上开始编辑的点，以设备坐标系表示。
[in]	end_point	在页面上结束编辑的点，以设备坐标系表示。

返回: 无。

Public 类型

Public 成员函数

详细描述

成员枚举类型说明

◆ BulletType

◆ NumberingType

构造及析构函数说明

◆ ParagraphEditing()

成员函数说明

◆ Activate()

◆ CanCopy()

◆ CanCut()

◆ CanDelete()

◆ CanDeselectAll()

◆ CanPaste()

◆ CanSelectAll()

◆ CopySelected()

◆ CutSelected()

◆ Deactivate()

◆ Dedent()

◆ DeleteSelected()

◆ DeselectAll()

◆ ExitEditing()

◆ Indent()

◆ InsertText()

◆ IsEmpty()

◆ OnChar()

◆ OnKeyDown()

◆ OnKeyUp()

◆ OnLButtonDoubleClick()

◆ OnLButtonDown()

◆ OnLButtonUp()

◆ OnMouseMove()

◆ OnMouseWheel()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ PasteSelected()

◆ Render()

◆ SelectAll()

◆ SetAlignment()

◆ SetBold()

◆ SetBulletedList()

◆ SetCharHorizontalScale()

◆ SetCharSpace()

◆ SetFontName()

◆ SetFontSize()

◆ SetItalic()

◆ SetLineSpace()

◆ SetNumberedList()

◆ SetParagraphSpacing()

◆ SetStrikethrough()

◆ SetSubscript()

◆ SetSuperscript()

◆ SetTextColor()

◆ SetUnderline()

◆ StartEditing()