xbelreader.cpp Example File

  /****************************************************************************
  **
  ** Copyright (C) 2016 The Qt Company Ltd.
  ** Contact: https://www.qt.io/licensing/
  **
  ** This file is part of the examples of the Qt Toolkit.
  **
  ** $QT_BEGIN_LICENSE:BSD$
  ** Commercial License Usage
  ** Licensees holding valid commercial Qt licenses may use this file in
  ** accordance with the commercial license agreement provided with the
  ** Software or, alternatively, in accordance with the terms contained in
  ** a written agreement between you and The Qt Company. For licensing terms
  ** and conditions see https://www.qt.io/terms-conditions. For further
  ** information use the contact form at https://www.qt.io/contact-us.
  **
  ** BSD License Usage
  ** Alternatively, you may use this file under the terms of the BSD license
  ** as follows:
  **
  ** "Redistribution and use in source and binary forms, with or without
  ** modification, are permitted provided that the following conditions are
  ** met:
  **   * Redistributions of source code must retain the above copyright
  **     notice, this list of conditions and the following disclaimer.
  **   * Redistributions in binary form must reproduce the above copyright
  **     notice, this list of conditions and the following disclaimer in
  **     the documentation and/or other materials provided with the
  **     distribution.
  **   * Neither the name of The Qt Company Ltd nor the names of its
  **     contributors may be used to endorse or promote products derived
  **     from this software without specific prior written permission.
  **
  **
  ** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  ** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  ** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  ** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  ** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  ** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  ** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  ** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  ** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  ** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  ** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
  **
  ** $QT_END_LICENSE$
  **
  ****************************************************************************/

  #include <QtWidgets>

  #include "xbelreader.h"

  XbelReader::XbelReader(QTreeWidget *treeWidget)
      : treeWidget(treeWidget)
  {
      QStyle *style = treeWidget->style();

      folderIcon.addPixmap(style->standardPixmap(QStyle::SP_DirClosedIcon),
                           QIcon::Normal, QIcon::Off);
      folderIcon.addPixmap(style->standardPixmap(QStyle::SP_DirOpenIcon),
                           QIcon::Normal, QIcon::On);
      bookmarkIcon.addPixmap(style->standardPixmap(QStyle::SP_FileIcon));
  }

  bool XbelReader::read(QIODevice *device)
  {
      xml.setDevice(device);

      if (xml.readNextStartElement()) {
          if (xml.name() == "xbel" && xml.attributes().value("version") == "1.0")
              readXBEL();
          else
              xml.raiseError(QObject::tr("The file is not an XBEL version 1.0 file."));
      }

      return !xml.error();
  }

  QString XbelReader::errorString() const
  {
      return QObject::tr("%1\nLine %2, column %3")
              .arg(xml.errorString())
              .arg(xml.lineNumber())
              .arg(xml.columnNumber());
  }

  void XbelReader::readXBEL()
  {
      Q_ASSERT(xml.isStartElement() && xml.name() == "xbel");

      while (xml.readNextStartElement()) {
          if (xml.name() == "folder")
              readFolder(0);
          else if (xml.name() == "bookmark")
              readBookmark(0);
          else if (xml.name() == "separator")
              readSeparator(0);
          else
              xml.skipCurrentElement();
      }
  }

  void XbelReader::readTitle(QTreeWidgetItem *item)
  {
      Q_ASSERT(xml.isStartElement() && xml.name() == "title");

      QString title = xml.readElementText();
      item->setText(0, title);
  }

  void XbelReader::readSeparator(QTreeWidgetItem *item)
  {
      Q_ASSERT(xml.isStartElement() && xml.name() == "separator");

      QTreeWidgetItem *separator = createChildItem(item);
      separator->setFlags(item->flags() & ~Qt::ItemIsSelectable);
      separator->setText(0, QString(30, 0xB7));
      xml.skipCurrentElement();
  }

  void XbelReader::readFolder(QTreeWidgetItem *item)
  {
      Q_ASSERT(xml.isStartElement() && xml.name() == "folder");

      QTreeWidgetItem *folder = createChildItem(item);
      bool folded = (xml.attributes().value("folded") != "no");
      treeWidget->setItemExpanded(folder, !folded);

      while (xml.readNextStartElement()) {
          if (xml.name() == "title")
              readTitle(folder);
          else if (xml.name() == "folder")
              readFolder(folder);
          else if (xml.name() == "bookmark")
              readBookmark(folder);
          else if (xml.name() == "separator")
              readSeparator(folder);
          else
              xml.skipCurrentElement();
      }
  }

  void XbelReader::readBookmark(QTreeWidgetItem *item)
  {
      Q_ASSERT(xml.isStartElement() && xml.name() == "bookmark");

      QTreeWidgetItem *bookmark = createChildItem(item);
      bookmark->setFlags(bookmark->flags() | Qt::ItemIsEditable);
      bookmark->setIcon(0, bookmarkIcon);
      bookmark->setText(0, QObject::tr("Unknown title"));
      bookmark->setText(1, xml.attributes().value("href").toString());

      while (xml.readNextStartElement()) {
          if (xml.name() == "title")
              readTitle(bookmark);
          else
              xml.skipCurrentElement();
      }
  }

  QTreeWidgetItem *XbelReader::createChildItem(QTreeWidgetItem *item)
  {
      QTreeWidgetItem *childItem;
      if (item) {
          childItem = new QTreeWidgetItem(item);
      } else {
          childItem = new QTreeWidgetItem(treeWidget);
      }
      childItem->setData(0, Qt::UserRole, xml.name().toString());
      return childItem;
  }