CartoType API
Public Member Functions | Public Attributes
CartoType::CIcon Class Reference

#include <cartotype_icon.h>

Inheritance diagram for CartoType::CIcon:
CartoType::CBitmapIcon CartoType::CBoxIcon

List of all members.

Public Member Functions

virtual TResult Draw (CGraphicsContext &aGc, const TPoint &aTopLeft) const =0
virtual TResult Test (CLabelGraphicsContext &aGc, const TPoint &aTopLeft, bool aCanOverlapEdge) const =0
virtual void GetBounds (TRect &aBounds) const =0
virtual void GetLabelPos (TPoint &aLabelPos) const
virtual int32 LabelMaxLength () const
virtual const TBitmapBitmap () const
virtual class CBitmapIconBitmapIcon ()
virtual CT_IMPORT int32 MaxDistanceFromOrigin () const

Public Attributes

TIconName iName

Detailed Description

An abstract base class for icons to be drawn on a map.


Member Function Documentation

virtual const TBitmap* CartoType::CIcon::Bitmap ( ) const [inline, virtual]

Return a pointer to the bitmap of this icon if one exists, or null if there is none.

Reimplemented in CartoType::CBitmapIcon.

virtual class CBitmapIcon* CartoType::CIcon::BitmapIcon ( ) [inline, virtual]

Return a pointer to a CBitmapIcon if this is an object of that class, or null if not.

Reimplemented in CartoType::CBitmapIcon.

virtual TResult CartoType::CIcon::Draw ( CGraphicsContext aGc,
const TPoint aTopLeft 
) const [pure virtual]

Draw the icon with its top left (not its hotspot) at aTopLeft.

Implemented in CartoType::CBoxIcon, and CartoType::CBitmapIcon.

virtual void CartoType::CIcon::GetBounds ( TRect aBounds) const [pure virtual]

Get the bounds of the icon relative to its hotspot. The hotspot is the point, relative to the top left corner of the icon, that should be made to coincide with the point of interest marked by the icon.

Implemented in CartoType::CBoxIcon, and CartoType::CBitmapIcon.

virtual void CartoType::CIcon::GetLabelPos ( TPoint aLabelPos) const [inline, virtual]

Get the position for label text (center of baseline) relative to the hot spot.

Reimplemented in CartoType::CBitmapIcon.

virtual int32 CartoType::CIcon::LabelMaxLength ( ) const [inline, virtual]

Get the maximum length in pixels for label text.

Reimplemented in CartoType::CBitmapIcon.

CT_EXPORT int32 CIcon::MaxDistanceFromOrigin ( ) const [virtual]

Return a value in 64ths of pixels that is at least the maximum distance from the origin of any part of the icon.

Reimplemented in CartoType::CBitmapIcon.

virtual TResult CartoType::CIcon::Test ( CLabelGraphicsContext aGc,
const TPoint aTopLeft,
bool  aCanOverlapEdge 
) const [pure virtual]

Test the icon for overlap, with its top left (not its hotspot) at aTopLeft.

Implemented in CartoType::CBoxIcon, and CartoType::CBitmapIcon.


Member Data Documentation

The name used in a defs section in a style sheet to refer to the icon.


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