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)
	Initializes a new IlvMapDefaultScaleBar instance. More...
const IlvColor *	getAlternateColor () const
	Gets the alternate color. More...
IlInt	getDivisions () const
	Retrieves the number of divisions. More...
IlvMapDefaultScaleBarStyle	getStyle () const
	Retrieves the style of the bar. More...
void	setAlternateColor (IlvColor *color)
	Sets the alternate color. More...
void	setDivisions (IlInt divs)
	Sets the number of divisions. More...
void	setStyle (IlvMapDefaultScaleBarStyle style)
	Changes the style of the bar. More...

Detailed Description

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

Library: ilvmaps

Constructor & Destructor Documentation

IlvMapDefaultScaleBar()

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

Initializes a new IlvMapDefaultScaleBar instance.

Parameters

display	The display to draw this object with.
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.

Member Function Documentation

getAlternateColor()

const IlvColor* IlvMapDefaultScaleBar::getAlternateColor

(

)

const

Gets the alternate color.

Returns

The alternate color.

getDivisions()

IlInt IlvMapDefaultScaleBar::getDivisions

(

)

const

Retrieves the number of divisions.

Returns

The number of divisions.

getStyle()

IlvMapDefaultScaleBarStyle IlvMapDefaultScaleBar::getStyle

(

)

const

Retrieves the style of the bar.

Returns

The style of the bar.

setAlternateColor()

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.

setDivisions()

void IlvMapDefaultScaleBar::setDivisions

(

IlInt

divs

)

Sets the number of divisions.

Parameters

divs	The number of divisions.

setStyle()

void IlvMapDefaultScaleBar::setStyle

(

IlvMapDefaultScaleBarStyle

style

)

Changes the style of the bar.

Parameters

style

The new style.