Foxit PDF SDK  9.1
FSButtonItem Class Reference
Inheritance diagram for FSButtonItem:

Instance Methods

(void) - dealloc
 
(void *) - getCptr
 
(id) - init
 Constructor.
More...
 
(id) - initWithButton_item:
 Constructor, with another button item object.
More...
 
(id) - initWithCptr:swigOwnCObject:
 
(id) - initWithName:pos:exec:enable:marked:tooltip:label:bitmap:
 Constructor, with parameters.
More...
 
(void) - set:pos:exec:enable:marked:tooltip:label:bitmap:
 Set values.
More...
 

Protected Attributes

BOOL swigCMemOwn
 
void * swigCPtr
 

Properties

FSBitmapbitmap
 A bitmap object of button.
More...
 
NSString * enable
 An expression string that determines whether to enable the toolbutton.
More...
 
NSString * exec
 The expression string to evaluate when the button is selected.
More...
 
NSString * label
 A text label to be displayed on the button to the right of the icon.
More...
 
NSString * marked
 An expression string that determines whether the toolbutton is marked.
More...
 
NSString * name
 A unique language-independent identifier for the button.
More...
 
int pos
 The button number to place the added button in the toolbar.
More...
 
NSString * tooltip
 The text to display in the button help text when the mouse is over the toolbutton.
More...
 

Detailed Description

This class represents button item.

Method Documentation

◆ dealloc

- (void) dealloc

◆ getCptr

- (void*) getCptr

◆ init

- (id) init

Constructor.

◆ initWithButton_item:

- (id) initWithButton_item: (FSButtonItem*)  button_item

Constructor, with another button item object.

Parameters
[in]button_itemAnother button item object.

◆ initWithCptr:swigOwnCObject:

- (id) initWithCptr: (void *)  cptr
swigOwnCObject: (BOOL)  ownCObject 

◆ initWithName:pos:exec:enable:marked:tooltip:label:bitmap:

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

Constructor, with parameters.

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.

◆ 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.

Member Data Documentation

◆ swigCMemOwn

- (BOOL) swigCMemOwn
protected

◆ swigCPtr

- (void*) swigCPtr
protected

Property Documentation

◆ bitmap

- (FSBitmap *) bitmap
readwritenonatomiccopy

A bitmap object of button.

◆ enable

- (NSString *) enable
readwritenonatomiccopy

An expression string that determines whether to enable the toolbutton.

◆ exec

- (NSString *) exec
readwritenonatomiccopy

The expression string to evaluate when the button is selected.

◆ label

- (NSString *) label
readwritenonatomiccopy

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

◆ marked

- (NSString *) marked
readwritenonatomiccopy

An expression string that determines whether the toolbutton is marked.

◆ name

- (NSString *) name
readwritenonatomiccopy

A unique language-independent identifier for the button.

◆ pos

- (int) pos
readwritenonatomicassign

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

◆ tooltip

- (NSString *) tooltip
readwritenonatomiccopy

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