File indexing completed on 2024-04-28 15:39:59

 // SPDX-FileCopyrightText: 2022 Johannes Zarl-Zierl <johannes@zarl-zierl.at>
 //
 //  SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
 
 #ifndef DB_TAGINFO_H
 #define DB_TAGINFO_H
 
 #include "Category.h"
 
 #include <QObject>
 
 namespace DB
 {
 class Category;
 
 /**
  * @brief The TagInfo class is a convenience class to bundle category and tag into a single object.
  * Instead of a pair of QStrings, this interface keeps a connection to the category object to update the tag name if a tag is renamed.
  */
 class TagInfo : public QObject
 {
     Q_OBJECT
 public:
     TagInfo();
     /**
      * @brief TagInfo
      * The TagInfo is parented to the DB::Category.
      *
      * @param category a valid category
      * @param tag a valid tag within the given category
      */
     TagInfo(Category *category, const QString &tag);
 
     /**
      * @brief category
      * @return A pointer to the DB::Category object for the tag.
      */
     Category *category() const;
     /**
      * @brief categoryName is a pure convenience function.
      * @return The category name, or an empty string if the TagInfo is null.
      */
     QString categoryName() const;
     /**
      * @brief tagName returns the name of the tag.
      * If you store the TagInfo object for a longer time, the tag name may change to a different value (if a tag is renamed) and even be empty (if a tag is removed).
      * Make sure that you check for an empty tag name if you don't use the TagInfo immediately.
      * @return The tag string.
      */
     QString tagName() const;
 
     /**
      * @brief isValid can be used to determine whether the TagInfo is actually usable.
      * A valid TagInfo can become invalid if the DB::Category or the tag is deleted.
      *
      * @return \c true, if both category and tag have valid values, \c false otherwise.
      */
     bool isValid() const;
     /**
      * @brief isNull
      * @return \c true, if the TagInfo is default-constructed, \c false otherwise.
      */
     bool isNull() const;
 
 private:
     Category *m_category;
     QString m_tag;
 
 private Q_SLOTS:
     void updateTagName(const QString &oldName, const QString &newName);
     void removeTagName(const QString &name);
 };
 
 } // namespace DB
 
 #endif // DB_TAGINFO_H