KReportLabelElement.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 KREPORTLABELELEMENT_H
#define KREPORTLABELELEMENT_H
 
#include "KReportElement.h"
#include "KReportLineStyle.h"
 
#include <QFont>
 
/*!
 * @brief The KReportLabelElement class represents a label element of a report design
 * @warning This API is currently private.
 */
class KREPORT_EXPORT KReportLabelElement : public KReportElement //SDC: explicit operator== virtual_dtor
{
public:
    /*!
    @getter
    @return element's name.
    @setter
    Sets the element's name to @a name.
    */
    QString text; //SDC:
 
    /*!
    @getter
    @return element's font.
    @setter
    Sets the element's font to @a font.
    */
    QFont font; //SDC:
 
    /*!
    @getter
    @return element's text alignment. Default value is Qt::AlignLeft|Qt::AlignVCenter.
    @setter
    Sets the element's text alignment to @a alignment.
    */
    Qt::Alignment alignment; //SDC: default=Qt::AlignLeft|Qt::AlignVCenter
 
    /*!
    @getter
    @return element's border style.
    @setter
    Sets the element's border style to @a borderStyle.
    */
    KReportLineStyle borderStyle; //SDC:
 
    //! Constructs a label with text @a text.
    explicit KReportLabelElement(const QString &text)
        : KReportElement(new Data)
    {
        setText(text);
    }
};
 
#endif // KREPORTLABELELEMENT_H