mpInfoLegend Class Reference

---

Detailed Description

Implements the legend to be added to the plot This layer allows you to add a legend to describe the plots in the window.

The legend uses the layer name as a label, and displays only layers of type mpLAYER_PLOT.

Definition at line 444 of file mathplot.h.

#include <mrpt/otherlibs/mathplot/mathplot.h>

Inheritance diagram for mpInfoLegend:

List of all members.

Public Member Functions
	mpInfoLegend ()
	Default constructor.
	mpInfoLegend (wxRect rect, const wxBrush *brush=wxTRANSPARENT_BRUSH)
	Complete constructor, setting initial rectangle and background brush.
	~mpInfoLegend ()
	Default destructor.
virtual void	UpdateInfo (mpWindow &w, wxEvent &event)
	Updates the content of the info box.
virtual void	Plot (wxDC &dc, mpWindow &w)
	Plot method.

---

Constructor & Destructor Documentation

mpInfoLegend::mpInfoLegend

(

)

Default constructor.

mpInfoLegend::mpInfoLegend	(	wxRect	rect,
		const wxBrush *	brush = wxTRANSPARENT_BRUSH
	)

Complete constructor, setting initial rectangle and background brush.

Parameters:

rect	The initial bounding rectangle.
brush	The wxBrush to be used for box background: default is transparent

See also:

mpInfoLayer::mpInfoLayer

mpInfoLegend::~mpInfoLegend

(

)

Default destructor.

---

Member Function Documentation

virtual void mpInfoLegend::Plot	(	wxDC &	dc,
		mpWindow &	w
	)		[virtual]

Plot method.

Parameters:

dc	the device content where to plot
w	the window to plot

See also:

mpLayer::Plot

Reimplemented from mpInfoLayer.

virtual void mpInfoLegend::UpdateInfo	(	mpWindow &	w,
		wxEvent &	event
	)		[virtual]

Updates the content of the info box.

Unused in this class.

Parameters:

w	parent mpWindow from which to obtain information
event	The event which called the update.

Reimplemented from mpInfoLayer.