src/plugins/help/xbelsupport.h

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (qt-info@nokia.com)
   8 **
   9 ** No Commercial Usage
  10 **
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 **
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Nokia gives you certain additional
  26 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** If you have questions regarding the use of this file, please contact
  30 ** Nokia at qt-info@nokia.com.
  31 **
  32 **************************************************************************/
  33
  34 #ifndef XBELSUPPORT_H
  35 #define XBELSUPPORT_H
  36
  37 #include <QtGui/QIcon>
  38 #include <QtXml/QXmlStreamReader>
  39
  40 QT_FORWARD_DECLARE_CLASS(QIODevice)
  41 QT_FORWARD_DECLARE_CLASS(QStandardItem)
  42
  43 class BookmarkModel;
  44
  45 namespace Help {
  46 namespace Internal {
  47
  48 class XbelWriter : public QXmlStreamWriter
  49 {
  50 public:
  51     XbelWriter(BookmarkModel *model);
  52     void writeToFile(QIODevice *device);
  53
  54 private:
  55     void writeData(QStandardItem *item);
  56
  57 private:
  58     BookmarkModel *treeModel;
  59 };
  60
  61 class XbelReader : public QXmlStreamReader
  62 {
  63 public:
  64     XbelReader(BookmarkModel *tree, BookmarkModel *list);
  65     bool readFromFile(QIODevice *device);
  66
  67 private:
  68     void readXBEL();
  69     void readUnknownElement();
  70     void readFolder(QStandardItem *item);
  71     void readBookmark(QStandardItem *item);
  72     QStandardItem* createChildItem(QStandardItem *item);
  73
  74 private:
  75     QIcon folderIcon;
  76     QIcon bookmarkIcon;
  77
  78     BookmarkModel *treeModel;
  79     BookmarkModel *listModel;
  80 };
  81
  82     }   // Internal
  83 }   // Help
  84
  85 #endif  // XBELSUPPORT_H