GRE::LAYER::COMMONPARM Class Reference

Base class for shared layer display parameters. More...

#include <gre/layer.h>

Inheritance diagram for GRE::LAYER::COMMONPARM:
Inheritance graph
[legend]

List of all members.

Classes

class  FORM
 Base class for user interface form. More...

Public Types

enum  STATE { STATE_False = 0, STATE_True = 1, STATE_ByLayer = 2 }

Public Member Functions

virtual ~COMMONPARM ()=0
FORMConstructForm () const
bool DlgEditValues (MDLGPARENT dlgparent)
GROUPGetGroup () const
LAYER::TYPE GetLayerType () const
bool HasUI () const
const SERIALIZERITEMSerialGetItemDef () const
const char * SerialGetTagName () const
ERRVALUE SerialRead (SERIALIZER &serializer)
ERRVALUE SerialWrite (SERIALIZER &serializer) const

Protected Member Functions

 COMMONPARM (GROUP *group, LAYER::TYPE layertype, bool HasUI=true)

Private Member Functions

virtual FORMv_ConstructForm () const
virtual bool v_DlgEditValues (MDLGPARENT dlgparent)
virtual const SERIALIZERITEMv_SerialGetItemDef () const =0
virtual const char * v_SerialGetTagName () const =0
virtual ERRVALUE v_SerialRead (SERIALIZER &serializer)
virtual ERRVALUE v_SerialWrite (SERIALIZER &serializer) const

Detailed Description

Base class for shared layer display parameters.

Generally accessed through GRE::GROUP methods.


Member Enumeration Documentation

Enumerator:
STATE_False 
STATE_True 
STATE_ByLayer 

Constructor & Destructor Documentation

virtual GRE::LAYER::COMMONPARM::~COMMONPARM (  )  [pure virtual]
GRE::LAYER::COMMONPARM::COMMONPARM ( GROUP group,
LAYER::TYPE  layertype,
bool  HasUI = true 
) [explicit, protected]

Constructor.


Member Function Documentation

FORM* GRE::LAYER::COMMONPARM::ConstructForm (  )  const [inline]

Construct user interface form.

bool GRE::LAYER::COMMONPARM::DlgEditValues ( MDLGPARENT  dlgparent  )  [inline]

Open modal dialog to edit values.

Returns:
true if changed, false if not
GROUP* GRE::LAYER::COMMONPARM::GetGroup (  )  const [inline]

Get group attached to.

LAYER::TYPE GRE::LAYER::COMMONPARM::GetLayerType (  )  const [inline]

Get layer type parameters apply to.

bool GRE::LAYER::COMMONPARM::HasUI (  )  const [inline]

Determine if has user interface methods.

const SERIALIZERITEM* GRE::LAYER::COMMONPARM::SerialGetItemDef (  )  const [inline]

Get serialization item definition.

const char* GRE::LAYER::COMMONPARM::SerialGetTagName (  )  const [inline]

Get tag name for serialization.

ERRVALUE GRE::LAYER::COMMONPARM::SerialRead ( SERIALIZER serializer  )  [inline]

Read from serialization.

ERRVALUE GRE::LAYER::COMMONPARM::SerialWrite ( SERIALIZER serializer  )  const [inline]

Write to serialization.

virtual FORM* GRE::LAYER::COMMONPARM::v_ConstructForm (  )  const [private, virtual]

Construct user interface form.

virtual bool GRE::LAYER::COMMONPARM::v_DlgEditValues ( MDLGPARENT  dlgparent  )  [private, virtual]

Open modal dialog to edit values.

Returns:
true if changed, false if not Default implementation creates simple dialog with ConstructForm used for contents.
virtual const SERIALIZERITEM* GRE::LAYER::COMMONPARM::v_SerialGetItemDef (  )  const [private, pure virtual]

Get serialization item definition.

virtual const char* GRE::LAYER::COMMONPARM::v_SerialGetTagName (  )  const [private, pure virtual]

Get serialization tag name.

virtual ERRVALUE GRE::LAYER::COMMONPARM::v_SerialRead ( SERIALIZER serializer  )  [private, virtual]

Read from serialization.

Default implementation reads based on item definition array.

virtual ERRVALUE GRE::LAYER::COMMONPARM::v_SerialWrite ( SERIALIZER serializer  )  const [private, virtual]

Write to serialization.

Default implementation writes using item definition array and tag name returned by SerialGet... methods.


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

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