<AGSCalloutDelegate> Protocol Reference

Description

A delegate of AGSCallout.

A protocol which must be adopted by a class wishing to control the behavior of displaying a callout for a map's features, graphics, or location display symbol. The delegate is also notified when a user interacts with the callout. An instance of the class must be set as AGSCallout::delegate.

All of the methods of this protocol are optional.

@define{AGSCallout.h, ArcGIS}

Since

100

Instance Methods
(BOOL)	- callout:willShowAtMapPoint:
(BOOL)	- callout:willShowForLocationDisplay:
(void)	- calloutDidDismiss:
(void)	- calloutWillDismiss:
(void)	- didTapAccessoryButtonForCallout:

Method Documentation

callout:willShowAtMapPoint:

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

optional

Informs the delegate that a callout is about to be shown at the specfied map location. The delegate should return NO if it wants to abort showing the callout.

Parameters

callout	The callout that will show.
mapPoint	The location at which the callout will show.

Returns

Value indicating whether or not the callout should actually show.

Since

100

callout:willShowForLocationDisplay:

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

optional

Informs the delegate that a callout is about to be shown for the map's location display symbol. The delegate should return NO if it wants to abort showing the callout.

Parameters

callout	The callout that will show.
locationDisplay	The locationDisplay to display the callout for.

Returns

Value indicating whether or not the callout should actually show.

Since

100

calloutDidDismiss:

- (void) calloutDidDismiss: (AGSCallout *)  callout

optional

Informs the delegate that the callout was dismissed.

Since

100

calloutWillDismiss:

- (void) calloutWillDismiss: (AGSCallout *)  callout

optional

Informs the delegate that the callout will be dismissed.

Since

100

didTapAccessoryButtonForCallout:

- (void) didTapAccessoryButtonForCallout: (AGSCallout *)  callout

optional

Informs the delegate the user tapped on the accessory button in the callout. You can check the AGSCallout::representedObject to find out what object the callout was being displayed for

Parameters

callout

Callout containing accessory button.

Since

100