rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Maps Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
IlvMapCoordViewer Class Reference

Displays the coordinates of the mouse when it is on top of an IlvView displaying a map. More...

#include <ilviews/maps/gui/coordview.h>

Inheritance diagram for IlvMapCoordViewer:
IlvSimpleGraphic IlvGraphic

Public Member Functions

 IlvMapCoordViewer (IlvDisplay *display, const IlvRect &rect, IlvPalette *palette=0)
 Constructor. More...
 
 IlvMapCoordViewer (IlvDisplay *display, const IlvPoint &pos, IlvPalette *palette=0)
 Constructor. More...
 
const char * getEastingFormat ()
 Retrieves the easting format. More...
 
const char * getEastinglabel ()
 Retrieves the easting label. More...
 
const char * getNorthingFormat ()
 Retrieves the northing format. More...
 
const char * getNorthinglabel ()
 Retrieves the northing label. More...
 
IlBoolean isDisplayingEasting ()
 Checks if the object is displaying easting values. More...
 
IlBoolean isDisplayingNorthing ()
 Checks if the object is displaying northing values. More...
 
void setDisplayingEasting (IlBoolean displayEasting, IlBoolean redraw=IlFalse)
 Specifies whether the coordinate viewer should display the easting value of the mouse coordinates. More...
 
void setDisplayingNorthing (IlBoolean displayNorthing, IlBoolean redraw=IlFalse)
 Specifies whether the coordinate viewer should display the northing value of the mouse coordinates. More...
 
void setDisplayMode (IlvMapCoordViewerMode mode, IlBoolean redraw=IlFalse)
 Specifies the display mode of the mouse coordinates. More...
 
void setEastingFormat (const char *format, IlBoolean redraw=IlFalse)
 Sets the easting format. More...
 
void setEastinglabel (const char *label, IlBoolean redraw=IlFalse)
 Sets the prompt string to be displayed before the easting value. More...
 
void setNorthingFormat (const char *format, IlBoolean redraw=IlFalse)
 Sets the northing format. More...
 
void setNorthinglabel (const char *, IlBoolean redraw=IlFalse)
 Sets the prompt string to be displayed before the northing value. More...
 
void setVertical (IlBoolean vertical, IlBoolean redraw=IlFalse)
 Sets the orientation of the display. More...
 
void setView (IlvView *view)
 Sets the view for which coordinates are to be displayed. More...
 

Detailed Description

Displays the coordinates of the mouse when it is on top of an IlvView displaying a map.

Library: ilvmaps

The coordinates can be displayed in two modes:

Constructor & Destructor Documentation

IlvMapCoordViewer::IlvMapCoordViewer ( IlvDisplay display,
const IlvRect rect,
IlvPalette palette = 0 
)

Constructor.

Parameters
displayThe IlvDisplay.
rectThe position and dimension of the object.
paletteThe IlvPalette.
IlvMapCoordViewer::IlvMapCoordViewer ( IlvDisplay display,
const IlvPoint pos,
IlvPalette palette = 0 
)

Constructor.

Parameters
displayThe IlvDisplay.
posThe position of the upper left point of the object. A size is then automatically computed.
paletteThe IlvPalette.

Member Function Documentation

const char* IlvMapCoordViewer::getEastingFormat ( )

Retrieves the easting format.

Returns
The easting format. This string is still owned by the object.
const char* IlvMapCoordViewer::getEastinglabel ( )

Retrieves the easting label.

Returns
The easting label. The string is still owned by the IlvMapCoordViewer.
const char* IlvMapCoordViewer::getNorthingFormat ( )

Retrieves the northing format.

Returns
The northing format. This string is still owned by the object.
const char* IlvMapCoordViewer::getNorthinglabel ( )

Retrieves the northing label.

Returns
The northing label. This string is still owned by the IlvMapCoordViewer.
IlBoolean IlvMapCoordViewer::isDisplayingEasting ( )

Checks if the object is displaying easting values.

Returns
IlTrue if object is displaying easting, IlFalse otherwise.
IlBoolean IlvMapCoordViewer::isDisplayingNorthing ( )

Checks if the object is displaying northing values.

Returns
IlTrue if object is displaying northing, IlFalse otherwise.
void IlvMapCoordViewer::setDisplayingEasting ( IlBoolean  displayEasting,
IlBoolean  redraw = IlFalse 
)

Specifies whether the coordinate viewer should display the easting value of the mouse coordinates.

The coordinate viewer can be used to display either the easting value or the northing value of the coordinates, or both.

Parameters
displayEastingIf set to IlTrue, easting is displayed.
redrawSpecifies if the object is to be redrawn.
void IlvMapCoordViewer::setDisplayingNorthing ( IlBoolean  displayNorthing,
IlBoolean  redraw = IlFalse 
)

Specifies whether the coordinate viewer should display the northing value of the mouse coordinates.

The coordinate viewer can be used to display either the northing value or the northing value of the coordinates, or both.

Parameters
displayNorthingIf set to IlTrue, northing is displayed.
redrawSpecifies if the object is to be redrawn.
void IlvMapCoordViewer::setDisplayMode ( IlvMapCoordViewerMode  mode,
IlBoolean  redraw = IlFalse 
)

Specifies the display mode of the mouse coordinates.

Parameters
modeThe display mode.
redrawSpecifies if the object is to be redrawn.
void IlvMapCoordViewer::setEastingFormat ( const char *  format,
IlBoolean  redraw = IlFalse 
)

Sets the easting format.

This string is used to format the value of the easting coordinate in Cartesian mode. The default value is %1.6f. This string is copied by the object.

Parameters
formatThe easting format.
redrawSpecifies if the object is to be redrawn.
void IlvMapCoordViewer::setEastinglabel ( const char *  label,
IlBoolean  redraw = IlFalse 
)

Sets the prompt string to be displayed before the easting value.

The default value is "X = ".

Parameters
labelThe easting label. This string is copied by the object.
redrawSpecifies if the object is to be redrawn.
void IlvMapCoordViewer::setNorthingFormat ( const char *  format,
IlBoolean  redraw = IlFalse 
)

Sets the northing format.

This string is used to format the value of the northing coordinate in Cartesian mode. The default value is %1.6f. This string is copied by the object.

Parameters
formatThe northing format.
redrawSpecifies if the object is to be redrawn.
void IlvMapCoordViewer::setNorthinglabel ( const char *  ,
IlBoolean  redraw = IlFalse 
)

Sets the prompt string to be displayed before the northing value.

The default value is "Y = ".

Parameters
labelThe northing label. This string is copied by the object.
redrawSpecifies if the object is to be redrawn.
void IlvMapCoordViewer::setVertical ( IlBoolean  vertical,
IlBoolean  redraw = IlFalse 
)

Sets the orientation of the display.

Parameters
verticalIf set to IlTrue the northing value is displayed under the easting value. If set to IlFalse, the northing value is displayed to the right of the easting value.
redrawSpecifies if the object is to be redrawn.
void IlvMapCoordViewer::setView ( IlvView view)

Sets the view for which coordinates are to be displayed.

Parameters
viewThe view for which coordinates are to be displayed.

© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.