IlvMapDefaultScaleBar Class Reference

The default scale bar used by IlvMapScale when none is provided by the user. More...

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

Inheritance diagram for IlvMapDefaultScaleBar:

Public Member Functions
	IlvMapDefaultScaleBar (IlvDisplay display, const IlvRect &rect, IlUInt divs, IlvMapDefaultScaleBarStyle style, IlvColor altColor=0, IlvPalette *palette=0)
	Constructor.
const IlvColor *	getAlternateColor ()
	Gets the alternate color.
IlInt	getDivisions ()
	Retrieves the number of divisions.
IlvMapDefaultScaleBarStyle	getStyle ()
	Retrieves the style of the bar.
void	setAlternateColor (IlvColor *color)
	Sets the alternate color.
void	setDivisions (IlInt divs)
	Sets the number of divisions.
void	setStyle (IlvMapDefaultScaleBarStyle style)
	Changes the style of the bar.

Detailed Description

The default scale bar used by IlvMapScale when none is provided by the user.

Library: ilvmaps

IlvMapDefaultScaleBar::IlvMapDefaultScaleBar	(	IlvDisplay *	display,
		const IlvRect &	rect,
		IlUInt	divs,
		IlvMapDefaultScaleBarStyle	style,
		IlvColor *	altColor = `0`,
		IlvPalette *	palette = `0`
	)

Constructor.

Parameters:

	display	The `IlvDisplay`.
	rect	The initial size of the bar.
	divs	The number of divisions.
	style	The style of the scale.
	altColor	The alternate color used in filled styles.
	palette	The palette.

const IlvColor* IlvMapDefaultScaleBar::getAlternateColor ( )

Gets the alternate color.

IlInt IlvMapDefaultScaleBar::getDivisions ( )

Retrieves the number of divisions.

IlvMapDefaultScaleBarStyle IlvMapDefaultScaleBar::getStyle ( )

Retrieves the style of the bar.

void IlvMapDefaultScaleBar::setAlternateColor ( IlvColor * color )

Sets the alternate color.

Parameters:

color

The new alternate color. The previous alternate color (if any) is unlocked and the new supplied color is locked.

void IlvMapDefaultScaleBar::setDivisions ( IlInt divs )

Sets the number of divisions.

Parameters:

divs

The number of divisions.

void IlvMapDefaultScaleBar::setStyle ( IlvMapDefaultScaleBarStyle style )

Changes the style of the bar.

Parameters:

style

The new style.