deCartaInfoWindow Class Reference
[Classes for map display and map-related functionality]

An information text window that is displayed on the map. More...

#import <deCartaInfoWindow.h>

Inherits deCartaEventSource-p.

List of all members.

Public Member Functions

(void) - setOffset:andRotationTilt:

Static Public Member Functions

(deCartaInfoWindow *) + getInfoWindowInstance

Properties

deCartaXYFloatoffset
NSString * message
deCartaPositionposition
BOOL visible
int backgroundColor
deCartaPinassociatedPin
deCartaRotationTiltoffsetRotationTilt
CGRect rect

Detailed Description

An information text window that is displayed on the map.

This class is a textbox for displaying simple information that can be displayed on the map. Generally this info window will be associated with a specific deCartaPin, and will be positioned above the pin. To have a deCartaInfoWindow appear on the map, assign the deCartaMapView object's infoWindow property to a specific deCartaInfoWindow object.

The deCartaInfoWindow class inherits from the deCartaEventSource class, and extends the class by adding functionality for triggering events. When TOUCH event is detected on the deCartaMapView over the deCartaInfoWindow's location, the deCartaInfoWindow will call it's listeners (deCartaEventLister objects) with the TOUCH event type (defined by the EventTypeEnum).


Member Function Documentation

+ (deCartaInfoWindow *) getInfoWindowInstance  

Returns a pointer to this deCartaInfoWindow object.

Returns:
Pointer to this deCartaInfoWindow object.
- (void) setOffset: (deCartaXYFloat *)  offset
andRotationTilt: (deCartaRotationTilt *)  offsetRotationTilt 

Sets the rotation and tilt of the info window. See the deCartaRotationTilt class for details about how to set the rotation and tilt of the info window relative to the screen, or relative to the map's rotation and tilt.

Parameters:
offset The offset, in pixels, to place the info window relative to the corresponding map location. Note that positive X,Y offset values give an offset that is up and to the left.
offsetRotationTilt The amount to rotate and tilt the info window.

Property Documentation

- (deCartaPin*) associatedPin [read, write, retain]

The deCartaPin with which this info window is associated (if it has an associated pin)

- (int) backgroundColor [read, write, assign]

Background color of the info window in 0xXXRRGGBB format.

- (NSString*) message [read, write, retain]

The text to display in the info window.

- (deCartaXYFloat*) offset [read, retain]

An XY pixel offset from the position on the map associated with this info window to the bottom-center tip of the info window. Generally, this offset is sufficient to place the info window just above the POI icon with which this info window is associated. Example: 0,0 - put bottom-center of info window directly on map location Example: 10,20 - position bottom-center of info window to the left 0 pixels, and up 20 pixels from the map location

- (deCartaRotationTilt*) offsetRotationTilt [read, retain]

The amount of rotation and tilt of this info window. See the deCartaRotationTilt class for details on rotating or tilting the info window relative to the screen, or relative to the map's rotation and tilt.

- (deCartaPosition*) position [read, write, retain]

The geographic position on the map that this info window is associated with.

- (CGRect) rect [read, assign]

The rectangular bounds of the info window

- (BOOL) visible [read, write, assign]

TRUE to make the info window visible.


The documentation for this class was generated from the following files:
 All Classes Functions Variables Properties

Generated on Fri Aug 12 16:23:01 2011 for deCarta iPhone API by  doxygen 1.6.1