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

#include <childframe.h>

Inheritance diagram for wxStfChildFrame:

Collaboration diagram for wxStfChildFrame:

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.
wxStfGrid *	GetCopyGrid ()
	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:

doc	Pointer to the attached document.
view	Pointer to the attached view.
parent	Pointer to the parent frame.
id	Window id.
title	Window title string.
pos	Initial window position.
size	Initial window size.
style	Window style.
name	Name of this frame.

Member Function Documentation

void wxStfChildFrame::CreateComboChannels ( const wxArrayString & channelNames )

Creates the channel selection combo boxes.

Parameters:

channelNames The channel names for the combo box drop-down list.

void wxStfChildFrame::CreateMenuTraces ( std::size_t value )

Creates the trace selection menu.

Parameters:

value The number of traces.

wxStfGrid* wxStfChildFrame::GetCopyGrid ( ) [inline]

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:

act	Index of the active channel.
inact	Index 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:

value The 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.

bool wxStfChildFrame::ShowSecond ( )

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:

table	The table to be added.
caption	The title of the new table in the notebook.

void wxStfChildFrame::UpdateResults ( )

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:

/git/stimfit/src/stimfit/gui/childframe.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation