File indexing completed on 2024-06-23 05:06:55

 /*
     SPDX-FileCopyrightText: 2014 Christian Mollekopf <mollekopf@kolabsys.com>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #pragma once
 
 #include "akonadicore_export.h"
 
 #include <QSharedPointer>
 
 namespace Akonadi
 {
 class TagFetchScopePrivate;
 
 /**
  * @short Specifies which parts of a tag should be fetched from the Akonadi storage.
  *
  * @since 4.13
  */
 class AKONADICORE_EXPORT TagFetchScope
 {
 public:
     /**
      * Creates an empty tag fetch scope.
      *
      * Using an empty scope will only fetch the very basic meta data of tags,
      * e.g. local id, remote id and mime type
      */
     TagFetchScope();
 
     /**
      * Creates a new tag fetch scope from an @p other.
      */
     TagFetchScope(const TagFetchScope &other);
 
     /**
      * Destroys the tag fetch scope.
      */
     ~TagFetchScope();
 
     /**
      * Assigns the @p other to this scope and returns a reference to this scope.
      */
     TagFetchScope &operator=(const TagFetchScope &other);
 
     /**
      * Returns all explicitly fetched attributes.
      *
      * Undefined if fetchAllAttributes() returns true.
      *
      * @see fetchAttribute()
      */
     [[nodiscard]] QSet<QByteArray> attributes() const;
 
     /**
      * Sets whether to fetch tag remote ID.
      *
      * This option only has effect for Resources.
      */
     void setFetchRemoteId(bool fetchRemoteId);
 
     /**
      * Returns whether tag remote ID should be fetched.
      */
     [[nodiscard]] bool fetchRemoteId() const;
 
     /**
      * Sets whether to fetch all attributes.
      */
     void setFetchAllAttributes(bool fetchAllAttributes);
 
     /**
      * Returns whether to fetch all attributes
      */
     [[nodiscard]] bool fetchAllAttributes() const;
 
     /**
      * Sets whether the attribute of the given @p type should be fetched.
      *
      * @param type The attribute type to fetch.
      * @param fetch @c true if the attribute should be fetched, @c false otherwise.
      */
     void fetchAttribute(const QByteArray &type, bool fetch = true);
 
     /**
      * Sets whether the attribute of the requested type should be fetched.
      *
      * @param fetch @c true if the attribute should be fetched, @c false otherwise.
      */
     template<typename T>
     inline void fetchAttribute(bool fetch = true)
     {
         T dummy;
         fetchAttribute(dummy.type(), fetch);
     }
 
     /**
      * Sets whether only the id or the complete tag should be fetched.
      *
      * The default is @c false.
      *
      * @since 4.15
      */
     void setFetchIdOnly(bool fetchIdOnly);
 
     /**
      * Sets whether only the id of the tags should be retrieved or the complete tag.
      *
      * @see tagFetchScope()
      * @since 4.15
      */
     [[nodiscard]] bool fetchIdOnly() const;
 
 private:
     /// @cond PRIVATE
     QSharedPointer<TagFetchScopePrivate> d;
     /// @endcond
 };
 
 }
 
 // Q_DECLARE_METATYPE(Akonadi::TagFetchScope)