Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Class Members | File Members

ChildBase Class Reference

The base class for all modules. More...

#include <ChildBase.h>

Inheritance diagram for ChildBase:

ExternalInterface MyChild TABIviewer TAlignment TAminoAcids TCalculator TCloningAssistant TGraph TImageDisplay TPhyloTree TPrimerDesign TVirtualGel List of all members.

Public Member Functions

 ChildBase ()
 Default constructor.
 ChildBase (wxWindow *parent, const wxString &title, const wxPoint &pos, const wxSize &size, const long style)
 Constructor.
 ChildBase (wxWindow *parent, const wxString &title)
 Constructor.
virtual wxString getName ()
 Returns the name of the module (e.g., the vector name).
virtual void showName (wxString x=_T(""))
 Shows the module name in the window title.
virtual void OnFocus (wxFocusEvent &event)
 Event handler for focus event.
virtual bool caniclose (wxCloseEvent &event)
 Checks for unsaved edits.
virtual void OnFileSave (wxCommandEvent &WXUNUSED(event))
virtual wxToolBar * CreateToolBar (int i)
 Tool bar creation.
virtual void Maximize (bool isit=true)
 Maximize the window.
virtual void updateUndoMenu ()
 Updates the "undo" menu entry.
virtual void updateSequenceCanvas (bool remember=false)
 Refresh the sequence display.
virtual void OnClose (wxCloseEvent &event)
 Close event handler.
virtual void OnDummy (wxCommandEvent &WXUNUSED(event))
virtual void OnPaste (wxCommandEvent &WXUNUSED(event))
 Dummy event handler.
virtual void OnExport (wxCommandEvent &WXUNUSED(event))
 Export command event handler.
virtual void EnforceRefesh ()
virtual void init ()
 Initializes pointers and toolbar options.
virtual void initHelp ()
 Initializes help link for online help.
virtual wxToolBar * CreateToolBar (int i, int j, wxString s)
 Generates the tool bar.
virtual void SetMenuBar (wxMenuBar *menu_bar)
 Sets the menu bar for the window.
virtual wxMenuBar * GetMenuBar ()
 Returns a pointer to the menu bar.
virtual wxToolBar * GetToolBar ()
 Returns a pointer to the tool bar.
virtual void Activate ()
 Activates the module (in foreground etc.).
virtual void SetIcon (wxIcon icon)
 Sets the module icon (unused).
virtual void SetMyMenuBar ()
 Sets the menu bar (used for mac version primarily).

Public Attributes

wxString def
 The class name, as a wxString.
TVectorvec
 Pointer to the base vector (may be NULL, depending on the module).
wxTreeItemId inMainTree
 The ID of this module in the main tree.
SequenceCanvascSequence
 Pointer to the sequence display (may be NULL, depending on the module).
bool allow_cut
bool allow_copy
bool allow_paste
bool allow_find
bool allow_save
bool allow_print
bool allow_undo

Protected Member Functions

virtual wxString getExportFilters ()
virtual void doExport (wxString filename, int filter)
 Export data, depending on filename and export type.
virtual void exportVector (TVector *vec, wxFile &out, int filter, wxString filename=_T(""))
 Exports a TVector.
virtual void arrangedExport (wxFile &out, wxString n, wxString s, int l)
virtual void updateToolbar ()
 Sets the tool bar.

Protected Attributes

wxMenuBar * menubar
 Pointer to the window menu bar.
wxToolBar * toolbar
 Pointer to the window too bar.

Friends

class MyFrame

Detailed Description

The base class for all modules.


Constructor & Destructor Documentation

ChildBase::ChildBase  ) 
 

Default constructor.

ChildBase::ChildBase wxWindow *  parent,
const wxString &  title,
const wxPoint &  pos,
const wxSize &  size,
const long  style
 

Constructor.

ChildBase::ChildBase wxWindow *  parent,
const wxString &  title
 

Constructor.


Member Function Documentation

void ChildBase::Activate  )  [virtual]
 

Activates the module (in foreground etc.).

void ChildBase::arrangedExport wxFile &  out,
wxString  n,
wxString  s,
int  l
[protected, virtual]
 

bool ChildBase::caniclose wxCloseEvent &  event  )  [virtual]
 

Checks for unsaved edits.

wxToolBar * ChildBase::CreateToolBar int  i,
int  j,
wxString  s
[virtual]
 

Generates the tool bar.

wxToolBar * ChildBase::CreateToolBar int  i  )  [virtual]
 

Tool bar creation.

void ChildBase::doExport wxString  filename,
int  filter
[protected, virtual]
 

Export data, depending on filename and export type.

Reimplemented in TAlignment.

virtual void ChildBase::EnforceRefesh  )  [inline, virtual]
 

Reimplemented in TCloningAssistant, and MyChild.

void ChildBase::exportVector TVector vec,
wxFile &  out,
int  filter,
wxString  filename = _T("")
[protected, virtual]
 

Exports a TVector.

wxString ChildBase::getExportFilters  )  [protected, virtual]
 

Reimplemented in TAlignment.

wxMenuBar * ChildBase::GetMenuBar  )  [virtual]
 

Returns a pointer to the menu bar.

virtual wxString ChildBase::getName  )  [inline, virtual]
 

Returns the name of the module (e.g., the vector name).

Reimplemented in TABIviewer, TAlignment, TAminoAcids, TCloningAssistant, ExternalInterface, MyChild, TPrimerDesign, TCalculator, TGraph, TImageDisplay, TPhyloTree, and TVirtualGel.

wxToolBar * ChildBase::GetToolBar  )  [virtual]
 

Returns a pointer to the tool bar.

void ChildBase::init  )  [virtual]
 

Initializes pointers and toolbar options.

void ChildBase::initHelp  )  [virtual]
 

Initializes help link for online help.

void ChildBase::Maximize bool  isit = true  )  [virtual]
 

Maximize the window.

void ChildBase::OnClose wxCloseEvent &  event  )  [virtual]
 

Close event handler.

virtual void ChildBase::OnDummy wxCommandEvent &  WXUNUSED(event)  )  [inline, virtual]
 

Reimplemented in TABIviewer, TAminoAcids, MyChild, TPrimerDesign, TCalculator, and TGraph.

virtual void ChildBase::OnExport wxCommandEvent &  WXUNUSED(event)  )  [virtual]
 

Export command event handler.

virtual void ChildBase::OnFileSave wxCommandEvent &  WXUNUSED(event)  )  [inline, virtual]
 

Reimplemented in TAminoAcids, and MyChild.

void ChildBase::OnFocus wxFocusEvent &  event  )  [virtual]
 

Event handler for focus event.

virtual void ChildBase::OnPaste wxCommandEvent &  WXUNUSED(event)  )  [inline, virtual]
 

Dummy event handler.

Reimplemented in TPrimerDesign.

void ChildBase::SetIcon wxIcon  icon  )  [virtual]
 

Sets the module icon (unused).

void ChildBase::SetMenuBar wxMenuBar *  menu_bar  )  [virtual]
 

Sets the menu bar for the window.

void ChildBase::SetMyMenuBar  )  [virtual]
 

Sets the menu bar (used for mac version primarily).

void ChildBase::showName wxString  x = _T("")  )  [virtual]
 

Shows the module name in the window title.

void ChildBase::updateSequenceCanvas bool  remember = false  )  [virtual]
 

Refresh the sequence display.

Reimplemented in MyChild.

void ChildBase::updateToolbar  )  [protected, virtual]
 

Sets the tool bar.

Reimplemented in TAminoAcids, and MyChild.

void ChildBase::updateUndoMenu  )  [virtual]
 

Updates the "undo" menu entry.

Reimplemented in TAminoAcids, and MyChild.


Friends And Related Function Documentation

friend class MyFrame [friend]
 

Reimplemented in TABIviewer.


Member Data Documentation

bool ChildBase::allow_copy
 

bool ChildBase::allow_cut
 

bool ChildBase::allow_find
 

bool ChildBase::allow_paste
 

bool ChildBase::allow_print
 

bool ChildBase::allow_save
 

bool ChildBase::allow_undo
 

SequenceCanvas* ChildBase::cSequence
 

Pointer to the sequence display (may be NULL, depending on the module).

wxString ChildBase::def
 

The class name, as a wxString.

wxTreeItemId ChildBase::inMainTree
 

The ID of this module in the main tree.

wxMenuBar* ChildBase::menubar [protected]
 

Pointer to the window menu bar.

wxToolBar* ChildBase::toolbar [protected]
 

Pointer to the window too bar.

TVector* ChildBase::vec
 

Pointer to the base vector (may be NULL, depending on the module).


The documentation for this class was generated from the following files:
Generated on Fri Aug 11 16:19:44 2006 for GENtle by  doxygen 1.4.1