Foxit PDF SDK  9.1
UIExtensionsManager.h
1 
18 #ifndef UIExtensionsManager_h
19 #define UIExtensionsManager_h
20 
21 #import "PanelController.h"
22 #import "FSSettingBar.h"
23 #import "MoreView.h"
24 #import <FoxitRDK/FSPDFViewControl.h>
25 #import "FSReadToolbarItem.h"
26 #import "FSUtilities.h"
27 #import "FSMenuViewManager.h"
28 #import "FSMainToolbar.h"
29 #import "FSMenuControl.h"
30 #import "FSPermissionProvider.h"
31 #import "FSAppInfoProvider.h"
32 
33 @class UIExtensionsConfig;
34 
35 NS_ASSUME_NONNULL_BEGIN
36 
38 @protocol IModule <NSObject>
40 - (FSModuleStringName)getName;
41 @end
42 
44 @protocol FSAnnotsPermissionDelegate <NSObject>
45 @optional
50 - (BOOL)canAddAnnot;
55 - (BOOL)canModifyAnnot;
60 - (BOOL)canDeleteAnnot;
61 @end
62 
64 @protocol IAnnotEventListener <NSObject>
65 @optional
72 - (void)onAnnotAdded:(FSPDFPage *)page annot:(FSAnnot *)annot;
79 - (void)onAnnotWillDelete:(FSPDFPage *)page annot:(FSAnnot *)annot;
86 - (void)onAnnotDeleted:(FSPDFPage *)page annot:(FSAnnot *)annot;
93 - (void)onAnnotModified:(FSPDFPage *)page annot:(FSAnnot *)annot;
100 - (void)onAnnotSelected:(FSPDFPage *)page annot:(FSAnnot *)annot;
107 - (void)onAnnotDeselected:(FSPDFPage *)page annot:(FSAnnot *)annot;
108 
115 - (void)onAnnotWillFlatten:(FSPDFPage *)page annot:(FSAnnot *)annot;
122 - (void)onAnnotFlattened:(FSPDFPage *)page annot:(FSAnnot *)annot;
123 
124 #pragma mark - Batch Operation
125 
129 - (void)onAnnotsAdded:(NSArray<FSAnnot*> *)annots;
134 - (void)onAnnotsWillDelete:(NSArray<FSAnnot*> *)annots;
135 @end
136 
138 @protocol IToolEventListener <NSObject>
139 @required
146 - (void)onToolChanged:(NSString *)lastToolName CurrentToolName:(NSString *)toolName;
147 @end
148 
150 @protocol ISearchEventListener <NSObject>
151 @optional
153 - (void)onSearchStarted;
155 - (void)onSearchCanceled;
156 @end
157 
158 @class FSReadToolSettings;
160 @protocol IToolHandler <NSObject>
162 @property (nonatomic, assign) FSAnnotType type;
166 - (NSString *)getName;
167 
172 - (BOOL)isEnabled;
174 - (void)onActivate;
176 - (void)onDeactivate;
177 
178 #pragma mark - PageView Gesture+Touch
179 
187 - (BOOL)onPageViewLongPress:(int)pageIndex recognizer:(UILongPressGestureRecognizer *)recognizer;
196 - (BOOL)onPageViewTap:(int)pageIndex recognizer:(UITapGestureRecognizer *_Nullable)recognizer;
205 - (BOOL)onPageViewPan:(int)pageIndex recognizer:(UIPanGestureRecognizer *)recognizer;
214 - (BOOL)onPageViewShouldBegin:(int)pageIndex recognizer:(UIGestureRecognizer *)gestureRecognizer;
225 - (BOOL)onPageViewTouchesBegan:(int)pageIndex touches:(NSSet *)touches withEvent:(UIEvent *)event;
236 - (BOOL)onPageViewTouchesMoved:(int)pageIndex touches:(NSSet *)touches withEvent:(UIEvent *)event;
247 - (BOOL)onPageViewTouchesEnded:(int)pageIndex touches:(NSSet *)touches withEvent:(UIEvent *)event;
258 - (BOOL)onPageViewTouchesCancelled:(int)pageIndex touches:(NSSet *)touches withEvent:(UIEvent *)event;
259 @optional
261 @property (nonatomic, weak) FSReadToolSettings *toolSettings;
268 - (void)onDraw:(int)pageIndex inContext:(CGContextRef)context;
269 
278 - (BOOL)shouldDrawAnnot:(FSAnnot *)annot inPDFViewCtrl:(FSPDFViewCtrl *)pdfViewCtrl;
279 @end
280 
282 @protocol IAnnotHandler <NSObject>
291 - (BOOL)isHitAnnot:(FSAnnot *)annot point:(FSPointF *)point;
296 - (void)onAnnotSelected:(FSAnnot *)annot;
301 - (void)onAnnotDeselected:(FSAnnot *)annot;
302 @optional
309 - (BOOL)addAnnot:(FSAnnot *)annot;
318 - (BOOL)addAnnot:(FSAnnot *)annot addUndo:(BOOL)addUndo;
325 - (BOOL)modifyAnnot:(FSAnnot *)annot;
334 - (BOOL)modifyAnnot:(FSAnnot *)annot addUndo:(BOOL)addUndo;
341 - (BOOL)removeAnnot:(FSAnnot *)annot;
350 - (BOOL)removeAnnot:(FSAnnot *)annot addUndo:(BOOL)addUndo;
351 
358 - (BOOL)flattenAnnot:(FSAnnot *)annot;
359 #pragma mark - PageView Gesture+Touch
360 
370 - (BOOL)onPageViewLongPress:(int)pageIndex recognizer:(UILongPressGestureRecognizer *)recognizer annot:(FSAnnot *_Nullable)annot;
381 - (BOOL)onPageViewTap:(int)pageIndex recognizer:(UITapGestureRecognizer *)recognizer annot:(FSAnnot *_Nullable)annot;
392 - (BOOL)onPageViewPan:(int)pageIndex recognizer:(UIPanGestureRecognizer *)recognizer annot:(FSAnnot *)annot;
403 - (BOOL)onPageViewShouldBegin:(int)pageIndex recognizer:(UIGestureRecognizer *)gestureRecognizer annot:(FSAnnot *_Nullable)annot;
416 - (BOOL)onPageViewTouchesBegan:(int)pageIndex touches:(NSSet *)touches withEvent:(UIEvent *)event annot:(FSAnnot *)annot;
429 - (BOOL)onPageViewTouchesMoved:(int)pageIndex touches:(NSSet *)touches withEvent:(UIEvent *)event annot:(FSAnnot *)annot;
442 - (BOOL)onPageViewTouchesEnded:(int)pageIndex touches:(NSSet *)touches withEvent:(UIEvent *)event annot:(FSAnnot *)annot;
455 - (BOOL)onPageViewTouchesCancelled:(int)pageIndex touches:(NSSet *)touches withEvent:(UIEvent *)event annot:(FSAnnot *)annot;
456 @optional
466 - (NSString *)getName;
475 - (void)onDraw:(int)pageIndex inContext:(CGContextRef)context annot:(FSAnnot *_Nullable)annot;
486 - (void)onAnnotChanged:(FSAnnot *)annot property:(long)property from:(NSValue *)oldValue to:(NSValue *)newValue;
495 - (BOOL)shouldDrawAnnot:(FSAnnot *)annot inPDFViewCtrl:(FSPDFViewCtrl *)pdfViewCtrl;
500 - (void)onXFAWidgetSelected:(FSXFAWidget *)widget;
505 - (void)onXFAWidgetDeselected:(FSXFAWidget *)widget;
516 - (BOOL)onPageViewTap:(int)pageIndex recognizer:(UITapGestureRecognizer *)recognizer widget:(FSXFAWidget *_Nullable)widget;
527 - (BOOL)onPageViewShouldBegin:(int)pageIndex recognizer:(UIGestureRecognizer *)gestureRecognizer widget:(FSXFAWidget *_Nullable)widget;
540 - (BOOL)onPageViewTouchesBegan:(int)pageIndex touches:(NSSet *)touches withEvent:(UIEvent *)event widget:(FSXFAWidget *_Nullable)widget;
553 - (BOOL)onPageViewTouchesMoved:(int)pageIndex touches:(NSSet *)touches withEvent:(UIEvent *)event widget:(FSXFAWidget *_Nullable)widget;
566 - (BOOL)onPageViewTouchesEnded:(int)pageIndex touches:(NSSet *)touches withEvent:(UIEvent *)event widget:(FSXFAWidget *_Nullable)widget;
575 - (void)onDraw:(int)pageIndex inContext:(CGContextRef)context widget:(FSXFAWidget *_Nullable)widget;
576 @end
577 
579 @protocol IFullScreenListener <NSObject>
585 - (void)onFullScreen:(BOOL)isFullScreen;
586 @end
587 
589 @protocol IPageNumberListener <NSObject>
593 - (void)updatePageNumber;
594 @end
595 
597 @protocol ILinkEventListener <NSObject>
598 @optional
605 - (BOOL)onLinkOpen:(id)link LocationInfo:(CGPoint)pointParam;
606 @end
607 
609 typedef NS_ENUM(NSUInteger, FSToolbarType) {
611  FSTopBar = 1,
614 };
615 
617 @protocol IDocModifiedEventListener <NSObject>
618 @optional
623 - (void)onDocModified:(FSPDFDoc *)doc;
624 
625 @end
626 
628 @protocol ISignatureEventListener <NSObject>
629 @optional
634 - (void)onDigitalSignatureSigned:(BOOL)success;
635 
644 - (void)onDigitalSignatureSigned:(BOOL)success originalDoc:(FSPDFDoc *)originalDoc outputPath:(NSString *)outputPath;
645 
648 - (BOOL)canReplaceDigitalSignatureOriginalFile:(NSString *)originalFile;
649 @end
650 
652 @protocol IUIInteractionEventListener <NSObject>
658 - (void)onUIInteractElementClicked:(FSUIElementType)element;
659 @end
660 
661 @protocol FSExtFileOpenDelegate <NSObject>
662 @optional
669 - (BOOL)openFileAtPath:(NSString *)filePath;
670 @end
671 
677 typedef NS_ENUM(NSUInteger, FSMeasurementUnits) {
684 };
685 
686 @class UIExtensionsManager;
687 @protocol UIExtensionsManagerDelegate <NSObject>
688 @optional
701 - (void)uiextensionsManager:(UIExtensionsManager *)uiextensionsManager onToolBar:(FSToolbarType)type hidden:(BOOL)hidden;
713 - (BOOL)uiextensionsManager:(UIExtensionsManager *)uiextensionsManager openNewDocAtPath:(NSString *)path shouldCloseCurrentDoc:(BOOL)closeCurrentDoc completionCallBack:(void (^)(void))completionCallBack;
714 /* @brief normally should save doc and close it.
715  *
716  * @param[in] uiextensionsManager Current UIExtensionsManager.
717  *
718  * @param[in] control Current clicked control.
719  *
720  */
721 - (void)quitUIExtensionsManager:(UIExtensionsManager *)uiextensionsManager control:(UIControl *)control;
722 
723 @end
724 
728 @property (class, nonatomic, assign) UIStatusBarStyle preferredStatusBarStyle;
730 @property (class, nonatomic, strong) UIColor *primaryColor;
732 @property (class, nonatomic, strong) UIColor *stateBarColor;
734 @property (nonatomic, copy) NSString *annotAuthor;
736 @property (nonatomic, strong ,readonly) FSPDFViewCtrl *pdfViewCtrl;
738 @property (nonatomic, strong, readonly) MoreMenuView *more;
740 @property (nonatomic, strong, readonly) FSMenuViewManager *menuViewManager;
742 @property (nonatomic, strong) NSMutableDictionary<NSNumber *, FSReadToolSettings *> *addToolsSettings;
744 @property (nonatomic, weak) id<UIExtensionsManagerDelegate> delegate;
746 @property (nonatomic, strong, nullable) id<IToolHandler> currentToolHandler;
748 @property (nonatomic, assign) BOOL canUpdateAnnotDefaultProperties;
750 @property (nonatomic, strong, nullable) FSAnnot *currentAnnot;
752 @property (nonatomic, assign) BOOL enableLinks;
754 @property (nonatomic, assign) BOOL enableHighlightLinks;
756 @property (nonatomic, assign) BOOL enableHighlightForm;
758 @property (nonatomic, strong) UIColor *linksHighlightColor;
760 @property (nonatomic, strong) UIColor *selectionHighlightColor;
762 @property (nonatomic, strong) UIColor *highlightFormColor;
764 @property (nonatomic, copy, nullable) void (^goBack)(void);
766 @property (nonatomic, strong, readonly, nullable) FSMainTopbar *topToolbar;
768 @property (nonatomic, strong, readonly, nullable) FSMainBottombar *bottomToolbar;
770 @property (nonatomic, strong) FSPanelController *panelController;
772 @property (nonatomic, strong) FSSettingBar *settingBar;
774 @property (nonatomic, assign) BOOL continueAddAnnot;
776 @property (nonatomic, assign) BOOL isFullScreen;
778 @property (nonatomic, assign, readonly) BOOL isScreenLocked;
780 @property (nonatomic, strong) NSString *preventOverrideFilePath;
782 @property (nonatomic, assign, setter=setDocModified:) BOOL isDocModified;
784 @property (nonatomic, assign) BOOL isMultiFileMode;
786 @property (nonatomic, assign, setter=setAutoSaveDoc:) BOOL isAutoSaveDoc;
788 @property (nonatomic, assign) FSPDFDocSaveFlags docSaveFlag;
790 @property (nonatomic, strong) id<FSActionCallback> actionHandler;
791 
793 @property (nonatomic, strong, nullable) FSXFAWidget *currentWidget;
794 
796 @property (nonatomic, assign, setter=setAutoSaveSignedDoc:) BOOL isAutoSaveSignedDoc;
798 @property (nonatomic, strong) NSString *signedDocSavePath;
800 @property (nonatomic, assign, readonly) BOOL prefersStatusBarHidden;
802 @property (nonatomic, weak) id<FSAnnotsPermissionDelegate> annotsPermissionDelegate;
804 @property (nonatomic, weak) id<FSMenuControlDelegate> menuControlDelegate;
806 @property (nonatomic, strong) id<IFSPermissionProvider> permissionProvider;
808 @property (nonatomic, strong) FSAppInfoProvider* appInfoProvider;
810 @property (nonatomic, weak) id<FSExtFileOpenDelegate> extFileOpenDelegate;
812 @property (nonatomic, assign) BOOL disableFingerWhenLinkApplePencil;
813 #if __IPHONE_OS_VERSION_MAX_ALLOWED >= 130000
814 
815 @property (nonatomic, weak, readonly) UIWindowScene *windowScene API_AVAILABLE(ios(13.0));
816 #endif
817 
818 @property (nonatomic, assign) BOOL useLogicalPageNumbers;
820 @property (nonatomic, assign) FSMeasurementUnits measurementUnits;
828 - (id)initWithPDFViewControl:(FSPDFViewCtrl *)viewctrl;
837 - (id)initWithPDFViewControl:(FSPDFViewCtrl *)viewctrl configuration:(NSData *_Nullable)jsonConfigData;
846 - (id)initWithPDFViewControl:(FSPDFViewCtrl *)viewctrl configurationObject:(UIExtensionsConfig *_Nonnull)configuration;
847 
854 - (void)registerFullScreenListener:(id<IFullScreenListener>)listener;
861 - (void)unregisterFullScreenListener:(id<IFullScreenListener>)listener;
862 
869 - (void)registerPageNumberListener:(id<IPageNumberListener>)listener ;
876 - (void)unregisterPageNumerListener:(id<IPageNumberListener>)listener ;
877 
884 - (void)registerRotateChangedListener:(id<IRotationEventListener>)listener;
891 - (void)unregisterRotateChangedListener:(id<IRotationEventListener>)listener;
897 - (void)enableTopToolbar:(BOOL)isEnabled;
903 - (void)enableBottomToolbar:(BOOL)isEnabled;
904 
910 - (void)enableSmallTopToolbar:(BOOL)isEnabled;
916 - (void)enableSmallBottomToolbar:(BOOL)isEnabled;
917 
918 #pragma mark - Toolhandler and AnnotHandler registration.
919 
926 - (id<IToolHandler>)getToolHandlerByName:(NSString *)name;
934 - (id<IAnnotHandler>)getAnnotHandlerByType:(FSAnnotType)type;
941 - (void)registerToolHandler:(id<IToolHandler>)toolHandler;
948 - (void)unregisterToolHandler:(id<IToolHandler>)toolHandler;
955 - (void)registerAnnotHandler:(id<IAnnotHandler>)annotHandler;
962 - (void)unregisterAnnotHandler:(id<IAnnotHandler>)annotHandler;
963 
964 #pragma mark - Tool and annotation event listeners.
965 
971 - (void)registerAnnotEventListener:(id<IAnnotEventListener>)listener;
978 - (void)unregisterAnnotEventListener:(id<IAnnotEventListener>)listener;
985 - (void)registerToolEventListener:(id<IToolEventListener>)listener;
992 - (void)unregisterToolEventListener:(id<IToolEventListener>)listener;
993 
994 #pragma mark - Document modified event listeners.
995 
1001 - (void)registerDocModifiedEventListener:(id<IDocModifiedEventListener>)listener;
1002 
1009 - (void)unregisterDocModifiedEventListener:(id<IDocModifiedEventListener>)listener;
1010 
1011 #pragma mark - link event listeners.
1012 
1018 - (void)registerLinkEventListener:(id<ILinkEventListener>)listener;
1025 - (void)unregisterLinkEventListener:(id<ILinkEventListener>)listener;
1026 
1027 #pragma mark - signature event listeners.
1028 
1034 - (void)registerSignatureEventListener:(id<ISignatureEventListener>)listener;
1041 - (void)unregisterSignatureEventListener:(id<ISignatureEventListener>)listener;
1042 
1043 #pragma mark - UI Interaction event listeners.
1044 
1050 - (void)registerUIInteractionEventListener:(id<IUIInteractionEventListener>)listener;
1057 - (void)unregisterUIInteractionEventListener:(id<IUIInteractionEventListener>)listener;
1058 
1059 #pragma mark - Property bar of annotation for setting/getting annotation color and opacity.
1060 
1068 - (void)showPropertyWithToolSettings:(FSReadToolSettings *)toolSettings rect:(CGRect)rect inView:(UIView *)view;
1075 - (void)showSearchBar:(BOOL)show;
1082 - (void)registerSearchEventListener:(id<ISearchEventListener>)listener;
1089 - (void)unregisterSearchEventListener:(id<ISearchEventListener>)listener;
1090 
1097 - (NSString *)getCurrentSelectedText;
1098 
1099 #pragma mark - Module
1100 
1104 - (__kindof id<IModule>)getModuleByName:(FSModuleStringName)name;
1105 
1111 - (void)setFullScreen:(BOOL)fullScreen;
1112 
1114 - (void)suspendAutoFullScreen;
1115 
1117  - (void)resumeAutoFullScreen;
1118 
1128 + (void)printDoc:(FSPDFDoc *)doc animated:(BOOL)animated inWindow:(UIWindow *)window jobName:(nullable NSString *)jobName delegate:(nullable id<UIPrintInteractionControllerDelegate>)delegate completionHandler:(nullable UIPrintInteractionCompletionHandler)completion;
1129 
1141 + (void)printDoc:(FSPDFDoc *)doc fromRect:(CGRect)rect inView:(UIView *)view animated:(BOOL)animated inWindow:(UIWindow *)window jobName:(nullable NSString *)jobName delegate:(nullable id<UIPrintInteractionControllerDelegate>)delegate completionHandler:(nullable UIPrintInteractionCompletionHandler)completion;
1142 
1149 - (FSReadToolSettings *)getReadToolSettingsForType:(FSReadToolSettingsType)settingsType;
1150 
1162 - (void)changeState:(FSUIManagerState)state;
1170 -(void)documentSaveAS:(void (^_Nullable)(void))successed error:(void (^_Nullable)(void))error;
1171 
1177 - (void)setMoreItemClikedCallback:(void (^)(UIView* moreItem))clickedCallback;
1178 
1179 #pragma mark - Main toolbar item info
1180 
1186 -(NSMutableDictionary *)getToolbarItemHiddenStatus;
1187 
1198 -(void)setToolbarItemHiddenWithTag:(FS_TOOLBAR_ITEM_TAG)itemTag hidden:(BOOL)isHidden;
1199 
1206 - (void)enableModification:(BOOL)isEnabled;
1207 
1208 @end
1209 
1210 
1211 @interface UIExtensionsManager (SupportsMultipleScenes) <FSPDFMultipleScenes>
1212 @property (class, nonatomic, weak) UIExtensionsManager *currentExtManager;
1214 @end
1215 
1216 NS_ASSUME_NONNULL_END
1217 
1218 #endif /* UIExtensionsManager_h */
FSMeasurementMM
@ FSMeasurementMM
Millimeters.
Definition: UIExtensionsManager.h:683
IDocEventListener-p
The PDF document event listener.
Definition: FSPDFViewControl.h:203
UIExtensionsManager::currentWidget
FSXFAWidget * currentWidget
The Current selected xfa widget.
Definition: UIExtensionsManager.h:793
UIExtensionsManager::actionHandler
id< FSActionCallback > actionHandler
The Current action handler.
Definition: UIExtensionsManager.h:790
FSReadToolSettingsType
FSReadToolSettingsType
The read tool settings type.
Definition: FSReadToolbarItem.h:17
UIExtensionsManager::canUpdateAnnotDefaultProperties
BOOL canUpdateAnnotDefaultProperties
Can update annot default properties, default is yes.
Definition: UIExtensionsManager.h:748
UIExtensionsManager::primaryColor
UIColor * primaryColor
Get/Set the primary color The default is #923094.
Definition: UIExtensionsManager.h:730
UIExtensionsManager
The UI extensions manager which has included the default implementation of text selection tool,...
Definition: UIExtensionsManager.h:726
UIExtensionsManager::goBack
void(^ goBack)(void)
Caller can choose to provide a block to execute when user tap on 'back' button on the top toolbar.
IRotationEventListener-p
Device rotation delegate.
Definition: FSPDFViewControl.h:178
UIExtensionsManager::enableHighlightLinks
BOOL enableHighlightLinks
Whether to allow to highlight links.
Definition: UIExtensionsManager.h:754
IModule-p
Module base.
Definition: UIExtensionsManager.h:38
UIExtensionsManager::permissionProvider
id< IFSPermissionProvider > permissionProvider
Permission provider.
Definition: UIExtensionsManager.h:806
FSPDFUIExtensionsManager-p
The UI extensions manager.
Definition: FSPDFViewControl.h:618
-[IAnnotHandler-p getName]
NSString * getName()
FSToolbarType
FSToolbarType
Panel types.
Definition: UIExtensionsManager.h:609
UIExtensionsManager::topToolbar
FSMainTopbar * topToolbar
The Current UIExtensionsManager topToolbar.
Definition: UIExtensionsManager.h:766
FSPDFDoc
Definition: FSPDFObjC.h:4922
FSMenuViewManager
Definition: FSMenuViewManager.h:98
FSPanelController
Panel controller.
Definition: PanelController.h:36
+[UIExtensionsManager(SupportsMultipleScenes) openedExtensionsManagers]
NSSet< UIExtensionsManager * > * openedExtensionsManagers()
UIExtensionsManager::more
MoreMenuView * more
The more menu View.
Definition: UIExtensionsManager.h:738
UIExtensionsManager::delegate
id< UIExtensionsManagerDelegate > delegate
Delegate of UI extensions manager.
Definition: UIExtensionsManager.h:744
UIExtensionsManager::continueAddAnnot
BOOL continueAddAnnot
Whether to keep tool active after using it to add an annotation.
Definition: UIExtensionsManager.h:774
UIExtensionsManager::isAutoSaveDoc
BOOL isAutoSaveDoc
Set to automatically save documents Yes/No.
Definition: UIExtensionsManager.h:786
IToolHandler-p
The tool handler, it handles the gesture and touch events, which a tool should always implement most ...
Definition: UIExtensionsManager.h:160
UIExtensionsManager::stateBarColor
UIColor * stateBarColor
Get/Set the stateBar color.
Definition: UIExtensionsManager.h:732
UIExtensionsManager::currentAnnot
FSAnnot * currentAnnot
The Current selected annotation.
Definition: UIExtensionsManager.h:750
UIExtensionsManagerDelegate-p
Definition: UIExtensionsManager.h:687
UIExtensionsManager::settingBar
FSSettingBar * settingBar
The setting bar. It shows when tap on the view button in the bottom bar.
Definition: UIExtensionsManager.h:772
-[IToolHandler-p isEnabled]
BOOL isEnabled()
If the tool handler is enabled.
FSMainTopbar
Definition: FSMainToolbar.h:214
-[IAnnotHandler-p getType]
FSAnnotType getType()
UIExtensionsManager::panelController
FSPanelController * panelController
The panel controller.
Definition: UIExtensionsManager.h:770
-[IToolHandler-p onActivate]
void onActivate()
If the tool handler is activated.
IToolEventListener-p
A Tool event listener.
Definition: UIExtensionsManager.h:138
-[FSAnnotsPermissionDelegate-p canAddAnnot]
BOOL canAddAnnot()
Judge whether the annotation can be added.
UIExtensionsManager::isMultiFileMode
BOOL isMultiFileMode
Whether the preview mode is multiple file mode.
Definition: UIExtensionsManager.h:784
UIExtensionsManager::isFullScreen
BOOL isFullScreen
Whether is full screen. When full screen, top and bottom bar is not shown.
Definition: UIExtensionsManager.h:776
MoreMenuView
Definition: MoreView.h:119
UIExtensionsManager::annotAuthor
NSString * annotAuthor
Set/get annot author.
Definition: UIExtensionsManager.h:734
FSReadToolSettings
Definition: FSReadToolbarItem.h:163
-[UIExtensionsManager getState]
FSUIManagerState getState()
Get state of extensions manager.
UIExtensionsManager::appInfoProvider
FSAppInfoProvider * appInfoProvider
Set/Get the app Info provider.
Definition: UIExtensionsManager.h:808
FSUIManagerState
FSUIManagerState
States of extensions manager.
Definition: FSUtilities.h:270
UIExtensionsManager::docSaveFlag
FSPDFDocSaveFlags docSaveFlag
The Current doc save flag.
Definition: UIExtensionsManager.h:788
FSExtFileOpenDelegate-p
Definition: UIExtensionsManager.h:661
UIExtensionsManager::highlightFormColor
UIColor * highlightFormColor
Get/Set the highlight color for form and call -[FSPDFViewCtrl Refresh] if you want to take effect imm...
Definition: UIExtensionsManager.h:762
UIExtensionsConfig
Modules config for UIExtensionsManager.
Definition: UIExtensionsConfig.h:109
-[FSAnnotsPermissionDelegate-p canModifyAnnot]
BOOL canModifyAnnot()
Judge whether the annotation can be modified.
UIExtensionsManager::preferredStatusBarStyle
UIStatusBarStyle preferredStatusBarStyle
The controller preferred status bar style for UIExtensionsManager. The default is UIStatusBarStyleDef...
Definition: UIExtensionsManager.h:728
UIExtensionsManager::pdfViewCtrl
FSPDFViewCtrl * pdfViewCtrl
The PDF view control.
Definition: UIExtensionsManager.h:736
IPageEventListener-p
The page event listener.
Definition: FSPDFViewControl.h:255
FSAppInfoProvider
Definition: FSAppInfoProvider.h:18
ISignatureEventListener-p
Signature modified event listener.
Definition: UIExtensionsManager.h:628
FSPDFViewCtrl
Foxit PDF view control for viewing/editing/saving the PDF file.
Definition: FSPDFViewControl.h:783
UIExtensionsManager::isScreenLocked
BOOL isScreenLocked
Whether screen rotation is locked or not.
Definition: UIExtensionsManager.h:778
UIExtensionsManager::menuControlDelegate
id< FSMenuControlDelegate > menuControlDelegate
Delegate of menucontrol.
Definition: UIExtensionsManager.h:804
UIExtensionsManager::bottomToolbar
FSMainBottombar * bottomToolbar
The Current UIExtensionsManager bottomToolbar.
Definition: UIExtensionsManager.h:768
FSAnnotType
FSAnnotType
Enumeration for PDF annotation type.
Definition: FSPDFObjC.h:3809
UIExtensionsManager::isDocModified
BOOL isDocModified
Whether the current document is modified or not.
Definition: UIExtensionsManager.h:782
FSAnnotsPermissionDelegate-p
Annotations permission delegate.
Definition: UIExtensionsManager.h:44
ISearchEventListener-p
A search event listener.
Definition: UIExtensionsManager.h:150
UIExtensionsManager::currentToolHandler
id< IToolHandler > currentToolHandler
The Current tool handler.
Definition: UIExtensionsManager.h:746
FSMainBottombar
Definition: FSMainToolbar.h:263
FSAnnot
Definition: FSPDFObjC.h:3901
-[IPageNumberListener-p updatePageNumber]
void updatePageNumber()
update page number.
UIExtensionsManager::addToolsSettings
NSMutableDictionary< NSNumber *, FSReadToolSettings * > * addToolsSettings
Get/set settings on add tools .If set to nil, it will be automatically created using default config.
Definition: UIExtensionsManager.h:742
IUIInteractionEventListener-p
The ui interaction event listener.
Definition: UIExtensionsManager.h:652
UIExtensionsManager::extFileOpenDelegate
id< FSExtFileOpenDelegate > extFileOpenDelegate
Delegate for opening external file .
Definition: UIExtensionsManager.h:810
-[IModule-p getName]
FSModuleStringName getName()
Get the module name.
UIExtensionsManager::disableFingerWhenLinkApplePencil
BOOL disableFingerWhenLinkApplePencil
Whether to disable finger add ink type annotation when linking to Apple Pencil . The default is YES.
Definition: UIExtensionsManager.h:812
FSMeasurementUnits
FSMeasurementUnits
Enumeration for measurement units of page size information.
Definition: UIExtensionsManager.h:677
IAnnotHandler-p
The annotation handler, it should handle the operations on the specified annotation.
Definition: UIExtensionsManager.h:282
UIExtensionsManager::enableHighlightForm
BOOL enableHighlightForm
Whether to allow to highlight form and call -[FSPDFViewCtrl Refresh] if you want to take effect immed...
Definition: UIExtensionsManager.h:756
FSUIElementType
FSUIElementType
ui emlement types.
Definition: FSUtilities.h:25
IFullScreenListener-p
The full screen event listener.
Definition: UIExtensionsManager.h:579
UIExtensionsManager(SupportsMultipleScenes)::currentExtManager
UIExtensionsManager * currentExtManager
Definition: UIExtensionsManager.h:1212
-[UIExtensionsManager resumeAutoFullScreen]
void resumeAutoFullScreen()
Resume the auto full screen mode.
FSPointF
Definition: FSPDFObjC.h:185
UIExtensionsManager::linksHighlightColor
UIColor * linksHighlightColor
Get/Set the highlight color for links.
Definition: UIExtensionsManager.h:758
-[UIExtensionsManager getCurrentSelectedText]
NSString * getCurrentSelectedText()
Get current selected text.
UIExtensionsManager::preventOverrideFilePath
NSString * preventOverrideFilePath
Prevent to override original pdf file.
Definition: UIExtensionsManager.h:780
-[UIExtensionsManager suspendAutoFullScreen]
void suspendAutoFullScreen()
Suspend the auto full screen mode.
IToolHandler-p::toolSettings
FSReadToolSettings * toolSettings
Get/set the tool settings.
Definition: UIExtensionsManager.h:261
IToolHandler-p::type
FSAnnotType type
Get/set the current annot type if it's an annotation tool handler.
Definition: UIExtensionsManager.h:162
FSTopBar
@ FSTopBar
The top tool bar.
Definition: UIExtensionsManager.h:611
IAnnotEventListener-p
Annotation event listener.
Definition: UIExtensionsManager.h:64
UIExtensionsManager::menuViewManager
FSMenuViewManager * menuViewManager
The custom view manager .
Definition: UIExtensionsManager.h:740
FSMeasurementCM
@ FSMeasurementCM
Centermeters.
Definition: UIExtensionsManager.h:681
FSPDFPage
Definition: FSPDFObjC.h:5757
FSMeasurementInch
@ FSMeasurementInch
Inch.
Definition: UIExtensionsManager.h:679
-[FSAnnotsPermissionDelegate-p canDeleteAnnot]
BOOL canDeleteAnnot()
Judge whether the annotation can be deleted.
FSXFAWidget
Definition: FSPDFObjC.h:1706
UIExtensionsManager::annotsPermissionDelegate
id< FSAnnotsPermissionDelegate > annotsPermissionDelegate
Delegate of annotations permission. If set, once one of the implementation results is false,...
Definition: UIExtensionsManager.h:802
FSSettingBar
Setting bar is actived by tapping "View" item on the bottom bar.
Definition: FSSettingBar.h:197
IPageNumberListener-p
The page number event listener.
Definition: UIExtensionsManager.h:589
UIExtensionsManager::isAutoSaveSignedDoc
BOOL isAutoSaveSignedDoc
Set to automatically save the signed document Yes/No.
Definition: UIExtensionsManager.h:796
UIExtensionsManager::useLogicalPageNumbers
BOOL useLogicalPageNumbers
Whether to use logical page numbers. The default is NO.
Definition: UIExtensionsManager.h:818
UIExtensionsManager::measurementUnits
FSMeasurementUnits measurementUnits
Measurement units for page size information. The default is inch.
Definition: UIExtensionsManager.h:820
UIExtensionsManager::prefersStatusBarHidden
BOOL prefersStatusBarHidden
Whether the PDF view hide the status bar.
Definition: UIExtensionsManager.h:800
FSBottomBar
@ FSBottomBar
The bottom tool bar.
Definition: UIExtensionsManager.h:613
UIExtensionsManager::enableLinks
BOOL enableLinks
Whether to allow to jump to link address when tap on the link annotation.
Definition: UIExtensionsManager.h:752
IDocModifiedEventListener-p
Document modified event listener.
Definition: UIExtensionsManager.h:617
UIExtensionsManager::selectionHighlightColor
UIColor * selectionHighlightColor
Get/Set the highlight color for text selection.
Definition: UIExtensionsManager.h:760
-[IToolHandler-p getName]
NSString * getName()
Get the tool name.
-[ISearchEventListener-p onSearchCanceled]
void onSearchCanceled()
Triggered when the text searching is canceled.
IRecoveryEventListener-p
Recovery event listener used when view control runs out of memory.
Definition: FSPDFViewControl.h:165
-[IToolHandler-p onDeactivate]
void onDeactivate()
If the tool handler is deactivated.
UIExtensionsManager::signedDocSavePath
NSString * signedDocSavePath
Set/Get the full PDF file path where the signed document is saved and it works when set to automatica...
Definition: UIExtensionsManager.h:798
UIExtensionsManager(SupportsMultipleScenes)
Definition: UIExtensionsManager.h:1211
-[ISearchEventListener-p onSearchStarted]
void onSearchStarted()
Triggered when the text searching is started.
-[UIExtensionsManager getToolbarItemHiddenStatus]
NSMutableDictionary * getToolbarItemHiddenStatus()
Get toolbar item hide/show status.
FSPDFDocSaveFlags
FSPDFDocSaveFlags
Enumeration for PDF document saving flags.
Definition: FSPDFObjC.h:4871