AGSCallout.h

Go to the documentation of this file.

/*
 COPYRIGHT 1995-2020 ESRI
 
 TRADE SECRETS: ESRI PROPRIETARY AND CONFIDENTIAL
 Unpublished material - all rights reserved under the
 Copyright Laws of the United States and applicable international
 laws, treaties, and conventions.
 
 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
 */

#import <Foundation/Foundation.h>
#if TARGET_OS_IPHONE
#import <ArcGIS/AGSView.h>
#import <ArcGIS/AGSImage.h>
#import <UIKit/UIButton.h>
#endif
#import <ArcGIS/AGSColor.h>

@protocol AGSCalloutDelegate;
@class AGSPoint;
@class AGSLocationDisplay;
@class AGSFeature;
@class AGSGraphic;



#if TARGET_OS_IPHONE

typedef NS_OPTIONS(NSUInteger, AGSCalloutLeaderPosition) {
    AGSCalloutLeaderPositionBottom = 1UL << 0,          
    AGSCalloutLeaderPositionTop = 1UL << 1,             
    AGSCalloutLeaderPositionLeft = 1UL << 2,            
    AGSCalloutLeaderPositionRight = 1UL << 3,           
    AGSCalloutLeaderPositionAny = AGSCalloutLeaderPositionBottom | AGSCalloutLeaderPositionTop | AGSCalloutLeaderPositionLeft | AGSCalloutLeaderPositionRight                   
} ;
#endif
 //Required for Globals API doc

#if TARGET_OS_IPHONE
@interface AGSCallout : AGSView

#pragma mark -
#pragma mark initializers

#pragma mark -
#pragma mark properties

@property (nonatomic) CGFloat width;

@property (nullable, nonatomic, strong) AGSView *customView;


@property (nonatomic) UIButtonType accessoryButtonType;

@property (nullable, nonatomic, strong) UIImage *accessoryButtonImage;


@property (nullable, nonatomic, strong) AGSImage *image;

@property (nonatomic) BOOL autoAdjustWidth;

@property (nonatomic, assign, getter=isAccessoryButtonHidden) BOOL accessoryButtonHidden;

@property (nonatomic, assign) AGSCalloutLeaderPosition leaderPositionFlags;

@property (nullable, nonatomic, strong) AGSColor *borderColor;

@property (nonatomic, assign) CGFloat borderWidth;


#elif TARGET_OS_OSX
@interface AGSCallout : NSObject

@property (nonatomic, assign, getter = isHidden) BOOL hidden;

@property (nonatomic, assign) BOOL highlightTop;

#endif

@property (nullable, nonatomic, strong, readonly) AGSPoint *mapLocation;

@property (nonatomic, readonly) CGPoint screenOffset;

@property (nullable, nonatomic, copy) NSString *title;

@property (nullable, nonatomic, copy) NSString *detail;

@property (nonatomic, strong) AGSColor *color;

@property (nullable, nonatomic, strong) AGSColor *highlight;

@property (nonatomic, strong) AGSColor *titleColor;

@property (nonatomic, strong) AGSColor *detailColor;

@property (nullable, nonatomic, weak) id<AGSCalloutDelegate> delegate;

@property (nonatomic) CGSize margin;

@property (nonatomic) CGFloat cornerRadius;

@property (nonatomic) CGFloat maxWidth;

@property (nullable, nonatomic, strong, readonly) id representedObject;

#pragma mark -
#pragma mark methods

-(BOOL)showCalloutForFeature:(AGSFeature*)feature tapLocation:(nullable AGSPoint*)mapTapLocation animated:(BOOL)animated;

-(BOOL)showCalloutForGraphic:(AGSGraphic*)graphic tapLocation:(nullable AGSPoint*)mapTapLocation animated:(BOOL)animated;

-(BOOL)showCalloutForLocationDisplay;

-(void)showCalloutAt:(AGSPoint*)mapLocation screenOffset:(CGPoint)screenOffset rotateOffsetWithMap:(BOOL)rotateOffsetWithMap animated:(BOOL)animated;

-(void)dismiss;

@end



#pragma mark -

@protocol AGSCalloutDelegate 

@optional

-(BOOL)callout:(AGSCallout*)callout willShowAtMapPoint:(AGSPoint *)mapPoint;

-(BOOL)callout:(AGSCallout*)callout willShowForLocationDisplay:(AGSLocationDisplay*)locationDisplay;

-(void)calloutWillDismiss:(AGSCallout*)callout;

-(void)calloutDidDismiss:(AGSCallout*)callout;

#if TARGET_OS_IPHONE

- (void)didTapAccessoryButtonForCallout:(AGSCallout *)callout;

#elif TARGET_OS_OSX

-(void)didTapCallout:(AGSCallout*)callout;

#endif

@end