LabelAxis Class Reference

#include <labelaxis.h>

Inheritance diagram for LabelAxis:

Inheritance graph
[legend]
Collaboration diagram for LabelAxis:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 LabelAxis (AXIS_LOCATION location)
void SetTitle (const wxString &title)
const wxString & GetTitle ()
void SetTitleLocation (int location)
int GetTitleLocation ()
void SetTitleFont (wxFont &font)
const wxFont & GetTitleFont ()
void SetTitleColour (wxColour &colour)
wxColour GetTitleColour ()
void SetLabelPen (wxPen labelPen)
void SetLabelTextColour (wxColour labelTextColour)
wxColour GetLabelTextColour ()
void SetLabelTextFont (wxFont labelTextFont)
const wxFont & GetLabelTextFont ()
void SetVerticalLabelText (bool verticalLabelText)
bool GetVerticalLabelText ()
virtual void Draw (wxDC &dc, wxRect rc)
virtual void DrawGridLines (wxDC &dc, wxRect rc)
virtual wxCoord GetExtent (wxDC &dc)

Protected Member Functions

virtual double GetValue (size_t step)=0
virtual void GetLabel (size_t step, wxString &label)=0
virtual bool IsEnd (size_t step)=0
virtual wxSize GetLongestLabelExtent (wxDC &dc)=0
virtual bool HasLabels ()


Detailed Description

Base class for axes for displaying data labels.

Member Function Documentation

virtual void LabelAxis::Draw ( wxDC &  dc,
wxRect  rc 
) [virtual]

Performs axis drawing.

Parameters:
dc device context
rc rectangle where to draw

Implements Axis.

virtual void LabelAxis::DrawGridLines ( wxDC &  dc,
wxRect  rcData 
) [virtual]

Draws grid lines for axis.

Parameters:
dc device context
rc data area rectangle of plot

Implements Axis.

virtual wxCoord LabelAxis::GetExtent ( wxDC &  dc  )  [virtual]

Used to determine minimal size needed to draw axis contents, minimal width for vertical axes, minimal height for horizontal.

Parameters:
dc device context
Returns:
extent

Implements Axis.

virtual void LabelAxis::GetLabel ( size_t  step,
wxString &  label 
) [protected, pure virtual]

Returns label on step.

Parameters:
step step index
label output label

Implemented in CategoryAxis, DateAxis, LogarithmicNumberAxis, and NumberAxis.

wxColour LabelAxis::GetLabelTextColour (  )  [inline]

Returns label colour.

Returns:
label colour

const wxFont& LabelAxis::GetLabelTextFont (  )  [inline]

Returns label font.

Returns:
label font

const wxString& LabelAxis::GetTitle (  )  [inline]

Returns axis title.

Returns:
axis title

wxColour LabelAxis::GetTitleColour (  )  [inline]

Returns axis title colour.

Returns:
axis title colour

const wxFont& LabelAxis::GetTitleFont (  )  [inline]

Returns axis title font.

Returns:
axis title font

int LabelAxis::GetTitleLocation (  )  [inline]

Returns axis title location.

Returns:
axis title location

virtual double LabelAxis::GetValue ( size_t  step  )  [protected, pure virtual]

Returns value on step.

Parameters:
step step index
Returns:
value on step

Implemented in CategoryAxis, DateAxis, LogarithmicNumberAxis, and NumberAxis.

bool LabelAxis::GetVerticalLabelText (  )  [inline]

Returns whether to draw labels text vertical.

Returns:
true if labels text will be drawn vertical

virtual bool LabelAxis::IsEnd ( size_t  step  )  [protected, pure virtual]

Check whether step is last.

Parameters:
step step
Returns:
true if step is last

Implemented in CategoryAxis, DateAxis, and NumberAxis.

void LabelAxis::SetLabelPen ( wxPen  labelPen  )  [inline]

Sets pen for label lines.

Parameters:
labelPen pen for label lines

void LabelAxis::SetLabelTextColour ( wxColour  labelTextColour  )  [inline]

Sets colour for labels.

Parameters:
labelColour color for labels

void LabelAxis::SetLabelTextFont ( wxFont  labelTextFont  )  [inline]

Sets font for labels text.

Parameters:
labelFont font for labels text

void LabelAxis::SetTitle ( const wxString &  title  )  [inline]

Sets axis title.

Parameters:
new axis title

void LabelAxis::SetTitleColour ( wxColour &  colour  )  [inline]

Sets axis title colour.

Parameters:
new axis title colour

void LabelAxis::SetTitleFont ( wxFont &  font  )  [inline]

Sets axis title font.

Parameters:
axis title font

void LabelAxis::SetTitleLocation ( int  location  )  [inline]

Sets axis title location.

Parameters:
location new location for axis title, acceptable values wxLEFT, wxCENTER, wxRIGHT for horizontal axes, wxTOP, wxCENTER, wxBOTTOM for vertical axes.

void LabelAxis::SetVerticalLabelText ( bool  verticalLabelText  )  [inline]

Sets whether to draw labels text vertical.

Parameters:
verticalLabelText true to draw labels text vertical


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

Generated on Mon Feb 15 21:32:26 2010 for wxFreeChart by  doxygen 1.5.8