GRE::UI::FORM_VIEW::SETTINGS Class Reference

Constainer for savable settings for GRE::UI::FORM_VIEW. More...

#include <gre/uiformviewsettings.h>

Inheritance diagram for GRE::UI::FORM_VIEW::SETTINGS:
Inheritance graph
[legend]

List of all members.

Classes

class  STATUSPOS
 Settings for statusbar position reports. More...

Public Member Functions

 SETTINGS (const SETTINGS &rhs)
 SETTINGS ()
virtual ~SETTINGS ()
INT32 GetCanvasHeight () const
INT32 GetCanvasWidth () const
INT16 GetLocatorHeight () const
INT16 GetMagnifierHeight () const
INT16 GetMagnifierZoom () const
INT16 GetPlacesHeight () const
bool GetShowLegend () const
bool GetShowLocator () const
bool GetShowMagnifier () const
bool GetShowPlaces () const
bool GetShowSidebar () const
bool GetShowZoom () const
INT16 GetSidebarWidth () const
const STATUSPOS & GetStatusPos (unsigned idx) const
bool GetStatusPosShowAny () const
INT16 GetZoomHeight () const
void IniRead (INIHANDLE handle, const char *inigroup, const char *ViewTypeName=0)
void IniWrite (INIHANDLE handle=0, const char *inigroup=0) const
void IniWriteLayout (INIHANDLE handle=0, const char *inigroup=0) const
SETTINGS & operator= (const SETTINGS &rhs)
void SetCanvasDimensions (INT32 width, INT32 height)
void SetCanvasHeight (INT32 height)
void SetCanvasWidth (INT32 width)
void SetLocatorHeight (INT16 height)
void SetMagnifierHeight (INT16 height)
void SetMagnifierZoom (INT16 zoom)
void SetPlacesHeight (INT16 height)
void SetShowLegend (bool show)
void SetShowLocator (bool show)
void SetShowMagnifier (bool show)
void SetShowPlaces (bool show)
void SetShowSidebar (bool show)
void SetShowZoom (bool show)
void SetSidebarWidth (INT16 width)
void SetStatusPos (unsigned idx, const STATUSPOS &StatusPos)
void SetStatusPosCRS (unsigned idx, const SPATREF::COORDREFSYS &CoordRefSys)
void SetStatusPosLatLonFormat (unsigned idx, DMSTYPE LatLonFormat)
void SetStatusPosShow (unsigned idx, bool Show)
void SetZoomHeight (INT16 height)
void UpdateFromForm (UI::FORM_VIEW &form)

Static Public Member Functions

static const SERIALIZERITEM * SerialGetItemDef ()

Detailed Description

Constainer for savable settings for GRE::UI::FORM_VIEW.

Constructor & Destructor Documentation

GRE::UI::FORM_VIEW::SETTINGS::SETTINGS (  ) 

Default constructor.

GRE::UI::FORM_VIEW::SETTINGS::SETTINGS ( const SETTINGS &  rhs  ) 

Copy constructor.

virtual GRE::UI::FORM_VIEW::SETTINGS::~SETTINGS (  )  [virtual]

Destructor.

Member Function Documentation

INT32 GRE::UI::FORM_VIEW::SETTINGS::GetCanvasHeight (  )  const [inline]

Get canvas height.

Returns:
Height in pixels.
INT32 GRE::UI::FORM_VIEW::SETTINGS::GetCanvasWidth (  )  const [inline]

Get canvas width.

Returns:
Width in pixels.
INT16 GRE::UI::FORM_VIEW::SETTINGS::GetLocatorHeight (  )  const [inline]

Get locator height.

Returns:
Height in pixels.
INT16 GRE::UI::FORM_VIEW::SETTINGS::GetMagnifierHeight (  )  const [inline]

Get magnifier height.

Returns:
Height in pixels.
INT16 GRE::UI::FORM_VIEW::SETTINGS::GetMagnifierZoom (  )  const [inline]

Get magnifier zoom.

INT16 GRE::UI::FORM_VIEW::SETTINGS::GetPlacesHeight (  )  const [inline]

Get places height.

Returns:
Height in pixels.
bool GRE::UI::FORM_VIEW::SETTINGS::GetShowLegend (  )  const [inline]

Get whether to show legend.

bool GRE::UI::FORM_VIEW::SETTINGS::GetShowLocator (  )  const [inline]

Get whether to show locator.

bool GRE::UI::FORM_VIEW::SETTINGS::GetShowMagnifier (  )  const [inline]

Get whether to show magnifier.

bool GRE::UI::FORM_VIEW::SETTINGS::GetShowPlaces (  )  const [inline]

Get whether to show places.

bool GRE::UI::FORM_VIEW::SETTINGS::GetShowSidebar (  )  const [inline]

Get whether to show sidebar.

bool GRE::UI::FORM_VIEW::SETTINGS::GetShowZoom (  )  const [inline]

Get whether to show zoom pane.

INT16 GRE::UI::FORM_VIEW::SETTINGS::GetSidebarWidth (  )  const [inline]

Get sidebar width.

Returns:
Width in pixels.
const STATUSPOS& GRE::UI::FORM_VIEW::SETTINGS::GetStatusPos ( unsigned  idx  )  const [inline]

Get status position settings.

Parameters:
idx Report index (0 or 1)
bool GRE::UI::FORM_VIEW::SETTINGS::GetStatusPosShowAny (  )  const [inline]

Determine if any position report shown.

INT16 GRE::UI::FORM_VIEW::SETTINGS::GetZoomHeight (  )  const [inline]

Get zoom pane height.

Returns:
Height in pixels.
void GRE::UI::FORM_VIEW::SETTINGS::IniRead ( INIHANDLE  handle,
const char *  inigroup,
const char *  ViewTypeName = 0 
)

Read settings from INI file.

Parameters:
handle INI handle, 0 for default
inigroup INI group, 0 for default
ViewTypeName View "type name", 0 for generic
void GRE::UI::FORM_VIEW::SETTINGS::IniWrite ( INIHANDLE  handle = 0,
const char *  inigroup = 0 
) const

Write all settings to INI file.

Parameters:
handle INI handle, 0 for default
inigroup INI group, 0 to use one specified in IniRead
void GRE::UI::FORM_VIEW::SETTINGS::IniWriteLayout ( INIHANDLE  handle = 0,
const char *  inigroup = 0 
) const

Write layout (control arrangement) settings to INI file.

Parameters:
handle INI handle, 0 for default
inigroup INI group, 0 to use one specified in IniRead
SETTINGS& GRE::UI::FORM_VIEW::SETTINGS::operator= ( const SETTINGS &  rhs  ) 

Assignment operator.

static const SERIALIZERITEM* GRE::UI::FORM_VIEW::SETTINGS::SerialGetItemDef (  )  [static]

Get serialization item definition array.

void GRE::UI::FORM_VIEW::SETTINGS::SetCanvasDimensions ( INT32  width,
INT32  height 
) [inline]

Set canvas dimensions.

Parameters:
width Width in pixels
height Height in pixels
void GRE::UI::FORM_VIEW::SETTINGS::SetCanvasHeight ( INT32  height  )  [inline]

Set canvas height.

Parameters:
height Height in pixels
void GRE::UI::FORM_VIEW::SETTINGS::SetCanvasWidth ( INT32  width  )  [inline]

Set canvas width.

Parameters:
width Width in pixels
void GRE::UI::FORM_VIEW::SETTINGS::SetLocatorHeight ( INT16  height  )  [inline]

Set locator height.

Parameters:
height Height in pixels
void GRE::UI::FORM_VIEW::SETTINGS::SetMagnifierHeight ( INT16  height  )  [inline]

Set magnifier height.

Parameters:
height Height in pixels
void GRE::UI::FORM_VIEW::SETTINGS::SetMagnifierZoom ( INT16  zoom  )  [inline]

Set magnifier zoom.

Parameters:
zoom Zoom (2x, 4x, 8x, 16x)
void GRE::UI::FORM_VIEW::SETTINGS::SetPlacesHeight ( INT16  height  )  [inline]

Set places height.

Parameters:
height Height in pixels
void GRE::UI::FORM_VIEW::SETTINGS::SetShowLegend ( bool  show  )  [inline]

Set whether to show legend.

void GRE::UI::FORM_VIEW::SETTINGS::SetShowLocator ( bool  show  )  [inline]

Set whether to show locator.

void GRE::UI::FORM_VIEW::SETTINGS::SetShowMagnifier ( bool  show  )  [inline]

Set whether to show magnifier.

void GRE::UI::FORM_VIEW::SETTINGS::SetShowPlaces ( bool  show  )  [inline]

Set whether to show places.

void GRE::UI::FORM_VIEW::SETTINGS::SetShowSidebar ( bool  show  )  [inline]

Set whether to show sidebar.

void GRE::UI::FORM_VIEW::SETTINGS::SetShowZoom ( bool  show  )  [inline]

Set whether to show zoom pane.

void GRE::UI::FORM_VIEW::SETTINGS::SetSidebarWidth ( INT16  width  )  [inline]

Set sidebar width.

Parameters:
width Width in pixels
void GRE::UI::FORM_VIEW::SETTINGS::SetStatusPos ( unsigned  idx,
const STATUSPOS &  StatusPos 
) [inline]

Set all position report values.

Parameters:
idx Report index (0 or 1)
void GRE::UI::FORM_VIEW::SETTINGS::SetStatusPosCRS ( unsigned  idx,
const SPATREF::COORDREFSYS &  CoordRefSys 
) [inline]

Set position report CRS.

Parameters:
idx Report index (0 or 1)
void GRE::UI::FORM_VIEW::SETTINGS::SetStatusPosLatLonFormat ( unsigned  idx,
DMSTYPE  LatLonFormat 
) [inline]

Set geographic position report format.

Parameters:
idx Report index (0 or 1)
void GRE::UI::FORM_VIEW::SETTINGS::SetStatusPosShow ( unsigned  idx,
bool  Show 
) [inline]

Set whether to show position indicator.

Parameters:
idx Report index (0 or 1)
void GRE::UI::FORM_VIEW::SETTINGS::SetZoomHeight ( INT16  height  )  [inline]

Set zoom pane height.

Parameters:
height Height in pixels
void GRE::UI::FORM_VIEW::SETTINGS::UpdateFromForm ( UI::FORM_VIEW &  form  ) 

Update values from form.

Typically done just prior to saving.

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