mpScaleX Class Reference

#include <mathplot.h>

Inheritance diagram for mpScaleX:

Public Member Functions
	mpScaleX (wxString name=wxT("X"), int flags=mpALIGN_CENTER, bool ticks=true, unsigned int type=mpX_NORMAL)
virtual void	Plot (wxDC &dc, mpWindow &w)
virtual bool	HasBBox ()
void	SetAlign (int align)
void	SetTicks (bool ticks)
bool	GetTicks ()
unsigned int	GetLabelMode ()
void	SetLabelMode (unsigned int mode)
void	SetLabelFormat (const wxString &format)
const wxString &	SetLabelFormat ()
Protected Attributes
int	m_flags
	Flag for axis alignment.
bool	m_ticks
	Flag to toggle between ticks or grid.
unsigned int	m_labelType
	Select labels mode: mpX_NORMAL for normal labels, mpX_TIME for time axis in hours, minutes, seconds.
wxString	m_labelFormat
	Format string used to print labels.

Detailed Description

Plot layer implementing a x-scale ruler. The ruler is fixed at Y=0 in the coordinate system. A label is plotted at the bottom-right hand of the ruler. The scale numbering automatically adjusts to view and zoom factor.

Constructor & Destructor Documentation

mpScaleX::mpScaleX	(	wxString	name = `wxT("X")`,
		int	flags = `mpALIGN_CENTER`,
		bool	ticks = `true`,
		unsigned int	type = `mpX_NORMAL`
	)

Full constructor.

Parameters:

	name	Label to plot by the ruler
	flags	Set the position of the scale with respect to the window.
	ticks	Select ticks or grid. Give TRUE (default) for drawing axis ticks, FALSE for drawing the grid.
	type	mpX_NORMAL for normal labels, mpX_TIME for time axis in hours, minutes, seconds.

References mpLAYER_AXIS.

Member Function Documentation

unsigned int mpScaleX::GetLabelMode ( ) [inline]

Get X axis label view mode.

Returns:: mpX_NORMAL for normal labels, mpX_TIME for time axis in hours, minutes, seconds.

bool mpScaleX::GetTicks ( ) [inline]

Get X axis ticks or grid

Returns:: TRUE if plot is drawing axis ticks, FALSE if the grid is active.

virtual bool mpScaleX::HasBBox ( ) [inline, virtual]

Check whether this layer has a bounding box. This implementation returns FALSE thus making the ruler invisible to the plot layer bounding box calculation by mpWindow.

Reimplemented from mpLayer.

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

Layer plot handler. This implementation will plot the ruler adjusted to the visible area.

Implements mpLayer.

References mpWindow::GetMarginBottom(), mpWindow::GetMarginLeft(), mpWindow::GetMarginRight(), mpWindow::GetMarginTop(), mpWindow::GetPosX(), mpWindow::GetScaleX(), mpWindow::GetScrX(), mpWindow::GetScrY(), mpLayer::m_drawOutsideMargins, m_flags, mpLayer::m_font, m_labelFormat, m_labelType, mpLayer::m_name, mpLayer::m_pen, m_ticks, mpLayer::m_visible, mpALIGN_BORDER_BOTTOM, mpALIGN_BORDER_TOP, mpALIGN_BOTTOM, mpALIGN_CENTER, mpALIGN_TOP, mpLN10, mpMIN_X_AXIS_LABEL_SEPARATION, mpX_DATE, mpX_DATETIME, mpX_HOURS, mpX_NORMAL, mpX_TIME, X_BORDER_SEPARATION, and mpWindow::y2p().

void mpScaleX::SetAlign ( int align ) [inline]

Set X axis alignment.

Parameters:

align

alignment (choose between mpALIGN_BORDER_BOTTOM, mpALIGN_BOTTOM, mpALIGN_CENTER, mpALIGN_TOP, mpALIGN_BORDER_TOP

const wxString& mpScaleX::SetLabelFormat ( ) [inline]

Get X axis Label format (used for mpX_NORMAL draw mode).

Returns:: The format string

void mpScaleX::SetLabelFormat ( const wxString & format ) [inline]

Set X axis Label format (used for mpX_NORMAL draw mode).

Parameters:

format

The format string

void mpScaleX::SetLabelMode ( unsigned int mode ) [inline]

Set X axis label view mode.

Parameters:

mode

mpX_NORMAL for normal labels, mpX_TIME for time axis in hours, minutes, seconds.

void mpScaleX::SetTicks ( bool ticks ) [inline]

Set X axis ticks or grid

Parameters:

ticks

TRUE to plot axis ticks, FALSE to plot grid.

Member Data Documentation

int mpScaleX::m_flags [protected]

Flag for axis alignment.

Referenced by Plot().

wxString mpScaleX::m_labelFormat [protected]

Format string used to print labels.

Referenced by Plot().

unsigned int mpScaleX::m_labelType [protected]

Select labels mode: mpX_NORMAL for normal labels, mpX_TIME for time axis in hours, minutes, seconds.

Referenced by Plot().

bool mpScaleX::m_ticks [protected]

Flag to toggle between ticks or grid.

Referenced by Plot().

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

mpScaleX Class Reference

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation