This class represents a join split operation. Before use join split feature, ensure the function fsdk.JoinSplit.Activate has been called successfully. Please call the function fsdk.JoinSplit.Deactivate to deactivate when no need to use any join split function.
◆ Activate()
| def fsdk.JoinSplit.Activate |
( |
| ) |
|
Activate join split editing.
- Returns
- true means success, while false means failure.
◆ Deactivate()
| def fsdk.JoinSplit.Deactivate |
( |
| ) |
|
Deactivate join split editing.
- Returns
- true means success, while false means failure.
◆ ExitJoinEditing()
| def fsdk.JoinSplit.ExitJoinEditing |
( |
| ) |
|
Exit join split editing.
- Returns
- None.
◆ GetEnableStatus()
| def fsdk.JoinSplit.GetEnableStatus |
( |
|
type | ) |
|
Get join split editing operation state.
- Returns
- true means enabled, while false means not.
◆ IsEmpty()
| def fsdk.JoinSplit.IsEmpty |
( |
| ) |
|
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
- Returns
- true means current object is empty, while false means not.
◆ JoinBoxes()
| def fsdk.JoinSplit.JoinBoxes |
( |
| ) |
|
Call this function to join text.
- Returns
- None.
◆ LinkBoxes()
| def fsdk.JoinSplit.LinkBoxes |
( |
| ) |
|
Call this function to link text.
- Returns
- None.
◆ OnLButtonDown()
| def fsdk.JoinSplit.OnLButtonDown |
( |
|
page_index, |
|
|
|
point |
|
) |
| |
Call this function when left mouse button is down.
- Parameters
-
| [in] | page_index | The page index. |
| [in] | point | A point where left mouse button is down in the page, in device coordinate system. |
- Returns
- true means success, while false means failure.
◆ OnLButtonUp()
| def fsdk.JoinSplit.OnLButtonUp |
( |
|
page_index, |
|
|
|
point |
|
) |
| |
Call this function when left mouse button is up.
- Parameters
-
| [in] | page_index | The page index. |
| [in] | point | A point where left mouse button is up in the page, in device coordinate system. |
- Returns
- true means success, while false means failure.
◆ OnMouseMove()
| def fsdk.JoinSplit.OnMouseMove |
( |
|
page_index, |
|
|
|
point |
|
) |
| |
Call this function when mouse moves.
- Parameters
-
| [in] | page_index | The page index. |
| [in] | point | A point where mouse moves in the page, in device coordinate system. |
- Returns
- true means success, while false means failure.
◆ Render()
| def fsdk.JoinSplit.Render |
( |
|
page_index_array, |
|
|
|
renderer |
|
) |
| |
Draw the currently join split operation state on the rendering.
The matrix used in the rendering process is returned by fsdk.ParagraphEditingProviderCallback.GetRenderMatrix .
- Parameters
-
| [in] | page_index_array | The page index array to render. |
| [in] | renderer | A valid renderer object for rendering. |
- Returns
- true means success, while false means failure.
◆ SelectNone()
| def fsdk.JoinSplit.SelectNone |
( |
| ) |
|
Call this function to clear all selected text.
- Returns
- None.
◆ SplitBoxes()
| def fsdk.JoinSplit.SplitBoxes |
( |
| ) |
|
Call this function to split text.
- Returns
- None.
◆ UnlinkBoxes()
| def fsdk.JoinSplit.UnlinkBoxes |
( |
| ) |
|
Call this function to unlink text.
- Returns
- None.