gobchartsview.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 GOBCHARTSVIEW_H
#define GOBCHARTSVIEW_H

#include <QAbstractItemView>
#include "utils/globalincludes.h"
#include "utils/gobchartsnocopy.h"

class QGraphicsView;
class QGraphicsItem;
class QDomNode;
class GobChartsTextItem;


class GobChartsView : public QAbstractItemView,
                      public GobChartsNoCopy
{
  Q_OBJECT

public:
  virtual ~GobChartsView();

  void drawChart();

  void legendItemSelected( const QString &text );

  void setStateXML( const QDomNode &viewNode, const QDomNode &dataNode, bool includeData = true );

  QString getStateXML( bool includeData = true ) const;

  QRect visualRect( const QModelIndex &index ) const;

  QModelIndex indexAt( const QPoint &point ) const;

  void scrollTo( const QModelIndex &index, ScrollHint hint = EnsureVisible );

  void setModel( QAbstractItemModel *model );

public slots:
  void setLabelDetails( GobChartsLabel label, const QString &text, const QFont &font, const QColor &colour, Qt::Alignment align );

  void requestLabelDetails( GobChartsLabel label );

  void setGridLineStyle( Qt::PenStyle style );

  void setHorizontalGridLines( bool set, int number );

  void setVerticalGridLines( bool set, int number );

  void setGridColour( QColor colour );

  void setFixedColour( QColor colour );

  void setRandomColours();

  void setAllowedDataRange( qreal lowerBoundary, qreal upperBoundary );

  void setShowTotalRange();

  void setDebugLoggingOn( bool logging );

signals:
  void lastDebugLogMsg( QString );

  void emitLabelDetails( GobChartsLabel label, const QString &text, const QFont &font, const QColor &colour, Qt::Alignment align );

  void createLegendItem( const QColor &colour, const QString &text );

  void clearLegend();

  void highLightLegendItem( const QString &text );

protected:
  enum GobChartsColumn { CATEGORY, VALUE };

  explicit GobChartsView( QWidget *parent = 0 );

  virtual void generateGraphicsItems() = 0;

  virtual bool needsGrid() const = 0;

  virtual QString typeInteger()  const = 0;

  bool useFixedColour() const;

  QColor fixedColour() const;

  void addToGraphItemsContainer( const QModelIndex &valueIndex, QGraphicsItem *item, const QString &legendText );

  int nrValidItems() const;

  QList< int > validRowList() const;

  QString category( int row ) const;

  qreal value( int row ) const;

  const QRectF &innerSceneRectF() const;

  bool  isWithinAllowedRange( qreal value ) const;

  qreal gridWidth() const;

  qreal stripSpace( qreal perc ) const;

  qreal totalValue() const;

  QModelIndex moveCursor( QAbstractItemView::CursorAction cursorAction, Qt::KeyboardModifiers modifiers );

  QRegion visualRegionForSelection( const QItemSelection &selection ) const;

  int  horizontalOffset() const;

  int  verticalOffset() const;

  bool isIndexHidden( const QModelIndex &index ) const;

  void setSelection( const QRect& rect, QItemSelectionModel::SelectionFlags command );

  void keyPressEvent( QKeyEvent *event );

protected slots:
  void debugLog( QString msg );

  void dataChanged( const QModelIndex &topLeft, const QModelIndex &bottomRight );

  void rowsInserted( const QModelIndex &parent, int start, int end );

  void rowsAboutToBeRemoved( const QModelIndex &parent, int start, int end );

  void mousePressEvent( QMouseEvent *p_event );

private:
  friend class GobChartsViewPrivate;
  class GobChartsViewPrivate;
  GobChartsViewPrivate* const m_private;

  void resizeEvent( QResizeEvent *event );

private slots:
  void setSelectedTextItem( const QString &itemName );
};

#endif // GOBCHARTSVIEW_H