|
Foxit PDF SDK
|
Instance Methods | |
| (BOOL) | - activate |
| Activate paragraph editing. More... | |
| (BOOL) | - canCopy |
| Check whether can copy text. More... | |
| (BOOL) | - canCut |
| Check whether can cut text. More... | |
| (BOOL) | - canDelete |
| Check whether can delete text. More... | |
| (BOOL) | - canDeselectAll |
| Check whether can deselect all text. More... | |
| (BOOL) | - canPaste |
| Check whether can paste text. More... | |
| (BOOL) | - canSelectAll |
| Check whether can select all text. More... | |
| (BOOL) | - copySelected |
| Copy the selected text. More... | |
| (BOOL) | - cutSelected |
| Cut the selected text. More... | |
| (BOOL) | - deactivate |
| Deactivate paragraph editing. More... | |
| (void) | - dedent |
| Decrease indent for text. More... | |
| (BOOL) | - deleteSelected |
| Delete the selected text. More... | |
| (BOOL) | - deselectAll |
| Deselect all text. More... | |
| (void) | - exitEditing: |
| Exit paragraph editing. More... | |
| (void) | - indent |
| Increase indent for text. More... | |
| (id) | - initWithOther: |
| Constructor, with another paragraph edit object. More... | |
| (BOOL) | - insertText: |
| Call this function when insert text into the page. More... | |
| (BOOL) | - isEmpty |
| Check whether current object is empty or not. More... | |
| (BOOL) | - onChar: |
| Call this function when a character code is being input. More... | |
| (BOOL) | - onKeyDown: |
| Call this function when key on the keyboard is down. More... | |
| (BOOL) | - onKeyUp: |
| Call this function when key on the keyboard is up. More... | |
| (BOOL) | - onLButtonDoubleClick:point: |
| Call this function when left mouse button is double clicked. More... | |
| (BOOL) | - onLButtonDown:point: |
| Call this function when left mouse button is down. More... | |
| (BOOL) | - onLButtonUp:point: |
| Call this function when left mouse button is up. More... | |
| (BOOL) | - onMouseMove:point: |
| Call this function when mouse moves. More... | |
| (BOOL) | - onMouseWheel:point:delta: |
| Call this function when scrolling the mouse wheel. More... | |
| (BOOL) | - pasteSelected |
| Paste the copied text. More... | |
| (BOOL) | - render:renderer: |
| Draw the current paragraph editing operation status on the rendering. More... | |
| (BOOL) | - selectAll |
| Select all text. More... | |
| (void) | - setAlignment: |
| Set text alignment for text. More... | |
| (void) | - setBold: |
| Set bold status for text. More... | |
| (void) | - setBulletedList: |
| Set bullet list for text. More... | |
| (void) | - setCharHorizontalScale: |
| Set char horizontal scale for text. More... | |
| (void) | - setCharSpace: |
| Set char space for text. More... | |
| (void) | - setFontName: |
| Set font name for text. More... | |
| (void) | - setFontSize: |
| Set the font size for text. More... | |
| (void) | - setItalic: |
| Set italic status for text. More... | |
| (void) | - setLineSpace: |
| Set line space for text. More... | |
| (void) | - setNumberedList: |
| Set the look of numbering for text. More... | |
| (void) | - setParagraphSpacing: |
| Set paragraph spacing for text. More... | |
| (void) | - setStrikethrough: |
| Set strikeout word style for text. More... | |
| (void) | - setSubscript: |
| Set the word property of subscript type for text. More... | |
| (void) | - setSuperscript: |
| Set the word property of superscript type for text. More... | |
| (void) | - setTextColor: |
| Set text color for text. More... | |
| (void) | - setUnderline: |
| Set underline for text. More... | |
| (void) | - startEditing:start_point:end_point: |
| Start paragraph editing. More... | |
This class represents a paragraph edit operation. Before use any methods of paragraph edit function, please ensure the function FSParagraphEditing::activate has been called. Please call the function FSParagraphEditing::deactivate to deactivate when no need to use any paragraph edit function.
| - (BOOL) activate |
Activate paragraph editing.
| - (BOOL) canCopy |
Check whether can copy text.
| - (BOOL) canCut |
Check whether can cut text.
| - (BOOL) canDelete |
Check whether can delete text.
| - (BOOL) canDeselectAll |
Check whether can deselect all text.
| - (BOOL) canPaste |
Check whether can paste text.
| - (BOOL) canSelectAll |
Check whether can select all text.
| - (BOOL) copySelected |
Copy the selected text.
| - (BOOL) cutSelected |
Cut the selected text.
| - (BOOL) deactivate |
Deactivate paragraph editing.
| - (void) dedent |
Decrease indent for text.
| - (BOOL) deleteSelected |
Delete the selected text.
| - (BOOL) deselectAll |
Deselect all text.
| - (void) exitEditing: | (BOOL) | is_end_directly |
Exit paragraph editing.
| [in] | is_end_directly | Whether to end editing directly. |
| - (void) indent |
Increase indent for text.
| - (id) initWithOther: | (FSParagraphEditing*) | other |
Constructor, with another paragraph edit object.
| [in] | other | Another paragraph edit object. |
| - (BOOL) insertText: | (NSString *) | text |
Call this function when insert text into the page.
| [in] | text | The text to be inserted. |
| - (BOOL) isEmpty |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
| - (BOOL) onChar: | (unsigned int) | char_code |
Call this function when a character code is being input.
| [in] | char_code | A character code, in UTF16-LE encoding. |
| - (BOOL) onKeyDown: | (unsigned int) | key_code |
Call this function when key on the keyboard is down.
| [in] | key_code | The key code. Please refer to values starting from FSFillerVkeyUnknown and this should be one of these values. |
| - (BOOL) onKeyUp: | (unsigned int) | key_code |
Call this function when key on the keyboard is up.
| [in] | key_code | The key code. Please refer to values starting from FSFillerVkeyUnknown and this should be one of these values. |
| - (BOOL) onLButtonDoubleClick: | (int) | page_index | |
| point: | (FSPointF*) | point | |
Call this function when left mouse button is double clicked.
| [in] | page_index | The page index. |
| [in] | point | A point where left mouse button is double-clicked in the page, in device coordinate system. |
| - (BOOL) onLButtonDown: | (int) | page_index | |
| point: | (FSPointF*) | point | |
Call this function when left mouse button is down.
| [in] | page_index | The page index. |
| [in] | point | A point where left mouse button is down in the page, in device coordinate system. |
| - (BOOL) onLButtonUp: | (int) | page_index | |
| point: | (FSPointF*) | point | |
Call this function when left mouse button is up.
| [in] | page_index | The page index. |
| [in] | point | A point where left mouse button is up in the page, in device coordinate system. |
| - (BOOL) onMouseMove: | (int) | page_index | |
| point: | (FSPointF*) | point | |
Call this function when mouse moves.
| [in] | page_index | The page index. |
| [in] | point | A point where the mouse in the page, in device coordinate system. |
| - (BOOL) onMouseWheel: | (int) | page_index | |
| point: | (FSPointF*) | point | |
| delta: | (int) | delta | |
Call this function when scrolling the mouse wheel.
| [in] | page_index | The page index. |
| [in] | point | A point where the mouse in the page, in device coordinate system. |
| [in] | delta | Indicates the amount the mouse wheel has been moved. A positive value means to be moved forward, and a negative value means to be moved backward. |
| - (BOOL) pasteSelected |
Paste the copied text.
| - (BOOL) render: | (FSInt32Array*) | page_index_array | |
| renderer: | (FSRenderer*) | renderer | |
Draw the current paragraph editing operation status on the rendering.
The matrix used in the rendering process is returned by ParagraphEditingProviderCallback::GetRenderMatrix.
| [in] | page_index_array | The page index array to render. |
| [in] | renderer | A valid renderer object for rendering. |
| - (BOOL) selectAll |
Select all text.
| - (void) setAlignment: | (FSAlignment) | alignment |
Set text alignment for text.
| [in] | alignment | Alignment value.Please refer to values starting from FSAlignmentLeft and this should be one of these values. |
| - (void) setBold: | (BOOL) | is_bold |
Set bold status for text.
| [in] | is_bold | Whether to set selected text as bold. YES means current selected text will be set as bold, while NO means not. |
| - (void) setBulletedList: | (FSParagraphEditingBulletType) | bullet_type |
Set bullet list for text.
Before setting a bullet list, ensure the "wingding.ttf" font has been installed.
| [in] | bullet_type | The type of bullet. Please refer to values starting from and this should be one of these values. |
| - (void) setCharHorizontalScale: | (int) | scale |
Set char horizontal scale for text.
| [in] | scale | The scale. It should be bigger than 0. |
| - (void) setCharSpace: | (float) | char_space |
Set char space for text.
| [in] | char_space | The char space (unit is 1/72 inch). |
| - (void) setFontName: | (NSString *) | font_name |
Set font name for text.
| [in] | font_name | The font name. |
| - (void) setFontSize: | (float) | font_size |
Set the font size for text.
| [in] | font_size | The font size. |
| - (void) setItalic: | (BOOL) | is_italic |
Set italic status for text.
| [in] | is_italic | Whether to set selected text as italic. YES means current selected text will be set as italic, while NO means not. |
| - (void) setLineSpace: | (float) | line_space |
Set line space for text.
| [in] | line_space | The line space (unit is 1/72 inch). |
| - (void) setNumberedList: | (FSParagraphEditingNumberingType) | numbering_type |
Set the look of numbering for text.
| [in] | numbering_type | The type of numbering. Please refer to values starting from and this should be one of these values. |
| - (void) setParagraphSpacing: | (float) | paragraph_space |
Set paragraph spacing for text.
| [in] | paragraph_space | The paragraph spacing. |
| - (void) setStrikethrough: | (BOOL) | is_striketrough |
Set strikeout word style for text.
| [in] | is_striketrough | YES means to set the strikeout word style, while NO means not. |
| - (void) setSubscript: | (BOOL) | is_subscript |
Set the word property of subscript type for text.
| - (void) setSuperscript: | (BOOL) | is_superscript |
Set the word property of superscript type for text.
| - (void) setTextColor: | (unsigned int) | text_color |
Set text color for text.
| [in] | text_color | The text color. |
| - (void) setUnderline: | (BOOL) | is_underline |
Set underline for text.
| [in] | is_underline | YES means to underline text, while NO means not. |
| - (void) startEditing: | (int) | page_index | |
| start_point: | (FSPointF*) | start_point | |
| end_point: | (FSPointF*) | end_point | |
Start paragraph editing.
| [in] | page_index | The page index. |
| [in] | start_point | A point to start editing on the page, in the device coordinate system. |
| [in] | end_point | A point to end editing on the page, in the device coordinate system. |