File indexing completed on 2024-05-12 15:54:16

0001 /*
0002  * Copyright (C) 2001-2015 Klaralvdalens Datakonsult AB.  All rights reserved.
0003  *
0004  * This file is part of the KD Chart library.
0005  *
0006  * This program is free software; you can redistribute it and/or
0007  * modify it under the terms of the GNU General Public License as
0008  * published by the Free Software Foundation; either version 2 of
0009  * the License, or (at your option) any later version.
0010  *
0011  * This program is distributed in the hope that it will be useful,
0012  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0013  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0014  * GNU General Public License for more details.
0015  *
0016  * You should have received a copy of the GNU General Public License
0017  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
0018  */
0019 
0020 #ifndef KCHARTHEADERFOOTER_H
0021 #define KCHARTHEADERFOOTER_H
0022 
0023 #include "KChartTextArea.h"
0024 #include "KChartPosition.h"
0025 
0026 namespace KChart {
0027 
0028     class Chart;
0029     class TextAttributes;
0030 
0031 /**
0032   * @brief A header or footer displaying text above or below charts
0033   */
0034 class KCHART_EXPORT HeaderFooter : public TextArea
0035 {
0036     Q_OBJECT
0037 
0038     KCHART_DECLARE_PRIVATE_DERIVED_PARENT( HeaderFooter, Chart* )
0039 
0040 public:
0041     HeaderFooter( Chart* parent = nullptr );
0042     virtual ~HeaderFooter();
0043 
0044     /**
0045       * Creates an exact copy of this header/footer.
0046       */
0047     virtual HeaderFooter * clone() const;
0048 
0049     bool compare( const HeaderFooter& other ) const;
0050 
0051     enum HeaderFooterType{ Header,
0052                            Footer };
0053 
0054     void setType( HeaderFooterType type );
0055     HeaderFooterType type() const;
0056 
0057     void setPosition( Position position );
0058     Position position() const;
0059 
0060     void setParent( QObject* parent );
0061 
0062 Q_SIGNALS:
0063     void destroyedHeaderFooter( HeaderFooter* );
0064     void positionChanged( HeaderFooter* );
0065 
0066 }; // End of class HeaderFooter
0067 
0068 }
0069 
0070 
0071 #endif // KCHARTHEADERFOOTER_H