Foxit PDF SDK
FSWidgetMenu Class Reference
Inheritance diagram for FSWidgetMenu:
FSBase

Instance Methods

(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...
 
(NSString *) - copy
 Copy the text of related XFA widget.
More...
 
(NSString *) - 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...
 
(id) - initWithOther:
 Constructor, with another widget menu object.
More...
 
(id) - initWithXfa_widget:
 Constructor, from XFA widget object.
More...
 
(BOOL) - isEmpty
 Check whether current object is empty or not.
More...
 
(BOOL) - italic
 (Only useful for rich text) Make the rich text italic.
More...
 
(BOOL) - paste:
 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...
 

Detailed Description

Class FSWidgetMenu represents the menu of a XFA widget.

Method Documentation

◆ bold()

- (BOOL) bold

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

Returns
YES means success, while NO means failure.

◆ canCopy()

- (BOOL) canCopy

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

Returns
YES means the text can be copied, while NO means the text cannot be copied.

◆ canCut()

- (BOOL) canCut

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

Returns
YES means the text can be cut, while NO means the text cannot be cut.

◆ canDelete()

- (BOOL) canDelete

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

Returns
YES means the text can be deleted, while NO means the text cannot be deleted.

◆ canDeSelect()

- (BOOL) canDeSelect

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

Returns
YES means the selection can be canceled, while NO means the selection cannot be canceled.

◆ canPaste()

- (BOOL) canPaste

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

Returns
YES means the text can be pasted, while NO means the text cannot be pasted.

◆ canRedo()

- (BOOL) canRedo

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

Returns
YES means the operation can be redone, while NO means the operation cannot be redone.

◆ canSelectAll()

- (BOOL) canSelectAll

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

Returns
YES means the text can be selected all, while NO means the text cannot be selected all.

◆ canUndo()

- (BOOL) canUndo

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

Returns
YES means the operation can be undone, while NO means the operation cannot be undone.

◆ clearStyle()

- (BOOL) clearStyle

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

Returns
YES means success, while NO means failure.

◆ copy()

- (NSString *) copy

Copy the text of related XFA widget.

Returns
The copied text.

◆ cut()

- (NSString *) cut

Cut the text of related XFA widget.

Returns
The cut text.

◆ delete()

- (BOOL) delete

Delete all the text of related XFA widget.

Returns
YES means success, while NO means failure.

◆ deSelect()

- (BOOL) deSelect

Cancel the selection of the text in related XFA widget.

Returns
YES means success, while NO means failure.

◆ initWithOther:()

- (id) initWithOther: (FSWidgetMenu*)  other

Constructor, with another widget menu object.

Parameters
[in]otherAnother widget menu object.

◆ initWithXfa_widget:()

- (id) initWithXfa_widget: (FSXFAWidget*)  xfa_widget

Constructor, from XFA widget object.

Parameters
[in]xfa_widgetA valid XFA widget object.

◆ isEmpty()

- (BOOL) isEmpty

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
YES means current object is empty, while NO means not.

◆ italic()

- (BOOL) italic

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

Returns
YES means success, while NO means failure.

◆ paste:()

- (BOOL) paste: (NSString *)  text

Paste the text to related XFA widget.

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

◆ redo()

- (BOOL) redo

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

Returns
YES means success, while NO means failure.

◆ selectAll()

- (BOOL) selectAll

Select all the text of related XFA widget.

Returns
YES means success, while NO means failure.

◆ subscript()

- (BOOL) subscript

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

Returns
YES means success, while NO means failure.

◆ superscript()

- (BOOL) superscript

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

Returns
YES means success, while NO means failure.

◆ underline()

- (BOOL) underline

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

Returns
YES means success, while NO means failure.

◆ undo()

- (BOOL) undo

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

Returns
YES means success, while NO means failure.