CartoTypeLegend.h File Reference

#import <CartoType/CartoTypeBase.h>

Go to the source code of this file.

Classes
class	CtLegend

Typedefs
typedef uint32_t CtLegendStyle	NS_TYPED_ENUM
typedef CtLegendStyle	CartoTypeLegendStyle

Variables
CtLegendStyle const	CtLegendStyleFlagTitle = 1
CtLegendStyle const	CtLegendStyleFlagScaleInTitle = 2
CtLegendStyle const	CtLegendStyleFlagMapObjects = 4
CtLegendStyle const	CtLegendStyleFlagScaleBar = 8
CtLegendStyle const	CtLegendStyleStandard = CtLegendStyleFlagTitle | CtLegendStyleFlagScaleInTitle | CtLegendStyleFlagMapObjects | CtLegendStyleFlagScaleBar
CtLegendStyle const	CtLegendStyleTurn = 16
CtLegendStyle const	CtLegendStyleScale = 32
CtLegendStyle const	CtLegendStyleEmpty = 0
compatibility_alias CartoTypeLegend	CtLegend

Detailed Description

The CtLegend class, which is used for map legends, turn instructions, scale bars and copyright notices.

Typedef Documentation

CartoTypeLegendStyle

typedef CtLegendStyle CartoTypeLegendStyle

A synonym of CtLegendStyle.

NS_TYPED_ENUM

typedef uint32_t CtLegendStyle NS_TYPED_ENUM

Style flags used in the Legend constructor.

Variable Documentation

CtLegend

compatibility_alias CartoTypeLegend CtLegend

A synonym of CtLegend.

CtLegendStyleEmpty

CtLegendStyle const CtLegendStyleEmpty = 0

Style flags used in the Legend constructor to create an empty legend object.

CtLegendStyleFlagMapObjects

CtLegendStyle const CtLegendStyleFlagMapObjects = 4

A style flag used in the Legend constructor to add lines for common map objects including roads, forests, parks and stations.

CtLegendStyleFlagScaleBar

CtLegendStyle const CtLegendStyleFlagScaleBar = 8

A style flag used in the Legend constructor to add a scale bar.

CtLegendStyleFlagScaleInTitle

CtLegendStyle const CtLegendStyleFlagScaleInTitle = 2

A style flag used in the Legend constructor to add the scale in the form 1:NNN to the title.

CtLegendStyleFlagTitle

CtLegendStyle const CtLegendStyleFlagTitle = 1

A style flag used in the Legend constructor to add the name of the main map as a title.

CtLegendStyleScale

CtLegendStyle const CtLegendStyleScale = 32

Style flags used in the constructor to create an empty legend object suitable for a scale bar. The font, border, colors, etc., of the legend can then be changed, after which the legend can be used in SetScaleBar.

CtLegendStyleStandard

CtLegendStyle const CtLegendStyleStandard = CtLegendStyleFlagTitle | CtLegendStyleFlagScaleInTitle | CtLegendStyleFlagMapObjects | CtLegendStyleFlagScaleBar

Style flags used in the Legend constructor to select the standard style.

CtLegendStyleTurn

CtLegendStyle const CtLegendStyleTurn = 16

Style flags used in the constructor to create an empty legend object suitable for turn instructions. The font, border, colors, etc., of the legend can then be changed, after which the legend can be used in SetTurnInstructions.