Qt 5.11 | Qt XML | SAX Bookmarks Example | xbelhandler.cpp Example File

Qt 5.11.3 Reference Documentation

# xbelhandler.cpp Example File

saxbookmarks/xbelhandler.cpp

      /****************************************************************************
      **
      ** 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 "xbelhandler.h"

      static inline QString versionAttribute() { return QStringLiteral("version"); }
      static inline QString hrefAttribute() { return QStringLiteral("href"); }
      static inline QString foldedAttribute() { return QStringLiteral("folded"); }

      XbelHandler::XbelHandler(QTreeWidget *treeWidget)
          : treeWidget(treeWidget)
      {
          item = 0;
          metXbelTag = false;

          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 XbelHandler::startElement(const QString & /* namespaceURI */,
                                     const QString & /* localName */,
                                     const QString &qName,
                                     const QXmlAttributes &attributes)
      {
          if (!metXbelTag && qName != QLatin1String("xbel")) {
              errorStr = QObject::tr("The file is not an XBEL file.");
              return false;
          }

          if (qName == QLatin1String("xbel")) {
              QString version = attributes.value(versionAttribute());
              if (!version.isEmpty() && version != QLatin1String("1.0")) {
                  errorStr = QObject::tr("The file is not an XBEL version 1.0 file.");
                  return false;
              }
              metXbelTag = true;
          } else if (qName == QLatin1String("folder")) {
              item = createChildItem(qName);
              item->setFlags(item->flags() | Qt::ItemIsEditable);
              item->setIcon(0, folderIcon);
              item->setText(0, QObject::tr("Folder"));
              bool folded = (attributes.value(foldedAttribute()) != QLatin1String("no"));
              treeWidget->setItemExpanded(item, !folded);
          } else if (qName == QLatin1String("bookmark")) {
              item = createChildItem(qName);
              item->setFlags(item->flags() | Qt::ItemIsEditable);
              item->setIcon(0, bookmarkIcon);
              item->setText(0, QObject::tr("Unknown title"));
              item->setText(1, attributes.value(hrefAttribute()));
          } else if (qName == QLatin1String("separator")) {
              item = createChildItem(qName);
              item->setFlags(item->flags() & ~Qt::ItemIsSelectable);
              item->setText(0, QString(30, 0xB7));
          }

          currentText.clear();
          return true;
      }

      bool XbelHandler::endElement(const QString & /* namespaceURI */,
                                   const QString & /* localName */,
                                   const QString &qName)
      {
          if (qName == QLatin1String("title")) {
              if (item)
                  item->setText(0, currentText);
          } else if (qName == QLatin1String("folder") || qName == QLatin1String("bookmark")
                     || qName == QLatin1String("separator")) {
              item = item->parent();
          }
          return true;
      }

      bool XbelHandler::characters(const QString &str)
      {
          currentText += str;
          return true;
      }

      bool XbelHandler::fatalError(const QXmlParseException &exception)
      {
          QMessageBox::information(treeWidget->window(), QObject::tr("SAX Bookmarks"),
                                   QObject::tr("Parse error at line %1, column %2:\n"
                                               "%3")
                                   .arg(exception.lineNumber())
                                   .arg(exception.columnNumber())
                                   .arg(exception.message()));
          return false;
      }

      QString XbelHandler::errorString() const
      {
          return errorStr;
      }

      QTreeWidgetItem *XbelHandler::createChildItem(const QString &tagName)
      {
          QTreeWidgetItem *childItem;
          if (item) {
              childItem = new QTreeWidgetItem(item);
          } else {
              childItem = new QTreeWidgetItem(treeWidget);
          }
          childItem->setData(0, Qt::UserRole, tagName);
          return childItem;
      }