wxStfParentFrame Class Reference

Provides the top-level frame. More...

#include <parentframe.h>

Inheritance diagram for wxStfParentFrame:

Collaboration diagram for wxStfParentFrame:

List of all members.

Public Member Functions
	wxStfParentFrame (wxDocManager *manager, wxFrame *frame, const wxString &title, const wxPoint &pos, const wxSize &size, long style)
	Constructor.
	~wxStfParentFrame ()
	Destructor.
void	OnAbout (wxCommandEvent &event)
	Shows the "About" dialog.
wxStfGraph *	CreateGraph (wxView *view, wxStfChildFrame *parent)
	Creates a new graph.
stf::cursor_type	GetMouseQual () const
	Retrieve the current mouse mode.
void	SetMouseQual (stf::cursor_type value)
	Sets the current mouse cursor mode.
void	SetSelectedButton (bool selected)
	Sets status of the toolbar's selection button.
stf::zoom_channels	GetZoomQual () const
	Retrieve which channels will be affected by scaling operations.
void	SetZoomQual (stf::zoom_channels value)
	Set the channels that will be affected by scaling operations.
void	SetSingleChannel (bool value)
	Set the zoom buttons to single- or multi-channel mode.
wxPrintData *	GetPrintData ()
	Retrieves the print data.
wxPageSetupDialogData *	GetPageSetup ()
	Retrieves the page setup.
wxAuiManager &	GetMgr ()
	Retrieve the wxAuiManager.
void	CheckUpdate (wxProgressDialog *progDlg=NULL) const
	Checks for updates.
new_wxwindow	MakePythonWindow (const std::string &windowFunc, const std::string &mgr_name="pythonShell", const std::string &caption="Python Shell", bool show=true, bool full=false, bool isfloat=true, int width=-1, int height=-1, double mpl_width=8.0, double mpl_height=6.0)
int	GetMplFigNo ()

---

Detailed Description

Provides the top-level frame.

It is part of the of the document/view framework implemented in wxWidgets. This class can only be used for MDI parent frames.

Definition at line 79 of file parentframe.h.

---

Constructor & Destructor Documentation

wxStfParentFrame::wxStfParentFrame	(	wxDocManager *	manager,
		wxFrame *	frame,
		const wxString &	title,
		const wxPoint &	pos,
		const wxSize &	size,
		long	style
	)

Constructor.

Parameters:

manager	Pointer to the document manager.
frame	Pointer to the parent frame (should be NULL, because this is the top-level frame
title	Title of this frame.
pos	Initial position of this frame.
size	Initial size of this frame.
style	Window style.

---

Member Function Documentation

void wxStfParentFrame::CheckUpdate

(

wxProgressDialog *

progDlg = NULL

)

const

Checks for updates.

Parameters:

progDlg

An optional progress dialog

wxStfGraph* wxStfParentFrame::CreateGraph	(	wxView *	view,
		wxStfChildFrame *	parent
	)

Creates a new graph.

Called from view.cpp when a new drawing view is created.

Parameters:

view	Pointer to the attached view.
parent	Pointer to the child frame that will serve as a parent for the new graph.

Returns:

A pointer to the newly created graph.

wxAuiManager& wxStfParentFrame::GetMgr

(

)

[inline]

Retrieve the wxAuiManager.

Returns:

A reference to the wxAuiManager.

Definition at line 153 of file parentframe.h.

stf::cursor_type wxStfParentFrame::GetMouseQual

(

)

const

Retrieve the current mouse mode.

Returns:

The current mouse cursor mode.

wxPageSetupDialogData* wxStfParentFrame::GetPageSetup

(

)

[inline]

Retrieves the page setup.

Returns:

Pointer to the page setup data.

Definition at line 148 of file parentframe.h.

wxPrintData* wxStfParentFrame::GetPrintData

(

)

[inline]

Retrieves the print data.

Returns:

Pointer to the stored print data.

Definition at line 143 of file parentframe.h.

stf::zoom_channels wxStfParentFrame::GetZoomQual

(

)

const

Retrieve which channels will be affected by scaling operations.

Returns:

The channels affected by scaling operations.

void wxStfParentFrame::OnAbout

(

wxCommandEvent &

event

)

Shows the "About" dialog.

Parameters:

event

The menu event that made the call.

void wxStfParentFrame::SetMouseQual

(

stf::cursor_type

value

)

Sets the current mouse cursor mode.

Parameters:

value

The new mouse cursor mode.

void wxStfParentFrame::SetSelectedButton

(

bool

selected

)

Sets status of the toolbar's selection button.

Parameters:

selected

The desired toggle status of the selection button.

void wxStfParentFrame::SetSingleChannel

(

bool

value

)

Set the zoom buttons to single- or multi-channel mode.

Parameters:

value

Set to true for single- or false for multi-channel mode.

void wxStfParentFrame::SetZoomQual

(

stf::zoom_channels

value

)

Set the channels that will be affected by scaling operations.

Parameters:

value

The channels affected by scaling operations.

---

The documentation for this class was generated from the following file:

• /git/stimfit/src/stimfit/gui/parentframe.h