123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147 |
- //
- // GMSAutocompleteViewController.h
- // Google Places SDK for iOS
- //
- // Copyright 2016 Google LLC
- //
- // Usage of this SDK is subject to the Google Maps/Google Earth APIs Terms of
- // Service: https://developers.google.com/maps/terms
- //
- #import <UIKit/UIKit.h>
- #import "GMSAutocompleteFilter.h"
- #import "GMSAutocompletePrediction.h"
- #import "GMSPlace.h"
- #import "GMSPlaceFieldMask.h"
- #import "GMSPlacesDeprecationUtils.h"
- @class GMSAutocompleteViewController;
- NS_ASSUME_NONNULL_BEGIN
- /**
- * Protocol used by |GMSAutocompleteViewController|, to communicate the user's interaction
- * with the controller to the application.
- */
- @protocol GMSAutocompleteViewControllerDelegate <NSObject>
- @required
- /**
- * Called when a place has been selected from the available autocomplete predictions.
- *
- * Implementations of this method should dismiss the view controller as the view controller will not
- * dismiss itself.
- *
- * @param viewController The |GMSAutocompleteViewController| that generated the event.
- * @param place The |GMSPlace| that was returned.
- */
- - (void)viewController:(GMSAutocompleteViewController *)viewController
- didAutocompleteWithPlace:(GMSPlace *)place;
- /**
- * Called when a non-retryable error occurred when retrieving autocomplete predictions or place
- * details. A non-retryable error is defined as one that is unlikely to be fixed by immediately
- * retrying the operation.
- *
- * Only the following values of |GMSPlacesErrorCode| are retryable:
- * <ul>
- * <li>kGMSPlacesNetworkError
- * <li>kGMSPlacesServerError
- * <li>kGMSPlacesInternalError
- * </ul>
- * All other error codes are non-retryable.
- *
- * @param viewController The |GMSAutocompleteViewController| that generated the event.
- * @param error The |NSError| that was returned.
- */
- - (void)viewController:(GMSAutocompleteViewController *)viewController
- didFailAutocompleteWithError:(NSError *)error;
- /**
- * Called when the user taps the Cancel button in a |GMSAutocompleteViewController|.
- *
- * Implementations of this method should dismiss the view controller as the view controller will not
- * dismiss itself.
- *
- * @param viewController The |GMSAutocompleteViewController| that generated the event.
- */
- - (void)wasCancelled:(GMSAutocompleteViewController *)viewController;
- @optional
- /**
- * Called when the user selects an autocomplete prediction from the list but before requesting
- * place details.
- *
- * Returning NO from this method will suppress the place details fetch and didAutocompleteWithPlace
- * will not be called.
- *
- * @param viewController The |GMSAutocompleteViewController| that generated the event.
- * @param prediction The |GMSAutocompletePrediction| that was selected.
- */
- - (BOOL)viewController:(GMSAutocompleteViewController *)viewController
- didSelectPrediction:(GMSAutocompletePrediction *)prediction;
- /**
- * Called once every time new autocomplete predictions are received.
- *
- * @param viewController The |GMSAutocompleteViewController| that generated the event.
- */
- - (void)didUpdateAutocompletePredictions:(GMSAutocompleteViewController *)viewController;
- /**
- * Called once immediately after a request for autocomplete predictions is made.
- *
- * @param viewController The |GMSAutocompleteViewController| that generated the event.
- */
- - (void)didRequestAutocompletePredictions:(GMSAutocompleteViewController *)viewController;
- @end
- /**
- * GMSAutocompleteViewController provides an interface that displays a table of autocomplete
- * predictions that updates as the user enters text. Place selections made by the user are
- * returned to the app via the |GMSAutocompleteViewControllerResultsDelegate| protocol.
- *
- * To use GMSAutocompleteViewController, set its delegate to an object in your app that
- * conforms to the |GMSAutocompleteViewControllerDelegate| protocol and present the controller
- * (eg using presentViewController). The |GMSAutocompleteViewControllerDelegate| delegate methods
- * can be used to determine when the user has selected a place or has cancelled selection.
- */
- @interface GMSAutocompleteViewController : UIViewController
- /** Delegate to be notified when a place is selected or picking is cancelled. */
- @property(nonatomic, weak, nullable) IBOutlet id<GMSAutocompleteViewControllerDelegate> delegate;
- /** Filter to apply to autocomplete suggestions (can be nil). */
- @property(nonatomic, strong, nullable) GMSAutocompleteFilter *autocompleteFilter;
- /** The background color of table cells. */
- @property(nonatomic, strong) IBInspectable UIColor *tableCellBackgroundColor;
- /** The color of the separator line between table cells. */
- @property(nonatomic, strong) IBInspectable UIColor *tableCellSeparatorColor;
- /** The color of result name text in autocomplete results */
- @property(nonatomic, strong) IBInspectable UIColor *primaryTextColor;
- /** The color used to highlight matching text in autocomplete results */
- @property(nonatomic, strong) IBInspectable UIColor *primaryTextHighlightColor;
- /** The color of the second row of text in autocomplete results. */
- @property(nonatomic, strong) IBInspectable UIColor *secondaryTextColor;
- /** The tint color applied to controls in the Autocomplete view. */
- @property(nonatomic, strong, nullable) IBInspectable UIColor *tintColor;
- /**
- * Specify individual place details to fetch for object |GMSPlace|.
- * Defaults to returning all details if not overridden.
- */
- @property(nonatomic, assign) GMSPlaceField placeFields;
- @end
- NS_ASSUME_NONNULL_END
|