CartoTypeCore::ExtendedNoticePosition Class Reference

#include <cartotype_base.h>

Public Member Functions
	ExtendedNoticePosition (NoticePosition aBasePosition)
	ExtendedNoticePosition (NoticePosition aBasePosition, double aXInset, const char *aXInsetUnit, double aYInset, const char *aYInsetUnit)
NoticePosition	BasePosition () const
double	XInset () const
const char *	XInsetUnit () const
double	YInset () const
const char *	YInsetUnit () const

Detailed Description

Positions for notices like the legend or scale bar.

Notices are positioned by moving them inwards from the designated position by the specified insets. For central positions (e.g., the X inset in Top, or both insets in Center) X insets move the position right and Y insets move it down. Units may be 'cm', 'mm', 'in', 'pt' (points: 1/72in), or 'pc' (picas: 1/6in); anything else, including null, means pixels.

The default inset is 3mm, or zero for central positions.

Constructor & Destructor Documentation

ExtendedNoticePosition() [1/2]

CartoTypeCore::ExtendedNoticePosition::ExtendedNoticePosition

(

NoticePosition

aBasePosition

)

Creates an extended notice position with a given base position, inset from the side or corner by 3mm.

ExtendedNoticePosition() [2/2]

CartoTypeCore::ExtendedNoticePosition::ExtendedNoticePosition	(	NoticePosition	aBasePosition,
		double	aXInset,
		const char *	aXInsetUnit,
		double	aYInset,
		const char *	aYInsetUnit
	)

Creates an extended notice position with a given base position and X and Y insets.

Member Function Documentation

BasePosition()

NoticePosition CartoTypeCore::ExtendedNoticePosition::BasePosition ( ) const

inline

Returns the base position.

XInset()

double CartoTypeCore::ExtendedNoticePosition::XInset ( ) const

inline

Returns the X (horizontal) inset.

XInsetUnit()

const char * CartoTypeCore::ExtendedNoticePosition::XInsetUnit ( ) const

inline

Returns the unit (e.g., "mm") used for the X inset.

YInset()

double CartoTypeCore::ExtendedNoticePosition::YInset ( ) const

inline

Returns the Y (vertical) inset.

YInsetUnit()

const char * CartoTypeCore::ExtendedNoticePosition::YInsetUnit ( ) const

inline

Returns the unit (e.g., "mm") used for the Y inset.

---

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

• cartotype_base.h
• cartotype_base.cpp