KDReportsFrame.h

/****************************************************************************
** Copyright (C) 2007-2020 Klaralvdalens Datakonsult AB.  All rights reserved.
**
** This file is part of the KD Reports library.
**
** Licensees holding valid commercial KD Reports licenses may use this file in
** accordance with the KD Reports Commercial License Agreement provided with
** the Software.
**
**
** This file may be distributed and/or modified under the terms of the
** GNU Lesser General Public License version 2.1 and version 3 as published by the
** Free Software Foundation and appearing in the file LICENSE.LGPL.txt included.
**
** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
**
** Contact info@kdab.com if any conditions of this licensing are not
** clear to you.
**
**********************************************************************/

#ifndef KDREPORTSFRAME_H
#define KDREPORTSFRAME_H

#include "KDReportsElement.h"
#include "KDReportsUnit.h"
#include "KDReportsVariableType.h"
#include <QtCore/Qt>
#include <QMap>
#include <QPair>

namespace KDReports
{
class ReportBuilder;
class Element;
class FramePrivate;

class KDREPORTS_EXPORT Frame : public Element
{
public:
    explicit Frame();
    virtual ~Frame();

    Frame(const Frame &other);
    Frame &operator=(const Frame &other);

    void setWidth( qreal width, Unit unit = Millimeters );
    void setHeight( qreal height, Unit unit = Millimeters );

    void setPadding( qreal padding );

    qreal padding() const;

    void setBorder( qreal border );

    qreal border() const;

    void addInlineElement( const Element& element );

    void addElement( const Element& element, Qt::AlignmentFlag horizontalAlignment = Qt::AlignLeft );

    void addVariable( VariableType variable );

    void build( ReportBuilder& builder ) const;

    Element* clone() const;

private:

    FramePrivate* const d;
};

}

#endif /* KDREPORTSFRAME_H */