/****************************************************************************
**
** Copyright (C) 2012 Digia Plc
** All rights reserved.
** For any questions to Digia, please use contact form at http://qt.digia.com
**
** This file is part of the Qt Commercial Charts Add-on.
**
** $QT_BEGIN_LICENSE$
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.
**
** If you have questions regarding the use of this file, please use
** contact form at http://qt.digia.com
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QLEGEND_H
#define QLEGEND_H

#include <QChartGlobal>
#include <QGraphicsWidget>
#include <QPen>
#include <QBrush>

QTCOMMERCIALCHART_BEGIN_NAMESPACE

class Domain;
class LegendMarker;
class QPieSlice;
class QXYSeries;
class QBarSet;
class QBarSeries;
class QPieSeries;
class QAreaSeries;
class LegendScrollButton;
class QSeries;
class QChart;

class QTCOMMERCIALCHART_EXPORT QLegend : public QGraphicsWidget
{
    Q_OBJECT
public:

    // We only support these alignments (for now)
    enum Alignment {
        AlignmentTop = Qt::AlignTop,
        AlignmentBottom = Qt::AlignBottom,
        AlignmentLeft = Qt::AlignLeft,
        AlignmentRight = Qt::AlignRight
    };

    Q_DECLARE_FLAGS(Alignments, Alignment)

private:
    explicit QLegend(QChart *chart);

public:
    void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = 0);
    QRectF boundingRect() const;

    void setBrush(const QBrush &brush);
    QBrush brush() const;

    void setPen(const QPen &pen);
    QPen pen() const;

    void setAlignmnent(QLegend::Alignments alignment);
    QLegend::Alignments alignment() const;

    QSizeF maximumSize() const;
    void setMaximumSize(const QSizeF size);

    QSizeF size() const;
    void setSize(const QSizeF size);
    void setPos(const QPointF &pos);

    void scrollButtonClicked(LegendScrollButton *scrollButton);

    void detachFromChart();
    void attachToChart();
    bool attachedToChart();

Q_SIGNALS:
    // for interactions.
    void clicked(QSeries *series, Qt::MouseButton button);
    void clicked(QBarSet *barset, Qt::MouseButton button);
    void clicked(QPieSlice *slice, Qt::MouseButton button);
    void legendGeometryChanged();

public Q_SLOTS:
    // PIMPL --->
    void handleSeriesAdded(QSeries *series, Domain *domain);
    void handleSeriesRemoved(QSeries *series);
    void handleAdded(QList<QPieSlice *> slices);
    void handleRemoved(QList<QPieSlice *> slices);
    void handleMarkerDestroyed();

    // PIMPL <---

private:
    // PIMPL --->
    void appendMarkers(QAreaSeries *series);
    void appendMarkers(QXYSeries *series);
    void appendMarkers(QBarSeries *series);
    void appendMarkers(QPieSeries *series);
    void deleteMarkers(QSeries *series);
    void updateLayout();
    void rescaleScrollButtons(const QSize &size);
    QSizeF maximumMarkerSize();
    void checkFirstMarkerBounds();
    bool scrollButtonsVisible();

    qreal m_margin;
    QPointF m_pos;
    QSizeF m_minimumSize;
    QSizeF m_maximumSize;
    QSizeF m_size;

    QList<LegendMarker *> m_markers;

    QBrush m_brush;
    QPen m_pen;
    QLegend::Alignments m_alignment;

    int mFirstMarker;

    LegendScrollButton *m_scrollButtonLeft;
    LegendScrollButton *m_scrollButtonRight;
    LegendScrollButton *m_scrollButtonUp;
    LegendScrollButton *m_scrollButtonDown;

    bool m_attachedToChart;

    QChart *m_chart;
    friend class QChart;
    // <--- PIMPL
};

QTCOMMERCIALCHART_END_NAMESPACE

#endif // QLEGEND_H