File indexing completed on 2025-01-19 03:58:02

 /* ============================================================
  *
  * This file is a part of digiKam project
  * https://www.digikam.org
  *
  * Date        : 2017-05-15
  * Description : a node container for bookmarks
  *
  * SPDX-FileCopyrightText: 2017-2024 by Gilles Caulier <caulier dot gilles at gmail dot com>
  *
  * SPDX-License-Identifier: GPL-2.0-or-later
  *
  * ============================================================ */
 
 #ifndef DIGIKAM_BOOKMARK_NODE_H
 #define DIGIKAM_BOOKMARK_NODE_H
 
 // Qt includes
 
 #include <QObject>
 #include <QString>
 #include <QList>
 #include <QDateTime>
 #include <QIODevice>
 #include <QXmlStreamReader>
 #include <QXmlStreamWriter>
 
 namespace Digikam
 {
 
 class BookmarkNode : public QObject
 {
     Q_OBJECT
 
 public:
 
     enum Type
     {
         Root,
         Folder,
         Bookmark,
         Separator,
         RootFolder
     };
 
 public:
 
     explicit BookmarkNode(Type type = Root, BookmarkNode* const parent = nullptr);
     ~BookmarkNode() override;
 
     bool operator==(const BookmarkNode& other) const;
 
     Type type()                                const;
     void setType(Type type);
 
     QList<BookmarkNode*> children()            const;
     BookmarkNode*        parent()              const;
 
     void add(BookmarkNode* const child, int offset = -1);
     void remove(BookmarkNode* const child);
 
 public:
 
     QString   url;
     QString   title;
     QString   desc;
     QDateTime dateAdded;
     bool      expanded;
 
 private:
 
     // Disable
     BookmarkNode(const BookmarkNode&)            = delete;
     BookmarkNode& operator=(const BookmarkNode&) = delete;
 
 private:
 
     class Private;
     Private* const d;
 };
 
 // -----------------------------------------------------------
 
 class XbelReader : public QXmlStreamReader
 {
 public:
 
     explicit XbelReader();
 
     BookmarkNode* read(const QString& fileName);
     BookmarkNode* read(QIODevice* const device, bool addRootFolder = false);
 
 private:
 
     void readXBEL(BookmarkNode* const parent);
     void readTitle(BookmarkNode* const parent);
     void readDescription(BookmarkNode* const parent);
     void readSeparator(BookmarkNode* const parent);
     void readFolder(BookmarkNode* const parent);
     void readBookmarkNode(BookmarkNode* const parent);
 };
 
 // -----------------------------------------------------------
 
 class XbelWriter : public QXmlStreamWriter
 {
 public:
 
     explicit XbelWriter();
 
     bool write(const QString& fileName, const BookmarkNode* const root);
     bool write(QIODevice* const device, const BookmarkNode* const root);
 
 private:
 
     void writeItem(const BookmarkNode* const parent);
 };
 
 } // namespace Digikam
 
 #endif // DIGIKAM_BOOKMARK_NODE_H