File indexing completed on 2024-04-21 04:41:49

 /* This file is part of the KDE project
  * Copyright (C) 2007-2010 by Adam Pigg (adam@piggz.co.uk)
  *
  * 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 KREPORTITEMBASE_H
 #define KREPORTITEMBASE_H
 
 #include "config-kreport.h"
 #include "kreport_export.h"
 #include "KReportUnit.h"
 
 #include <QObject>
 #include <QFont>
 #include <QColor>
 
 class OROPage;
 class OROSection;
 class KReportDataSource;
 class KReportLineStyle;
 
 #ifdef KREPORT_SCRIPTING
 class KReportScriptHandler;
 #else
 #define KReportScriptHandler void
 #endif
 
 class KProperty;
 class KPropertySet;
 
 class QDomElement;
 
 class KReportTextStyleData
 {
 public:
     QFont font;
     Qt::Alignment alignment;
     QColor backgroundColor;
     QColor foregroundColor;
     int backgroundOpacity;
 
 };
 
 /*!
  * @brief Base class for items that are drawn syncronously.
  */
 class KREPORT_EXPORT KReportItemBase : public QObject
 {
     Q_OBJECT
 public:
 
     KReportItemBase();
     ~KReportItemBase() override;
 
     /**
     @brief Return the item type as a string.  Required by all items
     @return Item type
     */
     virtual QString typeName() const = 0;
 
     /**
     @brief Render the item into a primitive which is used by the second stage renderer
     @return the height required by the object
     */
     virtual int renderSimpleData(OROPage *page, OROSection *section, const QPointF &offset, const QVariant &data, KReportScriptHandler *script);
 
     /**
     @brief Render a complex item that uses a sub query as a data source
     @return the height required by the object
     */
     virtual int renderReportData(OROPage *page, OROSection *section, const QPointF &offset, KReportDataSource *dataSource, KReportScriptHandler *script);
 
     /**
     @return The field name or expression for the data source
     */
     QString itemDataSource() const;
 
     void setItemDataSource(const QString &source);
 
     /**
     @brief Override if the item uses a sub query and linked fields, such as a chart or sub-report
     @return True if uses a sub query
     */
     virtual bool supportsSubQuery() const;
 
     KPropertySet* propertySet();
     const KPropertySet* propertySet() const;
 
     void setEntityName(const QString& n);
     QString entityName() const;
 
     KReportUnit unit() const;
 
     //! Sets unit to @a a and converts values of position and size property from the old
     //! unit to new if needed.
     virtual void setUnit(const KReportUnit &u);
 
     /**
      * @brief Return the size in points
      */
     QSizeF size() const;
 
     /**
      * @brief Return the position in points
      */
     QPointF position() const;
 
     /**
      * @brief Sets position for the element
      * @param ptPos Position in points
      */
     void setPosition(const QPointF &ptPos);
 
     /**
      * @brief Sets size for the element
      * @param ptSize Size in points
      */
     void setSize(const QSizeF &ptSize);
 
     /**
      * @brief Return the z-value in points
      */
     qreal z() const;
 
     /**
      * @brief Sets the z-value for the element
      * @param z Z-value in points
      */
     void setZ(qreal z);
 
     //! Helper function mapping to screen units (pixels), @a ptPos is in points
     static QPointF scenePosition(const QPointF &ptPos);
 
     //! Helper function mapping to screen units (pixels), @a ptSize is in points
     static QSizeF sceneSize(const QSizeF &ptSize);
 
     //! Helper function mapping from screen units to points, @a pos is in pixels
     static QPointF positionFromScene(const QPointF &pos);
 
     //! Helper function mapping from screen units to points, @a size is in pixels
     static QSizeF sizeFromScene(const QSizeF &size);
 
 protected:
     virtual void createProperties() = 0;
     void createDataSourceProperty();
     bool parseReportRect(const QDomElement &elem);
     static bool parseReportTextStyleData(const QDomElement &, KReportTextStyleData*);
     static bool parseReportLineStyleData(const QDomElement &, KReportLineStyle*);
 
     KProperty *nameProperty();
     QString oldName() const;
     void setOldName(const QString &old);
     KProperty* dataSourceProperty();
 
     Q_SLOT virtual void propertyChanged(KPropertySet &s, KProperty &p);
 
 private:
     Q_DISABLE_COPY(KReportItemBase)
     class Private;
     Private * const d;
     Q_SLOT void aboutToDeleteProperty(KPropertySet& set, KProperty& property);
 
     friend class KReportDesignerItemRectBase;
 };
 
 #endif