GRE::LAYOUT Class Reference

#include <gre/layout.h>

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

List of all members.

Public Types

enum  CREATEFLAGS {
  CREATEFLAG_None = 0x0000, CREATEFLAG_NoCallCreateCB = 0x0001, CREATEFLAG_Temporary = 0x0002, CREATEFLAG_Hardcopy = 0x0010,
  CREATEFLAG_DeferCreate = 0x0020
}

Public Member Functions

 LAYOUT (CREATEFLAGS flags=CREATEFLAG_None)
virtual ~LAYOUT ()
ERRVALUE AddGroupLayer (MDLGPARENT dlgparent, GRE::LAYER::TYPE layertype, GRE::LAYER **player=0)
ERRVALUE AddGroupMulti (MDLGPARENT dlgparent)
int AddGroupSaved (MDLGPARENT dlgparent, bool fromtext)
void Create (CREATEFLAGS createflags=CREATEFLAG_None)
ERRVALUE CreateGroup (GRE::GROUP **retgroup=0, GRE::GROUP::CREATEFLAGS createflags=GRE::GROUP::CREATEFLAG_None, GRE::LISTPOS listpos=GRE::LISTPOS_After, GRE::GROUP *refgroup=0)
void DestroyAllGroups ()
virtual GRE::LAYER * FindLayerByID (UINT32 LayerID) const
GRE::GROUP * FindPointGroup (const DPOINT2D &point, GRE::FINDFLAGS findflags, const SPATREF::COORDREFSYS *pPointCRS=NULL) const
GRE::GROUP * GetActiveGroup () const
GRE::GROUP * GetFirstGroup () const
virtual void GetFullName (MISTRING &name) const
double GetHardcopyDPI () const
DRECT2D GetHardcopyMarginRect () const
DRECT2D GetHardcopyPageRect () const
DRECT2D GetHardcopyPrintableRect () const
double GetHardcopyScale () const
const LAYOUTPARMS & GetHardcopyValues () const
double GetHardcopyZoom () const
GRE::GROUP * GetLastGroup () const
MATTE & GetMatte ()
const MISTRING & GetName () const
LAYOUT * GetNext () const
virtual UINT32 GetNextLayerID () const
UINT8 GetPosnMode () const
const MISTRING & GetSavedLocations () const
virtual ERRVALUE GetSizeMeters (DPOINT2D &sizemeters)
bool GroupControlsGetAutoRedraw () const
int GroupControlsGetLayoutUnits () const
bool GroupControlsIsOpen () const
void GroupControlsOpen (MDLGPARENT dlgparent=0, GRE::GROUP *group=0, UINT32 flags=0)
void GroupControlsSetPrompts (double hoffset, double hsize, double voffset, double vsize, double relscale)
void GroupControlsSetTabLayout ()
virtual bool HasLayers () const
bool HasTempLayers () const
void InvalidateAllViews ()
bool IsBeingLoaded () const
bool IsCreated () const
bool IsHardcopy () const
bool IsSortLegendNatural () const
bool IsValid () const
bool KeepInTNTserverCache () const
virtual ERRVALUE SerialRead (SERIALIZER &serializer)
virtual ERRVALUE SerialWrite (SERIALIZER &serializer, const char *tagname=0) const
void SetActiveGroup (GRE::GROUP *group)
void SetHardcopyValues (const LAYOUTPARMS &values, bool notify=true)
void SetKeepInTNTserverCache (bool keepInTNTserverCache)
void SetMatte (const MATTE &matte, bool notify=true)
void SetModified (bool notify=true, bool ViewsNeedRedraw=true)
ERRVALUE SetName (const MISTRING &newname)
void SetNeedUpdatePositions ()
void SetPosnMode (UINT8 posnmode)
void SetSavedLocations (const MISTRING &string)
int SetZoomToFitPage ()
ERRVALUE TemplateRead (SERIALIZER &serializer)
ERRVALUE TemplateWrite (SERIALIZER &serializer)
int UpdatePositions (bool ForceUpdate=true)
void ValidateGroupAttachments ()

Static Public Member Functions

static void SMLClassInstall (SML::CONTEXT *context)

Member Enumeration Documentation

enum GRE::LAYOUT::CREATEFLAGS

Flags used in creation.

Enumerator:
CREATEFLAG_None 
CREATEFLAG_NoCallCreateCB 

Don't call callback list when object created.

CREATEFLAG_Temporary 

Create as 'temporary'.

CREATEFLAG_Hardcopy 

Create layout in "hardcopy" mode.

CREATEFLAG_DeferCreate 

Defer creation until Create() called.

Constructor & Destructor Documentation

GRE::LAYOUT::LAYOUT ( CREATEFLAGS  flags = CREATEFLAG_None  )  [explicit]

Constructor.

virtual GRE::LAYOUT::~LAYOUT (  )  [virtual]

Destructor.

Member Function Documentation

ERRVALUE GRE::LAYOUT::AddGroupLayer ( MDLGPARENT  dlgparent,
GRE::LAYER::TYPE  layertype,
GRE::LAYER **  player = 0 
)

Dialog to add single-layer group and layer of specified type.

Should only be used for single-layer-group types (eg scalebar, text, legend).

Parameters:
player Pointer to layer returned
ERRVALUE GRE::LAYOUT::AddGroupMulti ( MDLGPARENT  dlgparent  ) 

Dialog to prompt user for objects and add as multiple groups.

int GRE::LAYOUT::AddGroupSaved ( MDLGPARENT  dlgparent,
bool  fromtext 
)

Dialog to prompt user for saved group and add to layout.

void GRE::LAYOUT::Create ( CREATEFLAGS  createflags = CREATEFLAG_None  ) 

Create layout if CREATEFLAG_DeferCreate was specified in constructor.

ERRVALUE GRE::LAYOUT::CreateGroup ( GRE::GROUP **  retgroup = 0,
GRE::GROUP::CREATEFLAGS  createflags = GRE::GROUP::CREATEFLAG_None,
GRE::LISTPOS  listpos = GRE::LISTPOS_After,
GRE::GROUP *  refgroup = 0 
)

Create new group in this layout.

Parameters:
retgroup New group returned
refgroup Reference group for InsertBefore/InsertAfter
void GRE::LAYOUT::DestroyAllGroups (  ) 

Destroy all groups in this layout This method must not be used if any groups exist which have been created on the stack.

virtual GRE::LAYER* GRE::LAYOUT::FindLayerByID ( UINT32  LayerID  )  const [virtual]

Find layer using unique ID.

Implements GRE::VIEWABLE.

GRE::GROUP* GRE::LAYOUT::FindPointGroup ( const DPOINT2D &  point,
GRE::FINDFLAGS  findflags,
const SPATREF::COORDREFSYS *  pPointCRS = NULL 
) const

Find group containing specified point.

GRE::GROUP* GRE::LAYOUT::GetActiveGroup (  )  const [inline]

Get active group for this layout.

GRE::GROUP* GRE::LAYOUT::GetFirstGroup (  )  const [inline]

Get first group in layout.

virtual void GRE::LAYOUT::GetFullName ( MISTRING &  name  )  const [virtual]

Get full layout name.

Parameters:
name Name returned

Implements GRE::VIEWABLE.

double GRE::LAYOUT::GetHardcopyDPI (  )  const [inline]

Get hardcopy DPI value.

DRECT2D GRE::LAYOUT::GetHardcopyMarginRect (  )  const

Get "margin" rectangle in layout (page) coordinates.

DRECT2D GRE::LAYOUT::GetHardcopyPageRect (  )  const

Get "page" rectangle in layout (page) coordinates.

DRECT2D GRE::LAYOUT::GetHardcopyPrintableRect (  )  const

Get "printable" rectangle in layout (page) coordinates.

double GRE::LAYOUT::GetHardcopyScale (  )  const [inline]

Get hardcopy layout scale.

const LAYOUTPARMS& GRE::LAYOUT::GetHardcopyValues (  )  const [inline]

Get hardcopy layout values.

double GRE::LAYOUT::GetHardcopyZoom (  )  const [inline]

Get hardcopy zoom factor.

GRE::GROUP* GRE::LAYOUT::GetLastGroup (  )  const [inline]

Get last group in layout.

MATTE& GRE::LAYOUT::GetMatte (  )  [inline]

Get matte reference for layout.

const MISTRING& GRE::LAYOUT::GetName (  )  const [inline]

Get name of layout.

LAYOUT* GRE::LAYOUT::GetNext (  )  const [inline]

Get next layout.

virtual UINT32 GRE::LAYOUT::GetNextLayerID (  )  const [virtual]

Get next available unique ID.

Implements GRE::VIEWABLE.

UINT8 GRE::LAYOUT::GetPosnMode (  )  const [inline]

Get group positioning mode.

const MISTRING& GRE::LAYOUT::GetSavedLocations (  )  const [inline]

Get Saved Locations string.

virtual ERRVALUE GRE::LAYOUT::GetSizeMeters ( DPOINT2D &  sizemeters  )  [virtual]

Compute dimensions of object based on scale and georeference.

Parameters:
sizemeters Size returned in meters

Implements GRE::VIEWABLE.

bool GRE::LAYOUT::GroupControlsGetAutoRedraw (  )  const

Return true if Auto-Redraw toggle is set on the Group Controls dialog.

int GRE::LAYOUT::GroupControlsGetLayoutUnits (  )  const

Return the units for measurements in the Layout tab of the Group Controls dialog.

bool GRE::LAYOUT::GroupControlsIsOpen (  )  const

Determine if the Group Controls dialog is open.

void GRE::LAYOUT::GroupControlsOpen ( MDLGPARENT  dlgparent = 0,
GRE::GROUP *  group = 0,
UINT32  flags = 0 
)

Open the Group Controls dialog.

If already open, it is brought to the front. If group passed in is NULL (default) use the Active group.

Parameters:
dlgparent Parent (0 to use default)
group Group to show initially,
flags MDISP_GCP_Xxxx
void GRE::LAYOUT::GroupControlsSetPrompts ( double  hoffset,
double  hsize,
double  voffset,
double  vsize,
double  relscale 
)

Set the values of the size, spacing and relative zoom prompts in the Group Controls dialog.

This is used to temporarly change the values being reported in several of the prompts while a group is being moved or resized by an external tool. It is assumed that when the user releases the mouse, the tool will actually modify the group and the prompts will be restored to new "real" values.

This function should only be called by GRE::TOOL_PLACEMENT

Parameters:
hoffset value for "Spacing" (horizontal)
hsize value for "Width"
voffset value for "Spacing" (vertical)
vsize value for "Height"
relscale value for "Relative Zoom"
void GRE::LAYOUT::GroupControlsSetTabLayout (  ) 

Set the group controls dialog (if open) to the "layout" tab.

virtual bool GRE::LAYOUT::HasLayers (  )  const [virtual]

Determine if layout has any layers.

Implements GRE::VIEWABLE.

bool GRE::LAYOUT::HasTempLayers (  )  const

Determine if layout has any "temporary" layers.

void GRE::LAYOUT::InvalidateAllViews (  ) 

Invalidate all view buffers for this layout.

bool GRE::LAYOUT::IsBeingLoaded (  )  const [inline]

Determine if layout is currently being loaded.

bool GRE::LAYOUT::IsCreated (  )  const [inline]

Determine if layout has been created.

This is done automatically by constructor unless CREATEFLAG_DeferCreate was specified.

bool GRE::LAYOUT::IsHardcopy (  )  const [inline]

Determine if layout is in "hardcopy" mode.

bool GRE::LAYOUT::IsSortLegendNatural (  )  const [inline]

Determine if legends should be sorted in "natural" order.

bool GRE::LAYOUT::IsValid (  )  const

Determine if layout is an existing GRE object.

bool GRE::LAYOUT::KeepInTNTserverCache (  )  const [inline]

Determine if layout should be kept in TNTserver cache.

virtual ERRVALUE GRE::LAYOUT::SerialRead ( SERIALIZER &  serializer  )  [virtual]

Read from serialization.

Implements SERIALIZABLE.

virtual ERRVALUE GRE::LAYOUT::SerialWrite ( SERIALIZER &  serializer,
const char *  tagname = 0 
) const [virtual]

Write values to serialization.

Implements SERIALIZABLE.

void GRE::LAYOUT::SetActiveGroup ( GRE::GROUP *  group  ) 

Set active group for layout.

void GRE::LAYOUT::SetHardcopyValues ( const LAYOUTPARMS &  values,
bool  notify = true 
)

Set hardcopy layout values.

void GRE::LAYOUT::SetKeepInTNTserverCache ( bool  keepInTNTserverCache  )  [inline]

Set whether layout should be retained in TNTserver cache.

void GRE::LAYOUT::SetMatte ( const MATTE &  matte,
bool  notify = true 
)

Set matte values.

Parameters:
matte Matte values to set
notify Set to invoke callbacks with "Changed" message
void GRE::LAYOUT::SetModified ( bool  notify = true,
bool  ViewsNeedRedraw = true 
)

Set that layout has been modified.

Parameters:
notify Set to invoke callbacks with "Changed" message
ViewsNeedRedraw Set all views of layout as needing redraw
ERRVALUE GRE::LAYOUT::SetName ( const MISTRING &  newname  ) 

Set new layout name.

void GRE::LAYOUT::SetNeedUpdatePositions (  )  [inline]

Set that group positions need to be recomputed.

void GRE::LAYOUT::SetPosnMode ( UINT8  posnmode  ) 

Set group positioning mode.

void GRE::LAYOUT::SetSavedLocations ( const MISTRING &  string  )  [inline]

Set saved locations string.

int GRE::LAYOUT::SetZoomToFitPage (  ) 

Set hardcopy zoom to fit to page size.

static void GRE::LAYOUT::SMLClassInstall ( SML::CONTEXT *  context  )  [static]

Install SML class, called by internal SML function.

Parameters:
context SML context

Reimplemented from GRE::VIEWABLE.

ERRVALUE GRE::LAYOUT::TemplateRead ( SERIALIZER &  serializer  ) 

Read from template (serialization).

ERRVALUE GRE::LAYOUT::TemplateWrite ( SERIALIZER &  serializer  ) 

Write template to serialization.

int GRE::LAYOUT::UpdatePositions ( bool  ForceUpdate = true  ) 

Recompute group positions.

void GRE::LAYOUT::ValidateGroupAttachments (  ) 

Validate and correct group attachments.

The documentation for this class was generated from the following file:
Generated on Sun Oct 7 21:34:38 2012 for TNTsdk 2012 by  doxygen 1.6.1