KReportScriptImage.h

/* This file is part of the KDE project
 * Copyright (C) 2007-2008 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 SCRIPTINGKRSCRIPTIMAGE_H
#define SCRIPTINGKRSCRIPTIMAGE_H
 
#include <QObject>
#include <QPointF>
#include <QSizeF>
 
class KReportItemImage;
 
namespace Scripting
{
 
    /**
     @brief Image item script interface
 
     The user facing interface for scripting report image items
     */
class Image : public QObject
{
    Q_OBJECT
public:
    explicit Image(KReportItemImage *);
 
    ~Image() override;
public Q_SLOTS:
 
 
    /**
    * Get the position of the barcode
    * @return position in points
     */
    QPointF position() const;
 
 
    /**
     * Sets the position of the barcode in points
     * @param Position
     */
    void setPosition(const QPointF&);
 
    /**
     * Get the size of the barcode
     * @return size in points
     */
    QSizeF size() const;
 
    /**
     * Set the size of the barcode in points
     * @param Size
     */
    void setSize(const QSizeF&);
 
    /**
     * Get the resize mode for the image
     * @return resizeMode Clip or Stretch
     */
    QString resizeMode() const;
 
    /**
     * Sets the resize mode for the image
     * @param ResizeMode "Stretch" or "Clip" default is to clip
     */
    void setResizeMode(const QString &);
 
    /**
     * Sets the data for the static image
     * the data should be base64 encoded
     * @param RawImageData
     */
    void setInlineImage(const QByteArray&);
 
    /**
     * Get the data from a file (expected to be an image)
     * the returned data will be base64 encoded
     * @param path location of file
     */
    void loadFromFile(const QVariant &path);
 
private:
    KReportItemImage *m_image;
 
};
 
}
 
#endif