AGSPopupsViewController.h

Go to the documentation of this file.

/*
 COPYRIGHT 2022 ESRI
 
 All rights reserved under the copyright laws of the United States
 and applicable international laws, treaties, and conventions.
 
 This material is licensed for use under the Esri Master License
 Agreement (MLA), and is bound by the terms of that agreement.
 You may redistribute and use this code without modification,
 provided you adhere to the terms of the MLA and include this
 copyright notice.
 
 See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
 
 For additional information, contact:
 Environmental Systems Research Institute, Inc.
 Attn: Contracts and Legal Services Department
 380 New York Street
 Redlands, California, 92373
 USA
 
 email: contracts@esri.com
 */
 //Required for Globals API doc
 
#import <Foundation/Foundation.h>
#import <UIKit/UIKit.h>
#import <ArcGIS/AGSPopupAttachment.h>
 
 
 
@class AGSPopupViewController;
@class AGSGeometry;
@class AGSGeometryBuilder;
@class AGSPopup;
@class AGSPopupsViewController;
@class AGSPopupsViewControllerTheme;
@class AGSSketchEditor;
 
typedef NS_ENUM(NSInteger, AGSPopupsViewControllerContainerStyle) {
    AGSPopupsViewControllerContainerStyleNavigationController,  
    AGSPopupsViewControllerContainerStyleNavigationBar,         
    AGSPopupsViewControllerContainerStyleCustom                 
};
 
typedef NS_ENUM(NSInteger, AGSPopupsViewControllerGeometryEditingStyle) {
    AGSPopupsViewControllerGeometryEditingStyleToolbar,     
    AGSPopupsViewControllerGeometryEditingStyleInline       
};
 
typedef NS_ENUM(NSInteger, AGSPopupViewControllerType) {
    AGSPopupViewControllerTypeContainer = 0,    
    AGSPopupViewControllerTypeUIImagePicker,    
    AGSPopupViewControllerTypeFullMedia,        
    AGSPopupViewControllerTypeWeb,              
    AGSPopupViewControllerTypeMovie,            
    AGSPopupViewControllerTypeAttributeInput,   
    AGSPopupViewControllerTypeAlert             
};
 
@protocol AGSPopupsViewControllerDelegate 
 
@optional
 
- (nullable AGSSketchEditor *)popupsViewController:(AGSPopupsViewController *)popupsViewController sketchEditorForPopup:(AGSPopup *)popup;
 
- (void)popupsViewController:(AGSPopupsViewController *)popupsViewController readyToEditGeometryWithSketchEditor:(nullable AGSSketchEditor *)sketchEditor forPopup:(AGSPopup *)popup;
 
- (void)popupsViewController:(AGSPopupsViewController *)popupsViewController didStartEditingForPopup:(AGSPopup *)popup;
 
- (void)popupsViewController:(AGSPopupsViewController *)popupsViewController willFinishEditingForPopup:(AGSPopup *)popup;
 
- (void)popupsViewController:(AGSPopupsViewController *)popupsViewController didFinishEditingForPopup:(AGSPopup *)popup;
 
- (void)popupsViewController:(AGSPopupsViewController *)popupsViewController didFailToFinishEditingForPopup:(AGSPopup *)popup withError:(NSError *)error;
 
- (void)popupsViewController:(AGSPopupsViewController *)popupsViewController didCancelEditingForPopup:(AGSPopup *)popup;
 
- (BOOL)popupsViewController:(AGSPopupsViewController *)popupsViewController wantsToDeleteForPopup:(AGSPopup *)popup;
 
- (void)popupsViewController:(AGSPopupsViewController *)popupsViewController didDeleteForPopup:(AGSPopup *)popup;
 
- (void)popupsViewController:(AGSPopupsViewController *)popupsViewController didFailToDeleteForPopup:(AGSPopup *)popup withError:(NSError *)error;
 
- (void)popupsViewControllerDidFinishViewingPopups:(AGSPopupsViewController *)popupsViewController;
 
- (void)popupsViewController:(AGSPopupsViewController *)popupsViewController validityChanged:(BOOL)isValid forPopup:(AGSPopup *)popup;
 
- (void)popupsViewController:(AGSPopupsViewController *)popupsViewController wantsToShowViewController:(UIViewController *)svc ofType:(AGSPopupViewControllerType)viewType fromViewController:(UIViewController *)fvc atRect:(CGRect)rect;
 
- (void)popupsViewController:(AGSPopupsViewController *)popupsViewController wantsToHideViewController:(UIViewController *)vc ofType:(AGSPopupViewControllerType)viewType;
 
- (BOOL)popupsViewController:(AGSPopupsViewController *)popupsViewController shouldAutorotateForViewController:(UIViewController *)vc ofType:(AGSPopupViewControllerType)viewType;
 
- (nullable UIView *)popupsViewController:(AGSPopupsViewController *)popupsViewController headerViewForPopup:(AGSPopup *)popup;
 
- (nullable UIView *)popupsViewController:(AGSPopupsViewController *)popupsViewController footerViewForPopup:(AGSPopup *)popup;
 
- (void)popupsViewController:(AGSPopupsViewController *)popupsViewController didChangeToCurrentPopup:(AGSPopup *)popup;
 
- (void)popupsViewController:(AGSPopupsViewController *)popupsViewController wantsToPreviewDocumentAtURL:(NSURL *)documentURL fromViewController:(UIViewController *)fvc atRect:(CGRect)rect;
 
- (void)popupsViewController:(AGSPopupsViewController *)popupsViewController didChangeFeatureTypeForPopup:(AGSPopup *)popup;
 
@end
 
@interface AGSPopupsViewController : UIViewController
 
#pragma mark -
#pragma mark initializers
 
-(instancetype)initWithPopups:(nullable NSArray<AGSPopup*>*)popups;
 
 
+(instancetype)popupsViewControllerWithPopups:(nullable NSArray<AGSPopup*>*)popups;
 
#pragma mark -
#pragma mark properties
 
@property (nonatomic, weak, nullable) id<AGSPopupsViewControllerDelegate> delegate;
 
@property (nonatomic, copy, nullable) NSArray<AGSPopup*> *popups;
 
@property (nonatomic, assign, readonly) BOOL inEditingMode;
 
@property (nonatomic, strong, readonly) AGSSketchEditor *currentSketchEditor;
 
@property (nonatomic, strong, readonly, nullable) AGSPopup *currentPopup;
 
@property (nonatomic, strong, readwrite) AGSPopupsViewControllerTheme *theme;
 
@property (nonatomic, assign, readwrite) AGSPopupAttachmentSize defaultAttachmentSize;
 
#pragma mark -
#pragma mark methods
 
-(void)showAdditionalPopups:(NSArray<AGSPopup*> *)popups;
 
-(void)startEditingCurrentPopup;
 
-(void)finishEditingCurrentPopupWithCompletion:(nullable void(^)(NSError *__nullable error))completion;
 
-(void)cancelEditingCurrentPopup;
 
-(void)clearAllPopups;
 
-(instancetype)initWithPopups:(nullable NSArray<AGSPopup*> *)popups containerStyle:(AGSPopupsViewControllerContainerStyle)containerStyle;
 
+(instancetype)popupsViewControllerWithPopups:(nullable NSArray<AGSPopup*> *)popups containerStyle:(AGSPopupsViewControllerContainerStyle)containerStyle;
 
@property (nonatomic, strong, readonly, nullable) UIBarButtonItem *doneButton;
 
@property (nonatomic, strong, readwrite, nullable) UIBarButtonItem *customDoneButton;
 
@property (nonatomic, strong, readonly, nullable) UIBarButtonItem *actionButton;
 
@property (nonatomic, strong, readwrite, nullable) UIBarButtonItem *customActionButton;
 
@property (nonatomic, assign) AGSPopupsViewControllerGeometryEditingStyle geometryEditingStyle;
 
@property (nonatomic, strong, nullable) UIViewController *modalPresenter;
 
@end