File indexing completed on 2025-01-05 03:53:36

 /* ============================================================
  *
  * This file is a part of digiKam project
  * https://www.digikam.org
  *
  * Date        : 2011-03-22
  * Description : a Iface C++ interface
  *
  * SPDX-FileCopyrightText: 2011-2024 by Gilles Caulier <caulier dot gilles at gmail dot com>
  * SPDX-FileCopyrightText: 2011      by Ludovic Delfau <ludovicdelfau at gmail dot com>
  *
  * SPDX-License-Identifier: GPL-2.0-or-later
  *
  * ============================================================ */
 
 #ifndef DIGIKAM_MEDIAWIKI_QUERYIMAGEINFO_H
 #define DIGIKAM_MEDIAWIKI_QUERYIMAGEINFO_H
 
 // Qt includes
 
 #include <QList>
 
 // Local includes
 
 #include "mediawiki_imageinfo.h"
 #include "mediawiki_job.h"
 
 namespace MediaWiki
 {
 
 class Iface;
 class QueryImageinfoPrivate;
 
 /**
  * @brief Query image info job.
  *
  * Gets image information for an image.
  */
 class QueryImageinfo : public Job
 {
     Q_OBJECT
     Q_DECLARE_PRIVATE(QueryImageinfo)
 
 public:
 
     /**
     * @brief Property.
     */
     enum Property
     {
         Timestamp = 0x01,
         User      = 0x02,
         Comment   = 0x04,
         Url       = 0x08,
         Size      = 0x10,
         Sha1      = 0x20,
         Mime      = 0x40,
         Metadata  = 0x80
     };
     Q_DECLARE_FLAGS(Properties, Property)
 
 public:
 
     /**
      * @brief Constructs a query image info job.
      *
      * You can set parameters of the query after.
      *
      * By default, a single image info is returned.
      *
      * @param MediaWiki the MediaWiki concerned by the job
      * @param parent the QObject parent
      */
     explicit QueryImageinfo(Iface& MediaWiki, QObject* const parent = nullptr);
 
     /**
      * @brief Destructs a query image info job.
      */
     ~QueryImageinfo() override;
 
     /**
      * @brief Set the title of the image requested.
      * @param title the title of the image requested
      */
     void setTitle(const QString& title);
 
     /**
      * @brief Set which properties to get.
      * @param properties the properties to get
      */
     void setProperties(Properties properties);
 
     /**
      * @brief Set how many image info to return per signal.
      * @param limit how many image info to return per signal
      */
     void setLimit(unsigned int limit);
 
     /**
      * @brief If true stop the request to the first signal.
      * @param onlyOneSignal if true stop the request to the first signal
      */
     void setOnlyOneSignal(bool onlyOneSignal);
 
     /**
      * @brief Set timestamp to start listing from.
      * @param begin timestamp to start listing from
      */
     void setBeginTimestamp(const QDateTime& begin);
 
     /**
      * @brief Set timestamp to stop listing at.
      * @param end timestamp to stop listing at
      */
     void setEndTimestamp(const QDateTime& end);
 
     /**
      * @brief Set width scale.
      *
      * Only for the first image info. The property URL must be set.
      *
      * @param width the width scale
      */
     void setWidthScale(unsigned int width);
 
     /**
      * @brief Set height scale.
      *
      * Only for the first image info. The property URL must be set.
      *
      * @param height the height scale
      */
     void setHeightScale(unsigned int height);
 
     /**
      * @brief Starts the job asynchronously.
      */
     void start() override;
 
 Q_SIGNALS:
 
     /**
     * @brief Provides a list of imageinfos.
     * @param imageinfos a list of imageinfos
     */
     void result(const QList<Imageinfo>& imageinfos);
 
 private Q_SLOTS:
 
     void doWorkSendRequest();
     void doWorkProcessReply();
 };
 
 Q_DECLARE_OPERATORS_FOR_FLAGS(QueryImageinfo::Properties)
 
 } // namespace MediaWiki
 
 #endif // DIGIKAM_MEDIAWIKI_QUERYIMAGEINFO_H