Views
Maps Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
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:
IlvSimpleGraphic IlvGraphic IlvStylable IlvValueInterface

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 IlvColorgetAlternateColor () 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
displayThe display to draw this object with.
rectThe initial size of the bar.
divsThe number of divisions.
styleThe style of the scale.
altColorThe alternate color used in filled styles.
paletteThe 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
colorThe 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
divsThe number of divisions.

◆ setStyle()

void IlvMapDefaultScaleBar::setStyle ( IlvMapDefaultScaleBarStyle  style)

Changes the style of the bar.

Parameters
styleThe new style.