KChartLegend.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 KCHARTLEGEND_H
#define KCHARTLEGEND_H

#include "KChartAbstractAreaWidget.h"
#include "KChartPosition.h"
#include "KChartMarkerAttributes.h"

class QTextTable;

namespace KChart {

class AbstractDiagram;
typedef QList<AbstractDiagram*> DiagramList;
typedef QList<const AbstractDiagram*> ConstDiagramList;

class KCHART_EXPORT Legend : public AbstractAreaWidget
{
    Q_OBJECT

    Q_DISABLE_COPY( Legend )
    KCHART_DECLARE_PRIVATE_DERIVED_QWIDGET( Legend )

public:
    explicit Legend( QWidget* parent = nullptr );
    explicit Legend( KChart::AbstractDiagram* diagram, QWidget* parent = nullptr );
    virtual ~Legend();


    enum LegendStyle { MarkersOnly     = 0,
                       LinesOnly       = 1,
                       MarkersAndLines = 2 };


    void setLegendStyle( LegendStyle style );
    LegendStyle legendStyle() const;



    virtual Legend * clone() const;

    bool compare( const Legend* other ) const;

    void resizeEvent( QResizeEvent * event ) override; // TODO: should be protected

    virtual void paint( QPainter* painter ) override;
    void paint( QPainter* painter, const QRect &rect);
    void setVisible( bool visible ) override;

    void setReferenceArea( const QWidget* area );
    const QWidget* referenceArea() const;

    KChart::AbstractDiagram* diagram() const;

    DiagramList diagrams() const;

    ConstDiagramList constDiagrams() const;

    void addDiagram( KChart::AbstractDiagram* newDiagram );

    void removeDiagram( KChart::AbstractDiagram* oldDiagram );

    void removeDiagrams();

    void replaceDiagram( KChart::AbstractDiagram* newDiagram,
                         KChart::AbstractDiagram* oldDiagram = nullptr );

    uint dataSetOffset( KChart::AbstractDiagram* diagram );

    void setDiagram( KChart::AbstractDiagram* newDiagram );

    void setPosition( Position position );

    Position position() const;

    void setAlignment( Qt::Alignment );

    Qt::Alignment alignment() const;

    void setTextAlignment( Qt::Alignment );

     Qt::Alignment textAlignment() const;

     void setLegendSymbolAlignment(Qt::Alignment);

     Qt::Alignment legendSymbolAlignment() const;

    void setFloatingPosition( const RelativePosition& relativePosition );

    const RelativePosition floatingPosition() const;

    void setOrientation( Qt::Orientation orientation );
    Qt::Orientation orientation() const;


    void setSortOrder( Qt::SortOrder order );
    Qt::SortOrder sortOrder() const;

    void setShowLines( bool legendShowLines );
    bool showLines() const;


    void resetTexts();
    void setText( uint dataset, const QString& text );
    QString text( uint dataset ) const;
    const QMap<uint,QString> texts() const;

    void setHiddenDatasets( const QList<uint> hiddenDatasets );
    const QList<uint> hiddenDatasets() const;
    void setDatasetHidden( uint dataset, bool hidden );
    bool datasetIsHidden( uint dataset ) const;

    uint datasetCount() const;

    void setDefaultColors();
    void setRainbowColors();
    void setSubduedColors( bool ordered = false );

    void setBrushesFromDiagram( KChart::AbstractDiagram* diagram );

    void setColor( uint dataset, const QColor& color );

    void setBrush( uint dataset, const QBrush& brush );
    QBrush brush( uint dataset ) const;
    const QMap<uint,QBrush> brushes() const;

    void setPen( uint dataset, const QPen& pen );
    QPen pen( uint dataset ) const;
    const QMap<uint,QPen> pens() const;

    void setMarkerAttributes( uint dataset, const MarkerAttributes& );
    MarkerAttributes markerAttributes( uint dataset ) const;
    const QMap<uint, MarkerAttributes> markerAttributes() const;

    void setUseAutomaticMarkerSize( bool useAutomaticMarkerSize );
    bool useAutomaticMarkerSize() const;

    void setTextAttributes( const TextAttributes &a );
    TextAttributes textAttributes() const;

    void setTitleText( const QString& text );
    QString titleText() const;

    void setTitleTextAttributes( const TextAttributes &a );
    TextAttributes titleTextAttributes() const;

    void setSpacing( uint space );
    uint spacing() const;

    // called internally by KChart::Chart, when painting into a custom QPainter
    void forceRebuild() override;

    QSize minimumSizeHint() const override;
    QSize sizeHint() const override;
    bool hasHeightForWidth() const override;
    int heightForWidth( int width ) const override;
    void needSizeHint() override;
    void resizeLayout( const QSize& size ) override;

Q_SIGNALS:
    void destroyedLegend( Legend* );
    void propertiesChanged();

private Q_SLOTS:
    void emitPositionChanged();
    void resetDiagram( AbstractDiagram* );
    void activateTheLayout();
    void setNeedRebuild();
    void buildLegend();
}; // End of class Legend

}


#endif // KCHARTLEGEND_H