Foxit PDF SDK
foxit::addon::xfa::WidgetMenu Class Reference
Inheritance diagram for foxit::addon::xfa::WidgetMenu:
foxit::Base

Public Member Functions

 WidgetMenu (const XFAWidget &xfa_widget)
 Constructor, from XFA widget object. More...
 
 WidgetMenu (const WidgetMenu &other)
 Constructor, with another widget menu object. More...
 
 ~WidgetMenu ()
 Destructor.
 
bool Bold ()
 (Only useful for rich text) Make the rich text bold. More...
 
bool CanCopy ()
 Check if the text of related XFA widget can be copied. More...
 
bool CanCut ()
 Check if the text of related XFA widget can be cut. More...
 
bool CanDelete ()
 Check if the text of related XFA widget can be deleted. More...
 
bool CanDeSelect ()
 Check if the selection of the text in related XFA widget can be canceled. More...
 
bool CanPaste ()
 Check if the text of related XFA widget can be pasted. More...
 
bool CanRedo ()
 Check if the operation of related XFA widget can be redone. More...
 
bool CanSelectAll ()
 Check if the text of related XFA widget can be selected all. More...
 
bool CanUndo ()
 Check if the operation of related XFA widget can be undone. More...
 
bool ClearStyle ()
 (Only useful for rich text) Clear the style of the rich text. More...
 
WString Copy ()
 Copy the text of related XFA widget. More...
 
WString Cut ()
 Cut the text of related XFA widget. More...
 
bool Delete ()
 Delete all the text of related XFA widget. More...
 
bool DeSelect ()
 Cancel the selection of the text in related XFA widget. More...
 
bool IsEmpty () const
 Check whether current object is empty or not. More...
 
bool Italic ()
 (Only useful for rich text) Make the rich text italic. More...
 
bool operator!= (const WidgetMenu &other) const
 Not equal operator. More...
 
WidgetMenuoperator= (const WidgetMenu &other)
 Assign operator. More...
 
bool operator== (const WidgetMenu &other) const
 Equal operator. More...
 
bool Paste (const wchar_t *text)
 Paste the text to related XFA widget. More...
 
bool Redo ()
 Redo the operation of related XFA widget. (No effect for rich text) More...
 
bool SelectAll ()
 Select all the text of related XFA widget. More...
 
bool Subscript ()
 (Only useful for rich text) Make the rich text as subscript. More...
 
bool Superscript ()
 (Only useful for rich text) Make the rich text as superscript. More...
 
bool Underline ()
 (Only useful for rich text) Underline the rich text. More...
 
bool Undo ()
 Undo the operation of related XFA widget. (No effect for rich text) More...
 
- Public Member Functions inherited from foxit::Base
FS_HANDLE Handle () const
 Get the handle of current object. More...
 

Detailed Description

Class WidgetMenu represents the menu of a XFA widget.

Constructor & Destructor Documentation

◆ WidgetMenu() [1/2]

foxit::addon::xfa::WidgetMenu::WidgetMenu ( const XFAWidget xfa_widget)
explicit

Constructor, from XFA widget object.

Parameters
[in]xfa_widgetA valid XFA widget object.

◆ WidgetMenu() [2/2]

foxit::addon::xfa::WidgetMenu::WidgetMenu ( const WidgetMenu other)

Constructor, with another widget menu object.

Parameters
[in]otherAnother widget menu object.

Member Function Documentation

◆ Bold()

bool foxit::addon::xfa::WidgetMenu::Bold ( )

(Only useful for rich text) Make the rich text bold.

Returns
true means success, while false means failure.

◆ CanCopy()

bool foxit::addon::xfa::WidgetMenu::CanCopy ( )

Check if the text of related XFA widget can be copied.

Returns
true means the text can be copied, while false means the text cannot be copied.

◆ CanCut()

bool foxit::addon::xfa::WidgetMenu::CanCut ( )

Check if the text of related XFA widget can be cut.

Returns
true means the text can be cut, while false means the text cannot be cut.

◆ CanDelete()

bool foxit::addon::xfa::WidgetMenu::CanDelete ( )

Check if the text of related XFA widget can be deleted.

Returns
true means the text can be deleted, while false means the text cannot be deleted.

◆ CanDeSelect()

bool foxit::addon::xfa::WidgetMenu::CanDeSelect ( )

Check if the selection of the text in related XFA widget can be canceled.

Returns
true means the selection can be canceled, while false means the selection cannot be canceled.

◆ CanPaste()

bool foxit::addon::xfa::WidgetMenu::CanPaste ( )

Check if the text of related XFA widget can be pasted.

Returns
true means the text can be pasted, while false means the text cannot be pasted.

◆ CanRedo()

bool foxit::addon::xfa::WidgetMenu::CanRedo ( )

Check if the operation of related XFA widget can be redone.

Returns
true means the operation can be redone, while false means the operation cannot be redone.

◆ CanSelectAll()

bool foxit::addon::xfa::WidgetMenu::CanSelectAll ( )

Check if the text of related XFA widget can be selected all.

Returns
true means the text can be selected all, while false means the text cannot be selected all.

◆ CanUndo()

bool foxit::addon::xfa::WidgetMenu::CanUndo ( )

Check if the operation of related XFA widget can be undone.

Returns
true means the operation can be undone, while false means the operation cannot be undone.

◆ ClearStyle()

bool foxit::addon::xfa::WidgetMenu::ClearStyle ( )

(Only useful for rich text) Clear the style of the rich text.

Returns
true means success, while false means failure.

◆ Copy()

WString foxit::addon::xfa::WidgetMenu::Copy ( )

Copy the text of related XFA widget.

Returns
The copied text.

◆ Cut()

WString foxit::addon::xfa::WidgetMenu::Cut ( )

Cut the text of related XFA widget.

Returns
The cut text.

◆ Delete()

bool foxit::addon::xfa::WidgetMenu::Delete ( )

Delete all the text of related XFA widget.

Returns
true means success, while false means failure.

◆ DeSelect()

bool foxit::addon::xfa::WidgetMenu::DeSelect ( )

Cancel the selection of the text in related XFA widget.

Returns
true means success, while false means failure.

◆ IsEmpty()

bool foxit::addon::xfa::WidgetMenu::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.

◆ Italic()

bool foxit::addon::xfa::WidgetMenu::Italic ( )

(Only useful for rich text) Make the rich text italic.

Returns
true means success, while false means failure.

◆ operator!=()

bool foxit::addon::xfa::WidgetMenu::operator!= ( const WidgetMenu other) const

Not equal operator.

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

◆ operator=()

WidgetMenu& foxit::addon::xfa::WidgetMenu::operator= ( const WidgetMenu other)

Assign operator.

Parameters
[in]otherAnother widget menu object, whose value would be assigned to current object.
Returns
Reference to current object itself.

◆ operator==()

bool foxit::addon::xfa::WidgetMenu::operator== ( const WidgetMenu other) const

Equal operator.

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

◆ Paste()

bool foxit::addon::xfa::WidgetMenu::Paste ( const wchar_t *  text)

Paste the text to related XFA widget.

Parameters
[in]textA text string to be pasted.
Returns
true means success, while false means failure.

◆ Redo()

bool foxit::addon::xfa::WidgetMenu::Redo ( )

Redo the operation of related XFA widget. (No effect for rich text)

Returns
true means success, while false means failure.

◆ SelectAll()

bool foxit::addon::xfa::WidgetMenu::SelectAll ( )

Select all the text of related XFA widget.

Returns
true means success, while false means failure.

◆ Subscript()

bool foxit::addon::xfa::WidgetMenu::Subscript ( )

(Only useful for rich text) Make the rich text as subscript.

Returns
true means success, while false means failure.

◆ Superscript()

bool foxit::addon::xfa::WidgetMenu::Superscript ( )

(Only useful for rich text) Make the rich text as superscript.

Returns
true means success, while false means failure.

◆ Underline()

bool foxit::addon::xfa::WidgetMenu::Underline ( )

(Only useful for rich text) Underline the rich text.

Returns
true means success, while false means failure.

◆ Undo()

bool foxit::addon::xfa::WidgetMenu::Undo ( )

Undo the operation of related XFA widget. (No effect for rich text)

Returns
true means success, while false means failure.