Main Page | Modules | Directories | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

GRE_VIEWABLE Class Reference

Base class for objects that can have "views" (GRE_LAYOUT, GRE_GROUP). More...

#include <gre/viewable.h>

Inheritance diagram for GRE_VIEWABLE:

Inheritance graph
[legend]
List of all members.

Public Member Functions

void ClearMacroScriptList ()
void ClearSaveLocation ()
void ClearToolScriptList ()
ERRVALUE ControlScriptEdit (MDLGPARENT dlgparent)
void DestroyAllViews ()
void DlgObjMgrClose ()
ERRVALUE DlgObjMgrCreate (MDLGPARENT dlgparent, const MISTRING &title)
ERRVALUE DlgObjMgrCreate (MDLGPARENT dlgparent)
void DlgObjMgrDestroy ()
bool DlgObjMgrIsOpen () const
void DlgObjMgrOpen ()
ERRVALUE DrawAllViews (GRE::DRAWCONDITION condition=GRE::DRAWCONDITION_Always)
virtual GRE_LAYER * FindLayerByID (UINT32 LayerID) const =0
MAINSCRIPT & GetControlScript ()
double GetDesignScale () const
MDLGPARENT GetDialogParent () const
GRE::HIGHLIGHTMODE GetElemHighlightMode () const
const DRECT2D & GetExtents () const
GRE_VIEW * GetFirstView () const
virtual void GetFullName (MISTRING &name) const =0
const char * GetIniName () const
GRE::MACROSCRIPTLIST & GetMacroScriptList ()
virtual UINT32 GetNextLayerID () const =0
const FILEPATH & GetSaveFilePath () const
const RVC::OBJITEM & GetSaveObjItem () const
bool GetShowInternalTables () const
bool GetShowScaleRanges () const
virtual ERRVALUE GetSizeMeters (DPOINT2D &sizemeters)=0
GRE::TOOLSCRIPTLIST & GetToolScriptList ()
GRE_VIEWABLE * GetTopViewable ()
const GRE_VIEWABLE * GetTopViewable () const
GRE_VIEW * GetView (int ViewNum) const
virtual bool HasLayers () const =0
bool HasSaveLocation () const
bool IsModified () const
Widget ObjMgrCreate (Widget pwidget, Arg *arglist, int argcount)
Widget ObjMgrGetContainer () const
void ObjMgrMakeVisible (Widget widget)
short ObjMgrSetPosition (Widget widget, short newindex)
ERRVALUE RenderToRaster (RVC::OBJITEM &objitem, COLORSPACE colorspace, INT32 rastcols, INT32 rastlins, double cellsize, const COLOR &bgcolor, int viewnum=1, bool savegeoref=true, const SIMPLE_ARRAY< COLOR > *pColors=0, const DRECT2D *pRect=0, MGD::PIXEL *pFallbackPixel=0)
void ResetModified ()
void SetDesignScale (double DesignScale, bool notify=true)
void SetDialogParent (MDLGPARENT DialogParent)
void SetElemHighlightMode (GRE::HIGHLIGHTMODE HighlightMode)
void SetIniBase (const char *name)
void SetMacroScriptList (const GRE::MACROSCRIPTLIST &ScriptList)
void SetSaveFilePath (const FILEPATH &SaveFilePath)
void SetSaveObjItem (const RVC::OBJITEM &SaveObjItem)
void SetShowInternalTables (bool ShowInternalTables)
void SetShowScaleRanges (bool ShowScaleRanges)
void SetToolScriptList (const GRE::TOOLSCRIPTLIST &ScriptList)
void UpdateViewScriptUI ()
virtual ~GRE_VIEWABLE ()

Static Public Member Functions

void SMLClassInstall (SMLCONTEXT *context)

Protected Member Functions

ERRVALUE ControlScriptInitialize ()
UINT8 GetIniIndex () const
 GRE_VIEWABLE (GRE_OBJTYPE type, GRE_VIEWABLE *container)
virtual void ObjMgrInitItems ()=0
void SetIniIndex (UINT8 IniIndex)

Static Protected Member Functions

const SERIALIZER::ITEMDEF * SerialGetItemDef (SERIALIZER &)
const SERIALIZER::ITEMDEF * TemplateGetItemDef ()

Protected Attributes

bool m_IsModified

Detailed Description

Base class for objects that can have "views" (GRE_LAYOUT, GRE_GROUP).

Definition at line 135 of file viewable.h.

Constructor & Destructor Documentation

virtual GRE_VIEWABLE::~GRE_VIEWABLE (   )  [virtual]
 

Destructor.

GRE_VIEWABLE::GRE_VIEWABLE (  GRE_OBJTYPE  type,
GRE_VIEWABLE *  container
)  [explicit, protected]
 

Constructor.

Parameters:
type  Object type
container  Containing viewable

Member Function Documentation

void GRE_VIEWABLE::ClearMacroScriptList (   )  [inline]
 

Clear MacroScript list.

Definition at line 200 of file viewable.h.

void GRE_VIEWABLE::ClearSaveLocation (   )  [inline]
 

Clear save location specification.

Definition at line 205 of file viewable.h.

void GRE_VIEWABLE::ClearToolScriptList (   )  [inline]
 

Clear ToolScript list.

Definition at line 210 of file viewable.h.

ERRVALUE GRE_VIEWABLE::ControlScriptEdit (  MDLGPARENT  dlgparent  ) 
 

ERRVALUE GRE_VIEWABLE::ControlScriptInitialize (   )  [protected]
 

void GRE_VIEWABLE::DestroyAllViews (   ) 
 

Destroy all views of this object.

void GRE_VIEWABLE::DlgObjMgrClose (   )  [inline]
 

Definition at line 224 of file viewable.h.

ERRVALUE GRE_VIEWABLE::DlgObjMgrCreate (  MDLGPARENT  dlgparent,
const MISTRING &  title
)  [inline]
 

Definition at line 231 of file viewable.h.

ERRVALUE GRE_VIEWABLE::DlgObjMgrCreate (  MDLGPARENT  dlgparent  )  [inline]
 

Definition at line 227 of file viewable.h.

void GRE_VIEWABLE::DlgObjMgrDestroy (   )  [inline]
 

Definition at line 236 of file viewable.h.

bool GRE_VIEWABLE::DlgObjMgrIsOpen (   )  const [inline]
 

Definition at line 239 of file viewable.h.

void GRE_VIEWABLE::DlgObjMgrOpen (   )  [inline]
 

Definition at line 242 of file viewable.h.

ERRVALUE GRE_VIEWABLE::DrawAllViews (  GRE::DRAWCONDITION  condition = GRE::DRAWCONDITION_Always  )  [inline]
 

Draw all views of this object.

Definition at line 247 of file viewable.h.

virtual GRE_LAYER* GRE_VIEWABLE::FindLayerByID (  UINT32  LayerID  )  const [pure virtual]
 

Find layer using unique ID.

Implemented in GRE_GROUP, and GRE_LAYOUT.

MAINSCRIPT& GRE_VIEWABLE::GetControlScript (   )  [inline]
 

Get reference to "display control script".

Definition at line 253 of file viewable.h.

double GRE_VIEWABLE::GetDesignScale (   )  const [inline]
 

Get 'design scale' for layout or group.

Definition at line 267 of file viewable.h.

MDLGPARENT GRE_VIEWABLE::GetDialogParent (   )  const [inline]
 

Get parent for dialogs relating to this object.

Definition at line 271 of file viewable.h.

GRE::HIGHLIGHTMODE GRE_VIEWABLE::GetElemHighlightMode (   )  const [inline]
 

Get element highlighting mode.

Definition at line 275 of file viewable.h.

const DRECT2D& GRE_VIEWABLE::GetExtents (   )  const [inline]
 

Get overall viewable extents.

Definition at line 258 of file viewable.h.

GRE_VIEW* GRE_VIEWABLE::GetFirstView (   )  const
 

Get first view of this object.

Returns:
Pointer to view or NULL if no views of this object.
To loop through all views for an object use this method to get the first view. Then use the GRE_VIEW::GetNext() to obtain the next view, checking for NULL as shown:

for (GRE_VIEW *view = object->GetFirstView(); (view != 0); view = view->GetNext()) { ... }

virtual void GRE_VIEWABLE::GetFullName (  MISTRING &  name  )  const [pure virtual]
 

Get full object name.

Parameters:
name  Name returned

Implemented in GRE_GROUP, and GRE_LAYOUT.

UINT8 GRE_VIEWABLE::GetIniIndex (   )  const [inline, protected]
 

Get unique index for building Ini name.

Definition at line 488 of file viewable.h.

const char* GRE_VIEWABLE::GetIniName (   )  const [inline]
 

Get name of object to use in Ini file access.

Definition at line 296 of file viewable.h.

GRE::MACROSCRIPTLIST& GRE_VIEWABLE::GetMacroScriptList (   )  [inline]
 

Get MacroScript list.

Definition at line 301 of file viewable.h.

virtual UINT32 GRE_VIEWABLE::GetNextLayerID (   )  const [pure virtual]
 

Get next available unique ID.

Implemented in GRE_GROUP, and GRE_LAYOUT.

const FILEPATH& GRE_VIEWABLE::GetSaveFilePath (   )  const [inline]
 

Get path to file where viewable saved.

Definition at line 310 of file viewable.h.

const RVC::OBJITEM& GRE_VIEWABLE::GetSaveObjItem (   )  const [inline]
 

Get object item reference to save location.

Definition at line 314 of file viewable.h.

bool GRE_VIEWABLE::GetShowInternalTables (   )  const [inline]
 

Get whether to show internal tables in table lists.

Definition at line 318 of file viewable.h.

bool GRE_VIEWABLE::GetShowScaleRanges (   )  const [inline]
 

Get whether to show scale ranges in layer lists.

Definition at line 322 of file viewable.h.

virtual ERRVALUE GRE_VIEWABLE::GetSizeMeters (  DPOINT2D &  sizemeters  )  [pure virtual]
 

Compute dimensions of object based on scale and georeference.

Parameters:
sizemeters  Size returned in meters

Implemented in GRE_GROUP, and GRE_LAYOUT.

GRE::TOOLSCRIPTLIST& GRE_VIEWABLE::GetToolScriptList (   )  [inline]
 

Get ToolScript list.

Definition at line 332 of file viewable.h.

GRE_VIEWABLE* GRE_VIEWABLE::GetTopViewable (   ) 
 

Get topmost containing viewable (non-const).

const GRE_VIEWABLE* GRE_VIEWABLE::GetTopViewable (   )  const
 

Get topmost containing viewable (const).

GRE_VIEW* GRE_VIEWABLE::GetView (  int  ViewNum  )  const
 

Get view of this object given view number.

Returns:
Pointer to view or NULL if no matching view.

virtual bool GRE_VIEWABLE::HasLayers (   )  const [pure virtual]
 

Determine if object has any layers.

Implemented in GRE_GROUP, and GRE_LAYOUT.

bool GRE_VIEWABLE::HasSaveLocation (   )  const
 

Determine if save location has been specified.

bool GRE_VIEWABLE::IsModified (   )  const [inline]
 

Determine if changes have been made since last save.

Definition at line 359 of file viewable.h.

Widget GRE_VIEWABLE::ObjMgrCreate (  Widget  pwidget,
Arg *  arglist,
int  argcount
) 
 

Create "object manager" container (RowColumn) widget.

Returns:
Frame widget surrounding container.

Widget GRE_VIEWABLE::ObjMgrGetContainer (   )  const [inline]
 

Get RowColumn widget for creating items in object manager.

Definition at line 374 of file viewable.h.

virtual void GRE_VIEWABLE::ObjMgrInitItems (   )  [protected, pure virtual]
 

Create initial set of items in object manager.

Implemented in GRE_GROUP, and GRE_LAYOUT.

void GRE_VIEWABLE::ObjMgrMakeVisible (  Widget  widget  ) 
 

Scroll to make specified widget visible in object manager.

short GRE_VIEWABLE::ObjMgrSetPosition (  Widget  widget,
short  newindex
) 
 

Set position of item in object manager.

Returns:
Next position after item.

ERRVALUE GRE_VIEWABLE::RenderToRaster (  RVC::OBJITEM &  objitem,
COLORSPACE  colorspace,
INT32  rastcols,
INT32  rastlins,
double  cellsize,
const COLOR &  bgcolor,
int  viewnum = 1,
bool  savegeoref = true,
const SIMPLE_ARRAY< COLOR > *  pColors = 0,
const DRECT2D *  pRect = 0,
MGD::PIXEL *  pFallbackPixel = 0
) 
 

Render to raster.

Parameters:
pColors  Colormap to use for COLORSPACE_Indexed
pRect  Rectangle in viewable coordinates to limit extent
pFallbackPixel  Pointer to fallback pixel, NULL to use 'transparent'

void GRE_VIEWABLE::ResetModified (   )  [inline]
 

Reset "is modified" status to "false".

Definition at line 410 of file viewable.h.

const SERIALIZER::ITEMDEF* GRE_VIEWABLE::SerialGetItemDef (  SERIALIZER &   )  [inline, static, protected]
 

Get serialization item definition array.

Definition at line 498 of file viewable.h.

void GRE_VIEWABLE::SetDesignScale (  double  DesignScale,
bool  notify = true
)  [inline]
 

Set 'design scale' for layout or group.

Parameters:
DesignScale  Design scale to set
notify  Send notification if changed

Definition at line 414 of file viewable.h.

void GRE_VIEWABLE::SetDialogParent (  MDLGPARENT  DialogParent  )  [inline]
 

Set parent for dialogs relating to this object.

Definition at line 420 of file viewable.h.

void GRE_VIEWABLE::SetElemHighlightMode (  GRE::HIGHLIGHTMODE  HighlightMode  ) 
 

Set element highlighting mode.

void GRE_VIEWABLE::SetIniBase (  const char *  name  ) 
 

Set base name of object for use in Ini file acces.

void GRE_VIEWABLE::SetIniIndex (  UINT8  IniIndex  )  [protected]
 

Set index for building Ini name.

void GRE_VIEWABLE::SetMacroScriptList (  const GRE::MACROSCRIPTLIST &  ScriptList  )  [inline]
 

Definition at line 435 of file viewable.h.

void GRE_VIEWABLE::SetSaveFilePath (  const FILEPATH &  SaveFilePath  ) 
 

Set path to file where viewable saved.

Also resets object such that expects to save to non-RVC file.

void GRE_VIEWABLE::SetSaveObjItem (  const RVC::OBJITEM &  SaveObjItem  )  [inline]
 

Set object item reference to save location.

Definition at line 447 of file viewable.h.

void GRE_VIEWABLE::SetShowInternalTables (  bool  ShowInternalTables  ) 
 

Set whether to show internal tables in table lists.

void GRE_VIEWABLE::SetShowScaleRanges (  bool  ShowScaleRanges  ) 
 

Set whether to show scale ranges in layer lists.

void GRE_VIEWABLE::SetToolScriptList (  const GRE::TOOLSCRIPTLIST &  ScriptList  )  [inline]
 

Definition at line 462 of file viewable.h.

void GRE_VIEWABLE::SMLClassInstall (  SMLCONTEXT *  context  )  [static]
 

Install SML class, called by internal SML function.

Reimplemented in GRE_GROUP, and GRE_LAYOUT.

const SERIALIZER::ITEMDEF* GRE_VIEWABLE::TemplateGetItemDef (   )  [static, protected]
 

Get serialization item definition array.

void GRE_VIEWABLE::UpdateViewScriptUI (   ) 
 

Update user interface for changes to view scripts.

Member Data Documentation

bool GRE_VIEWABLE::m_IsModified [protected]
 

Changes have been made since last save.

Definition at line 475 of file viewable.h.

The documentation for this class was generated from the following file:
Generated on Wed May 31 15:28:41 2006 for TNTsdk by  doxygen 1.3.8-20040913