labelaxis.h

// Name:    labelaxis.h
// Purpose:    label axis declaration
// Author:    Moskvichev Andrey V.
// Created:    2008/11/07
// Copyright:    (c) 2008-2010 Moskvichev Andrey V.
// Licence:    wxWidgets licence

#ifndef LABELAXIS_H_
#define LABELAXIS_H_

#include <wx/axis/axis.h>

class WXDLLIMPEXP_FREECHART LabelColourer
{
public:
    // IY: Virtual destructor needed otherwise behaviour is undefined.
    virtual ~LabelColourer() {}
    virtual wxColor GetColour(int step) = 0;
};

class WXDLLIMPEXP_FREECHART LabelAxis : public Axis
{
    DECLARE_CLASS(LabelAxis)
public:
    LabelAxis(AXIS_LOCATION location);
    virtual ~LabelAxis();

    void SetTitle(const wxString &title)
    {
        m_title = title;
    }

    const wxString &GetTitle()
    {
        return m_title;
    }

    void SetTitleLocation(int location)
    {
        if (m_titleLocation != location)
            m_titleLocation = location;
    }

    int GetTitleLocation()
    {
        return m_titleLocation;
    }

    void SetTitleFont(wxFont &font)
    {
        m_titleFont = font;
    }

    const wxFont &GetTitleFont()
    {
        return m_titleFont;
    }

    void SetTitleColour(wxColour &colour)
    {
        if (m_titleColour != colour) {
            m_titleColour = colour;
        }
    }

    wxColour GetTitleColour()
    {
        return m_titleColour;
    }

    void SetLabelPen(wxPen labelPen)
    {
        m_labelPen = labelPen;
    }

    void SetLabelTextColour(wxColour labelTextColour)
    {
        m_labelTextColour = labelTextColour;
    }

    wxColour GetLabelTextColour()
    {
        return m_labelTextColour;
    }

    void SetLabelTextFont(wxFont labelTextFont)
    {
        m_labelTextFont = labelTextFont;
    }

    const wxFont& GetLabelTextFont()
    {
        return m_labelTextFont;
    }

    void SetVerticalLabelText(bool verticalLabelText)
    {
        if (m_verticalLabelText != verticalLabelText)
            m_verticalLabelText = verticalLabelText;
    }

    bool GetVerticalLabelText()
    {
        return m_verticalLabelText;
    }

    wxDEPRECATED_MSG("Use SetMinorIntervalCount instead.")
    void SetMajorLabelSteps(size_t step)
    {
        if (m_majorLabelStep != step)
            m_majorLabelStep = step;
    }

    void SetMinorIntervalCount(size_t count)
    {
        m_minorIntervalCount = count;
    }

    size_t GetMinorIntervalCout()
    {
        return m_minorIntervalCount;
    }

    void SetLabelSkip(int blankLabels);

    int GetLabelSkip();

    void SetLabelColourer(LabelColourer *labelColourer)
    {
        wxREPLACE(m_labelColourer, labelColourer);
    }

    LabelColourer *GetLabelColourer()
    {
        return m_labelColourer;
    }

    void SetAxisVisible(bool bVisible);

    //
    // Axis
    //
    virtual void Draw(wxDC &dc, wxRect rc);

    virtual void DrawGridLines(wxDC &dc, wxRect rc);

    virtual wxCoord GetExtent(wxDC &dc);

protected:
    //
    // Functions that must be implemented by derivative classes
    //

    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();

private:
    void DrawLabels(wxDC &dc, wxRect rc);

    void DrawLabel(wxDC &dc, wxRect rc, const wxString &label, double value, bool isMajorLabel);

    void DrawBorderLine(wxDC &dc, wxRect rc);
    
    void DrawGridLine(wxDC& dc, const wxRect& rc, double value);

    wxCoord m_labelLineSize;
    wxCoord m_labelGap;

    // labels properties
    wxFont m_labelTextFont;
    wxColour m_labelTextColour;
    wxPen m_labelPen;
    bool m_verticalLabelText;
    size_t m_majorLabelStep;
    size_t m_minorIntervalCount;

    // label title properties
    wxString m_title;
    wxFont m_titleFont;
    wxColour m_titleColour;
    int m_titleLocation;

    bool m_visible;
    int m_blankLabels;

    LabelColourer *m_labelColourer;
};

#endif /*LABELAXIS_H_*/