Interface Class Reference

Interface is responsible for initially loading in a display description, creating a display description, showing and allowing users to release data, and creating the Evaluator and DataManager. More...

Inheritance diagram for Interface:

Collaboration diagram for Interface:

List of all members.

Public Member Functions
void	addDatabaseItem (std::string s, unsigned long memory, unsigned long totalMemory)
bool	Create (wxWindow *parent, wxWindowID id=SYMBOL_INTERFACE_IDNAME, const wxString &caption=SYMBOL_INTERFACE_TITLE, const wxPoint &pos=SYMBOL_INTERFACE_POSITION, const wxSize &size=SYMBOL_INTERFACE_SIZE, long style=SYMBOL_INTERFACE_STYLE)
void	CreateControls ()
	Creates the controls and sizers.
void	CreateNIREPDisplay (std::string &fileName)
void	DeleteSpatialData (int row, int col)
void	EditorShown (wxGridEvent &event)
wxBitmap	GetBitmapResource (const wxString &name)
	Retrieves bitmap resources.
NIREPDataManager *	GetDataManager ()
NIREPEvaluator *	GetEvaluator ()
wxString	GetEvalutorPath ()
wxIcon	GetIconResource (const wxString &name)
	Retrieves icon resources.
wxString	GetWidgetPath ()
void	Init ()
	Initialises member variables.
	Interface (wxWindow *parent, wxWindowID id=SYMBOL_INTERFACE_IDNAME, const wxString &caption=SYMBOL_INTERFACE_TITLE, const wxPoint &pos=SYMBOL_INTERFACE_POSITION, const wxSize &size=SYMBOL_INTERFACE_SIZE, long style=SYMBOL_INTERFACE_STYLE)
	Interface ()
	Constructors.
void	OnEditResourceNewFormat (wxCommandEvent &event)
void	OnGridChange (wxGridEvent &event)
void	OnHelpClick (wxCommandEvent &event)
void	OnLoadDisplayClick (wxCommandEvent &event)
	wxEVT_COMMAND_MENU_SELECTED event handler for wxID_OPEN
void	OnLoadResourceNewFormatClick (wxCommandEvent &event)
void	OnMaximize (wxMaximizeEvent &event)
	wxEVT_MAXIMIZE event handler for ID_FRAME
void	OnQuit (wxCommandEvent &event)
void	OnSaveAsClick (wxCommandEvent &event)
	wxEVT_COMMAND_MENU_SELECTED event handler for ID_SAVE_AS
void	OnSaveClick (wxCommandEvent &event)
	wxEVT_COMMAND_MENU_SELECTED event handler for wxID_SAVE
void	OnSaveResourceNewFormatClick (wxCommandEvent &event)
void	OnSize (wxSizeEvent &event)
	wxEVT_SIZE event handler for ID_FRAME
void	OnTimer (wxTimerEvent &event)
void	OnViewDisplayDescription (wxCommandEvent &event)
void	OnViewEvaluatorCommands (wxCommandEvent &event)
void	SetCmdLine (int argc, wxChar **argv)
void	SetEvalutorPath (wxString EP)
void	SetTotalMemoryUsage (unsigned long totalMemory)
void	SetWidgetPath (wxString WP)
	~Interface ()
	Destructor.
Static Public Member Functions
static bool	ShowToolTips ()
	Should we show tooltips?

---

Detailed Description

Interface is responsible for initially loading in a display description, creating a display description, showing and allowing users to release data, and creating the Evaluator and DataManager.

Interface class declaration

Notes

• Work in progress

Dependencies

• Libraries:

Bugs

Change Log

---

Constructor & Destructor Documentation

Interface::Interface

(

)

Constructors.

Interface::Interface	(	wxWindow *	parent,
		wxWindowID	id = SYMBOL_INTERFACE_IDNAME,
		const wxString &	caption = SYMBOL_INTERFACE_TITLE,
		const wxPoint &	pos = SYMBOL_INTERFACE_POSITION,
		const wxSize &	size = SYMBOL_INTERFACE_SIZE,
		long	style = SYMBOL_INTERFACE_STYLE
	)

Interface::~Interface

(

)

Destructor.

Interface destructor

---

Member Function Documentation

void Interface::addDatabaseItem	(	std::string	s,
		unsigned long	memory,
		unsigned long	totalMemory
	)

bool Interface::Create	(	wxWindow *	parent,
		wxWindowID	id = SYMBOL_INTERFACE_IDNAME,
		const wxString &	caption = SYMBOL_INTERFACE_TITLE,
		const wxPoint &	pos = SYMBOL_INTERFACE_POSITION,
		const wxSize &	size = SYMBOL_INTERFACE_SIZE,
		long	style = SYMBOL_INTERFACE_STYLE
	)

Interface creator

void Interface::CreateControls

(

)

Creates the controls and sizers.

Control creation for Interface

void Interface::CreateNIREPDisplay

(

std::string &

fileName

)

void Interface::DeleteSpatialData	(	int	row,
		int	col
	)

void Interface::EditorShown

(

wxGridEvent &

event

)

wxBitmap Interface::GetBitmapResource

(

const wxString &

name

)

Retrieves bitmap resources.

Get bitmap resources

NIREPDataManager* Interface::GetDataManager

(

)

[inline]

NIREPEvaluator* Interface::GetEvaluator

(

)

[inline]

wxString Interface::GetEvalutorPath

(

)

[inline]

wxIcon Interface::GetIconResource

(

const wxString &

name

)

Retrieves icon resources.

Get icon resources

wxString Interface::GetWidgetPath

(

)

[inline]

Interface::Init

(

)

Initialises member variables.

Member initialisation

void Interface::OnEditResourceNewFormat

(

wxCommandEvent &

event

)

void Interface::OnGridChange

(

wxGridEvent &

event

)

void Interface::OnHelpClick

(

wxCommandEvent &

event

)

void Interface::OnLoadDisplayClick

(

wxCommandEvent &

event

)

wxEVT_COMMAND_MENU_SELECTED event handler for wxID_OPEN

wxEVT_COMMAND_MENU_SELECTED event handler for ID_LOAD_DISPLAY

void Interface::OnLoadResourceNewFormatClick

(

wxCommandEvent &

event

)

void Interface::OnMaximize

(

wxMaximizeEvent &

event

)

wxEVT_MAXIMIZE event handler for ID_FRAME

void Interface::OnQuit

(

wxCommandEvent &

event

)

void Interface::OnSaveAsClick

(

wxCommandEvent &

event

)

wxEVT_COMMAND_MENU_SELECTED event handler for ID_SAVE_AS

void Interface::OnSaveClick

(

wxCommandEvent &

event

)

wxEVT_COMMAND_MENU_SELECTED event handler for wxID_SAVE

void Interface::OnSaveResourceNewFormatClick

(

wxCommandEvent &

event

)

void Interface::OnSize

(

wxSizeEvent &

event

)

wxEVT_SIZE event handler for ID_FRAME

wxEVT_MAXIMIZE event handler for ID_FRAME

void Interface::OnTimer

(

wxTimerEvent &

event

)

void Interface::OnViewDisplayDescription

(

wxCommandEvent &

event

)

void Interface::OnViewEvaluatorCommands

(

wxCommandEvent &

event

)

void Interface::SetCmdLine	(	int	argc,
		wxChar **	argv
	)		[inline]

void Interface::SetEvalutorPath

(

wxString

EP

)

[inline]

void Interface::SetTotalMemoryUsage

(

unsigned long

totalMemory

)

void Interface::SetWidgetPath

(

wxString

WP

)

[inline]

bool Interface::ShowToolTips

(

)

[static]

Should we show tooltips?