CartoType::CMapDrawParam Class Reference

#include <cartotype_style_sheet.h>

List of all members.

Public Member Functions
CT_IMPORT void	EnableLayer (const MString &aLayerName)
CT_IMPORT void	EnableLayer (const char *aLayerName)
CT_IMPORT TResult	DisableLayer (const MString &aLayerName)
CT_IMPORT TResult	DisableLayer (const char *aLayerName)
CT_IMPORT TResult	AddConditionToLayer (const MString &aLayerName, const MString &aCondition)
CT_IMPORT TResult	AddConditionToLayer (const char *aLayerName, const char *aCondition)
Public Attributes
CMapDataBase *	iAuxDataBase
CPointerArray< CLayerParam >	iLayerParam
CPointerArray< CLayerStyle >	iCustomStyle
CPointerArray< CIcon >	iCustomIconList
bool	iDrawMapObjects
bool	iDrawLabels
MObjectStyleOverride *	iObjectStyleOverride

---

Detailed Description

Optional advanced parameters for controlling map drawing, including objects to be highlighted, layers to be omitted, custom layer styles, custom icons, and a custom object styles.

---

Member Function Documentation

CT_EXPORT TResult CMapDrawParam::AddConditionToLayer	(	const MString &	aLayerName,
		const MString &	aCondition
	)

Add a condition, encoded as a string, to a named layer.

CT_EXPORT TResult CMapDrawParam::AddConditionToLayer	(	const char *	aLayerName,
		const char *	aCondition
	)

Add a condition, encoded as a string, to a named layer.

CT_EXPORT TResult CMapDrawParam::DisableLayer

(

const MString &

aLayerName

)

Disable a named layer. If the layer is already disabled this function has no effect.

CT_EXPORT TResult CMapDrawParam::DisableLayer

(

const char *

aLayerName

)

Disable a named layer. If the layer is already disabled this function has no effect.

CT_EXPORT void CMapDrawParam::EnableLayer

(

const MString &

aLayerName

)

Enable a named layer. If the layer is already enabled this function has no effect.

CT_EXPORT void CMapDrawParam::EnableLayer

(

const char *

aLayerName

)

Enable a named layer. If the layer is already enabled this function has no effect.

---

Member Data Documentation

CMapDataBase* CartoType::CMapDrawParam::iAuxDataBase

If non-null, the auxiliary database, containing objects to be highlighted, pushpins, etc.

CPointerArray<CIcon> CartoType::CMapDrawParam::iCustomIconList

Custom icons. Icons found here are used in preference over icons in the style sheet.

CPointerArray<CLayerStyle> CartoType::CMapDrawParam::iCustomStyle

Custom styles. Styles found here are used in preference to those in the style sheet. To override the style for layer "my-layer", create a style, set its iName member to "my-layer", and add it to the iCustomStyle array using CPointerArray::Append. You can create a style similar to a style defined in the style sheet by copying the style in the style sheet using CMap::CopyLayerStyle, then modifying the returned style.

The custom style refers to the current scale, therefore it needs to be modified or recreated every time the scale changes.

bool CartoType::CMapDrawParam::iDrawLabels

True if labels are to be drawn.

bool CartoType::CMapDrawParam::iDrawMapObjects

True if map objects are to be drawn. Making this false allows labels only to be drawn so that they can be used as an overlay.

CPointerArray<CLayerParam> CartoType::CMapDrawParam::iLayerParam

Parameters controlling which objects are drawn in a layer.

MObjectStyleOverride* CartoType::CMapDrawParam::iObjectStyleOverride

If non-null, iObjectStyleOverride->ObjectStyle is called for every object just before it is drawn, allowing the style of an object to be set according to its ID or attributes.

---

The documentation for this class was generated from the following files:

• cartotype_style_sheet.h
• cartotype_style_sheet.cpp