/home/kitware/dashboards/avogadro/libavogadro/src/plotaxis.h

/**********************************************************************
  PlotAxis -- Part of the Avogadro 2D plotting interface

  Copyright (C) 2003 Jason Harris <[email protected]> (KDE)
  Copyright (C) 2008 David Lonie <[email protected]> (Avogadro)

  This file is part of the Avogadro molecular editor project.
  For more information, see <http://avogadro.openmolecules.net/>

  This file is based on KPlotWidget from the KDE library. For more
  information see <http://www.kde.org/>

  Avogadro is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  Avogadro is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  02110-1301, USA.
 **********************************************************************/

#ifndef PLOTAXIS_H
#define PLOTAXIS_H

#include <QtCore/QString>
#include <QtCore/QList>

#include <avogadro/global.h>

namespace Avogadro {

  class A_EXPORT PlotAxis {
  public:

    explicit PlotAxis( const QString& label = QString() );

    ~PlotAxis();

    bool isVisible() const;

    void setVisible( bool visible );

    bool areTickLabelsShown() const;

    void setTickLabelsShown( bool b );

    void setLabel( const QString& label );

    QString label() const;

    QString tickLabel( double value ) const;

    void setTickLabelFormat( char format = 'g', int fieldWidth = 0, int precision = -1 );

    int tickLabelWidth() const;

    char tickLabelFormat() const;

    int tickLabelPrecision() const;

    void setTickMarks( double x0, double length );

    QList< double > majorTickMarks() const;

    QList< double > minorTickMarks() const;

  private:
    class Private;
    Private * const d;

    Q_DISABLE_COPY( PlotAxis )
  };

}

#endif // PLOTAXIS_H