Foxit PDF SDK
|
Public Types | |
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 } |
Enumeration for bullet type. More... | |
enum | NumberingType { e_NumberingTypeNone = 0, e_NumberingTypeDecimalDot = 1, e_NumberingTypeDecimalRParen = 2, e_NumberingTypeUpperLatinDot = 3, e_NumberingTypeLowerLatinRParen = 4, e_NumberingTypeLowerLatinDot = 5 } |
Enumeration for numbering type. More... | |
Public Member Functions | |
ParagraphEditing (const ParagraphEditing &other) | |
Constructor, with another paragraph edit object. More... | |
~ParagraphEditing () | |
Destructor. | |
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 (bool is_end_directly=false) |
Exit paragraph editing. More... | |
void | Indent () |
Increase indent for text. More... | |
bool | InsertText (const WString &text) |
Call this function when insert text into the page. More... | |
bool | IsEmpty () const |
Check whether current object is empty or not. More... | |
bool | OnChar (uint32 char_code) |
Call this function when a character code is being input. More... | |
bool | OnKeyDown (uint32 key_code) |
Call this function when key on the keyboard is down. More... | |
bool | OnKeyUp (uint32 key_code) |
Call this function when key on the keyboard is up. More... | |
bool | OnLButtonDoubleClick (int page_index, const PointF &point) |
Call this function when left mouse button is double clicked. More... | |
bool | OnLButtonDown (int page_index, const PointF &point) |
Call this function when left mouse button is down. More... | |
bool | OnLButtonUp (int page_index, const PointF &point) |
Call this function when left mouse button is up. More... | |
bool | OnMouseMove (int page_index, const PointF &point) |
Call this function when mouse moves. More... | |
bool | OnMouseWheel (int page_index, const PointF &point, int32 delta) |
Call this function when scrolling the mouse wheel. More... | |
bool | operator!= (const ParagraphEditing &other) const |
Not equal operator. More... | |
ParagraphEditing & | operator= (const ParagraphEditing &other) |
Assign operator. More... | |
bool | operator== (const ParagraphEditing &other) const |
Equal operator. More... | |
bool | PasteSelected () |
Paste the copied text. More... | |
bool | Render (const Int32Array page_index_array, const common::Renderer &renderer) |
Draw the current paragraph editing operation status on the rendering. More... | |
bool | SelectAll () |
Select all text. More... | |
void | SetAlignment (foxit::common::Alignment alignment) |
Set text alignment for text. More... | |
void | SetBold (bool is_bold) |
Set bold status for text. More... | |
void | SetBulletedList (BulletType bullet_type) |
Set bullet list for text. More... | |
void | SetCharHorizontalScale (int scale) |
Set char horizontal scale for text. More... | |
void | SetCharSpace (float char_space) |
Set char space for text. More... | |
void | SetFontName (const WString &font_name) |
Set font name for text. More... | |
void | SetFontSize (float font_size) |
Set the font size for text. More... | |
void | SetItalic (bool is_italic) |
Set italic status for text. More... | |
void | SetLineSpace (float line_space) |
Set line space for text. More... | |
void | SetNumberedList (NumberingType numbering_type) |
Set the look of numbering for text. More... | |
void | SetParagraphSpacing (float paragraph_space) |
Set paragraph spacing for text. More... | |
void | SetStrikethrough (bool is_striketrough) |
Set strikeout word style for text. More... | |
void | SetSubscript (bool is_subscript) |
Set the word property of subscript type for text. More... | |
void | SetSuperscript (bool is_superscript) |
Set the word property of superscript type for text. More... | |
void | SetTextColor (RGB text_color) |
Set text color for text. More... | |
void | SetUnderline (bool is_underline) |
Set underline for text. More... | |
void | StartEditing (int page_index, const PointF &start_point, const PointF &end_point) |
Start paragraph editing. More... | |
![]() | |
FS_HANDLE | Handle () const |
Get the handle of current object. More... | |
This class represents a paragraph edit operation. Before use any methods of paragraph edit function, please ensure the function ParagraphEditing::Activate has been called. Please call the function ParagraphEditing::Deactivate to deactivate when no need to use any paragraph edit function.
Enumeration for bullet type.
Values of this enumeration should be used alone.
Enumeration for numbering type.
Values of this enumeration should be used alone.
foxit::addon::pageeditor::ParagraphEditing::ParagraphEditing | ( | const ParagraphEditing & | other | ) |
Constructor, with another paragraph edit object.
[in] | other | Another paragraph edit object. |
bool foxit::addon::pageeditor::ParagraphEditing::Activate | ( | ) |
Activate paragraph editing.
bool foxit::addon::pageeditor::ParagraphEditing::CanCopy | ( | ) |
Check whether can copy text.
bool foxit::addon::pageeditor::ParagraphEditing::CanCut | ( | ) |
Check whether can cut text.
bool foxit::addon::pageeditor::ParagraphEditing::CanDelete | ( | ) |
Check whether can delete text.
bool foxit::addon::pageeditor::ParagraphEditing::CanDeselectAll | ( | ) |
Check whether can deselect all text.
bool foxit::addon::pageeditor::ParagraphEditing::CanPaste | ( | ) |
Check whether can paste text.
bool foxit::addon::pageeditor::ParagraphEditing::CanSelectAll | ( | ) |
Check whether can select all text.
bool foxit::addon::pageeditor::ParagraphEditing::CopySelected | ( | ) |
Copy the selected text.
bool foxit::addon::pageeditor::ParagraphEditing::CutSelected | ( | ) |
Cut the selected text.
bool foxit::addon::pageeditor::ParagraphEditing::Deactivate | ( | ) |
Deactivate paragraph editing.
void foxit::addon::pageeditor::ParagraphEditing::Dedent | ( | ) |
Decrease indent for text.
bool foxit::addon::pageeditor::ParagraphEditing::DeleteSelected | ( | ) |
Delete the selected text.
bool foxit::addon::pageeditor::ParagraphEditing::DeselectAll | ( | ) |
Deselect all text.
void foxit::addon::pageeditor::ParagraphEditing::ExitEditing | ( | bool | is_end_directly = false | ) |
Exit paragraph editing.
[in] | is_end_directly | Whether to end editing directly. |
void foxit::addon::pageeditor::ParagraphEditing::Indent | ( | ) |
Increase indent for text.
bool foxit::addon::pageeditor::ParagraphEditing::InsertText | ( | const WString & | text | ) |
Call this function when insert text into the page.
[in] | text | The text to be inserted. |
bool foxit::addon::pageeditor::ParagraphEditing::IsEmpty | ( | ) | const |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
bool foxit::addon::pageeditor::ParagraphEditing::OnChar | ( | uint32 | char_code | ) |
Call this function when a character code is being input.
[in] | char_code | A character code, in UTF16-LE encoding. |
bool foxit::addon::pageeditor::ParagraphEditing::OnKeyDown | ( | uint32 | key_code | ) |
Call this function when key on the keyboard is down.
[in] | key_code | The key code. Please refer to values starting from pdf::interform::Filler::e_VkeyUnknown and this should be one of these values. |
bool foxit::addon::pageeditor::ParagraphEditing::OnKeyUp | ( | uint32 | key_code | ) |
Call this function when key on the keyboard is up.
[in] | key_code | The key code. Please refer to values starting from pdf::interform::Filler::e_VkeyUnknown and this should be one of these values. |
bool foxit::addon::pageeditor::ParagraphEditing::OnLButtonDoubleClick | ( | int | page_index, |
const PointF & | 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 foxit::addon::pageeditor::ParagraphEditing::OnLButtonDown | ( | int | page_index, |
const PointF & | 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 foxit::addon::pageeditor::ParagraphEditing::OnLButtonUp | ( | int | page_index, |
const PointF & | 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 foxit::addon::pageeditor::ParagraphEditing::OnMouseMove | ( | int | page_index, |
const PointF & | 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 foxit::addon::pageeditor::ParagraphEditing::OnMouseWheel | ( | int | page_index, |
const PointF & | point, | ||
int32 | 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 foxit::addon::pageeditor::ParagraphEditing::operator!= | ( | const ParagraphEditing & | other | ) | const |
Not equal operator.
[in] | other | Another paragraph edit object. This function will check if current object is not equal to this one. |
ParagraphEditing& foxit::addon::pageeditor::ParagraphEditing::operator= | ( | const ParagraphEditing & | other | ) |
Assign operator.
[in] | other | Another paragraph edit object, whose value would be assigned to current object. |
bool foxit::addon::pageeditor::ParagraphEditing::operator== | ( | const ParagraphEditing & | other | ) | const |
Equal operator.
[in] | other | Another paragraph edit object. This function will check if current object is equal to this one. |
bool foxit::addon::pageeditor::ParagraphEditing::PasteSelected | ( | ) |
Paste the copied text.
bool foxit::addon::pageeditor::ParagraphEditing::Render | ( | const Int32Array | page_index_array, |
const common::Renderer & | 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 foxit::addon::pageeditor::ParagraphEditing::SelectAll | ( | ) |
Select all text.
void foxit::addon::pageeditor::ParagraphEditing::SetAlignment | ( | foxit::common::Alignment | alignment | ) |
Set text alignment for text.
[in] | alignment | Alignment value.Please refer to values starting from common::e_AlignmentLeft and this should be one of these values. |
void foxit::addon::pageeditor::ParagraphEditing::SetBold | ( | bool | is_bold | ) |
Set bold status for text.
[in] | is_bold | Whether to set selected text as bold. true means current selected text will be set as bold, while false means not. |
void foxit::addon::pageeditor::ParagraphEditing::SetBulletedList | ( | BulletType | 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 foxit::addon::pageeditor::e_BulletTypeNone and this should be one of these values. |
void foxit::addon::pageeditor::ParagraphEditing::SetCharHorizontalScale | ( | int | scale | ) |
Set char horizontal scale for text.
[in] | scale | The scale. It should be bigger than 0. |
void foxit::addon::pageeditor::ParagraphEditing::SetCharSpace | ( | float | char_space | ) |
Set char space for text.
[in] | char_space | The char space (unit is 1/72 inch). |
void foxit::addon::pageeditor::ParagraphEditing::SetFontName | ( | const WString & | font_name | ) |
Set font name for text.
[in] | font_name | The font name. |
void foxit::addon::pageeditor::ParagraphEditing::SetFontSize | ( | float | font_size | ) |
Set the font size for text.
[in] | font_size | The font size. |
void foxit::addon::pageeditor::ParagraphEditing::SetItalic | ( | bool | is_italic | ) |
Set italic status for text.
[in] | is_italic | Whether to set selected text as italic. true means current selected text will be set as italic, while false means not. |
void foxit::addon::pageeditor::ParagraphEditing::SetLineSpace | ( | float | line_space | ) |
Set line space for text.
[in] | line_space | The line space (unit is 1/72 inch). |
void foxit::addon::pageeditor::ParagraphEditing::SetNumberedList | ( | NumberingType | numbering_type | ) |
Set the look of numbering for text.
[in] | numbering_type | The type of numbering. Please refer to values starting from foxit::addon::pageeditor::e_NumberingTypeNone and this should be one of these values. |
void foxit::addon::pageeditor::ParagraphEditing::SetParagraphSpacing | ( | float | paragraph_space | ) |
Set paragraph spacing for text.
[in] | paragraph_space | The paragraph spacing. |
void foxit::addon::pageeditor::ParagraphEditing::SetStrikethrough | ( | bool | is_striketrough | ) |
Set strikeout word style for text.
[in] | is_striketrough | true means to set the strikeout word style, while false means not. |
void foxit::addon::pageeditor::ParagraphEditing::SetSubscript | ( | bool | is_subscript | ) |
Set the word property of subscript type for text.
[in] | is_sub_script | true means to set the word property of subscript type, while false means not. |
void foxit::addon::pageeditor::ParagraphEditing::SetSuperscript | ( | bool | is_superscript | ) |
Set the word property of superscript type for text.
[in] | is_super_set | true means to set the word property of superscript type, while false means not. |
void foxit::addon::pageeditor::ParagraphEditing::SetTextColor | ( | RGB | text_color | ) |
Set text color for text.
[in] | text_color | The text color. |
void foxit::addon::pageeditor::ParagraphEditing::SetUnderline | ( | bool | is_underline | ) |
Set underline for text.
[in] | is_underline | true means to underline text, while false means not. |
void foxit::addon::pageeditor::ParagraphEditing::StartEditing | ( | int | page_index, |
const PointF & | start_point, | ||
const PointF & | 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. |