GRE::LEGEND_IMAGESAMPLE Class Reference

Image Sample legend subclass. More...

#include <gre/legendimagesample.h>

Inheritance diagram for GRE::LEGEND_IMAGESAMPLE:

[legend]

List of all members.

Classes
class	ITEM
	Individual item in legend. More...
Public Types
enum	LOCATION {   LOCATION_TopLeft = 0, LOCATION_TopCenter = 1, LOCATION_TopRight = 2, LOCATION_CenterLeft = 3,   LOCATION_Center = 4, LOCATION_CenterRight = 5, LOCATION_BottomLeft = 6, LOCATION_BottomCenter = 7,   LOCATION_BottomRight = 8 }
Public Member Functions
	LEGEND_IMAGESAMPLE (LAYER_IMAGE *layer)
int	AddItem (SPATMOD::IMAGE::STAGE *pStageInput, const LPOINT2D &center, const MISTRING &label)
int	AddThumbnail (SPATMOD::IMAGE::STAGE *pStageInput, const MISTRING &label)
void	SetItemSize (INT32 xsize, INT32 ysize)

---

Detailed Description

Image Sample legend subclass.

---

Member Enumeration Documentation

enum GRE::LEGEND_IMAGESAMPLE::LOCATION

Enumerator:

LOCATION_TopLeft
LOCATION_TopCenter
LOCATION_TopRight
LOCATION_CenterLeft
LOCATION_Center
LOCATION_CenterRight
LOCATION_BottomLeft
LOCATION_BottomCenter
LOCATION_BottomRight

---

Constructor & Destructor Documentation

GRE::LEGEND_IMAGESAMPLE::LEGEND_IMAGESAMPLE

(

LAYER_IMAGE *

layer

)

[explicit]

Construct legend for layer.

---

Member Function Documentation

int GRE::LEGEND_IMAGESAMPLE::AddItem	(	SPATMOD::IMAGE::STAGE *	pStageInput,
		const LPOINT2D &	center,
		const MISTRING &	label
	)

Add item to legend.

Returns:

TRUE if item added, FALSE if all cells NULL in specified area, < 0 if error.

int GRE::LEGEND_IMAGESAMPLE::AddThumbnail	(	SPATMOD::IMAGE::STAGE *	pStageInput,
		const MISTRING &	label
	)

Add thumbnail to legend.

Returns:

TRUE if item added, FALSE if all cells NULL in specified area, < 0 if error.

void GRE::LEGEND_IMAGESAMPLE::SetItemSize	(	INT32	xsize,
		INT32	ysize
	)			[inline]

Set item size.

---

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

• gre/legendimagesample.h