Foxit PDF SDK
FSButtonItem Class Reference

Inherits NSObject.

Instance Methods

(id) - init
 Constructor.

 
(id) - initWithButton_item:
 Constructor, with another button item object.
More...
 
(void) - set:pos:exec:enable:marked:tooltip:label:bitmap:
 Set values.
More...
 

Properties

FSBitmapbitmap
 A bitmap object of button.

 
NSString * enable
 An expression string that determines whether to enable the toolbutton.

 
NSString * exec
 The expression string to evaluate when the button is selected.

 
NSString * label
 A text label to be displayed on the button to the right of the icon.

 
NSString * marked
 An expression string that determines whether the toolbutton is marked.

 
NSString * name
 A unique language-independent identifier for the button.

 
int pos
 The button number to place the added button in the toolbar.

 
NSString * tooltip
 The text to display in the button help text when the mouse is over the toolbutton.

 

Detailed Description

This class represents button item.

Method Documentation

◆ initWithButton_item:()

- (id) initWithButton_item: (FSButtonItem*)  button_item

Constructor, with another button item object.

Parameters
[in]button_itemAnother button item object.

◆ set:pos:exec:enable:marked:tooltip:label:bitmap:()

- (void) set: (NSString *)  name
pos: (int)  pos
exec: (NSString *)  exec
enable: (NSString *)  enable
marked: (NSString *)  marked
tooltip: (NSString *)  tooltip
label: (NSString *)  label
bitmap: (FSBitmap*)  bitmap 

Set values.

Parameters
[in]nameA unique language-independent identifier for the button.
[in]posThe button number to place the added button in the toolbar.
[in]execThe expression string to evaluate when the button is selected.
[in]enableAn expression string that determines whether to enable the toolbutton.
[in]markedAn expression string that determines whether the toolbutton is marked.
[in]tooltipThe text to display in the button help text when the mouse is over the toolbutton.
[in]labelA text label to be displayed on the button to the right of the icon.
[in]bitmapA bitmap object of button.
Returns
None.