wxStfView Class Reference

The view class, derived from wxView. More...

#include <view.h>

Inheritance diagram for wxStfView:

Collaboration diagram for wxStfView:

List of all members.

Public Member Functions
	wxStfView ()
	Constructor.
	~wxStfView ()
	Destructor.
virtual bool	OnCreate (wxDocument *doc, long flags)
	Override default view creation.
virtual void	OnDraw (wxDC *dc)
	The drawing function (note that actual drawing happens in wxStfGraph::OnDraw())
virtual void	OnUpdate (wxView *sender, wxObject *hint=(wxObject *) NULL)
	Override default updating behaviour.
virtual bool	OnClose (bool deleteWindow=true)
	Override default file closing behaviour.
wxStfGraph *	GetGraph ()
	Retrieve the attached graph.
wxStfDoc *	Doc ()
	Retrieve the attached document.
wxStfDoc *	DocC () const
	Retrieve the attached document.
Protected Member Functions
virtual void	OnActivateView (bool activate, wxView *activeView, wxView *deactiveView)
	Called when the view is activated; dialogs and menus are then updated.

---

Detailed Description

The view class, derived from wxView.

It is used to model the viewing and editing component of the file-based data. It is part of the document/view framework supported by wxWidgets. Note that this class does almost nothing in stimfit. Its only purpose is to adhere to the doc/view paradigm. All of the actual drawing happens in wxStfGraph.

Definition at line 38 of file view.h.

---

Member Function Documentation

wxStfDoc* wxStfView::Doc

(

)

Retrieve the attached document.

Returns:

A pointer to the attached document.

wxStfDoc* wxStfView::DocC

(

)

const

Retrieve the attached document.

Returns:

A pointer to the attached document.

wxStfGraph* wxStfView::GetGraph

(

)

[inline]

Retrieve the attached graph.

Returns:

A pointer to the attached graph.

Definition at line 76 of file view.h.

virtual void wxStfView::OnActivateView	(	bool	activate,
		wxView *	activeView,
		wxView *	deactiveView
	)		[protected, virtual]

Called when the view is activated; dialogs and menus are then updated.

Parameters:

activate	true if this view is being activated.
activeView	Pointer to the view that is now active.
deactiveView	Pointer to the view that has just been deactivated.

virtual bool wxStfView::OnClose

(

bool

deleteWindow = true

)

[virtual]

Override default file closing behaviour.

Parameters:

deleteWindow

true if the child frame should be deleted.

Returns:

true if file closing was successful.

virtual bool wxStfView::OnCreate	(	wxDocument *	doc,
		long	flags
	)		[virtual]

Override default view creation.

Creates a child frame and a graph, sets the window title.

Parameters:

doc	Pointer to the attached document.
flags	View creation flags.

Returns:

true upon successful view creation, false otherwise.

virtual void wxStfView::OnDraw

(

wxDC *

dc

)

[virtual]

The drawing function (note that actual drawing happens in wxStfGraph::OnDraw())

Parameters:

dc	Pointer to the device context.

See also:

wxStfGraph::OnDraw()

virtual void wxStfView::OnUpdate	(	wxView *	sender,
		wxObject *	hint = (wxObject *) NULL
	)		[virtual]

Override default updating behaviour.

Called when the graph should be refreshed.

Parameters:

sender	Pointer to the view that requested the update.
hint	Unused.

---

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

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