MIE::UI_BASE Class Reference

#include <mie/uibase.h>

Inheritance diagram for MIE::UI_BASE:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 UI_BASE (const FORMAT &format, SETTINGS &settings)
virtual ~UI_BASE ()
void ActivateExportPane (const RVC::OBJITEMLIST &objlist)
void ActivateImportPane (const MISTRINGLIST &filenamelist)
bool CheckOK ()
int CreateExportPane (MGUI::LAYOUT_PANE_BASE &pane, bool testmode=false)
int CreateImportPane (MGUI::LAYOUT_PANE_BASE &pane, bool testmode=false)
void DataTypeOMSetSensitive (bool sensitive)
bool ExportCoordPaneCreate (MGUI::LAYOUT_PANE_BASE &pane)
bool ExportOptionsPaneCreate (MGUI::LAYOUT_PANE_BASE &pane)
void ExportSetSingleFileAllowed (bool bCanDoSingle)
void ExtractPaneSetSensitive (bool sensitive)
const FORMATGetFormat () const
void GetImportProjection ()
SETTINGSGetSettings ()
void ImportPBSetSensitive (bool sensitive)
void LinColRangeClear ()
void LinColRangeSetEditable (bool sensitive)
void LinColRangeSetRange (INT32 maxlin, INT32 maxcol)
void LinkTBSetSensitive (bool sensitive)
void LinkTBSetState (bool state)
void MultiSingleOMSetSensitive (bool sensitive)
void MultiSingleOMSetValue (int value)
void NullValueSetValue (double value)
void NumBandsSetSensitive (bool sensitive)
void NumBandsSetValue (int value)
void NumColsSetSensitive (bool sensitive)
void NumColsSetValue (int value)
void NumLinsSetSensitive (bool sensitive)
void NumLinsSetValue (int value)
void ProjPBSetSensitive (bool sensitive)
void SetDialog (SETTINGSDIALOG *dlg)
void SetIs3D (bool sensitive)
void SetProjName (const MISTRING &name)
void SetTopology (int topology)
void SyncControlsFromExportSettings ()
void SyncControlsFromImportSettings ()
void SyncExportSettingsFromControls ()
void SyncImportSettingsFromControls ()

Protected Member Functions

void CallOnChange ()
MDLGPARENT GetDlgParent () const
bool ImportOptionsPaneCreate (MGUI::LAYOUT_PANE_BASE &pane)

Private Member Functions

virtual void v_ActivateExportPane (const RVC::OBJITEMLIST &objlist)
virtual void v_ActivateImportPane (const MISTRINGLIST &filelist)
virtual bool v_CheckExportOK ()
virtual bool v_CheckImportOK ()
virtual int v_CreateExportPane (MGUI::LAYOUT_PANE_BASE &pane)
virtual int v_CreateFormatSpecificExportPane (MGUI::LAYOUT_PANE_BASE &pane)
virtual int v_CreateFormatSpecificImportPane (MGUI::LAYOUT_PANE_BASE &pane)
virtual int v_CreateImportPane (MGUI::LAYOUT_PANE_BASE &pane)
virtual void v_OnChange ()
virtual void v_OnChangeEncoding ()
virtual void v_UpdateExportSettingsFromUI ()
virtual void v_UpdateImportSettingsFromUI ()

Constructor & Destructor Documentation

MIE::UI_BASE::UI_BASE ( const FORMAT format,
SETTINGS settings 
)
virtual MIE::UI_BASE::~UI_BASE (  )  [virtual]

Member Function Documentation

void MIE::UI_BASE::ActivateExportPane ( const RVC::OBJITEMLIST objlist  ) 
void MIE::UI_BASE::ActivateImportPane ( const MISTRINGLIST filenamelist  ) 
void MIE::UI_BASE::CallOnChange (  )  [protected]

Called by the GUI when anything is changed.

Call this method in any delegates that change settings members.

bool MIE::UI_BASE::CheckOK (  ) 

Check to see if the OK button should be enabled.

Will call the setting's v_IsSafeToImport/Export method. Will automatically be called after v_OnChange, but you can call it any time.

int MIE::UI_BASE::CreateExportPane ( MGUI::LAYOUT_PANE_BASE pane,
bool  testmode = false 
)

Create parameters pane for export.

If in testmode, will not allow export.

Returns:
TRUE if there are controls, FALSE if pane is empty, < 0 on error.
int MIE::UI_BASE::CreateImportPane ( MGUI::LAYOUT_PANE_BASE pane,
bool  testmode = false 
)

Create parameters pane for import.

Returns:
TRUE if there are controls, FALSE if pane is empty, < 0 on error.
void MIE::UI_BASE::DataTypeOMSetSensitive ( bool  sensitive  ) 
bool MIE::UI_BASE::ExportCoordPaneCreate ( MGUI::LAYOUT_PANE_BASE pane  ) 

Create a pane containing extents to export.

XXX Rename these to all start with Create instead of end with Create. Returns true if any controls were actually created

bool MIE::UI_BASE::ExportOptionsPaneCreate ( MGUI::LAYOUT_PANE_BASE pane  ) 

Create a pane containing options for export.

Returns true if any controls were actually created

void MIE::UI_BASE::ExportSetSingleFileAllowed ( bool  bCanDoSingle  ) 

Set whether or not single-file export is allowed.

If trying to export multiple objects and the format supports merging them into a single output file, this function should be called to tell the GUI to enable or disable the option. You would disable it if, for example, you're exporting multiple rasters of different sizes and the format requires them to be the same size. You can call this from your MIE::SETTINGS::v_IsSafeToExport, or UI_BASE::v_ActivateExportPane.

void MIE::UI_BASE::ExtractPaneSetSensitive ( bool  sensitive  ) 

The following functions are for use by derived classes, but are not protected because the _mieLegacyUIXxx functions call them.

Once all legacy code is rewritten, these can become protected (and some will just be obsolete)

MDLGPARENT MIE::UI_BASE::GetDlgParent (  )  const [inline, protected]
const FORMAT& MIE::UI_BASE::GetFormat (  )  const [inline]
void MIE::UI_BASE::GetImportProjection (  ) 
SETTINGS& MIE::UI_BASE::GetSettings (  )  [inline]
bool MIE::UI_BASE::ImportOptionsPaneCreate ( MGUI::LAYOUT_PANE_BASE pane  )  [protected]

Create a pane containing options for import This one is called by the default v_CreateImportPane derived class can call it too if it overrides v_CreateImportPane.

void MIE::UI_BASE::ImportPBSetSensitive ( bool  sensitive  ) 
void MIE::UI_BASE::LinColRangeClear (  ) 
void MIE::UI_BASE::LinColRangeSetEditable ( bool  sensitive  ) 
void MIE::UI_BASE::LinColRangeSetRange ( INT32  maxlin,
INT32  maxcol 
)
void MIE::UI_BASE::LinkTBSetSensitive ( bool  sensitive  ) 
void MIE::UI_BASE::LinkTBSetState ( bool  state  ) 
void MIE::UI_BASE::MultiSingleOMSetSensitive ( bool  sensitive  ) 

For legacy use only. Call ExportSetSingleFileAllowed instead.

void MIE::UI_BASE::MultiSingleOMSetValue ( int  value  ) 

For legacy use only.

void MIE::UI_BASE::NullValueSetValue ( double  value  ) 
void MIE::UI_BASE::NumBandsSetSensitive ( bool  sensitive  ) 
void MIE::UI_BASE::NumBandsSetValue ( int  value  ) 
void MIE::UI_BASE::NumColsSetSensitive ( bool  sensitive  ) 
void MIE::UI_BASE::NumColsSetValue ( int  value  ) 
void MIE::UI_BASE::NumLinsSetSensitive ( bool  sensitive  ) 
void MIE::UI_BASE::NumLinsSetValue ( int  value  ) 
void MIE::UI_BASE::ProjPBSetSensitive ( bool  sensitive  ) 
void MIE::UI_BASE::SetDialog ( SETTINGSDIALOG dlg  )  [inline]

Set the dialog pointer If set to non-NULL, CheckOK will call the dialog's SetOkEnabled to enable or disable the OK button.

void MIE::UI_BASE::SetIs3D ( bool  sensitive  ) 
void MIE::UI_BASE::SetProjName ( const MISTRING name  ) 
void MIE::UI_BASE::SetTopology ( int  topology  ) 
void MIE::UI_BASE::SyncControlsFromExportSettings (  ) 
void MIE::UI_BASE::SyncControlsFromImportSettings (  ) 
void MIE::UI_BASE::SyncExportSettingsFromControls (  ) 
void MIE::UI_BASE::SyncImportSettingsFromControls (  ) 
virtual void MIE::UI_BASE::v_ActivateExportPane ( const RVC::OBJITEMLIST objlist  )  [private, virtual]

Activate epxort pane.

Reimplemented in MIE::UI_RDBMS_SPATIAL.

virtual void MIE::UI_BASE::v_ActivateImportPane ( const MISTRINGLIST filelist  )  [private, virtual]

Activate import pane.

virtual bool MIE::UI_BASE::v_CheckExportOK (  )  [private, virtual]

Determine if you have enough settings set to do an export.

Default implementation just returns true.

virtual bool MIE::UI_BASE::v_CheckImportOK (  )  [private, virtual]

Determine if you have enough settings set to do an import.

Default implementation just returns true.

virtual int MIE::UI_BASE::v_CreateExportPane ( MGUI::LAYOUT_PANE_BASE pane  )  [private, virtual]

Create parameters form Default implementation will create a default pane, including calling the other virtual methods to create parts of the interface.

Only override this to completely override the interface

Returns:
Must return TRUE if there are any controls, FALSE if not. Some formats end up with no options on export, so the settings dialog will get skipped.
virtual int MIE::UI_BASE::v_CreateFormatSpecificExportPane ( MGUI::LAYOUT_PANE_BASE pane  )  [private, virtual]

Create format-specific parameters pane.

Default implementation will do nothing

Returns:
Must return TRUE if there are any controls, FALSE if not. or an error value < 0 on error. Some formats end up with no options on export, so the settings dialog will get skipped.

Reimplemented in MIE::UI_RDBMS_SPATIAL.

virtual int MIE::UI_BASE::v_CreateFormatSpecificImportPane ( MGUI::LAYOUT_PANE_BASE pane  )  [private, virtual]

Create format-specific parameters pane.

Default implementation will do nothing

Returns:
Must return TRUE if there are any controls, FALSE if not. or an error value < 0 on error. Some formats end up with no options on import, so the settings dialog will get skipped.
virtual int MIE::UI_BASE::v_CreateImportPane ( MGUI::LAYOUT_PANE_BASE pane  )  [private, virtual]

Create parameters pane Default implementation will create a default pane, including calling the other virtual methods to create parts of the interface.

Only override this to completely override the interface

virtual void MIE::UI_BASE::v_OnChange (  )  [private, virtual]

Virtual method which will get called if anything changes.

virtual void MIE::UI_BASE::v_OnChangeEncoding (  )  [private, virtual]

Virtual method which will get called if character encoding changes.

virtual void MIE::UI_BASE::v_UpdateExportSettingsFromUI (  )  [private, virtual]

Virtual method which will get called just before export starts This allows you to update the Settings from your controls.

Reimplemented in MIE::UI_RDBMS_SPATIAL.

virtual void MIE::UI_BASE::v_UpdateImportSettingsFromUI (  )  [private, virtual]

Virtual method which will get called just before import starts This allows you to update the Settings from your controls.


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

Generated on Sun Oct 7 21:36:37 2012 for TNTsdk 2012 by  doxygen 1.6.1