gobchartsgrid.h

/* Copyright (C) 2012 by William Hallatt.
 *
 * This file forms part of the "GobChartsWidget" library.
 *
 * This library 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 3 of the License, or
 * (at your option) any later version.
 *
 * This library 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 downloaded a copy of the GNU General Public License
 * (GNUGPL.txt) and GNU Lesser General Public License (GNULGPL.txt)
 * along with this library.  If not, see <http://www.gnu.org/licenses/>.
 *
 * The official website for this project is www.goblincoding.com and,
 * although not compulsory, it would be appreciated if all works of whatever
 * nature referring to or using this library include a reference to this site.
 */

#ifndef GOBCHARTSGRID_H
#define GOBCHARTSGRID_H

#include <QList>
#include <QPen>
#include "utils/gobchartsnocopy.h"

class QGraphicsLineItem;
class QGraphicsScene;


class GobChartsGrid : public QObject,
                      public GobChartsNoCopy
{
  Q_OBJECT

public:
  GobChartsGrid( QObject *parent = 0 );

  virtual ~GobChartsGrid();

  void addGridToScene( QGraphicsScene *scene );

  void removeGridFromScene( QGraphicsScene *scene );

  void constructGrid();

  void setGridRectF( const QRectF &rect );

  void setGridLineStyle( Qt::PenStyle style );

  void setHorizontalGridLines( bool set, int number );

  void setVerticalGridLines( bool set, int number );

  void setGridColour( QColor colour );

  qreal gridWidth() const;

  void setDebugLoggingOn( bool logging );

signals:
  void lastDebugLogMsg( QString );

private:
  QList< QGraphicsLineItem* > m_gridLines;
  QRectF m_rectF;
  QPen   m_gridPen;
  QPen   m_axesPen;
  int    m_nrHorizontalLines;
  int    m_nrVerticalLines;
  bool   m_showHorizontalGrid;
  bool   m_showVerticalGrid;
  bool   m_loggingOn;
};

#endif // GOBCHARTSGRID_H