mpText Class Reference

Plot layer implementing a text string. More...

#include <mathplot.h>

Inheritance diagram for mpText:

Collaboration diagram for mpText:

Public Member Functions
	mpText (const wxString &name=wxEmptyString)
	Default constructor.
	mpText (const wxString &name, int offsetx, int offsety)
	mpText (const wxString &name, mpLocation marginLocation)
virtual bool	HasBBox ()
	Text Layer has not bounding box.
void	SetLocation (mpLocation location)
	Set the location of the box.
mpLocation	GetLocation () const
	Returns the location of the box.
void	SetOffset (int offX, int offY)
	Set offset.
void	GetOffset (int *offX, int *offY) const
	Get the offset.
Public Member Functions inherited from mpLayer
	mpLayer (mpLayerType layerType)
	The base class of all layer objects.
void	SetWindow (mpWindow &w)
	Set the wxWindow handle.
mpLayerType	GetLayerType () const
	Get layer type: a Layer can be of different types: plot, lines, axis, info boxes, etc.
int	GetLayerSubType () const
	Get layer subtype: each layer type can have several flavors.
virtual bool	IsLayerType (mpLayerType typeOfInterest, int *subtype)
	Set the layer's subtype in caller variable, and return true if the layer is of type "typeOfInterest".
virtual double	GetMinX ()
	Get inclusive left border of bounding box.
virtual double	GetMaxX ()
	Get inclusive right border of bounding box.
virtual double	GetMinY ()
	Get inclusive bottom border of bounding box.
virtual double	GetMaxY ()
	Get inclusive top border of bounding box.
void	Plot (wxDC &dc, mpWindow &w)
	Plot given view of layer to the given device context.
void	SetName (const wxString &name)
	Set layer name.
const wxString &	GetName () const
	Get layer name.
void	SetFont (const wxFont &font)
	Set layer font.
const wxFont &	GetFont () const
	Get font set for this layer.
void	SetFontColour (const wxColour &colour)
	Set layer font foreground colour.
const wxColour &	GetFontColour () const
	Get font foreground colour set for this layer.
void	SetPen (const wxPen &pen)
	Set layer pen.
const wxPen &	GetPen () const
	Get pen set for this layer.
void	SetBrush (const wxBrush &brush)
	Set layer brush.
void	SetBrush (const wxColour &colour, enum wxBrushStyle style=wxBRUSHSTYLE_SOLID)
	Set layer brush.
const wxBrush &	GetBrush () const
	Get brush set for this layer.
void	SetShowName (bool show)
	Set Name visibility.
bool	GetShowName () const
	Get Name visibility.
void	SetDrawOutsideMargins (bool drawModeOutside)
	Set Draw mode: inside or outside margins.
bool	GetDrawOutsideMargins () const
	Get Draw mode: inside or outside margins.
wxBitmap	GetColourSquare (int side=16)
	Get a small square bitmap filled with the colour of the pen used in the layer.
bool	IsVisible () const
	Is this layer visible?
virtual void	SetVisible (bool show)
	Sets layer visibility.
bool	IsTractable () const
	Checks whether the layer is tractable or not.
virtual void	SetTractable (bool track)
	Sets layer tractability.
void	SetAlign (int align)
	Set X/Y alignment.
int	GetAlign () const
	Get X/Y alignment.
void	SetCanDelete (bool canDelete)
	Set what we do with the object associated with the layer when we delete the layer.
bool	GetCanDelete (void) const
	Retreive what we do with the object associated with the layer when we delete the layer.
mpLayerZOrder	GetZIndex (void) const
	Get the ZIndex of the plot.

Protected Member Functions
virtual void	DoPlot (wxDC &dc, mpWindow &w)
	Text Layer plot handler.
Protected Member Functions inherited from mpLayer
void	UpdateContext (wxDC &dc) const
	Initialize the context.
virtual bool	DoBeforePlot ()
	If we need to do something before plot like reinitialize some parameters ... Return true by default that mean that we can continue next operation.
void	CheckLog (double *x, double *y, int yAxisID)
	Test if we are in log axis and if true return the log of the values.

Protected Attributes
int	m_offsetx
	Holds offset for X in percentage.
int	m_offsety
	Holds offset for Y in percentage.
mpLocation	m_location
	The location of the text.
Protected Attributes inherited from mpLayer
const mpLayerType	m_type
	Layer type mpLAYER_*.
mpWindow *	m_win
	The wxWindow handle.
int	m_subtype
	Layer sub type, set in constructors.
wxFont	m_font
	Layer's font.
wxColour	m_fontcolour
	Layer's font foreground colour.
wxPen	m_pen
	Layer's pen. Default Colour = Black, width = 1, style = wxPENSTYLE_SOLID.
wxBrush	m_brush
	Layer's brush. Default wxTRANSPARENT_BRUSH.
wxString	m_name
	Layer's name.
bool	m_showName
	States whether the name of the layer must be shown. Default : false.
bool	m_drawOutsideMargins
	Select if the layer should draw only inside margins or over all DC. Default : false.
bool	m_visible
	Toggles layer visibility. Default : true.
bool	m_tractable
	Is the layer tractable.
int	m_flags
	Holds label alignment. Default : mpALIGN_SW for series and mpALIGN_CENTER for scale.
mpRect	m_plotBoundaries
	The boundaries for plotting curve calculated by mpWindow.
bool	m_CanDelete
	Is the layer can be deleted.
mpLayerZOrder	m_ZIndex
	The index in Z-Order to draw the layer.

Detailed Description

Plot layer implementing a text string.

The text is plotted in two ways : first : using a percentage system 0-100%, so the actual coordinates for the location are not required, and the text stays on the plot reguardless of the other layers location and scaling factors. second : center of a margin

Constructor & Destructor Documentation

mpText() [1/2]

mpText::mpText	(	const wxString &	name,
		int	offsetx,
		int	offsety
	)

Parameters

name	text to be drawn in the plot
offsetx	holds offset for the X location in percentage (0-100)
offsety	holds offset for the Y location in percentage (0-100)

mpText() [2/2]

mpText::mpText	(	const wxString &	name,
		mpLocation	marginLocation
	)

Parameters

name	text to be displayed
marginLocation	location in the margin

Member Function Documentation

DoPlot()

virtual void mpText::DoPlot ( wxDC &  dc, mpWindow &  w  )

protectedvirtual

Text Layer plot handler.

This implementation will plot text adjusted to the visible area.

Implements mpLayer.

GetLocation()

mpLocation mpText::GetLocation ( ) const

inline

Returns the location of the box.

Returns

location

HasBBox()

virtual bool mpText::HasBBox ( )

inlinevirtual

Text Layer has not bounding box.

See also

mpLayer::HasBBox

Returns

always FALSE

Reimplemented from mpLayer.

Member Data Documentation

m_location

mpLocation mpText::m_location

protected

The location of the text.

See also

mpLocation