cornelluniversity::vetcpr::MainFrame Class Reference

extends wxFrame and serves as our primary (and only) window for this application. Note that this is AUI managed. More...

#include <wxcpr.h>

List of all members.

Public Member Functions

 MainFrame (wxWindow *parent, wxWindowID id=ID_FRAME_MAIN, const wxString &title=_("VetSim: CPR"), const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxSize(776, 497), long style=wxCAPTION|wxCLOSE_BOX|wxDEFAULT_FRAME_STYLE|wxMAXIMIZE_BOX|wxMINIMIZE_BOX|wxSYSTEM_MENU|wxTAB_TRAVERSAL, const wxString &name=wxT("FRAME_MAIN"))
 ~MainFrame ()

Public Attributes

wxAuiManager m_mgr

Protected Types

 ID_FRAME_MAIN = 1000
 ID_TEXT_EXAMPLE
 ID_STATUSBAR_MAIN
 ID_MENUBAR_MAIN
 ID_MENUITEM_FILE_SERIAL_CONNECT
 ID_MENUITEM_FILE_SERIAL_DISCONNECT
 ID_MENUITEM_FILE_QUIT
 ID_MENUITEM_TOOLS_SERIAL
 ID_MENUITEM_TOOLS_PREFERENCES
 ID_MENUITEM_HELP_ABOUT
 ID_MENUITEM_HELP_HELP
enum  {
  ID_FRAME_MAIN = 1000, ID_TEXT_EXAMPLE, ID_STATUSBAR_MAIN, ID_MENUBAR_MAIN,
  ID_MENUITEM_FILE_SERIAL_CONNECT, ID_MENUITEM_FILE_SERIAL_DISCONNECT, ID_MENUITEM_FILE_QUIT, ID_MENUITEM_TOOLS_SERIAL,
  ID_MENUITEM_TOOLS_PREFERENCES, ID_MENUITEM_HELP_ABOUT, ID_MENUITEM_HELP_HELP
}
 GUI control and event IDs. More...

Protected Member Functions

virtual void doApplicationAbout (wxCommandEvent &event)
 launches an inane dialogue with the appname/description on it.
virtual void doApplicationCfg (wxCommandEvent &event)
 Launches a dialog for the user to define application-wide preferences.
virtual void doApplicationHelp (wxCommandEvent &event)
 Currently undefined; a dialog is launched serving as a placeholder for the eventual help system 9whatever form that takes).
virtual void doApplicationQuit (wxCommandEvent &event)
 shuts down the application according to wxApp semantics.
virtual void doSerialCfg (wxCommandEvent &event)
 Launches a dialog for the user to define serial connection preferences.
virtual void doSerialConnect (wxCommandEvent &event)
 Initiates a serial connection to the CPR mannequin.
virtual void doSerialQuit (wxCommandEvent &event)
 disconnects the current serial connection

Protected Attributes

wxTextCtrl * m_text_example
wxStatusBar * m_status_main
wxMenuBar * m_menubar_main
wxMenu * m_menu_file
wxMenu * m_menuitem_file_serial
wxMenu * m_menu_tools
wxMenu * m_menu_help


Detailed Description

extends wxFrame and serves as our primary (and only) window for this application. Note that this is AUI managed.


Member Enumeration Documentation

anonymous enum [protected]

GUI control and event IDs.

Enumerator:
ID_FRAME_MAIN  the MainFrame window
ID_TEXT_EXAMPLE  the textctrl widget used in the example pane
ID_STATUSBAR_MAIN  the main window status bar
ID_MENUBAR_MAIN  the main window menu object
ID_MENUITEM_FILE_SERIAL_CONNECT  the main menu element: file->serial->connect (sub-menu element), for opening a serial connection
ID_MENUITEM_FILE_SERIAL_DISCONNECT  the main menu element: file->serial->disconnect (sub-menu element), for closing an open serial connection
ID_MENUITEM_FILE_QUIT  the main menu element: file->quit, for closing the application
ID_MENUITEM_TOOLS_SERIAL  the main menu element: tools->serial, for launching a serial config dialog
ID_MENUITEM_TOOLS_PREFERENCES  the main menu element: tools->prefrences, for launching an app-wide config dialog
ID_MENUITEM_HELP_ABOUT  the main menu element: help->about, for launching an about dialog
ID_MENUITEM_HELP_HELP  the main menu element: help->help, for launching a help system (TBD)


Constructor & Destructor Documentation

cornelluniversity::vetcpr::MainFrame::MainFrame ( wxWindow *  parent,
wxWindowID  id = ID_FRAME_MAIN,
const wxString &  title = _("VetSim: CPR"),
const wxPoint &  pos = wxDefaultPosition,
const wxSize &  size = wxSize(776, 497),
long  style = wxCAPTION|wxCLOSE_BOX|wxDEFAULT_FRAME_STYLE|wxMAXIMIZE_BOX|wxMINIMIZE_BOX|wxSYSTEM_MENU|wxTAB_TRAVERSAL,
const wxString &  name = wxT("FRAME_MAIN") 
)

cornelluniversity::vetcpr::MainFrame::~MainFrame (  ) 


Member Function Documentation

virtual void cornelluniversity::vetcpr::MainFrame::doApplicationAbout ( wxCommandEvent &  event  )  [protected, virtual]

launches an inane dialogue with the appname/description on it.

Parameters:
event - refrence to the wxCommandEvent being processed

virtual void cornelluniversity::vetcpr::MainFrame::doApplicationCfg ( wxCommandEvent &  event  )  [protected, virtual]

Launches a dialog for the user to define application-wide preferences.

Parameters:
event - refrence to the wxCommandEvent being processed

virtual void cornelluniversity::vetcpr::MainFrame::doApplicationHelp ( wxCommandEvent &  event  )  [protected, virtual]

Currently undefined; a dialog is launched serving as a placeholder for the eventual help system 9whatever form that takes).

Parameters:
event - refrence to the wxCommandEvent being processed

virtual void cornelluniversity::vetcpr::MainFrame::doApplicationQuit ( wxCommandEvent &  event  )  [protected, virtual]

shuts down the application according to wxApp semantics.

Parameters:
event - refrence to the wxCommandEvent being processed

virtual void cornelluniversity::vetcpr::MainFrame::doSerialCfg ( wxCommandEvent &  event  )  [protected, virtual]

Launches a dialog for the user to define serial connection preferences.

Parameters:
event - refrence to the wxCommandEvent being processed

virtual void cornelluniversity::vetcpr::MainFrame::doSerialConnect ( wxCommandEvent &  event  )  [protected, virtual]

Initiates a serial connection to the CPR mannequin.

Parameters:
event - refrence to the wxCommandEvent being processed

virtual void cornelluniversity::vetcpr::MainFrame::doSerialQuit ( wxCommandEvent &  event  )  [protected, virtual]

disconnects the current serial connection

Parameters:
event - refrence to the wxCommandEvent being processed


Member Data Documentation

wxMenu* cornelluniversity::vetcpr::MainFrame::m_menu_file [protected]

pointer to the main window menu File element

wxMenu* cornelluniversity::vetcpr::MainFrame::m_menu_help [protected]

pointer to the main window menu Help element

wxMenu* cornelluniversity::vetcpr::MainFrame::m_menu_tools [protected]

pointer to the main window menu Tools element

wxMenuBar* cornelluniversity::vetcpr::MainFrame::m_menubar_main [protected]

pointer to the main window menu widget

wxMenu* cornelluniversity::vetcpr::MainFrame::m_menuitem_file_serial [protected]

pointer to the main window menu File element serial sub-menu

wxAuiManager cornelluniversity::vetcpr::MainFrame::m_mgr

wxStatusBar* cornelluniversity::vetcpr::MainFrame::m_status_main [protected]

pointer to the status bar widget

wxTextCtrl* cornelluniversity::vetcpr::MainFrame::m_text_example [protected]

pointer to the wxTextCtrl used in the example pane


The documentation for this class was generated from the following file:
Generated on Wed Nov 14 12:01:02 2012 for VetSim Applications by  doxygen 1.4.7