GRE::VIEW_LEGACY Class Reference

#include <gre/viewlegacy.h>

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

List of all members.

Public Types

enum  CREATEFLAGS {
  CREATEFLAG_None = 0x00000000, CREATEFLAG_3D = GRE::VIEW::CREATEFLAG_3D, CREATEFLAG_NoCallCreateCB = GRE::VIEW::CREATEFLAG_NoCallCreateCB, CREATEFLAG_NoRenderSeparate = GRE::VIEW::CREATEFLAG_NoRenderSeparate,
  CREATEFLAG_AllowGeoLock = 0x00000800, CREATEFLAG_DestroyOnClose = 0x00001000, CREATEFLAG_DialogModal = 0x00002000, CREATEFLAG_Locator = 0x00004000,
  CREATEFLAG_NoCancelButton = 0x00008000, CREATEFLAG_NoCloseOption = 0x00010000, CREATEFLAG_NoDftAddIcons = 0x00020000, CREATEFLAG_NoDftDrawIcons = 0x00040000,
  CREATEFLAG_NoDftMarkIcons = 0x00080000, CREATEFLAG_NoDftViewIcons = 0x00100000, CREATEFLAG_NoIconBar = 0x00200000, CREATEFLAG_NoLegendView = 0x00400000,
  CREATEFLAG_NoRedrawButton = 0x00800000, CREATEFLAG_NoScalePosLine = 0x01000000, CREATEFLAG_NoScrollbars = 0x02000000, CREATEFLAG_NoSelectTool = 0x04000000,
  CREATEFLAG_NoSkipButton = 0x08000000, CREATEFLAG_NoStatusLine = 0x10000000, CREATEFLAG_NoStdTools = 0x20000000, CREATEFLAG_NoToolBoxTool = 0x40000000,
  CREATEFLAG_Temporary = 0x80000000
}
enum  ICONVIEW {
  ICONVIEW_Full = 0x00000001, ICONVIEW_Previous = 0x00000002, ICONVIEW_PreviousZoom = 0x00000004, ICONVIEW_ZoomIn = 0x00000008,
  ICONVIEW_ZoomOut = 0x00000010, ICONVIEW_ZoomToGroup = 0x00000020, ICONVIEW_ZoomToLayer = 0x00000040, ICONVIEW_ZoomToMaxDetail = 0x00000080,
  ICONVIEW_ZoomToLocation = 0x00000100, ICONVIEW_Zoom1X = 0x00000200, ICONVIEW_Zoom2X = 0x00000400, ICONVIEW_Zoom3X = 0x00000800,
  ICONVIEW_Locator = 0x00001000, ICONVIEW_Snapshot = 0x00002000, ICONVIEW_GeoLock = 0x00004000, ICONVIEW_GoogleEarth = 0x00008000,
  ICONVIEW_Stereo = 0x00010000, ICONVIEW_Default = ICONVIEW_Full | ICONVIEW_Previous | ICONVIEW_PreviousZoom | ICONVIEW_ZoomIn | ICONVIEW_ZoomOut | ICONVIEW_ZoomToLayer | ICONVIEW_ZoomToGroup | ICONVIEW_ZoomToLocation | ICONVIEW_ZoomToMaxDetail | ICONVIEW_Zoom1X | ICONVIEW_Locator | ICONVIEW_Snapshot | ICONVIEW_GeoLock | ICONVIEW_GoogleEarth | ICONVIEW_Stereo
}

Public Member Functions

 VIEW_LEGACY ()
virtual ~VIEW_LEGACY ()
void AddDrawIcons ()
Widget AddIconRowItems (const BUTTONITEM *items, const char *icongroup=0, void *cbdata=0, void *userdata=0)
void AddMacroScriptIcons ()
void AddMacroScriptMenuItems ()
ERRVALUE AddMenuItemsOptions (const MENUITEM *newitems)
void AddToolIcons (bool addscripts=true)
void AddViewIcons (ICONVIEW icons=ICONVIEW_Default)
void ClearPreviousViewList ()
Widget CreateMenuBar (Widget form)
Widget CreateMenuBar (Widget form, MENUBARITEM *menubar)
ERRVALUE CreateX (VIEWABLE *viewable, Widget pwidget, Arg *arglist, int argcount, int iwidth, int iheight, const char *sizefield=0, CREATEFLAGS createflags=CREATEFLAG_None, const VIEW_LEGACY_SAVESETTINGS *pSettings=0)
void DataTipSetDelay (INT32 delay)
void DataTipSetPixelDelta (int PixelDelta)
void EditCustomization ()
TOOLGetActiveTool () const
Widget GetDrawingArea () const
Widget GetDrawingAreaForm () const
MGD::DEVICE_X32GetDrawingDeviceViewInView () const
Pixmap GetDrawingPixmap () const
Widget GetForm () const
const BUTTONITEMGetIconItemAdd (BUTTONITEMARRAY &items) const
const BUTTONITEMGetIconItemDraw (BUTTONITEMARRAY &items) const
const BUTTONITEMGetIconItemTool (BUTTONITEMARRAY &items) const
const BUTTONITEMGetIconItemView (BUTTONITEMARRAY &items, ICONVIEW icons=ICONVIEW_Default) const
Widget GetIconView (ICONVIEW icon) const
const MENUITEMGetMenuItemGPS ()
const MENUITEMGetMenuItemHotKeys ()
const MENUITEMGetMenuItemLegendView ()
const MENUITEMGetMenuItemOptions (MENUITEMARRAY &items)
const MENUITEMGetMenuItemTool (MENUITEMARRAY &items) const
const MENUITEMGetMenuItemView (MENUITEMARRAY &items)
Widget GetMenuWidget (const char *menupath) const
VIEW_LEGACYGetNextLegacy () const
VIEW_LEGACYGetNextLegacyOfAll () const
Widget GetToolBar () const
void LegendEnableRedraw (bool enable)
UINT8 LegendGetShowMode () const
void LegendHideAllLegends ()
void LegendRedraw (bool updatesizes=false)
void LegendSetShowLayerTypeIcon (bool ShowLayerType)
void LegendSetShowMode (UINT8 ShowMode)
void LegendSetVisiblityIndicator (UINT8 VisInd)
void LegendShowAllLegends ()
void ScalePosClearCoord (VIEW_LEGACY_COORDSOURCE CoordSource=VIEW_LEGACY_COORDSOURCE_None)
void ScalePosDisplayCoord (VIEW_LEGACY_COORDSOURCE CoordSource, const DPOINT2D &point, const SPATREF::COORDREFSYS &PointCRS)
const SPATREF::COORDREFSYSScalePosGetCoordRefSys (int idx) const
void ScalePosGetCoordString (int idx, const DPOINT2D &point, MISTRING &string) const
DEGTOSTRFLAGS ScalePosGetLatLonFormat (int idx) const
bool ScalePosIsPosVisible (int idx) const
void ScalePosSetCoordRefSys (int idx, const SPATREF::COORDREFSYS &CoordRefSys)
void ScalePosSetCoordSource (VIEW_LEGACY_COORDSOURCE CoordSource)
void ScalePosSetLatLonFormat (int idx, DEGTOSTRFLAGS LatLonFormat)
void ScalePosSetPosVisible (int idx, bool visible)
void ScalePosSetVisible (bool visible)
void SetDrawingArea (Widget da)
void SetEditCustomFunc (void(*EditCustomFunc)(VIEW_LEGACY *))
void SetInputFocusTo ()
void SetMessageVisible (bool visible)
void SetPreviousView ()
void SetPreviousZoom ()
void ToolAttach (TOOL *tool)
TOOLToolFindByName (const char *toolname) const
TOOLToolGetActive () const
bool ToolIsActive (const char *toolname) const
bool ToolIsActive (TOOL *tool) const
void ToolResume ()
int ToolSet (const char *toolname)
void ToolSet (TOOL *tool)
void ToolSetDefault ()
int ToolSuspend ()

Static Public Member Functions

static VIEW_LEGACYFindNextLegacyOfGroup (const GRE::GROUP *group, VIEW *view=0)
static VIEW_LEGACYFindNextLegacyOfLayer (const GRE::LAYER *layer, VIEW *view=0)
static void SML_ClassInstall (SML::CONTEXT *context)

Member Enumeration Documentation

Flags for view creation.

Enumerator:
CREATEFLAG_None 
CREATEFLAG_3D 

View is 3D.

CREATEFLAG_NoCallCreateCB 

Don't call callback list when object created.

CREATEFLAG_NoRenderSeparate 

Don't render to separate memory buffers.

CREATEFLAG_AllowGeoLock 

Allow GeoLocking.

CREATEFLAG_DestroyOnClose 

Destroy view when View/Close selected.

CREATEFLAG_DialogModal 

View is contained in modal dialog.

CREATEFLAG_Locator 

Create locator view.

CREATEFLAG_NoCancelButton 

Don't put "Cancel" button at bottom of window.

CREATEFLAG_NoCloseOption 

Don't include "Close" option on view menu.

CREATEFLAG_NoDftAddIcons 

Don't put default "add" icon(s) on toolbar.

CREATEFLAG_NoDftDrawIcons 

Don't create default "draw" icons when creating window.

CREATEFLAG_NoDftMarkIcons 

Don't create default "mark" icons when creating window.

CREATEFLAG_NoDftViewIcons 

Don't create default "view" icons when creating window.

CREATEFLAG_NoIconBar 

Don't create iconbar.

CREATEFLAG_NoLegendView 

Don't create LegendView.

CREATEFLAG_NoRedrawButton 

Don't put "Redraw" button at bottom of window.

CREATEFLAG_NoScalePosLine 

Don't create zoom/scale/position line at bottom of view window.

CREATEFLAG_NoScrollbars 

Don't create scroll bars.

CREATEFLAG_NoSelectTool 

Don't add "Select" tool.

CREATEFLAG_NoSkipButton 

Don't put "Skip" button at bottom of window.

CREATEFLAG_NoStatusLine 

Don't create "status" line.

CREATEFLAG_NoStdTools 

Don't add any standard tools.

CREATEFLAG_NoToolBoxTool 

Don't add "ToolBox" tool.

CREATEFLAG_Temporary 

Object is temporary.

Reimplemented from GRE::VIEW.

Enumerator:
ICONVIEW_Full 
ICONVIEW_Previous 
ICONVIEW_PreviousZoom 
ICONVIEW_ZoomIn 
ICONVIEW_ZoomOut 
ICONVIEW_ZoomToGroup 
ICONVIEW_ZoomToLayer 
ICONVIEW_ZoomToMaxDetail 
ICONVIEW_ZoomToLocation 
ICONVIEW_Zoom1X 
ICONVIEW_Zoom2X 
ICONVIEW_Zoom3X 
ICONVIEW_Locator 
ICONVIEW_Snapshot 
ICONVIEW_GeoLock 
ICONVIEW_GoogleEarth 
ICONVIEW_Stereo 
ICONVIEW_Default 

Constructor & Destructor Documentation

GRE::VIEW_LEGACY::VIEW_LEGACY (  ) 

Constructor.

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

Destructor.


Member Function Documentation

void GRE::VIEW_LEGACY::AddDrawIcons (  ) 

Add default "drawing" icons (redraw, skip, stop).

Widget GRE::VIEW_LEGACY::AddIconRowItems ( const BUTTONITEM items,
const char *  icongroup = 0,
void *  cbdata = 0,
void *  userdata = 0 
)

Add icon buttons to icon row.

Parameters:
items Items to add
icongroup Icon group
cbdata Button item callback data if NULL in item
userdata Button item userdata if NULL in item
void GRE::VIEW_LEGACY::AddMacroScriptIcons (  ) 

Add icon pushbuttons to toolbar for MacroScripts.

void GRE::VIEW_LEGACY::AddMacroScriptMenuItems (  ) 

Add menu items for MacroScripts.

ERRVALUE GRE::VIEW_LEGACY::AddMenuItemsOptions ( const MENUITEM newitems  ) 

Add additional items to "Options" menu (must be added before menubar created).

Parameters:
newitems Array of items to add, terminated by null item
void GRE::VIEW_LEGACY::AddToolIcons ( bool  addscripts = true  ) 

Add icon togglebuttons to toolbar for all defined tools.

Parameters:
addscripts Add ToolScripts and MacroScripts to toolbar
void GRE::VIEW_LEGACY::AddViewIcons ( ICONVIEW  icons = ICONVIEW_Default  ) 

Add "view" icons (previous, zoom in, zoom out, zoom 1X, etc).

Parameters:
icons Which icons to add.
void GRE::VIEW_LEGACY::ClearPreviousViewList (  )  [inline]

Clear previous view list.

Widget GRE::VIEW_LEGACY::CreateMenuBar ( Widget  form  ) 

Create menubar with default set of items.

Returns:
RowColumn widget for menubar.
Parameters:
form Form to contain menubar
Widget GRE::VIEW_LEGACY::CreateMenuBar ( Widget  form,
MENUBARITEM menubar 
)

Create menubar with specified set of items.

Returns:
RowColumn widget for menubar.
Parameters:
form Form to contain menubar
menubar Menu bar items
ERRVALUE GRE::VIEW_LEGACY::CreateX ( VIEWABLE viewable,
Widget  pwidget,
Arg *  arglist,
int  argcount,
int  iwidth,
int  iheight,
const char *  sizefield = 0,
CREATEFLAGS  createflags = CREATEFLAG_None,
const VIEW_LEGACY_SAVESETTINGS pSettings = 0 
)

Create "form" in X.

Parameters:
sizefield Field from .ini for retrieving window size
void GRE::VIEW_LEGACY::DataTipSetDelay ( INT32  delay  ) 

Set DataTip popup delay.

Parameters:
delay DataTip popup delay in milliseconds

Reimplemented from GRE::VIEW.

void GRE::VIEW_LEGACY::DataTipSetPixelDelta ( int  PixelDelta  ) 

Set distance cursor must move to hide DataTip.

Parameters:
PixelDelta Movement distance in screen pixels

Reimplemented from GRE::VIEW.

void GRE::VIEW_LEGACY::EditCustomization (  ) 

Edit interface customization settings for views of this type.

static VIEW_LEGACY* GRE::VIEW_LEGACY::FindNextLegacyOfGroup ( const GRE::GROUP group,
VIEW view = 0 
) [static]

Find next legacy view containing specified group.

Parameters:
group Group to find view of
view View to start search after, 0 to check first view
static VIEW_LEGACY* GRE::VIEW_LEGACY::FindNextLegacyOfLayer ( const GRE::LAYER layer,
VIEW view = 0 
) [static]

Find next legacy view containing specified layer.

Parameters:
layer Layer to find view of
view View to start search after, 0 to check first view
TOOL* GRE::VIEW_LEGACY::GetActiveTool (  )  const [inline]

Return current active tool for view.

Widget GRE::VIEW_LEGACY::GetDrawingArea (  )  const [inline]

Get DrawingArea widget for view.

Widget GRE::VIEW_LEGACY::GetDrawingAreaForm (  )  const [inline]

Get "form" containing DrawingArea and LegendView.

MGD::DEVICE_X32* GRE::VIEW_LEGACY::GetDrawingDeviceViewInView (  )  const [inline]

Get MGD::DEVICE for 'view-in-view'.

Pixmap GRE::VIEW_LEGACY::GetDrawingPixmap (  )  const [inline]

Get X Pixmap.

Returns:
0 if none exists
Widget GRE::VIEW_LEGACY::GetForm (  )  const [inline]

Get main "form" widget for this view.

const BUTTONITEM* GRE::VIEW_LEGACY::GetIconItemAdd ( BUTTONITEMARRAY items  )  const

Get BUTTONITEM array for "Add" icons on toolbar.

Returns:
Cast of array to BUTTONITEM* for convenience.
Parameters:
items Array to contain items
const BUTTONITEM* GRE::VIEW_LEGACY::GetIconItemDraw ( BUTTONITEMARRAY items  )  const

Get BUTTONITEM array for "Draw" icons on toolbar.

Returns:
Cast of array to BUTTONITEM* for convenience.
Parameters:
items Array to contain items
const BUTTONITEM* GRE::VIEW_LEGACY::GetIconItemTool ( BUTTONITEMARRAY items  )  const

Get BUTTONITEM array for "Tool" icons on toolbar.

This does not include items for custom script tools.

Returns:
Cast of array to BUTTONITEM* for convenience.
Parameters:
items Array to contain items
const BUTTONITEM* GRE::VIEW_LEGACY::GetIconItemView ( BUTTONITEMARRAY items,
ICONVIEW  icons = ICONVIEW_Default 
) const

Get BUTTONITEM array for "View" icons on toolbar.

Returns:
Cast of array to BUTTONITEM* for convenience.
Parameters:
items Array to contain items
icons Which icons to include
Widget GRE::VIEW_LEGACY::GetIconView ( ICONVIEW  icon  )  const

Get "view" toolbar icon.

Returns:
Icon widget or NULL if does not exist.
Parameters:
icon Icon to get widget for
const MENUITEM* GRE::VIEW_LEGACY::GetMenuItemGPS (  ) 

Get GPS menu items.

Returns:
Internal array
const MENUITEM* GRE::VIEW_LEGACY::GetMenuItemHotKeys (  ) 

Get "HotKeys" menu items.

Returns:
Internal array
const MENUITEM* GRE::VIEW_LEGACY::GetMenuItemLegendView (  ) 

Get "LegendView" menu items.

Returns:
Internal array
const MENUITEM* GRE::VIEW_LEGACY::GetMenuItemOptions ( MENUITEMARRAY items  ) 

Get "Options" menu items.

Returns:
Cast of array to MENUITEM* for convenience.
Parameters:
items Array of items returned
const MENUITEM* GRE::VIEW_LEGACY::GetMenuItemTool ( MENUITEMARRAY items  )  const

Get MENUITEM array for "Tool" menu.

Returns:
Cast of array to MENUITEM* for convenience.
Parameters:
items Array of items returned
const MENUITEM* GRE::VIEW_LEGACY::GetMenuItemView ( MENUITEMARRAY items  ) 

Get "View" menu items.

Returns:
Cast of array to MENUITEM* for convenience.
Parameters:
items Array of items returned
Widget GRE::VIEW_LEGACY::GetMenuWidget ( const char *  menupath  )  const

Get Widget for item on view's menubar.

Returns:
Widget or NULL if no matching item.
Parameters:
menupath Path to menu item (eg. "/view/redraw")
VIEW_LEGACY* GRE::VIEW_LEGACY::GetNextLegacy (  )  const

Get next legacy view of same object as this view.

Returns:
next view or 0 if no more views.
VIEW_LEGACY* GRE::VIEW_LEGACY::GetNextLegacyOfAll (  )  const
Widget GRE::VIEW_LEGACY::GetToolBar (  )  const [inline]

Get widget for view's ToolBar.

void GRE::VIEW_LEGACY::LegendEnableRedraw ( bool  enable  ) 

Enable or disable redraw of LegendView.

UINT8 GRE::VIEW_LEGACY::LegendGetShowMode (  )  const [inline]
void GRE::VIEW_LEGACY::LegendHideAllLegends (  ) 
void GRE::VIEW_LEGACY::LegendRedraw ( bool  updatesizes = false  ) 
void GRE::VIEW_LEGACY::LegendSetShowLayerTypeIcon ( bool  ShowLayerType  )  [inline]
void GRE::VIEW_LEGACY::LegendSetShowMode ( UINT8  ShowMode  ) 
void GRE::VIEW_LEGACY::LegendSetVisiblityIndicator ( UINT8  VisInd  )  [inline]
void GRE::VIEW_LEGACY::LegendShowAllLegends (  ) 
void GRE::VIEW_LEGACY::ScalePosClearCoord ( VIEW_LEGACY_COORDSOURCE  CoordSource = VIEW_LEGACY_COORDSOURCE_None  )  [inline]

Clear coordinate display in scale/position report.

void GRE::VIEW_LEGACY::ScalePosDisplayCoord ( VIEW_LEGACY_COORDSOURCE  CoordSource,
const DPOINT2D point,
const SPATREF::COORDREFSYS PointCRS 
) [inline]
const SPATREF::COORDREFSYS& GRE::VIEW_LEGACY::ScalePosGetCoordRefSys ( int  idx  )  const

Get coordinate reference system for scale/position report.

If no fixed projection is set the CRS of the first suitable group will be returned.

void GRE::VIEW_LEGACY::ScalePosGetCoordString ( int  idx,
const DPOINT2D point,
MISTRING string 
) const
Parameters:
point Point in 'view' coordinates
string String returned
DEGTOSTRFLAGS GRE::VIEW_LEGACY::ScalePosGetLatLonFormat ( int  idx  )  const [inline]

Get latitude-longtitude position report format.

bool GRE::VIEW_LEGACY::ScalePosIsPosVisible ( int  idx  )  const [inline]

Determine if statusbar position indicator is visible.

void GRE::VIEW_LEGACY::ScalePosSetCoordRefSys ( int  idx,
const SPATREF::COORDREFSYS CoordRefSys 
) [inline]

Set projection of coordinates displayed on scale/position line.

void GRE::VIEW_LEGACY::ScalePosSetCoordSource ( VIEW_LEGACY_COORDSOURCE  CoordSource  )  [inline]
void GRE::VIEW_LEGACY::ScalePosSetLatLonFormat ( int  idx,
DEGTOSTRFLAGS  LatLonFormat 
) [inline]
void GRE::VIEW_LEGACY::ScalePosSetPosVisible ( int  idx,
bool  visible 
) [inline]

Set whether statusbar position indicator is visible.

void GRE::VIEW_LEGACY::ScalePosSetVisible ( bool  visible  ) 

Set scale/position line visibility.

Parameters:
visible true to show, false to hide
void GRE::VIEW_LEGACY::SetDrawingArea ( Widget  da  )  [inline]
void GRE::VIEW_LEGACY::SetEditCustomFunc ( void(*)(VIEW_LEGACY *)  EditCustomFunc  )  [inline]
void GRE::VIEW_LEGACY::SetInputFocusTo (  ) 

Set input (mouse/keyboard) focus to view.

Will activate window, and direct keyboard input to drawing canvas control.

void GRE::VIEW_LEGACY::SetMessageVisible ( bool  visible  ) 

Set visibility of "message" line at bottom of view.

Parameters:
visible 'true' to show, 'false' to hide
void GRE::VIEW_LEGACY::SetPreviousView (  ) 
void GRE::VIEW_LEGACY::SetPreviousZoom (  ) 
static void GRE::VIEW_LEGACY::SML_ClassInstall ( SML::CONTEXT context  )  [static]

Reimplemented from GRE::VIEW.

void GRE::VIEW_LEGACY::ToolAttach ( TOOL tool  ) 

Attach tool to view.

This is done by the tool constructor and does not need to be called directly.

Parameters:
tool Tool to attach
TOOL* GRE::VIEW_LEGACY::ToolFindByName ( const char *  toolname  )  const

Find tool with given name if any.

Parameters:
toolname Tool name
TOOL* GRE::VIEW_LEGACY::ToolGetActive (  )  const [inline]

Get the active tool.

Returns:
Pointer to active tool or NULL if no tool active.
bool GRE::VIEW_LEGACY::ToolIsActive ( const char *  toolname  )  const [inline]

Determine if specified tool is active (by name).

Parameters:
toolname Tool name
bool GRE::VIEW_LEGACY::ToolIsActive ( TOOL tool  )  const [inline]

Determine if specified tool is active (by tool).

Parameters:
tool Tool
void GRE::VIEW_LEGACY::ToolResume (  )  [inline]

Resume tool after suspended.

See also:
ToolSuspend.
int GRE::VIEW_LEGACY::ToolSet ( const char *  toolname  ) 

Set active tool for view (by name).

Parameters:
toolname Tool name
void GRE::VIEW_LEGACY::ToolSet ( TOOL tool  )  [inline]

Set active tool for view (by tool).

Parameters:
tool Tool
void GRE::VIEW_LEGACY::ToolSetDefault (  ) 

Set tool to default.

int GRE::VIEW_LEGACY::ToolSuspend (  )  [inline]

Suspend tool (during screen update).

Before drawing on a view the current graphic tool must be suspended. Normally this is done automatically by the GRE system, but in cases where direct updates are required this method may be called directly. The caller should use the Resume() method if and only if the Suspend() method returns TRUE upon completion of the drawing operation.

Returns:
true if suspended, false if was already suspended.
See also:
ToolResume.

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

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