GRE_LAYER_LEGEND Class Reference

#include <gre/lrlegend.h>

Inheritance diagram for GRE_LAYER_LEGEND:

Inheritance graph
[legend]
List of all members.

Public Types

enum  SUBTYPE {
  SUBTYPE_Point = 0, SUBTYPE_Line = 1, SUBTYPE_Poly = 2, SUBTYPE_ColorSample = 3,
  SUBTYPE_ColorScale = 4, SUBTYPE_RasterSample = 5
}

Public Member Functions

const DISPPARMGetDispParm () const
 GRE_LAYER_LEGEND (GRE_GROUP *group, GRE_LAYER *reflayer=0, UINT32 flags=MDISPCREATE_InsertAfter)
ERRVALUE SetDispParm (const DISPPARM &dispparm)
virtual ~GRE_LAYER_LEGEND ()

Static Public Member Functions

int Construct (GRE_GROUP *group, GRE_LAYER **retlayer, GRE_LAYER *reflayer, UINT32 flags)
void RegisterType ()

Protected Attributes

DISPPARM m_dispparm

Member Enumeration Documentation

enum GRE_LAYER_LEGEND::SUBTYPE
 

Enumeration values:
SUBTYPE_Point  These types are stored in layouts by number and thus must not be changed.
SUBTYPE_Line 
SUBTYPE_Poly 
SUBTYPE_ColorSample 
SUBTYPE_ColorScale 
SUBTYPE_RasterSample 

Definition at line 39 of file lrlegend.h.


Constructor & Destructor Documentation

GRE_LAYER_LEGEND::GRE_LAYER_LEGEND GRE_GROUP group,
GRE_LAYER reflayer = 0,
UINT32  flags = MDISPCREATE_InsertAfter
[explicit]
 

Construct layer and insert into list.

Parameters:
group  Group to contain layer
reflayer  Reference layer for insertion
flags  MDISPCREATE flags

virtual GRE_LAYER_LEGEND::~GRE_LAYER_LEGEND  )  [virtual]
 


Member Function Documentation

int GRE_LAYER_LEGEND::Construct GRE_GROUP group,
GRE_LAYER **  retlayer,
GRE_LAYER reflayer,
UINT32  flags
[static]
 

Construct instance of this layer type.

Parameters:
group  Group to contain layer
retlayer  Layer returned
reflayer  Reference layer for insertion
flags  Creation flags

const DISPPARM& GRE_LAYER_LEGEND::GetDispParm  )  const [inline]
 

Retrieve layer-specific display parameters.

Definition at line 145 of file lrlegend.h.

void GRE_LAYER_LEGEND::RegisterType  )  [static]
 

Register this layer type.

ERRVALUE GRE_LAYER_LEGEND::SetDispParm const DISPPARM dispparm  ) 
 

Set layer-specific display parameters.

This is the recommended method for changing how an existing layer is to be rendered. Validation will be performed on the specified parameters and adjustments made to the layer's copy if necessary. Use of this method usually result in a ChangeBegin / ChangeEnd message pair, and will also generate a ChangeObject message if the spatial object used in the layer is changed.

Parameters:
dispparm  Parameters to set


Member Data Documentation

DISPPARM GRE_LAYER_LEGEND::m_dispparm [protected]
 

Layer-specific display parameters.

Definition at line 161 of file lrlegend.h.


The documentation for this class was generated from the following file:
Generated on Tue Dec 14 13:19:49 2004 for TNTsdk by  doxygen 1.3.8-20040913