wxPLplotwindow< WXWINDOW > Class Template Reference

#include "wxPLplotwindow.h"

Inheritance diagram for wxPLplotwindow< WXWINDOW >:

Public Member Functions
	wxPLplotwindow (bool useGraphicsContext=true, wxSize clientSize=wxDefaultSize)
	Constructor. More...
virtual	~wxPLplotwindow (void)
	Destructor. More...
void	RenewPlot (void)
	Redo plot. More...
bool	SavePlot (const wxString &driver, const wxString &filename)
	Save plot using a different driver. More...
wxPLplotstream *	GetStream ()
	Get pointer to wxPLplotstream of this widget. More...
void	setUseGraphicsContext (bool useGraphicsContext)
void	setCanvasColour (const wxColour &colour)
bool	IsReady ()

Protected Member Functions
virtual void	OnPaint (wxPaintEvent &event)
	Paint event. More...
virtual void	OnSize (wxSizeEvent &event)
	Size event. More...
virtual void	OnErase (wxEraseEvent &event)
	Background erase event. More...
virtual void	OnCreate (wxWindowCreateEvent &event)
	Window created event. More...
void	OnMouse (wxMouseEvent &event)
	Mouse events. More...

Protected Attributes
wxPLplotstream	m_stream
	The wxPLplotstream which belongs to this plot widget. More...
bool	m_created
	Flag to indicate the window has been Created. More...

Private Member Functions
virtual void	OnLocate (const PLGraphicsIn &graphicsIn)

Private Attributes
bool	m_useGraphicsContext
	Flag to indicate whether we should use a wxGCDC. More...
wxBitmap	m_bitmap
wxMemoryDC *	m_memoryDc
wxSize	m_initialSize
wxColour	m_canvasColour

Detailed Description

template<class WXWINDOW>
class wxPLplotwindow< WXWINDOW >

Definition at line 37 of file wxPLplotwindow.h.

Constructor & Destructor Documentation

template<class WXWINDOW >

wxPLplotwindow< WXWINDOW >::wxPLplotwindow	(	bool	useGraphicsContext = true,
		wxSize	clientSize = wxDefaultSize
	)

Constructor.

Constructor initialises variables, creates the wxStream and connects methods with events. The WXWINDOW default constructor is used.

Definition at line 82 of file wxPLplotwindow.h.

template<class WXWINDOW >

wxPLplotwindow< WXWINDOW >::~wxPLplotwindow ( void  )

virtual

Destructor.

Destructor - delete the dc and gcdc if needed.

Definition at line 114 of file wxPLplotwindow.h.

Member Function Documentation

template<class WXWINDOW >

wxPLplotstream* wxPLplotwindow< WXWINDOW >::GetStream ( )

inline

Get pointer to wxPLplotstream of this widget.

Definition at line 45 of file wxPLplotwindow.h.

template<class WXWINDOW >

bool wxPLplotwindow< WXWINDOW >::IsReady ( )

inline

Definition at line 48 of file wxPLplotwindow.h.

template<class WXWINDOW >

void wxPLplotwindow< WXWINDOW >::OnCreate ( wxWindowCreateEvent &  event )

protectedvirtual

Window created event.

This is called when the window is created, i.e., after WXWINDOW::Create has been called. We note that this has been called to avoid attempting to redraw a plot on a window that hasn't been created yet.

Definition at line 202 of file wxPLplotwindow.h.

template<class WXWINDOW >

void wxPLplotwindow< WXWINDOW >::OnErase ( wxEraseEvent &  event )

protectedvirtual

Background erase event.

This is called before each paint event

Definition at line 190 of file wxPLplotwindow.h.

template<class WXWINDOW >

virtual void wxPLplotwindow< WXWINDOW >::OnLocate ( const PLGraphicsIn &  graphicsIn )

inlineprivatevirtual

Definition at line 72 of file wxPLplotwindow.h.

template<class WXWINDOW >

void wxPLplotwindow< WXWINDOW >::OnMouse ( wxMouseEvent &  event )

protected

Mouse events.

Definition at line 242 of file wxPLplotwindow.h.

template<class WXWINDOW >

void wxPLplotwindow< WXWINDOW >::OnPaint ( wxPaintEvent &  event )

protectedvirtual

Paint event.

In the OnPaint Method we check if the Windows was resized (will be moved to OnSize() sometimes later), we also implement our own double buffering here (since the PLplot wxWidgets driver draws into a wxMemoryDC).

Definition at line 129 of file wxPLplotwindow.h.

template<class WXWINDOW >

void wxPLplotwindow< WXWINDOW >::OnSize ( wxSizeEvent &  event )

protectedvirtual

Size event.

This is called when the plot is resized

Definition at line 179 of file wxPLplotwindow.h.

template<class WXWINDOW >

void wxPLplotwindow< WXWINDOW >::RenewPlot

(

void

)

Redo plot.

Redo the whole plot, only if the window has been Created

Definition at line 316 of file wxPLplotwindow.h.

template<class WXWINDOW >

bool wxPLplotwindow< WXWINDOW >::SavePlot	(	const wxString &	devname,
		const wxString &	filename
	)

Save plot using a different driver.

Save plot.

Definition at line 329 of file wxPLplotwindow.h.

template<class WXWINDOW >

void wxPLplotwindow< WXWINDOW >::setCanvasColour

(

const wxColour &

colour

)

Definition at line 384 of file wxPLplotwindow.h.

template<class WXWINDOW >

void wxPLplotwindow< WXWINDOW >::setUseGraphicsContext

(

bool

useGraphicsContext

)

Set whether we wish to use wxGCDC instead of a wxDC.

Definition at line 363 of file wxPLplotwindow.h.

Member Data Documentation

template<class WXWINDOW >

wxBitmap wxPLplotwindow< WXWINDOW >::m_bitmap

private

Definition at line 61 of file wxPLplotwindow.h.

template<class WXWINDOW >

wxColour wxPLplotwindow< WXWINDOW >::m_canvasColour

private

Definition at line 71 of file wxPLplotwindow.h.

template<class WXWINDOW >

bool wxPLplotwindow< WXWINDOW >::m_created

protected

Flag to indicate the window has been Created.

Definition at line 57 of file wxPLplotwindow.h.

template<class WXWINDOW >

wxSize wxPLplotwindow< WXWINDOW >::m_initialSize

private

Definition at line 67 of file wxPLplotwindow.h.

template<class WXWINDOW >

wxMemoryDC* wxPLplotwindow< WXWINDOW >::m_memoryDc

private

Definition at line 66 of file wxPLplotwindow.h.

template<class WXWINDOW >

wxPLplotstream wxPLplotwindow< WXWINDOW >::m_stream

protected

The wxPLplotstream which belongs to this plot widget.

Definition at line 56 of file wxPLplotwindow.h.

template<class WXWINDOW >

bool wxPLplotwindow< WXWINDOW >::m_useGraphicsContext

private

Flag to indicate whether we should use a wxGCDC.

Definition at line 60 of file wxPLplotwindow.h.

---

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

• wxPLplotwindow.h