BImporter Class Reference

#include <BImporter.h>

List of all members.


Detailed Description

A class allowing a client application to import a data set using a common dialog.

Public Member Functions

 BImporter (QWidget *parent=0, const GeoCore::BString *caption=0, bool modal=true, bool advancedMode=false)
 Constructs for a dialog that will import to a Qt application.
 BImporter (HWND parent, const GeoCore::BString *caption=0, bool modal=true, bool advancedMode=false)
 Constructs a dialog that will import data into a Win32 application.
GeoCore::BString GetErrorMessage ()
 Returns the text for any errors encountered when running the import.
GeoCore::BString GetFileDir ()
 Returns the path to the chosen import file or directory.
GeoCore::BString GetTitleBarCaption ()
 Returns the text that appears in the dialog title bar.
GeoCore::EStatus Import (GeoCore::BLayers &importedLayers)
 Displays the dialog to import data into the specified layer collection.
bool SetParent (QWidget *parent)
 Sets the parent of this dialog.
void SetTitleBarCaption (const GeoCore::BString &caption)
 Sets the text that appears in the dialog title bar.
virtual ~BImporter ()
 Destroys the importer dialog.

Constructor & Destructor Documentation

BImporter ( HWND  parent,
const GeoCore::BString caption = 0,
bool  modal = true,
bool  advancedMode = false 
)

Constructs a dialog that will import data into a Win32 application.

Parameters:
parent The handle of the parent window.
caption The caption for the dialog (will default to "Import").
modal True if the dialog will be modal to the parent, false otherwise.
advancedMode True if the dialog should allow the coordinate system from the imported data to be overwritten.

BImporter ( QWidget *  parent = 0,
const GeoCore::BString caption = 0,
bool  modal = true,
bool  advancedMode = false 
)

Constructs for a dialog that will import to a Qt application.

Parameters:
parent The QWidget that represents the parent window
caption The caption for the dialog (will default to "Import").
modal True if the dialog will be modal to the parent, false otherwise.
advancedMode True if the dialog should allow the coordinate system from the imported data to be overwritten

virtual ~BImporter (  )  [virtual]

Destroys the importer dialog.


Member Function Documentation

GeoCore::BString GetErrorMessage (  ) 

Returns the text for any errors encountered when running the import.

This function may be called after an import has been performed to retrieve the text of any error message returned when running the import.

Returns:
The error messages.

GeoCore::BString GetFileDir (  ) 

Returns the path to the chosen import file or directory.

This function may be called after an import has been performed to retrieve the text selected by the user as the import file or directory.

Returns:
The file or directory path.

GeoCore::BString GetTitleBarCaption (  ) 

Returns the text that appears in the dialog title bar.

This function may be called after construction of the dialog to return the text displayed in the title bar.

Returns:
The title bar text.

GeoCore::EStatus Import ( GeoCore::BLayers importedLayers  ) 

Displays the dialog to import data into the specified layer collection.

This call actually displays the dialog to allow the user to chose a type of file to import and to browse for a matching file or directory from which to import. The dialog also allows the user to specify the coordinate system for the imported data (either because the data did not specify a coordinate system, or because the user wishes to override the coordinate system specified). If the user sucessfully imports data, it will be stored in the specified output parameter. If the import was sucessful, eStatusSuccess will be returned. If the import failed, eStatusFailure will be returned. If the import succeeded but with warnings, eStatusWarning will be returned (warnings may then be viewed in the log output). If the user cancelled out of the dialog, eStatusCancel will be returned.

Parameters:
importedLayers Reference to a layer collection that will store the imported layers.
Returns:
A status value indicating Success, Warning, Cancelled, or Failure.

bool SetParent ( QWidget *  parent  ) 

Sets the parent of this dialog.

This function may be called after construction of the dialog to change the parent form prior to display.

Parameters:
parent The parent widget.

void SetTitleBarCaption ( const GeoCore::BString caption  ) 

Sets the text that appears in the dialog title bar.

This function may be called after construction of the dialog to set the text displayed in the title bar.

Parameters:
caption The title bar text.


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

GeoTranslate 5.0 From Blue Marble Geographics