GRE::LAYER_LEGEND Class Reference

#include <gre/lrlegend.h>

Inheritance diagram for GRE::LAYER_LEGEND:
Inheritance graph
[legend]

List of all members.

Classes

class  DISPPARM

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

 LAYER_LEGEND (GRE::GROUP *group, CREATEFLAGS createflags=CREATEFLAG_None)
virtual ~LAYER_LEGEND ()
const DISPPARMGetDispParm () const
ERRVALUE SetDispParm (const DISPPARM &dispparm)

Static Public Member Functions

static void RegisterType ()

Protected Attributes

DISPPARM m_dispparm

Member Enumeration Documentation

Enumerator:
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 

Constructor & Destructor Documentation

GRE::LAYER_LEGEND::LAYER_LEGEND ( GRE::GROUP group,
CREATEFLAGS  createflags = CREATEFLAG_None 
) [explicit]

Construct layer and insert into list.

Parameters:
group Group to contain layer
createflags Creation flags
virtual GRE::LAYER_LEGEND::~LAYER_LEGEND (  )  [virtual]

Member Function Documentation

const DISPPARM& GRE::LAYER_LEGEND::GetDispParm (  )  const [inline]

Retrieve layer-specific display parameters.

static 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

Layer-specific display parameters.


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

Generated on Sun Oct 7 21:34:24 2012 for TNTsdk 2012 by  doxygen 1.6.1