-/***************************************************************************
- * Copyright (C) 2011 by Peter Penz <peter.penz19@gmail.com> *
- * *
- * This program is free software; you can redistribute it and/or modify *
- * it under the terms of the GNU General Public License as published by *
- * the Free Software Foundation; either version 2 of the License, or *
- * (at your option) any later version. *
- * *
- * This program 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 General Public License for more details. *
- * *
- * You should have received a copy of the GNU General Public License *
- * along with this program; if not, write to the *
- * Free Software Foundation, Inc., *
- * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
- ***************************************************************************/
+/*
+ * SPDX-FileCopyrightText: 2011 Peter Penz <peter.penz19@gmail.com>
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
#ifndef KFILEITEMMODELROLESUPDATER_H
#define KFILEITEMMODELROLESUPDATER_H
#include "dolphin_export.h"
#include "kitemviews/kitemmodelbase.h"
+#include <list>
+
#include <KFileItem>
#include <config-baloo.h>
*/
QStringList enabledPlugins() const;
-private slots:
+ /**
+ * Sets the maximum file size of local files for which
+ * previews will be generated (if enabled). A value of 0
+ * indicates no file size limit.
+ * Per default the value from KConfigGroup "PreviewSettings"
+ * MaximumSize is used, 0 otherwise.
+ * @param size
+ */
+ void setLocalFileSizePreviewLimit(qlonglong size);
+ qlonglong localFileSizePreviewLimit() const;
+
+ /**
+ * If set to true, directories contents are scanned to determine their size
+ * Default true
+ */
+ void setScanDirectories(bool enabled);
+ bool scanDirectories() const;
+
+ /**
+ * Notifies the updater of a change in the hover state on an item.
+ *
+ * This will trigger asynchronous loading of the next few thumb sequence images
+ * using a PreviewJob.
+ *
+ * @param item URL of the item that is hovered, or an empty URL if no item is hovered.
+ * @param seqIdx The current hover sequence index. While an item is hovered,
+ * this method will be called repeatedly with increasing values
+ * for this parameter.
+ */
+ void setHoverSequenceState(const QUrl& itemUrl, int seqIdx);
+
+private Q_SLOTS:
void slotItemsInserted(const KItemRangeList& itemRanges);
void slotItemsRemoved(const KItemRangeList& itemRanges);
void slotItemsMoved(const KItemRange& itemRange, const QList<int> &movedToIndexes);
/**
* Is invoked after a preview has been received successfully.
+ *
+ * Note that this is not called for hover sequence previews.
+ *
* @see startPreviewJob()
*/
void slotGotPreview(const KFileItem& item, const QPixmap& pixmap);
/**
* Is invoked after generating a preview has failed.
+ *
+ * Note that this is not called for hover sequence previews.
+ *
* @see startPreviewJob()
*/
void slotPreviewFailed(const KFileItem& item);
/**
* Is invoked when the preview job has been finished. Starts a new preview
* job if there are any interesting items without previews left, or updates
- * the changed items otherwise. *
+ * the changed items otherwise.
+ *
+ * Note that this is not called for hover sequence previews.
+ *
* @see startPreviewJob()
*/
void slotPreviewJobFinished();
+ /**
+ * Is invoked after a hover sequence preview has been received successfully.
+ */
+ void slotHoverSequenceGotPreview(const KFileItem& item, const QPixmap& pixmap);
+
+ /**
+ * Is invoked after generating a hover sequence preview has failed.
+ */
+ void slotHoverSequencePreviewFailed(const KFileItem& item);
+
+ /**
+ * Is invoked when a hover sequence preview job is finished. May start another
+ * job for the next sequence index right away by calling
+ * \a loadNextHoverSequencePreview().
+ *
+ * Note that a PreviewJob will only ever generate a single sequence image, due
+ * to limitations of the PreviewJob API.
+ */
+ void slotHoverSequencePreviewJobFinished();
+
/**
* Is invoked when one of the KOverlayIconPlugin emit the signal that an overlay has changed
*/
*/
void startPreviewJob();
+ /**
+ * Transforms a raw preview image, applying scale and frame.
+ *
+ * @param pixmap A raw preview image from a PreviewJob.
+ * @return The scaled and decorated preview image.
+ */
+ QPixmap transformPreviewPixmap(const QPixmap& pixmap);
+
+ /**
+ * Starts a PreviewJob for loading the next hover sequence image.
+ */
+ void loadNextHoverSequencePreview();
+
+ /**
+ * Aborts the currently running hover sequence PreviewJob (if any).
+ */
+ void killHoverSequencePreviewJob();
+
/**
* Ensures that icons, previews, and other roles are determined for any
* items that have been changed.
bool applyResolvedRoles(int index, ResolveHint hint);
QHash<QByteArray, QVariant> rolesData(const KFileItem& item);
- /**
- * @return The number of items of the path \a path.
- */
- int subItemsCount(const QString& path) const;
-
/**
* Must be invoked if a property has been changed that affects
* the look of the preview. Takes care to update all previews.
QList<int> indexesToResolve() const;
+ void trimHoverSequenceLoadedItems();
+
private:
enum State {
Idle,
QSet<QByteArray> m_roles;
QSet<QByteArray> m_resolvableRoles;
QStringList m_enabledPlugins;
+ qulonglong m_localFileSizePreviewLimit;
+ bool m_scanDirectories;
// Items for which the sort role still has to be determined.
QSet<KFileItem> m_pendingSortRoleItems;
KIO::PreviewJob* m_previewJob;
+ // Info about the item that the user currently hovers, and the current sequence
+ // index for thumb generation.
+ KFileItem m_hoverSequenceItem;
+ int m_hoverSequenceIndex;
+ KIO::PreviewJob* m_hoverSequencePreviewJob;
+ int m_hoverSequenceNumSuccessiveFailures;
+ std::list<KFileItem> m_hoverSequenceLoadedItems;
+
// When downloading or copying large files, the slot slotItemsChanged()
// will be called periodically within a quite short delay. To prevent
// a high CPU-load by generating e.g. previews for each notification, the update
};
#endif
-
-
projects / dolphin.git / blobdiff