KChartChart.h

/*
 * Copyright (C) 2001-2015 Klaralvdalens Datakonsult AB.  All rights reserved.
 *
 * This file is part of the KD Chart library.
 *
 * This program 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.
 *
 * This program 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, see <https://www.gnu.org/licenses/>.
 */

#ifndef KCHARTCHART_H
#define KCHARTCHART_H

#include <QWidget>

#include "kchart_export.h"
#include "KChartGlobal.h"

/*
Simplified(*) overview of object ownership in a chart:

                Chart is-a QWidget
                 |
          n CoordinatePlanes is-a AbstractArea is-a AbstractLayoutItem is-a QLayoutItem
                 |
            n Diagrams is-a QAbstractItemView is-a QWidget
              /   |   \
  AbstractGrid    |   Axes (can be shared between diagrams) is-a AbstractArea is-a... QLayoutItem
 (no base class)  |
                Legends is-a AbstractAreaWidget is-a QWidget

(*) less important classes, including base classes, removed.


Layout rules:

In principle, every size or existence change in one of the objects listed above must be propagated
to all other objects. This could change their size.
There are also settings changes that invalidate the size of other components, where the size changes
are detected and propagated.


Painting call tree (simplified):

Chart::paint() (from users) / paintEvent() (from framework)
ChartPrivate::paintAll()-----------------------------------------------\
CoordinatePlane::paintAll() (from AbstractArea)--------\               Axis::paintAll()-\
CoordinatePlane::paint() (from AbstractLayoutItem)     Grid::drawGrid()                 Axis::paint()
Diagram::paint( PaintContext* paintContext )

Note that grids are painted from the coordinate plane, not from the diagram as ownership would suggest.

*/

namespace KChart {

    class BackgroundAttributes;
    class FrameAttributes;
    class AbstractDiagram;
    class AbstractCoordinatePlane;
    class HeaderFooter;
    class Legend;

    typedef QList<AbstractCoordinatePlane*> CoordinatePlaneList;
    typedef QList<HeaderFooter*> HeaderFooterList;
    typedef QList<Legend*> LegendList;


    class KCHART_EXPORT Chart : public QWidget
    {
        Q_OBJECT
         // KD Chart 3.0: leading is inter-line distance of text. this here is MARGIN or SPACING.
        Q_PROPERTY( int globalLeadingTop READ globalLeadingTop WRITE setGlobalLeadingTop )
        Q_PROPERTY( int globalLeadingBottom READ globalLeadingBottom WRITE setGlobalLeadingBottom )
        Q_PROPERTY( int globalLeadingLeft READ globalLeadingLeft WRITE setGlobalLeadingLeft )
        Q_PROPERTY( int globalLeadingRight READ globalLeadingRight WRITE setGlobalLeadingRight )
        Q_PROPERTY( bool useNewLayoutSystem READ useNewLayoutSystem WRITE setUseNewLayoutSystem )

        KCHART_DECLARE_PRIVATE_BASE_POLYMORPHIC_QWIDGET( Chart )

    public:
        explicit Chart ( QWidget* parent = nullptr );
        ~Chart();

        bool useNewLayoutSystem() const;
        void setUseNewLayoutSystem( bool value );

        void setFrameAttributes( const FrameAttributes &a );
        FrameAttributes frameAttributes() const;

        void setBackgroundAttributes( const BackgroundAttributes &a );
        BackgroundAttributes backgroundAttributes() const;

        AbstractCoordinatePlane* coordinatePlane();

        CoordinatePlaneList coordinatePlanes();

        void addCoordinatePlane( AbstractCoordinatePlane* plane );

        void insertCoordinatePlane( int index, AbstractCoordinatePlane* plane );

        void replaceCoordinatePlane( AbstractCoordinatePlane* plane,
                                     AbstractCoordinatePlane* oldPlane = nullptr );

        void takeCoordinatePlane( AbstractCoordinatePlane* plane );

        void setCoordinatePlaneLayout( QLayout * layout );
        QLayout* coordinatePlaneLayout();

        HeaderFooter* headerFooter();

        HeaderFooterList headerFooters();

        void addHeaderFooter( HeaderFooter* headerFooter );

        void replaceHeaderFooter ( HeaderFooter* headerFooter,
                                   HeaderFooter* oldHeaderFooter = nullptr );

        void takeHeaderFooter( HeaderFooter* headerFooter );

        Legend* legend();

        LegendList legends();

        void addLegend( Legend* legend );

        void replaceLegend ( Legend* legend, Legend* oldLegend = nullptr );

        void takeLegend( Legend* legend );

        void setGlobalLeading( int left, int top, int right, int bottom );

        void setGlobalLeadingLeft( int leading );

        int globalLeadingLeft() const;

        void setGlobalLeadingTop( int leading );

        int globalLeadingTop() const;

        void setGlobalLeadingRight( int leading );

        int globalLeadingRight() const;

        void setGlobalLeadingBottom( int leading );

        int globalLeadingBottom() const;

        void paint( QPainter* painter, const QRect& rect );

        void reLayoutFloatingLegends();

    Q_SIGNALS:
        void propertiesChanged();
        void finishedDrawing();

    protected:
        /* reimp */ void resizeEvent ( QResizeEvent * event ) override;

        /* reimp */ void paintEvent( QPaintEvent* event ) override;

        void mousePressEvent( QMouseEvent* event ) override;
        void mouseDoubleClickEvent( QMouseEvent* event ) override;
        void mouseMoveEvent( QMouseEvent* event ) override;
        void mouseReleaseEvent( QMouseEvent* event ) override;
        bool event( QEvent* event ) override;

    private:
        // TODO move this to the private class
        void addLegendInternal( Legend *legend, bool setMeasures );
    };

// Here we have a few docu block to be included into the API documentation:
}
#endif