Stimfit  0.13.15
Public Member Functions

Provides the child frame for displaying documents on separate windows. More...

#include <childframe.h>

Inheritance diagram for wxStfChildFrame:
Inheritance graph
[legend]
Collaboration diagram for wxStfChildFrame:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 wxStfChildFrame (wxDocument *doc, wxView *view, wxStfParentType *parent, wxWindowID id, const wxString &title, const wxPoint &pos=wxPoint(48, 48), const wxSize &size=wxDefaultSize, long style=wxDEFAULT_FRAME_STYLE, const wxString &name=wxT("frame"))
 Constructor.
 ~wxStfChildFrame ()
 Destructor.
void ShowTable (const stf::Table &table, const wxString &caption)
 Adds a table to the results notebook.
std::size_t GetCurTrace () const
 Retrieves the current trace from the trace selection combo box.
void SetCurTrace (std::size_t)
 Sets the current trace from the trace selection combo box.
void CreateMenuTraces (std::size_t value)
 Creates the trace selection menu.
void CreateComboChannels (const wxArrayString &channelNames)
 Creates the channel selection combo boxes.
void SetSelected (std::size_t value)
 Refreshes the trace selection string.
void SetChannels (std::size_t act, std::size_t inact)
 Sets the channels in the combo boxes. Checks and corrects equal channels in both boxes.
void UpdateChannels ()
 Updates the channels according to the current combo boy selection.
void UpdateResults ()
 Updates the results table.
wxAuiManager * GetMgr ()
 Retrieve the wxAuiManager.
wxStfGridGetCopyGrid ()
 Retrieve the wxStfGrid that contains the results table.
void Saveperspective ()
 Write the current AUI perspective to the configuration.
void Loadperspective ()
 Load the saved AUI perspective from the configuration.
void Restoreperspective ()
 Restore the default AUI perspective.
bool ShowSelected () const
 Indicates whether all selected traces should be plotted.
bool ShowSecond ()
 Indicates whether the second channel should be plotted.
bool ShowAll () const
 Indicates whether all channels should be plotted.
void ActivateGraph ()
 Activated the current graph.
void OnActivate (wxActivateEvent &event)
virtual wxMenuBar * GetMenuBar () const
 Override default GetMenuBar.

Detailed Description

Provides the child frame for displaying documents on separate windows.

This class can only be used for MDI child frames. It is part of the document/view framework supported by wxWidgets.

Definition at line 76 of file childframe.h.


Constructor & Destructor Documentation

wxStfChildFrame::wxStfChildFrame ( wxDocument doc,
wxView view,
wxStfParentType parent,
wxWindowID  id,
const wxString title,
const wxPoint pos = wxPoint(48, 48),
const wxSize size = wxDefaultSize,
long  style = wxDEFAULT_FRAME_STYLE,
const wxString name = wxT("frame") 
)

Constructor.

Parameters:
docPointer to the attached document.
viewPointer to the attached view.
parentPointer to the parent frame.
idWindow id.
titleWindow title string.
posInitial window position.
sizeInitial window size.
styleWindow style.
nameName of this frame.

Member Function Documentation

void wxStfChildFrame::CreateComboChannels ( const wxArrayString &  channelNames)

Creates the channel selection combo boxes.

Parameters:
channelNamesThe channel names for the combo box drop-down list.
void wxStfChildFrame::CreateMenuTraces ( std::size_t  value)

Creates the trace selection menu.

Parameters:
valueThe number of traces.

Retrieve the wxStfGrid that contains the results table.

Returns:
A pointer to the grid.

Definition at line 160 of file childframe.h.

std::size_t wxStfChildFrame::GetCurTrace ( ) const

Retrieves the current trace from the trace selection combo box.

Returns:
The 0-based index of the currently selected trace.
virtual wxMenuBar* wxStfChildFrame::GetMenuBar ( ) const [inline, virtual]

Override default GetMenuBar.

Returns:
the menu bar if non-NULL; otherwise, the parent's menu bar

Definition at line 194 of file childframe.h.

wxAuiManager* wxStfChildFrame::GetMgr ( ) [inline]

Retrieve the wxAuiManager.

Returns:
A pointer to the wxAuiManager.

Definition at line 155 of file childframe.h.

void wxStfChildFrame::SetChannels ( std::size_t  act,
std::size_t  inact 
)

Sets the channels in the combo boxes. Checks and corrects equal channels in both boxes.

Parameters:
actIndex of the active channel.
inactIndex of the reference channel.
void wxStfChildFrame::SetCurTrace ( std::size_t  )

Sets the current trace from the trace selection combo box.

Returns:
The 0-based index of the trace to be selected.
void wxStfChildFrame::SetSelected ( std::size_t  value)

Refreshes the trace selection string.

Parameters:
valueThe number of selected traces.
bool wxStfChildFrame::ShowAll ( ) const [inline]

Indicates whether all channels should be plotted.

Returns:
true if they should be plotted, false otherwise.

Definition at line 184 of file childframe.h.

Indicates whether the second channel should be plotted.

Returns:
true if it should be plotted, false otherwise.
bool wxStfChildFrame::ShowSelected ( ) const [inline]

Indicates whether all selected traces should be plotted.

Returns:
true if they should be plotted, false otherwise.

Definition at line 174 of file childframe.h.

void wxStfChildFrame::ShowTable ( const stf::Table table,
const wxString caption 
)

Adds a table to the results notebook.

Parameters:
tableThe table to be added.
captionThe title of the new table in the notebook.

Updates the results table.

Called from wxStfApp::OnPeakcalcexecMsg() to update the results table. Don't call this directly; use wxStfApp::OnPeakcalcexecMsg() instead.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines