Foxit PDF SDK  9.1
FSMainToolbar.h
1 
13 #import <Foundation/Foundation.h>
14 
15 NS_ASSUME_NONNULL_BEGIN
16 
17 @class FSReadToolbarItem;
19 typedef NS_ENUM(NSInteger, FSMainToolbarItemPosition) {
26 };
28 typedef NS_ENUM(NSUInteger, FSMainTopbarToolTag) {
47 };
48 
50 typedef NS_ENUM(NSUInteger, FSMainToolbarItemType) {
73 
82 
85 };
86 
88 typedef NS_ENUM(NSUInteger, FSTopbarSubitemContentViewPosition) {
95 };
96 
97 @interface FSMainToolbarItem : NSObject
99 + (instancetype)new NS_UNAVAILABLE;
100 - (instancetype)init NS_UNAVAILABLE;
101 
103 @property (nonatomic, assign, readonly) FSMainToolbarItemType itemType;
105 @property (nonatomic, assign) CGFloat spacing;
107 @property (nonatomic, assign) CGFloat width;
109 @property (nonatomic, strong, readonly, nullable) UIView *customView;
110 
116 - (instancetype)initWithCustomView:(UIView *)customView;
117 @end
118 
119 @interface FSMainToolbar : NSObject
121 + (instancetype)new NS_UNAVAILABLE;
122 - (instancetype)init NS_UNAVAILABLE;
123 
125 @property (nonatomic, copy, nullable) NSArray<FSMainToolbarItem *> *itemsForPositionLeft;
127 @property (nonatomic, copy, nullable) NSArray<FSMainToolbarItem *> *itemsForPositionCenter;
129 @property (nonatomic, copy, nullable) NSArray<FSMainToolbarItem *> *itemsForPositionRight;
131 @property (nonatomic, assign) CGFloat contentHeight;
132 
137 - (__kindof UIStackView *)getToolbarContentView;
138 
140 - (void)addItem:(FSMainToolbarItem *)item atPosition:(FSMainToolbarItemPosition)position;
142 - (void)removeItemAtPosition:(FSMainToolbarItemPosition)position index:(NSUInteger)index;
144 - (void)removeItem:(FSMainToolbarItem *)item atPosition:(FSMainToolbarItemPosition)position;
146 - (void)setBackgroundColor:(UIColor *)color;
147 @end
148 
149 @interface FSMainTopbarToolTagItem : NSObject
151 + (instancetype)new NS_UNAVAILABLE;
152 - (instancetype)init NS_UNAVAILABLE;
153 
155 @property (nonatomic, copy) NSString *title;
157 @property (nonatomic, strong) UIImage *image;
158 
160 @property (nonatomic) UIEdgeInsets phoneTitleEdgeInsets;
161 @property (nonatomic) UIEdgeInsets phoneImageEdgeInsets;
163 @property (nonatomic) UIEdgeInsets padTitleEdgeInsets;
164 @property (nonatomic) UIEdgeInsets padImageEdgeInsets;
165 
167 @property (nonatomic, copy, nullable) NSArray<FSReadToolbarItem *> *readToolbarItems;
169 @property (nonatomic, copy, nullable) NSArray<FSMainToolbarItem *> *mainToolbarItems;
170 
172 @property (nonatomic, assign, readonly) FSMainTopbarToolTag toolTag;
174 @property (nonatomic, assign, readonly) BOOL isOnToolbar;
175 
184 + (instancetype)ItemWithToolTag:(FSMainTopbarToolTag)toolTag readToolbarItems:(nullable NSArray<FSReadToolbarItem *> *)readToolbarItems;
185 @end
186 
187 @protocol IFSMainTopbarEventListener <NSObject>
188 
189 @optional
193 - (void)didShowTagTabPopuper;
204 - (void)didSetCurrentTagItem:(FSMainTopbarToolTagItem *)curTagItem lastTagItem:(FSMainTopbarToolTagItem *)lastTagItem;
210 - (void)onSubitemViewChanged:(FSTopbarSubitemContentViewPosition)position;
211 @end
212 
215 @property (nonatomic, copy, nullable) NSArray<FSMainToolbarItem *> *itemsForPositionCenter NS_UNAVAILABLE;
217 @property (nonatomic, copy, nullable) NSArray<FSMainTopbarToolTagItem *> *tagItems;
219 @property (nonatomic, copy, nullable) NSArray<FSMainTopbarToolTagItem *> *currentNewTagItems;
221 @property (nonatomic, strong, readonly) FSMainTopbarToolTagItem *currentTagItem;
225 @property (nonatomic, assign) CGFloat horizontalContentHeight;
227 @property (nonatomic, assign) CGFloat verticalContentWidth;
229 @property (nonatomic, strong, nullable) __kindof UIView *attachView;
231 - (void)resetCurrentTagItem;
232 
237 - (void)setStateBarColor:(nullable UIColor *)color;
238 
243 - (void)setTagItemBackgroudColor:(nullable UIColor *)color;
244 
251 - (void)registerEventListener:(id<IFSMainTopbarEventListener>)listener;
252 
259 - (void)unregisterEventListener:(id<IFSMainTopbarEventListener>)listener;
260 @end
261 
264 @property (nonatomic, copy, nullable) NSArray<FSMainToolbarItem *> *itemsForPositionLeft NS_UNAVAILABLE;
265 @property (nonatomic, copy, nullable) NSArray<FSMainToolbarItem *> *itemsForPositionRight NS_UNAVAILABLE;
266 
268 @property (nonatomic, assign, getter=isAverage) BOOL average;
269 @end
270 
271 NS_ASSUME_NONNULL_END
-[FSMainTopbar resetCurrentTagItem]
void resetCurrentTagItem()
Reset the tag Item in order to update on the view.Calling this method causes the current toolbar to b...
FSMainTopbarToolTagSign
@ FSMainTopbarToolTagSign
The sign tag.
Definition: FSMainToolbar.h:42
FSMainTopbar::tagItems
NSArray< FSMainTopbarToolTagItem * > * tagItems
Get/Set the main tag Items displayed on the toolbar.
Definition: FSMainToolbar.h:217
FSTopbarSubitemContentViewPositionTop
@ FSTopbarSubitemContentViewPositionTop
The subbar is on the top.
Definition: FSMainToolbar.h:90
FSTopbarSubitemContentViewPositionLeft
@ FSTopbarSubitemContentViewPositionLeft
The subbar is on the left.
Definition: FSMainToolbar.h:92
FSMainTopbarToolTagItem::title
NSString * title
Get/Set the item title.
Definition: FSMainToolbar.h:155
FSMainToolbarItemTypeUndo
@ FSMainToolbarItemTypeUndo
The undo item.
Definition: FSMainToolbar.h:66
FSMainTopbar::attachView
__kindof UIView * attachView
Get/Set the subview to contview.
Definition: FSMainToolbar.h:229
FSMainTopbarToolTagItem::phoneImageEdgeInsets
UIEdgeInsets phoneImageEdgeInsets
Definition: FSMainToolbar.h:161
FSTopbarSubitemContentViewPosition
FSTopbarSubitemContentViewPosition
The subbar is in the bar.
Definition: FSMainToolbar.h:88
FSMainToolbarItemTypeRedo
@ FSMainToolbarItemTypeRedo
The redo item.
Definition: FSMainToolbar.h:64
FSMainTopbarToolTagItem::toolTag
FSMainTopbarToolTag toolTag
Get the existing-supplied tool tag. Please refer to FSMainTopbarToolTagXXX values and it would be one...
Definition: FSMainToolbar.h:172
+[FSMainToolbar NS_UNAVAILABLE]
instancetype NS_UNAVAILABLE()
Disable the default initialization.
FSMainToolbarItemTypeBack
@ FSMainToolbarItemTypeBack
The bark item.
Definition: FSMainToolbar.h:54
FSMainToolbarItemTypeReadingBookmark
@ FSMainToolbarItemTypeReadingBookmark
The bookmark item.
Definition: FSMainToolbar.h:81
FSMainToolbarItemTypeSortTool
@ FSMainToolbarItemTypeSortTool
The sort tool item.
Definition: FSMainToolbar.h:84
FSMainToolbarItemTypeMore
@ FSMainToolbarItemTypeMore
The more item.
Definition: FSMainToolbar.h:56
FSMainTopbarToolTagItem::image
UIImage * image
Get/Set the item image.
Definition: FSMainToolbar.h:157
FSMainToolbar::itemsForPositionLeft
NSArray< FSMainToolbarItem * > * itemsForPositionLeft
Get/Set the items displayed on the toolbar left.
Definition: FSMainToolbar.h:125
FSMainTopbarToolTagComment
@ FSMainTopbarToolTagComment
The comment tag.
Definition: FSMainToolbar.h:34
FSMainToolbar::contentHeight
CGFloat contentHeight
Set content bar height.
Definition: FSMainToolbar.h:131
FSMainToolbarItemTypeUnknown
@ FSMainToolbarItemTypeUnknown
The unknown item.
Definition: FSMainToolbar.h:52
FSMainTopbar
Definition: FSMainToolbar.h:214
FSMainTopbarToolTagItem
Definition: FSMainToolbar.h:150
FSMainTopbarToolTagItem::phoneTitleEdgeInsets
UIEdgeInsets phoneTitleEdgeInsets
Default iphone UIEdgeInsets.
Definition: FSMainToolbar.h:160
FSMainToolbarItemTypeDivide
@ FSMainToolbarItemTypeDivide
The divide item.
Definition: FSMainToolbar.h:72
FSMainToolbarItem::spacing
CGFloat spacing
Get/Set the add spacing to the toolbar.
Definition: FSMainToolbar.h:105
-[IFSMainTopbarEventListener-p didShowTagTabPopuper]
void didShowTagTabPopuper()
Did show tag tab popuper.
FSMainToolbarItemTypePanel
@ FSMainToolbarItemTypePanel
The panel item.
Definition: FSMainToolbar.h:75
FSMainTopbarToolTagEdit
@ FSMainTopbarToolTagEdit
The edit tag.
Definition: FSMainToolbar.h:32
FSMainToolbarItemTypeViewSettings
@ FSMainToolbarItemTypeViewSettings
The view settings item.
Definition: FSMainToolbar.h:77
FSMainToolbar::itemsForPositionCenter
NSArray< FSMainToolbarItem * > * itemsForPositionCenter
Get/Set the items displayed on the toolbar center.
Definition: FSMainToolbar.h:127
FSMainToolbar::itemsForPositionRight
NSArray< FSMainToolbarItem * > * itemsForPositionRight
Get/Set the items displayed on the toolbar right.
Definition: FSMainToolbar.h:129
FSMainTopbarToolTagHome
@ FSMainTopbarToolTagHome
The home tag.
Definition: FSMainToolbar.h:30
FSMainToolbarItemPosition
FSMainToolbarItemPosition
The item is in the bar.
Definition: FSMainToolbar.h:19
FSMainTopbarToolTagItem::mainToolbarItems
NSArray< FSMainToolbarItem * > * mainToolbarItems
Get/Set the main Items displayed on the toolbar.
Definition: FSMainToolbar.h:169
FSMainToolbarItemTypeAddTool
@ FSMainToolbarItemTypeAddTool
The add tool item.
Definition: FSMainToolbar.h:62
FSMainToolbarItem::customView
UIView * customView
Gets a custom view.
Definition: FSMainToolbar.h:109
FSMainTopbarToolTagView
@ FSMainTopbarToolTagView
The view tag.
Definition: FSMainToolbar.h:38
FSMainToolbarItem
Definition: FSMainToolbar.h:98
FSMainToolbarItem::width
CGFloat width
Get/Set the add width to the toolbar.
Definition: FSMainToolbar.h:107
FSMainTopbarToolTagItem::padImageEdgeInsets
UIEdgeInsets padImageEdgeInsets
Definition: FSMainToolbar.h:164
-[IFSMainTopbarEventListener-p didDismissTagTabPopuper]
void didDismissTagTabPopuper()
Did dismiss tag tab popuper.
FSMainBottombar
Definition: FSMainToolbar.h:263
+[FSMainTopbarToolTagItem NS_UNAVAILABLE]
instancetype NS_UNAVAILABLE()
Disable the default initialization.
-[FSMainToolbar getToolbarContentView]
__kindof UIStackView * getToolbarContentView()
Get the the toolbar content view.
FSMainTopbarToolTagForm
@ FSMainTopbarToolTagForm
The form tag.
Definition: FSMainToolbar.h:40
FSMainToolbar
Definition: FSMainToolbar.h:120
+[FSMainToolbarItem NS_UNAVAILABLE]
instancetype NS_UNAVAILABLE()
Disable the default initialization.
IFSMainTopbarEventListener-p
Definition: FSMainToolbar.h:187
FSMainTopbarToolTagCustom
@ FSMainTopbarToolTagCustom
The custom tag.
Definition: FSMainToolbar.h:46
FSMainTopbar::subitemContentPosition
FSTopbarSubitemContentViewPosition subitemContentPosition
Get the subtoolbar position. Please refer to FSTopbarSubitemContentViewPositionXXX values and it woul...
Definition: FSMainToolbar.h:223
FSMainToolbarItemTypePan
@ FSMainToolbarItemTypePan
The pan item.
Definition: FSMainToolbar.h:60
FSMainTopbarToolTagItem::padTitleEdgeInsets
UIEdgeInsets padTitleEdgeInsets
Default ipad UIEdgeInsets.
Definition: FSMainToolbar.h:163
FSMainToolbarItem::itemType
FSMainToolbarItemType itemType
Get the existing-supplied item. Please refer to FSMainToolbarItemTypeXXX values and it would be one o...
Definition: FSMainToolbar.h:103
FSMainTopbar::horizontalContentHeight
CGFloat horizontalContentHeight
Set horizontal content height.
Definition: FSMainToolbar.h:225
FSMainTopbarToolTagItem::isOnToolbar
BOOL isOnToolbar
Whether to display on the toolbar.
Definition: FSMainToolbar.h:174
FSMainTopbarToolTagItem::readToolbarItems
NSArray< FSReadToolbarItem * > * readToolbarItems
Get/Set the read Items displayed on the toolbar.
Definition: FSMainToolbar.h:167
FSMainTopbar::currentTagItem
FSMainTopbarToolTagItem * currentTagItem
Get the current tag Item.
Definition: FSMainToolbar.h:221
FSMainTopbarToolTag
FSMainTopbarToolTag
The tool tag.
Definition: FSMainToolbar.h:28
FSMainTopbarToolTagDrawing
@ FSMainTopbarToolTagDrawing
The drawing tag.
Definition: FSMainToolbar.h:36
FSReadToolbarItem
Definition: FSReadToolbarItem.h:203
FSMainToolbarItemTypeMultiSelect
@ FSMainToolbarItemTypeMultiSelect
The multi-select item.
Definition: FSMainToolbar.h:70
FSMainToolbarItemType
FSMainToolbarItemType
Defines existing-supplied images for main tool bar items..
Definition: FSMainToolbar.h:50
FSMainToolbarItemPositionLeft
@ FSMainToolbarItemPositionLeft
The item is on the left.
Definition: FSMainToolbar.h:21
FSMainToolbarItemTypeThumbnail
@ FSMainToolbarItemTypeThumbnail
The Thumbnai item.
Definition: FSMainToolbar.h:79
FSMainToolbarItemTypeSearch
@ FSMainToolbarItemTypeSearch
The search item.
Definition: FSMainToolbar.h:58
FSMainToolbarItemPositionRight
@ FSMainToolbarItemPositionRight
The item is on the right.
Definition: FSMainToolbar.h:25
FSMainTopbar::currentNewTagItems
NSArray< FSMainTopbarToolTagItem * > * currentNewTagItems
Get/Set the main tag Items to display a new icon in the popup window.
Definition: FSMainToolbar.h:219
FSMainTopbar::NS_UNAVAILABLE
NSArray< FSMainToolbarItem * > *itemsForPositionCenter NS_UNAVAILABLE
Disable this method.
Definition: FSMainToolbar.h:215
FSTopbarSubitemContentViewPositionRight
@ FSTopbarSubitemContentViewPositionRight
The subbar is on the right.
Definition: FSMainToolbar.h:94
FSMainToolbarItemTypeProperty
@ FSMainToolbarItemTypeProperty
The property item.
Definition: FSMainToolbar.h:68
FSMainTopbarToolTagProtect
@ FSMainTopbarToolTagProtect
The protect tag.
Definition: FSMainToolbar.h:44
FSMainToolbarItemPositionCenter
@ FSMainToolbarItemPositionCenter
The item is on the center.
Definition: FSMainToolbar.h:23
FSMainTopbar::verticalContentWidth
CGFloat verticalContentWidth
Set vertical content width.
Definition: FSMainToolbar.h:227