Foxit PDF SDK
foxit::addon::pageeditor::ParagraphEditingMgr Class Reference
Inheritance diagram for foxit::addon::pageeditor::ParagraphEditingMgr:
foxit::Base

Public Member Functions

 ParagraphEditingMgr (const ParagraphEditingMgr &other)
 Constructor, with another paragraph edit manager object. More...
 
 ParagraphEditingMgr (ParagraphEditingProviderCallback *callback, const pdf::PDFDoc &document)
 Constructor. More...
 
 ~ParagraphEditingMgr ()
 Destructor.
 
JoinSplit GetJoinSplit ()
 Get the join split object. More...
 
ParagraphEditing GetParagraphEditing ()
 Get the paragraph edit object. More...
 
bool IsEmpty () const
 Check whether current object is empty or not. More...
 
bool operator!= (const ParagraphEditingMgr &other) const
 Not equal operator. More...
 
ParagraphEditingMgroperator= (const ParagraphEditingMgr &other)
 Assign operator. More...
 
bool operator== (const ParagraphEditingMgr &other) const
 Equal operator. More...
 
void SetSystemDPI (float horizontal_dpi, float vertical_dpi)
 Set the dpi for the paragraph editing provider used. More...
 
- Public Member Functions inherited from foxit::Base
FS_HANDLE Handle () const
 Get the handle of current object. More...
 

Detailed Description

This class represents a paragraph editing manager used for editing PDF page.

User can call the function ParagraphEditingMgr::GetParagraphEditing to get current ParagraphEditing object in the process of using edit page. User can call the function ParagraphEditingMgr::GetJoinSplit to get current JoinSplit object in the process of using edit page.

See also
ParagraphEditing
JoinSplit

Constructor & Destructor Documentation

◆ ParagraphEditingMgr() [1/2]

foxit::addon::pageeditor::ParagraphEditingMgr::ParagraphEditingMgr ( ParagraphEditingProviderCallback callback,
const pdf::PDFDoc document 
)
explicit

Constructor.

Parameters
[in]callbackA valid paragraph editing provider callback object.
[in]documentA valid PDF document object.

◆ ParagraphEditingMgr() [2/2]

foxit::addon::pageeditor::ParagraphEditingMgr::ParagraphEditingMgr ( const ParagraphEditingMgr other)

Constructor, with another paragraph edit manager object.

Parameters
[in]otherAnother paragraph edit manager object.

Member Function Documentation

◆ GetJoinSplit()

JoinSplit foxit::addon::pageeditor::ParagraphEditingMgr::GetJoinSplit ( )

Get the join split object.

Returns
The JoinSplit object.

◆ GetParagraphEditing()

ParagraphEditing foxit::addon::pageeditor::ParagraphEditingMgr::GetParagraphEditing ( )

Get the paragraph edit object.

Returns
The ParagraphEditing object.

◆ IsEmpty()

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

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.

◆ operator!=()

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

Not equal operator.

Parameters
[in]otherAnother paragraph edit manager object. This function will check if current object is not equal to this one.
Returns
true means not equal, while false means equal.

◆ operator=()

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

Assign operator.

Parameters
[in]otherAnother paragraph edit manager object, whose value would be assigned to current object.
Returns
Reference to current object itself.

◆ operator==()

bool foxit::addon::pageeditor::ParagraphEditingMgr::operator== ( const ParagraphEditingMgr other) const

Equal operator.

Parameters
[in]otherAnother paragraph edit manager object. This function will check if current object is equal to this one.
Returns
true means equal, while false means not equal.

◆ SetSystemDPI()

void foxit::addon::pageeditor::ParagraphEditingMgr::SetSystemDPI ( float  horizontal_dpi,
float  vertical_dpi 
)

Set the dpi for the paragraph editing provider used.

Parameters
[in]horizontal_dpiA horizontal dpi for paragraph editing provider. It should be greater than 0.Default Value:96.
[in]vertical_dpiA vertical dpi for paragraph editing provider. It should be greater than 0. Default Value:96.
Returns
None.