类 FSParagraphEditing 继承关系图:

构造函数
(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:
	退出段落编辑。更多...

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

(id)	- initWithOther:
	构造函数，使用另一个段落编辑对象。更多...

(BOOL)	- insertText:
	在页面中插入文本时调用此函数。更多...

(BOOL)	- isEmpty
	检查当前对象是否为空。更多...

(BOOL)	- onChar:
	输入字符代码时调用此函数。更多...

(BOOL)	- onKeyDown:
	键盘按键按下时调用此函数。更多...

(BOOL)	- onKeyUp:
	键盘按键抬起时调用此函数。更多...

(BOOL)	- onLButtonDoubleClick:point:
	鼠标左键双击时调用此函数。更多...

(BOOL)	- onLButtonDown:point:
	鼠标左键按下时调用此函数。更多...

(BOOL)	- onLButtonUp:point:
	鼠标左键抬起时调用此函数。更多...

(BOOL)	- onMouseMove:point:
	鼠标移动时调用此函数。更多...

(BOOL)	- onMouseWheel:point:delta:
	鼠标滚轮滚动时调用此函数。更多...

(BOOL)	- pasteSelected
	粘贴复制的文本。更多...

(BOOL)	- render:renderer:
	在渲染器上绘制当前段落编辑操作状态。更多...

(BOOL)	- selectAll
	全选文本。更多...

(void)	- setAlignment:
	为文本设置文本对齐方式。更多...

(void)	- setBold:
	为文本设置粗体状态。更多...

(void)	- setBulletedList:
	为文本设置项目符号列表。更多...

(void)	- setCharHorizontalScale:
	为文本设置字符水平缩放。更多...

(void)	- setCharSpace:
	为文本设置字符间距。更多...

(void)	- setFontName:
	为文本设置字体名称。更多...

(void)	- setFontSize:
	为文本设置字体大小。更多...

(void)	- setItalic:
	为文本设置斜体状态。更多...

(void)	- setLineSpace:
	为文本设置行间距。更多...

(void)	- setNumberedList:
	为文本设置编号列表的外观。更多...

(void)	- setParagraphSpacing:
	为文本设置段落间距。更多...

(void)	- setStrikethrough:
	为文本设置删除线样式。更多...

(void)	- setSubscript:
	为文本设置下标属性。更多...

(void)	- setSuperscript:
	为文本设置上标属性。更多...

(void)	- setTextColor:
	为文本设置文本颜色。更多...

(void)	- setUnderline:
	为文本设置下划线。更多...

(void)	- startEditing:start_point:end_point:
	开始段落编辑。更多...

详细描述

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

函数文档

◆ activate()

- (BOOL) activate

激活段落编辑。

返回: YES 表示成功，NO 表示失败。

◆ canCopy()

- (BOOL) canCopy

检查是否可以复制文本。

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

◆ canCut()

- (BOOL) canCut

检查是否可以剪切文本。

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

◆ canDelete()

- (BOOL) canDelete

检查是否可以删除文本。

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

◆ canDeselectAll()

- (BOOL) canDeselectAll

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

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

◆ canPaste()

- (BOOL) canPaste

检查是否可以粘贴文本。

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

◆ canSelectAll()

- (BOOL) canSelectAll

检查是否可以全选文本。

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

◆ copySelected()

- (BOOL) copySelected

复制选中的文本。

返回: YES 表示成功，NO 表示失败。

◆ cutSelected()

- (BOOL) cutSelected

剪切选中的文本。

返回: YES 表示成功，NO 表示失败。

◆ deactivate()

- (BOOL) deactivate

停用段落编辑。

返回: YES 表示成功，NO 表示失败。

◆ dedent()

- (void) dedent

减少文本缩进。

返回: 无。

◆ deleteSelected()

- (BOOL) deleteSelected

删除选中的文本。

返回: YES 表示成功，NO 表示失败。

◆ deselectAll()

- (BOOL) deselectAll

取消选择所有文本。

返回: YES 表示成功，NO 表示失败。

◆ exitEditing:()

- (void) exitEditing: (BOOL) is_end_directly

退出段落编辑。

参数

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

返回: 无。

◆ indent()

- (void) indent

增加文本缩进。

返回: 无。

◆ initWithOther:()

- (id) initWithOther: (FSParagraphEditing*) other

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

参数

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

◆ insertText:()

- (BOOL) insertText: (NSString *) text

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

参数

[in] text 要插入的文本。

返回: YES 表示成功，NO 表示失败。

◆ isEmpty()

- (BOOL) isEmpty

检查当前对象是否为空。

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

返回: YES 表示当前对象为空，NO 表示不为空。

◆ onChar:()

- (BOOL) onChar: (unsigned int) char_code

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

参数

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

返回: YES 表示成功，NO 表示失败。

◆ onKeyDown:()

- (BOOL) onKeyDown: (unsigned int) key_code

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

参数

[in] key_code 键代码。请参考从 FSFillerVkeyUnknown 开始的值，应该是这些值中的一个。以下值将不起作用： FSFillerVkeyBack , FSFillerVkeyTab , FSFillerVkeySpace , 从 FSFillerVkey0 到 FSFillerVkeyNumpad9 .

返回: YES 表示成功，NO 表示失败。

◆ onKeyUp:()

- (BOOL) onKeyUp: (unsigned int) key_code

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

参数

[in] key_code 键代码。请参考从 FSFillerVkeyUnknown 开始的值，应该是这些值中的一个。以下值将不起作用： FSFillerVkeyBack , FSFillerVkeyTab , FSFillerVkeySpace , 从 FSFillerVkey0 到 FSFillerVkeyNumpad9 .

返回: YES 表示成功，NO 表示失败。

◆ onLButtonDoubleClick:point:()

- (BOOL) onLButtonDoubleClick:	(int)	page_index
point:	(FSPointF*)	point

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

参数

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

返回: YES 表示成功，NO 表示失败。

◆ onLButtonDown:point:()

- (BOOL) onLButtonDown:	(int)	page_index
point:	(FSPointF*)	point

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

参数

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

返回: YES 表示成功，NO 表示失败。

◆ onLButtonUp:point:()

- (BOOL) onLButtonUp:	(int)	page_index
point:	(FSPointF*)	point

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

参数

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

返回: YES 表示成功，NO 表示失败。

◆ onMouseMove:point:()

- (BOOL) onMouseMove:	(int)	page_index
point:	(FSPointF*)	point

鼠标移动时调用此函数。

参数

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

返回: YES 表示成功，NO 表示失败。

◆ onMouseWheel:point:delta:()

- (BOOL) onMouseWheel:	(int)	page_index
point:	(FSPointF*)	point
delta:	(int)	delta

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

参数

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

返回: YES 表示成功，NO 表示失败。

◆ pasteSelected()

- (BOOL) pasteSelected

粘贴复制的文本。

返回: YES 表示成功，NO 表示失败。

◆ render:renderer:()

- (BOOL) render:	(FSInt32Array*)	page_index_array
renderer:	(FSRenderer*)	renderer

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

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

参数

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

返回: YES 表示成功，NO 表示失败。

◆ selectAll()

- (BOOL) selectAll

全选文本。

返回: YES 表示成功，NO 表示失败。

◆ setAlignment:()

- (void) setAlignment: (FSAlignment) alignment

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

参数

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

返回: 无。

◆ setBold:()

- (void) setBold: (BOOL) is_bold

为文本设置粗体状态。

参数

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

返回: 无。

◆ setBulletedList:()

- (void) setBulletedList: (FSParagraphEditingBulletType) bullet_type

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

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

参数

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

返回: 无。

◆ setCharHorizontalScale:()

- (void) setCharHorizontalScale: (int) scale

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

参数

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

返回: 无。

◆ setCharSpace:()

- (void) setCharSpace: (float) char_space

为文本设置字符间距。

参数

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

返回: 无。

◆ setFontName:()

- (void) setFontName: (NSString *) font_name

为文本设置字体名称。

参数

[in] font_name 字体名称。

返回: 无。

◆ setFontSize:()

- (void) setFontSize: (float) font_size

为文本设置字体大小。

参数

[in] font_size 字体大小。

返回: 无。

◆ setItalic:()

- (void) setItalic: (BOOL) is_italic

为文本设置斜体状态。

参数

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

返回: 无。

◆ setLineSpace:()

- (void) setLineSpace: (float) line_space

为文本设置行间距。

参数

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

返回: 无。

◆ setNumberedList:()

- (void) setNumberedList: (FSParagraphEditingNumberingType) numbering_type

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

参数

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

返回: 无。

◆ setParagraphSpacing:()

- (void) setParagraphSpacing: (float) paragraph_space

为文本设置段落间距。

参数

[in] paragraph_space 段落间距。

返回: 无。

◆ setStrikethrough:()

- (void) setStrikethrough: (BOOL) is_striketrough

为文本设置删除线样式。

参数

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

返回: 无。

◆ setSubscript:()

- (void) setSubscript: (BOOL) is_subscript

为文本设置下标属性。

返回: 无。

◆ setSuperscript:()

- (void) setSuperscript: (BOOL) is_superscript

为文本设置上标属性。

返回: 无。

◆ setTextColor:()

- (void) setTextColor: (unsigned int) text_color

为文本设置文本颜色。

参数

[in] text_color 文本颜色。

返回: 无。

◆ setUnderline:()

- (void) setUnderline: (BOOL) is_underline

为文本设置下划线。

参数

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

返回: 无。

◆ startEditing:start_point:end_point:()

- (void) startEditing:	(int)	page_index
start_point:	(FSPointF*)	start_point
end_point:	(FSPointF*)	end_point

开始段落编辑。

参数

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

返回: 无。