File indexing completed on 2024-10-06 09:40:12

 /*
     This file is part of the KDE libraries
     SPDX-FileCopyrightText: 2009 David Nolden <david.nolden.kdevelop@art-master.de>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef _THUMBSEQUENCECREATOR_H_
 #define _THUMBSEQUENCECREATOR_H_
 
 #include "thumbcreator.h"
 
 #if KIOWIDGETS_ENABLE_DEPRECATED_SINCE(5, 101)
 
 #include <qglobal.h>
 
 #include <memory>
 
 class ThumbSequenceCreatorPrivate;
 
 /**
  * @class ThumbSequenceCreator thumbsequencecreator.h <KIO/ThumbSequenceCreator>
  *
  * @see ThumbCreator
  *
  * This is an extension of ThumbCreator that allows creating a thumbnail sequence for
  * a file. If your thumbnail plugin can create a thumbnail sequence, you should base it
  * on ThumbSequenceCreator instead of ThumbCreator, and should use sequenceIndex()
  * to decide what thumbnail you generate.
  *
  * You also need to set the following key in the thumbcreator .desktop file
  * \code
  * HandleSequences=true;
  * \endcode
  *
  * @deprecated since 5.101, use KIO::ThumbnailCreator instead
  *
  * @since 4.3
  */
 // KF6 TODO: put this in the KIO namespace
 class KIOWIDGETS_EXPORT ThumbSequenceCreator : public ThumbCreator
 {
 public:
     Q_DISABLE_COPY(ThumbSequenceCreator)
 
     /**
      * @deprecated since 5.101, use KIO::ThumbnailCreator instead
      */
     KIOWIDGETS_DEPRECATED_VERSION(5, 101, "Use KIO::ThumbnailCreator instead")
     ThumbSequenceCreator();
     ~ThumbSequenceCreator() override;
 
     /**
      * If this thumb-creator can create a sequence of thumbnails,
      * it should use this to decide what sequence item to use.
      *
      * If the value is zero, the standard thumbnail should be created.
      *
      * This can be used for example to create thumbnails for different
      * timeframes in videos(For example 0m, 10m, 20m, ...).
      *
      * If your thumb-creator supports a high granularity, like a video,
      * you can respect the sub-integer precision coming from the float.
      * Else, just round the index to an integer.
      *
      * If the end of your sequence is reached, the sequence should start
      * from the beginning, or continue in some other way.
      */
     float sequenceIndex() const;
 
     /**
      * Sets the sequence-index for this thumb creator.
      * @see sequenceIndex
      */
     void setSequenceIndex(float index);
 
     /**
      * Returns the point at which this thumb-creator's sequence indices
      * will wrap around (loop).
      *
      * Usually, the frontend will call setSequenceIndex() with indices
      * that increase indefinitely with time, e.g. as long as the user
      * keeps hovering a video file. Most thumb-creators however only
      * want to display a finite sequence of thumbs, after which their
      * sequence repeats.
      *
      * This method can return the sequence index at which this
      * thumb-creator's sequence starts wrapping around to the start
      * again ("looping"). The frontend may use this to generate only
      * thumbs up to this index, and then use cached versions for the
      * repeating sequence instead.
      *
      * Like sequenceIndex(), fractional values can be used if the
      * wraparound does not happen at an integer position, but
      * frontends handling only integer sequence indices may choose
      * to round it down.
      *
      * By default, this method returns a negative index, which signals
      * the frontend that it can't rely on this fixed-length sequence.
      *
      * @since 5.80
      */
     float sequenceIndexWraparoundPoint() const;
 
 protected:
     /**
      * Sets the point at which this thumb-creator's sequence indices
      * will wrap around.
      *
      * @see sequenceIndexWraparoundPoint()
      * @since 5.80
      */
     void setSequenceIndexWraparoundPoint(float wraparoundPoint);
 
 private:
     std::unique_ptr<ThumbSequenceCreatorPrivate> d;
 };
 
 typedef ThumbCreator *(*newCreator)();
 
 #endif
 
 #endif