KReportSection.shared.h

/* This file is part of the KDE project
 * Copyright (C) 2001-2007 by OpenMFG, LLC (info@openmfg.com)
 * Copyright (C) 2007-2008 by Adam Pigg (adam@piggz.co.uk)
 * Copyright (C) 2010-2015 Jarosław Staniek <staniek@kde.org>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef KREPORTSECTION_H
#define KREPORTSECTION_H
 
#include <QCoreApplication>
#include <QSet>
#include <KReportElement>
 
//! @brief The KReportSection class represents a section of a report design
/*! A section has optional report header, report footer, page header, page footer,
    group header, group footer and detail.
    In the case of page header and page footer it is possible to define (firstpage, odd, even or lastpage). */
class KREPORT_EXPORT KReportSection //SDC: explicit operator== virtual_dtor custom_clone
{
    Q_DECLARE_TR_FUNCTIONS(KReportSection)
public:
    enum class Type {
        Invalid,
        PageHeaderFirst,
        PageHeaderOdd,
        PageHeaderEven,
        PageHeaderLast,
        PageHeaderAny,
        ReportHeader,
        ReportFooter,
        PageFooterFirst,
        PageFooterOdd,
        PageFooterEven,
        PageFooterLast,
        PageFooterAny,
        GroupHeader,
        GroupFooter,
        Detail
    };
 
    /*!
    @getter
    @return section type
    Default section type is Invalid.
    @setter
    Sets section type.
    */
    KReportSection::Type type;  //SDC: default=KReportSection::Type::Invalid simple_type
 
    /*!
    @getter
    @return section height measured in points
    It is equal to KReportSection::defaultHeight() unless setHeight()
    is called with value > 0.
    @setter
    Sets section height measured in points.
    Set negative value to reset to the default height.
    */
    qreal height; //SDC: default=-1 custom_getter
 
    /*!
    @getter
    @return section background color
    It is equal to KReportSection::defaultBackgroundColor() unless setBackgroundColor()
    is called with a valid color.
    @setter
    Sets section background color.
    Set invalid color (QColor()) to reset to the default background color.
    */
    QColor backgroundColor;  //SDC: custom_getter
 
    /*!
    @getter
    @return all elements of this section
    */
    QList<KReportElement> elements;  //SDC: custom_getter no_setter
 
    /*!
    @internal A set that helps to quickly check if element is part of the section.
    */
    QSet<KReportElement> elementsSet; //SDC: internal
 
    //! Adds element @a element to this section.
    //! @return true on success.
    //! Adding fails if element is already added to this or other section.
    //! Use KReportElement::clone() to add a copy.
    bool addElement(const KReportElement &element);
 
    //! Adds element @a element to this section at index position @a i.
    //! @return true on success.
    //! Adding fails if element is already added to this or other section or if
    //! position @a i is out of bounds.
    //! Use KReportElement::clone() to add a copy.
    bool insertElement(int i, const KReportElement &element);
 
    //! Removes element @a element from this section.
    //! @return true on success.
    //! Removing fails if element @a element is not added in this section.
    bool removeElement(const KReportElement &element);
 
    //! Removes element from index position @a i from this section.
    //! @return true on success.
    //! Removing fails position @a i is out of bounds.
    bool removeElementAt(int i);
 
    //! @return default height for report sections. The standard is 2cm (converted to points).
    static qreal defaultHeight();
 
    //! Sets default height for report sections in points.
    static void setDefaultHeight(qreal height);
 
    //! @return default background color for report sections. The standard is white.
    static QColor defaultBackgroundColor();
 
    //! Sets default background color for report sections.
    static void setDefaultBackgroundColor(const QColor &color);
};
 
#endif // KREPORTSECTION_H