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

Instance Methods

(instancetype) - initWithCustomItem:
 Initialization method. More...
 
(instancetype) - initWithToolSettings:
 Initialization method. More...
 
(instancetype) - initWithToolSettings:withItemContentType:
 Initialization method. More...
 
(instancetype) - initWithToolSettingType:
 Initialization method. More...
 
(instancetype) - initWithToolSettingType:withItemContentType:
 Initialization method. More...
 
(BOOL) - replaceSettings:
 Replace tool settings,It is valid only if the control is not initialized. More...
 

Properties

FSMainToolbarItemcustomItem
 Get the custom Item. If it doesn't exist, it will be nil. More...
 
BOOL enabled
 A Boolean value indicating whether the item is enabled. More...
 
FSItemContentType itemContentType
 
UIColor * propertyColor
 Get the current item property color, If it doesn't exist, it will be nil. More...
 
FSReadToolbarItemType readToolbarItemType
 Get the current read tool item type. More...
 
FSReadToolSettingsType settingsType
 Get the tool settings type. If toolSettings doesn't exist, it will be 0. More...
 
FSReadToolSettingstoolSettings
 Get the tool settings Item. If it doesn't exist, it will be nil. More...
 

Method Documentation

◆ initWithCustomItem:

- (instancetype) initWithCustomItem: (FSMainToolbarItem *)  customItem

Initialization method.

Parameters
[in]customItemCreate your own item.
Returns
The read tool item.

◆ initWithToolSettings:

- (instancetype) initWithToolSettings: (FSReadToolSettings *)  toolSettings

Initialization method.

Parameters
[in]toolSettingsThe tool settings. The item is created with the tool settings passed in.
Returns
The read tool item.

◆ initWithToolSettings:withItemContentType:

- (instancetype) initWithToolSettings: (FSReadToolSettings *)  toolSettings
withItemContentType: (FSItemContentType itemContentType 

Initialization method.

Parameters
[in]toolSettingsThe tool settings. The item is created with the tool settings passed in.
Returns
The read tool item.

◆ initWithToolSettingType:

- (instancetype) initWithToolSettingType: (FSReadToolSettingsType settingType

Initialization method.

Parameters
[in]settingTypeThe read tool settings .Please refer to {@linkFSReadToolSettingsTypeXXX} and FSReadToolSettingsType values and it would be one of these values.
Returns
The read tool item.

◆ initWithToolSettingType:withItemContentType:

- (instancetype) initWithToolSettingType: (FSReadToolSettingsType settingType
withItemContentType: (FSItemContentType itemContentType 

Initialization method.

Parameters
[in]settingTypeThe read tool settings .Please refer to {@linkFSReadToolSettingsTypeXXX} and FSReadToolSettingsType values and it would be one of these values.
Returns
The read tool item.

◆ replaceSettings:

- (BOOL) replaceSettings: (FSReadToolSettings *)  settings

Replace tool settings,It is valid only if the control is not initialized.

Parameters
[in]settingsThe tool settings.
Returns
Whether the replacement is successful.

Property Documentation

◆ customItem

- (FSMainToolbarItem*) customItem
readnonatomicstrong

Get the custom Item. If it doesn't exist, it will be nil.

◆ enabled

- (BOOL) enabled
readwritenonatomicassign

A Boolean value indicating whether the item is enabled.

◆ itemContentType

- (FSItemContentType) itemContentType
readnonatomicassign

◆ propertyColor

- (UIColor*) propertyColor
readnonatomicstrong

Get the current item property color, If it doesn't exist, it will be nil.

◆ readToolbarItemType

- (FSReadToolbarItemType) readToolbarItemType
readnonatomicassign

Get the current read tool item type.

◆ settingsType

- (FSReadToolSettingsType) settingsType
readnonatomicassign

Get the tool settings type. If toolSettings doesn't exist, it will be 0.

◆ toolSettings

- (FSReadToolSettings*) toolSettings
readnonatomicstrong

Get the tool settings Item. If it doesn't exist, it will be nil.