demos/qtdemo/examplecontent.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2015 The Qt Company Ltd.
   4 ** Contact: http://www.qt.io/licensing/
   5 **
   6 ** This file is part of the demonstration applications of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and The Qt Company. For licensing terms
  14 ** and conditions see http://www.qt.io/terms-conditions. For further
  15 ** information use the contact form at http://www.qt.io/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 or version 3 as published by the Free
  20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
  21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
  22 ** following information to ensure the GNU Lesser General Public License
  23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
  24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  25 **
  26 ** As a special exception, The Qt Company gives you certain additional
  27 ** rights. These rights are described in The Qt Company LGPL Exception
  28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  29 **
  30 ** GNU General Public License Usage
  31 ** Alternatively, this file may be used under the terms of the GNU
  32 ** General Public License version 3.0 as published by the Free Software
  33 ** Foundation and appearing in the file LICENSE.GPL included in the
  34 ** packaging of this file.  Please review the following information to
  35 ** ensure the GNU General Public License version 3.0 requirements will be
  36 ** met: http://www.gnu.org/copyleft/gpl.html.
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #include "examplecontent.h"
  43 #include "colors.h"
  44 #include "menumanager.h"
  45 #include "imageitem.h"
  46 #include "headingitem.h"
  47
  48 ExampleContent::ExampleContent(const QString &name, QGraphicsScene *scene, QGraphicsItem *parent)
  49     : DemoItem(scene, parent)
  50 {
  51     this->name = name;
  52     this->heading = 0;
  53     this->description = 0;
  54     this->screenshot = 0;
  55 }
  56
  57 void ExampleContent::prepare()
  58 {
  59     if (!this->prepared){
  60         this->prepared = true;
  61         this->createContent();
  62     }
  63 }
  64
  65 void ExampleContent::animationStopped(int id)
  66 {
  67     if (id == DemoItemAnimation::ANIM_OUT){
  68         // Free up some memory:
  69         delete this->heading;
  70         delete this->description;
  71         delete this->screenshot;
  72         this->heading = 0;
  73         this->description = 0;
  74         this->screenshot = 0;
  75         this->prepared = false;
  76     }
  77 }
  78
  79 QString ExampleContent::loadDescription()
  80 {
  81     QByteArray ba = MenuManager::instance()->getHtml(this->name);
  82     QString errorMsg;
  83     int errorLine, errorColumn;
  84
  85     QDomDocument exampleDoc;
  86     if (ba.isEmpty()) {
  87         qDebug() << "No documentation found for" << name << "Is the documentation built?";
  88     } else if (!exampleDoc.setContent(ba, false, &errorMsg, &errorLine, &errorColumn)) {
  89         qDebug() << "Error loading documentation for " << name << ": " << errorMsg << errorLine << errorColumn;
  90     }
  91
  92     QDomNodeList paragraphs = exampleDoc.elementsByTagName("p");
  93     if (paragraphs.length() < 1 && Colors::verbose)
  94         qDebug() << "- ExampleContent::loadDescription(): Could not load description:"
  95                  << MenuManager::instance()->info[this->name]["docfile"];
  96     QString description = Colors::contentColor + QLatin1String("");
  97     //QLatin1String("Could not load description. Ensure that the documentation for Qt is built."); // QTBUG-12522: If there is no description why show an error to the user when qDebug above communications the issue (if it is indeed an issue at all) when demos are built?
  98     for (int p = 0; p < int(paragraphs.length()); ++p) {
  99         description = this->extractTextFromParagraph(paragraphs.item(p));
 100         if (this->isSummary(description)) {
 101             break;
 102         }
 103     }
 104     return Colors::contentColor + description;
 105 }
 106
 107 bool ExampleContent::isSummary(const QString &text)
 108 {
 109     return (!text.contains("[") &&
 110         text.indexOf(QRegExp(QString("(In )?((The|This) )?(%1 )?.*(tutorial|example|demo|application)").arg(this->name),
 111                              Qt::CaseInsensitive)) != -1);
 112 }
 113
 114 QString ExampleContent::extractTextFromParagraph(const QDomNode &parentNode)
 115 {
 116     QString description;
 117     QDomNode node = parentNode.firstChild();
 118
 119     while (!node.isNull()) {
 120         QString beginTag;
 121         QString endTag;
 122         if (node.isText())
 123             description += Colors::contentColor + node.nodeValue();
 124         else if (node.hasChildNodes()) {
 125             if (node.nodeName() == "b") {
 126                 beginTag = "<b>";
 127                 endTag = "</b>";
 128             } else if (node.nodeName() == "a") {
 129                 beginTag = Colors::contentColor;
 130                 endTag = "</font>";
 131             } else if (node.nodeName() == "i") {
 132                 beginTag = "<i>";
 133                 endTag = "</i>";
 134             } else if (node.nodeName() == "tt") {
 135                 beginTag = "<tt>";
 136                 endTag = "</tt>";
 137             }
 138             description += beginTag + this->extractTextFromParagraph(node) + endTag;
 139         }
 140         node = node.nextSibling();
 141     }
 142
 143     return description;
 144 }
 145
 146 void ExampleContent::createContent()
 147 {
 148     // Create the items:
 149     this->heading = new HeadingItem(this->name, this->scene(), this);
 150     this->description = new DemoTextItem(this->loadDescription(), Colors::contentFont(),
 151         Colors::heading, 500, this->scene(), this);
 152     int imgHeight = 340 - int(this->description->boundingRect().height()) + 50;
 153     this->screenshot = new ImageItem(QImage::fromData(MenuManager::instance()->getImage(this->name)),
 154           550, imgHeight, this->scene(), this);
 155
 156     // Place the items on screen:
 157     this->heading->setPos(0, 3);
 158     this->description->setPos(0, this->heading->pos().y() + this->heading->boundingRect().height() + 10);
 159     this->screenshot->setPos(0, this->description->pos().y() + this->description->boundingRect().height() + 10);
 160 }
 161
 162 QRectF ExampleContent::boundingRect() const
 163 {
 164     return QRectF(0, 0, 500, 100);
 165 }
 166
 167