previewjob.h

Go to the documentation of this file.

// -*- c++ -*-
// vim: ts=4 sw=4 et
/*  This file is part of the KDE libraries
    Copyright (C) 2000 David Faure <faure@kde.org>
                  2000 Carsten Pfeiffer <pfeiffer@kde.org>
                  2001 Malte Starostik <malte.starostik@t-online.de>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 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
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef KIO_PREVIEWJOB_H
#define KIO_PREVIEWJOB_H

#include <kfileitem.h>
#include <kio/job.h>

class QPixmap;

namespace KIO {
    class PreviewJobPrivate;
    class KIO_EXPORT PreviewJob : public KIO::Job
    {
        Q_OBJECT
    public:
        enum ScaleType {
            Unscaled,
            Scaled,
            ScaledAndCached
        };

#ifndef KDE_NO_DEPRECATED

        KDE_DEPRECATED PreviewJob(const KFileItemList& items, int width, int height,
                                  int iconSize, int iconAlpha, bool scale, bool save,
                                  const QStringList *enabledPlugins);
#endif

        PreviewJob(const KFileItemList &items,
                   const QSize &size,
                   const QStringList *enabledPlugins = 0);

        virtual ~PreviewJob();

        void setOverlayIconSize(int size);

        int overlayIconSize() const;

        void setOverlayIconAlpha(int alpha);

        int overlayIconAlpha() const;

        void setScaleType(ScaleType type);

        ScaleType scaleType() const;

        void removeItem( const KUrl& url );

        void setIgnoreMaximumSize(bool ignoreSize = true);

        void setSequenceIndex(int index);

        int sequenceIndex() const;

        static QStringList availablePlugins();

        static QStringList supportedMimeTypes();

#ifndef KDE_NO_DEPRECATED
        KDE_DEPRECATED static KIO::filesize_t maximumFileSize();
#endif


    Q_SIGNALS:
        void gotPreview( const KFileItem& item, const QPixmap &preview );
        void failed( const KFileItem& item );

    protected Q_SLOTS:
        virtual void slotResult( KJob *job );

    private:
        Q_PRIVATE_SLOT(d_func(), void startPreview())
        Q_PRIVATE_SLOT(d_func(), void slotThumbData(KIO::Job *, const QByteArray &))
        Q_DECLARE_PRIVATE(PreviewJob)
    };

#ifndef KDE_NO_DEPRECATED

    KIO_EXPORT_DEPRECATED PreviewJob *filePreview( const KFileItemList &items, int width, int height = 0, int iconSize = 0, int iconAlpha = 70, bool scale = true, bool save = true, const QStringList *enabledPlugins = 0 ); // KDE5: use enums instead of bool scale + bool save

    KIO_EXPORT_DEPRECATED PreviewJob *filePreview( const KUrl::List &items, int width, int height = 0, int iconSize = 0, int iconAlpha = 70, bool scale = true, bool save = true, const QStringList *enabledPlugins = 0 );
#endif

    KIO_EXPORT PreviewJob *filePreview(const KFileItemList &items, const QSize &size, const QStringList *enabledPlugins = 0);
}

#endif