Public Member Functions | Properties

BMUserLocation Class Reference

BMUserLocation shows the current location of the user on a map. More...

Inheritance diagram for BMUserLocation:
<BMMarker>

List of all members.

Public Member Functions

(CLLocationCoordinate2D) - coordinate [implementation]
 The current coordinate of the device. (read-only)
(void) - setTitle: [implementation]
 Sets the title to display in the callout for the user location marker.
(void) - setSubtitle: [implementation]
 Sets the subtitle to display in the callout for the user location marker.

Properties

CLLocation * location
 The current location of the device. (read-only)
NSString * title
 The title to display in the callout for the user location marker.
NSString * subtitle
 The subtitle to display in the callout for the user location marker.

Detailed Description

BMUserLocation shows the current location of the user on a map.

BMUserLocation is an implementation of BMMarker. It is not implemented directly, but is displayed on the map by calling the method setShowsUserLocation in BMMapView. The userLocation marker is a property of BMMapView and can be accessed as such.


Member Function Documentation

- (CLLocationCoordinate2D) coordinate [implementation]

The current coordinate of the device. (read-only)

Returns:
The current coordinate. Returns lon=0, lat=0 if the owning BMMapView's showsUserLocation is NO or the user's location has yet to be determined.
- (void) setSubtitle: (NSString*)  value [implementation]

Sets the subtitle to display in the callout for the user location marker.

- (void) setTitle: (NSString*)  value [implementation]

Sets the title to display in the callout for the user location marker.


Property Documentation

- (CLLocation *) location [read, assign]

The current location of the device. (read-only)

Returns:
The current location. Returns nil if the owning BMMapView's showsUserLocation is NO or the user's location has yet to be determined.
- (NSString *) subtitle [read, write, retain]

The subtitle to display in the callout for the user location marker.

Returns:
Subtitle value for user location callout.
- (NSString *) title [read, write, retain]

The title to display in the callout for the user location marker.

Returns:
Title value for user location callout. If no title is set, the default value is "Current Location".

The documentation for this class was generated from the following files: