diff options
49 files changed, 2 insertions, 3218 deletions
diff --git a/.gitignore b/.gitignore index 541c4bd5b..c592523a6 100644 --- a/.gitignore +++ b/.gitignore @@ -76,7 +76,6 @@ bin/patternist* bin/phonon* bin/qcollectiongenerator* bin/qdbus* -bin/qhelpconverter* bin/qhelpgenerator* bin/xmlpatterns* bin/cetest* diff --git a/src/assistant/assistant.pro b/src/assistant/assistant.pro index 799582a40..122a93b73 100644 --- a/src/assistant/assistant.pro +++ b/src/assistant/assistant.pro @@ -4,17 +4,14 @@ SUBDIRS += \ help \ assistant \ qhelpgenerator \ - qcollectiongenerator \ - qhelpconverter + qcollectiongenerator assistant.depends = help qhelpgenerator.depends = help qcollectiongenerator.depends = help -qhelpconverter.depends = help qtNomakeTools( \ assistant \ qhelpgenerator \ qcollectiongenerator \ - qhelpconverter \ ) diff --git a/src/assistant/assistant/doc/src/assistant-manual.qdoc b/src/assistant/assistant/doc/src/assistant-manual.qdoc index f29233233..cbd6ccde4 100644 --- a/src/assistant/assistant/doc/src/assistant-manual.qdoc +++ b/src/assistant/assistant/doc/src/assistant-manual.qdoc @@ -374,25 +374,6 @@ a semicolon, as shown in the following example: \snippet doc_src_assistant-manual.qdoc 4 - - \section1 Compatibility with Old Formats - - In Qt versions up to 4.3, the help system was based on Document Content File - (DCF) and Qt Assistant Documentation Profile (ADP) formats. - Unfortunately, the old file formats are not compatible with the new ones - that are described in this manual and that are used from Qt 4.4 on, also in Qt 5. - In general, the differences are not that big \mdash in most cases is the old - format is just a subset of the new one. One example is the \c namespace tag in - the Qt Help Project format, which was not part of the old format, but plays a vital - role in the new one. To help you to move to the new file format, we have created - a conversion wizard. - - The wizard is started by executing \c qhelpconverter. It guides you through the - conversion of different parts of the file and generates a new \c qch or \c qhcp - file. - - Once the wizard is finished and the files created, run the \c qhelpgenerator - or the \c qcollectiongenerator tool to generate the binary help files used by \QA. */ /* diff --git a/src/assistant/qhelpconverter/adpreader.cpp b/src/assistant/qhelpconverter/adpreader.cpp deleted file mode 100644 index 324b8cdc0..000000000 --- a/src/assistant/qhelpconverter/adpreader.cpp +++ /dev/null @@ -1,166 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#include <QRegExp> - -#include "adpreader.h" - -static bool versionIsAtLeast320(const QString &version) -{ - return QRegExp("\\d.\\d\\.\\d").exactMatch(version) - && (version[0] > '3' || (version[0] == '3' && version[2] >= '2')); -} - -QT_BEGIN_NAMESPACE - -void AdpReader::readData(const QByteArray &contents) -{ - clear(); - m_contents.clear(); - m_keywords.clear(); - m_properties.clear(); - m_files.clear(); - addData(contents); - while (!atEnd()) { - readNext(); - if (isStartElement()) { - if (name().toString().toLower() == QLatin1String("assistantconfig") - && versionIsAtLeast320(attributes().value(QLatin1String("version")).toString())) { - readProject(); - } else if (name().toString().toLower() == QLatin1String("dcf")) { - QString ref = attributes().value(QLatin1String("ref")).toString(); - addFile(ref); - m_contents.append(ContentItem(attributes().value(QLatin1String("title")).toString(), - ref, 0)); - readDCF(); - } else { - raiseError(); - } - } - } -} - -QList<ContentItem> AdpReader::contents() const -{ - return m_contents; -} - -QList<KeywordItem> AdpReader::keywords() const -{ - return m_keywords; -} - -QSet<QString> AdpReader::files() const -{ - return m_files; -} - -QMap<QString, QString> AdpReader::properties() const -{ - return m_properties; -} - -void AdpReader::readProject() -{ - while (!atEnd()) { - readNext(); - if (isStartElement()) { - QString s = name().toString().toLower(); - if (s == QLatin1String("profile")) { - readProfile(); - } else if (s == QLatin1String("dcf")) { - QString ref = attributes().value(QLatin1String("ref")).toString(); - addFile(ref); - m_contents.append(ContentItem(attributes().value(QLatin1String("title")).toString(), - ref, 0)); - readDCF(); - } else { - raiseError(); - } - } - } -} - -void AdpReader::readProfile() -{ - while (!atEnd()) { - readNext(); - if (isStartElement()) { - if (name().toString().toLower() == QLatin1String("property")) { - QString prop = attributes().value(QLatin1String("name")).toString().toLower(); - m_properties[prop] = readElementText(); - } else { - raiseError(); - } - } else if (isEndElement()) { - break; - } - } -} - -void AdpReader::readDCF() -{ - int depth = 0; - while (!atEnd()) { - readNext(); - QString str = name().toString().toLower(); - if (isStartElement()) { - if (str == QLatin1String("section")) { - QString ref = attributes().value(QLatin1String("ref")).toString(); - addFile(ref); - m_contents.append(ContentItem(attributes().value(QLatin1String("title")).toString(), - ref, ++depth)); - } else if (str == QLatin1String("keyword")) { - QString ref = attributes().value(QLatin1String("ref")).toString(); - addFile(ref); - m_keywords.append(KeywordItem(readElementText(), ref)); - } else { - raiseError(); - } - } else if (isEndElement()) { - if (str == QLatin1String("section")) - --depth; - else if (str == QLatin1String("dcf")) - break; - } - } -} - -void AdpReader::addFile(const QString &file) -{ - QString s = file; - if (s.startsWith(QLatin1String("./"))) - s = s.mid(2); - int i = s.indexOf(QLatin1Char('#')); - if (i > -1) - s = s.left(i); - if (!m_files.contains(s)) - m_files.insert(s); -} - -QT_END_NAMESPACE diff --git a/src/assistant/qhelpconverter/adpreader.h b/src/assistant/qhelpconverter/adpreader.h deleted file mode 100644 index d11660f1d..000000000 --- a/src/assistant/qhelpconverter/adpreader.h +++ /dev/null @@ -1,77 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#ifndef ADPREADER_H -#define ADPREADER_H - -#include <QtCore/QMap> -#include <QtCore/QSet> -#include <QtCore/QXmlStreamReader> - -QT_BEGIN_NAMESPACE - -struct ContentItem { - ContentItem(const QString &t, const QString &r, int d) - : title(t), reference(r), depth(d) {} - QString title; - QString reference; - int depth; -}; - -struct KeywordItem { - KeywordItem(const QString &k, const QString &r) - : keyword(k), reference(r) {} - QString keyword; - QString reference; -}; - -class AdpReader : public QXmlStreamReader -{ -public: - void readData(const QByteArray &contents); - QList<ContentItem> contents() const; - QList<KeywordItem> keywords() const; - QSet<QString> files() const; - - QMap<QString, QString> properties() const; - -private: - void readProject(); - void readProfile(); - void readDCF(); - void addFile(const QString &file); - - QMap<QString, QString> m_properties; - QList<ContentItem> m_contents; - QList<KeywordItem> m_keywords; - QSet<QString> m_files; -}; - -QT_END_NAMESPACE - -#endif diff --git a/src/assistant/qhelpconverter/assistant-128.png b/src/assistant/qhelpconverter/assistant-128.png Binary files differdeleted file mode 100644 index 7b9f47477..000000000 --- a/src/assistant/qhelpconverter/assistant-128.png +++ /dev/null diff --git a/src/assistant/qhelpconverter/assistant.png b/src/assistant/qhelpconverter/assistant.png Binary files differdeleted file mode 100644 index 2d7c47744..000000000 --- a/src/assistant/qhelpconverter/assistant.png +++ /dev/null diff --git a/src/assistant/qhelpconverter/conversionwizard.cpp b/src/assistant/qhelpconverter/conversionwizard.cpp deleted file mode 100644 index c69330e20..000000000 --- a/src/assistant/qhelpconverter/conversionwizard.cpp +++ /dev/null @@ -1,253 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#include <QtCore/QFileInfo> -#include <QtCore/QDir> -#include <QtCore/QVariant> -#include <QtCore/QTimer> -#include <QtWidgets/QApplication> -#include <QtGui/QMouseEvent> - -#include "conversionwizard.h" -#include "inputpage.h" -#include "generalpage.h" -#include "filterpage.h" -#include "identifierpage.h" -#include "pathpage.h" -#include "filespage.h" -#include "outputpage.h" -#include "finishpage.h" -#include "qhpwriter.h" -#include "qhcpwriter.h" -#include "helpwindow.h" - -QT_BEGIN_NAMESPACE - -ConversionWizard::ConversionWizard() -{ - setWindowIcon(QIcon(QLatin1String(":/qt-project.org/qhelpconverter/assistant.png"))); - setWindowTitle(tr("Help Conversion Wizard")); - setPixmap(QWizard::WatermarkPixmap, - QPixmap(QLatin1String(":/qt-project.org/qhelpconverter/assistant-128.png"))) ; - setOptions(QWizard::IndependentPages|QWizard::NoBackButtonOnLastPage - |QWizard::HaveHelpButton); - - m_inputPage = new InputPage(&m_adpReader); - setPage(Input_Page, m_inputPage); - - m_generalPage = new GeneralPage(); - setPage(General_Page, m_generalPage); - - m_filterPage = new FilterPage(); - setPage(Filter_Page, m_filterPage); - m_filterPage->setMaximumHeight(240); - - m_identifierPage = new IdentifierPage(); - setPage(Identifier_Page, m_identifierPage); - - m_pathPage = new PathPage(); - setPage(Path_Page, m_pathPage); - m_pathPage->setMaximumHeight(240); - - m_filesPage = new FilesPage(); - setPage(Files_Page, m_filesPage); - m_filesPage->setMaximumHeight(240); - - m_outputPage = new OutputPage(); - setPage(Output_Page, m_outputPage); - m_outputPage->setMaximumHeight(240); - - m_finishPage = new FinishPage(); - setPage(Finish_Page, m_finishPage); - m_finishPage->setMaximumHeight(240); - - connect(this, &QWizard::currentIdChanged, - this, &ConversionWizard::pageChanged); - - m_helpWindow = 0; - qApp->installEventFilter(this); - - QAbstractButton *btn = button(QWizard::HelpButton); - btn->setCheckable(true); - connect(btn, &QAbstractButton::toggled, - this, &ConversionWizard::showHelp); -} - -void ConversionWizard::setAdpFileName(const QString &fileName) -{ - setField(QLatin1String("adpFileName"), fileName); -} - -void ConversionWizard::initializePage(int id) -{ - switch (id) { - case Path_Page: { - QFileInfo fi(field(QLatin1String("adpFileName")).toString()); - m_pathPage->setPath(fi.absolutePath()); - break; - } - case Output_Page: { - QFileInfo fi(field(QLatin1String("adpFileName")).toString()); - m_outputPage->setPath(fi.absolutePath()); - setField(QLatin1String("ProjectFileName"), fi.baseName() - + QLatin1String(".qhp")); - setField(QLatin1String("CollectionFileName"), fi.baseName() - + QLatin1String(".qhcp")); - break; - } - } -} - -void ConversionWizard::pageChanged(int id) -{ - if (id == Files_Page) { - QApplication::setOverrideCursor(Qt::WaitCursor); - m_files.clear(); - QFileInfo fi(field(QLatin1String("adpFileName")).toString()); - QDir rootDir = fi.absolutePath(); - for (const QString &p : m_pathPage->paths()) { - QDir dir(p); - QString rel = rootDir.relativeFilePath(dir.absolutePath()); - if (!rel.isEmpty()) - rel.append(QLatin1Char('/')); - for (const QString &f : dir.entryList(m_pathPage->filters())) - m_files.append(rel + f); - } - m_filesPage->setFilesToRemove(getUnreferencedFiles(m_files)); - QApplication::restoreOverrideCursor(); - } else if (id == Output_Page) { - m_outputPage->setCollectionComponentEnabled( - !m_adpReader.properties().isEmpty()); - } else if (id == Finish_Page) { - QTimer::singleShot(300, this, &ConversionWizard::convert); - } -} - -void ConversionWizard::showHelp(bool toggle) -{ - int w = 180; - int h = 180; - if (!m_helpWindow) { - m_helpWindow = new HelpWindow(this); - m_helpWindow->setMaximumWidth(w); - m_helpWindow->setMaximumHeight(h); - m_helpWindow->setMinimumHeight(h); - } - - if (toggle) { - m_helpWindow->setHelp(currentPage()->objectName()); - QAbstractButton *btn = button(QWizard::HelpButton); - QPoint p = btn->pos(); - int x = p.x(); - if (btn->pos().x() > w) - x = p.x() + btn->width() - w; - m_helpWindow->move(x, p.y()-h); - m_helpWindow->show(); - } else { - m_helpWindow->hide(); - } -} - -bool ConversionWizard::eventFilter(QObject *obj, QEvent *e) -{ - if (m_helpWindow && m_helpWindow->isVisible()) { - if (obj != button(QWizard::HelpButton) - && e->type() == QEvent::MouseButtonRelease) { - QMouseEvent *me = static_cast<QMouseEvent*>(e); - if (!m_helpWindow->geometry().contains(mapFromParent(me->globalPos()))) { - m_helpWindow->hide(); - button(QWizard::HelpButton)->setChecked(false); - } - } else if (e->type() == QEvent::KeyPress) { - m_helpWindow->hide(); - button(QWizard::HelpButton)->setChecked(false); - } - } - return QWizard::eventFilter(obj, e); -} - -QStringList ConversionWizard::getUnreferencedFiles(const QStringList &files) -{ - QStringList lst; - const QSet<QString> &adpFiles = m_adpReader.files(); - for (const QString &s : files) { - if (!adpFiles.contains(s)) - lst.append(s); - } - return lst; -} - -void ConversionWizard::convert() -{ - QFileInfo fi(field(QLatin1String("adpFileName")).toString()); - m_finishPage->appendMessage(tr("Converting %1...") - .arg(fi.fileName())); - QApplication::setOverrideCursor(Qt::WaitCursor); - QString qhpFileName = field(QLatin1String("ProjectFileName")).toString(); - QhpWriter qhpWriter(field(QLatin1String("namespaceName")).toString(), - field(QLatin1String("virtualFolder")).toString()); - qhpWriter.setAdpReader(&m_adpReader); - qhpWriter.setFilterAttributes(m_filterPage->filterAttributes()); - qhpWriter.setCustomFilters(m_filterPage->customFilters()); - - for (const QString &f : m_filesPage->filesToRemove()) - m_files.removeAll(f); - qhpWriter.setFiles(m_files); - - if (field(QLatin1String("createIdentifier")).toBool()) { - if (field(QLatin1String("fileNamePrefix")).toBool()) - qhpWriter.generateIdentifiers(QhpWriter::FilePrefix); - else - qhpWriter.generateIdentifiers(QhpWriter::GlobalPrefix, - field(QLatin1String("globalPrefix")).toString()); - } else { - qhpWriter.generateIdentifiers(QhpWriter::SkipAll); - } - - qhpWriter.writeFile(fi.absolutePath() + QDir::separator() - + qhpFileName); - - m_finishPage->appendMessage(tr("Writing help collection file...")); - - if (!m_adpReader.properties().isEmpty()) { - QhcpWriter qhcpWriter; - qhcpWriter.setHelpProjectFile(qhpFileName); - qhcpWriter.setProperties(m_adpReader.properties()); - qhcpWriter.setTitlePath(QLatin1String("qthelp://") - + field(QLatin1String("namespaceName")).toString() - + QLatin1Char('/') - + field(QLatin1String("virtualFolder")).toString()); - qhcpWriter.writeFile(fi.absolutePath() + QDir::separator() - + field(QLatin1String("CollectionFileName")).toString()); - } - - m_finishPage->appendMessage(tr("Done.")); - QApplication::restoreOverrideCursor(); -} - -QT_END_NAMESPACE diff --git a/src/assistant/qhelpconverter/conversionwizard.h b/src/assistant/qhelpconverter/conversionwizard.h deleted file mode 100644 index 9c86f3e04..000000000 --- a/src/assistant/qhelpconverter/conversionwizard.h +++ /dev/null @@ -1,83 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#ifndef CONVERSIONWIZARD_H -#define CONVERSIONWIZARD_H - -#include <QtWidgets/QWizard> -#include "adpreader.h" - -QT_BEGIN_NAMESPACE - -class InputPage; -class GeneralPage; -class FilterPage; -class IdentifierPage; -class PathPage; -class FilesPage; -class OutputPage; -class FinishPage; -class HelpWindow; - -class ConversionWizard : public QWizard -{ - Q_OBJECT - -public: - ConversionWizard(); - void setAdpFileName(const QString &fileName); - -private slots: - void pageChanged(int id); - void showHelp(bool toggle); - void convert(); - -private: - enum Pages {Input_Page, General_Page, Filter_Page, - Identifier_Page, Path_Page, Files_Page, Output_Page, - Finish_Page}; - void initializePage(int id) override; - QStringList getUnreferencedFiles(const QStringList &files); - bool eventFilter(QObject *obj, QEvent *e) override; - - AdpReader m_adpReader; - InputPage *m_inputPage; - GeneralPage *m_generalPage; - FilterPage *m_filterPage; - IdentifierPage *m_identifierPage; - PathPage *m_pathPage; - FilesPage *m_filesPage; - OutputPage *m_outputPage; - FinishPage *m_finishPage; - QStringList m_files; - HelpWindow *m_helpWindow; -}; - -QT_END_NAMESPACE - -#endif diff --git a/src/assistant/qhelpconverter/doc/filespage.html b/src/assistant/qhelpconverter/doc/filespage.html deleted file mode 100644 index a7aac18da..000000000 --- a/src/assistant/qhelpconverter/doc/filespage.html +++ /dev/null @@ -1,8 +0,0 @@ -<html> -<body> -<p>Sometimes it can happen that the previously specified paths contain -more or other files than actually needed for the documentation.</p> -<p>This page lists all files which are likely to be unused because they -are neither referenced by any keyword nor be the TOC.</p> -</body> -</html> diff --git a/src/assistant/qhelpconverter/doc/filterpage.html b/src/assistant/qhelpconverter/doc/filterpage.html deleted file mode 100644 index f95f3b294..000000000 --- a/src/assistant/qhelpconverter/doc/filterpage.html +++ /dev/null @@ -1,13 +0,0 @@ -<html> -<body> -<p>The help system offers the possibility to filter all installed documentations -for certain <b>attributes</b>. Commonly specified attributes are e.g. the company -and product name as well as the product version.</p> -<p>The help engine and Assistant use <b>custom filters</b> to do the actual -documentation filtering. A custom filter is basically just a alias name for a -list of filter attributes. So, if e.g. the custom filter "MyFilter" lists -the attributes "mycompany, myproduct" then only the documentation with those -attributes will be shown.</p> -<p><b>Warning:</b> The filter attributes are case sensitive!</p> -</body> -</html> diff --git a/src/assistant/qhelpconverter/doc/generalpage.html b/src/assistant/qhelpconverter/doc/generalpage.html deleted file mode 100644 index 8d106bec1..000000000 --- a/src/assistant/qhelpconverter/doc/generalpage.html +++ /dev/null @@ -1,10 +0,0 @@ -<html> -<body> -<p>The <b>namespace</b> is needed to identify this documentation when having -several documentation sets installed in a collection.</p> -<p><b>Virtual</b> folders are used to enable file references between all -documents. Thereby, the virtual folder acts as the root path of all -documents, even if those are part of different documentation sets, -meaning listed under different namespaces.</p> -</body> -</html> diff --git a/src/assistant/qhelpconverter/doc/identifierpage.html b/src/assistant/qhelpconverter/doc/identifierpage.html deleted file mode 100644 index 714b51c56..000000000 --- a/src/assistant/qhelpconverter/doc/identifierpage.html +++ /dev/null @@ -1,17 +0,0 @@ -<html> -<body> -<p><b>Identifiers</b> are mostly used to make keywords unique, but they can also -be used to specify keywords which should not be shown in the index. Identifiers -are especially help full when using context sensitive help and one keyword has -more links assigned to it.</p> -<p>E.g. consider the keyword "replace" in Qt. It is -included, among others, in QString and QList. To be able to retrieve the proper -documentation, there is an identifier "QString::replace" and one -"QList::replace".</p> -<p>A <b>global prefix</b>, e.g. "MyApp::" is set for all keywords independent -where they are located. When <b>inheriting</b> the prefix from the file name, -the keywords get the prefix "[filename]::" where the file name is taken from the -reference of the keyword. The file name is just the base name, i.e. without any -directory or extension.</p> -</body> -</html> diff --git a/src/assistant/qhelpconverter/doc/inputpage.html b/src/assistant/qhelpconverter/doc/inputpage.html deleted file mode 100644 index 4054c5472..000000000 --- a/src/assistant/qhelpconverter/doc/inputpage.html +++ /dev/null @@ -1,7 +0,0 @@ -<html> -<body> -<p>Both, a .adp or .dcf file can be specified. If an .adp file is detected, -the wizard generates a Qt help collection file in addition to the help -project file.</p> -</body> -</html> diff --git a/src/assistant/qhelpconverter/doc/outputpage.html b/src/assistant/qhelpconverter/doc/outputpage.html deleted file mode 100644 index 332ef69fc..000000000 --- a/src/assistant/qhelpconverter/doc/outputpage.html +++ /dev/null @@ -1,7 +0,0 @@ -<html> -<body> -<p>The specified output files will be located in the same directory as the -.adp or .dcf file. The collection file will only be generated if the input -file was an .adp file.</p> -</body> -</html> diff --git a/src/assistant/qhelpconverter/doc/pathpage.html b/src/assistant/qhelpconverter/doc/pathpage.html deleted file mode 100644 index 95449b3c3..000000000 --- a/src/assistant/qhelpconverter/doc/pathpage.html +++ /dev/null @@ -1,8 +0,0 @@ -<html> -<body> -<p>The new help system uses, in contrast to the old Qt Assistant, compressed -help files containing all files (html files, images, stylesheets, ...) -necessary to display the documentation correctly.</p> -<p>To be able to find all those files, the source paths have to be given.</p> -</body> -</html> diff --git a/src/assistant/qhelpconverter/filespage.cpp b/src/assistant/qhelpconverter/filespage.cpp deleted file mode 100644 index 335a698f7..000000000 --- a/src/assistant/qhelpconverter/filespage.cpp +++ /dev/null @@ -1,99 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#include <QtGui/QKeyEvent> -#include "filespage.h" - -QT_BEGIN_NAMESPACE - -FilesPage::FilesPage(QWidget *parent) - : QWizardPage(parent) -{ - setTitle(tr("Unreferenced Files")); - setSubTitle(tr("Remove files which are neither referenced " - "by a keyword nor by the TOC.")); - - m_ui.setupUi(this); - m_ui.fileListWidget->setSelectionMode(QAbstractItemView::ExtendedSelection); - m_ui.fileListWidget->installEventFilter(this); - connect(m_ui.removeButton, &QAbstractButton::clicked, - this, &FilesPage::removeFile); - connect(m_ui.removeAllButton, &QAbstractButton::clicked, - this, &FilesPage::removeAllFiles); - - m_ui.fileLabel->setText(tr("<p><b>Warning:</b> " - "When removing images or stylesheets, be aware that those files " - "are not directly referenced by the .adp or .dcf " - "file.</p>")); -} - -void FilesPage::setFilesToRemove(const QStringList &files) -{ - m_files = files; - m_ui.fileListWidget->clear(); - m_ui.fileListWidget->addItems(files); -} - -QStringList FilesPage::filesToRemove() const -{ - return m_filesToRemove; -} - -void FilesPage::removeFile() -{ - int row = m_ui.fileListWidget->currentRow() - - m_ui.fileListWidget->selectedItems().count() + 1; - for (const QListWidgetItem *item : m_ui.fileListWidget->selectedItems()) { - m_filesToRemove.append(item->text()); - delete item; - } - if (m_ui.fileListWidget->count() > row && row >= 0) - m_ui.fileListWidget->setCurrentRow(row); - else - m_ui.fileListWidget->setCurrentRow(m_ui.fileListWidget->count()); -} - -void FilesPage::removeAllFiles() -{ - m_ui.fileListWidget->clear(); - m_filesToRemove = m_files; -} - -bool FilesPage::eventFilter(QObject *obj, QEvent *event) -{ - if (obj == m_ui.fileListWidget && event->type() == QEvent::KeyPress) { - QKeyEvent *ke = static_cast<QKeyEvent*>(event); - if (ke->key() == Qt::Key_Delete) { - removeFile(); - return true; - } - } - return QWizardPage::eventFilter(obj, event); -} - -QT_END_NAMESPACE diff --git a/src/assistant/qhelpconverter/filespage.h b/src/assistant/qhelpconverter/filespage.h deleted file mode 100644 index 3e0d6af3e..000000000 --- a/src/assistant/qhelpconverter/filespage.h +++ /dev/null @@ -1,60 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#ifndef FILESPAGE_H -#define FILESPAGE_H - -#include <QtWidgets/QWizardPage> -#include "ui_filespage.h" - -QT_BEGIN_NAMESPACE - -class FilesPage : public QWizardPage -{ - Q_OBJECT - -public: - FilesPage(QWidget *parent = 0); - void setFilesToRemove(const QStringList &files); - QStringList filesToRemove() const; - -private slots: - void removeFile(); - void removeAllFiles(); - -private: - bool eventFilter(QObject *obj, QEvent *event) override; - - Ui::FilesPage m_ui; - QStringList m_files; - QStringList m_filesToRemove; -}; - -QT_END_NAMESPACE - -#endif diff --git a/src/assistant/qhelpconverter/filespage.ui b/src/assistant/qhelpconverter/filespage.ui deleted file mode 100644 index d308b9664..000000000 --- a/src/assistant/qhelpconverter/filespage.ui +++ /dev/null @@ -1,79 +0,0 @@ -<ui version="4.0" > - <class>FilesPage</class> - <widget class="QWidget" name="FilesPage" > - <property name="geometry" > - <rect> - <x>0</x> - <y>0</y> - <width>417</width> - <height>242</height> - </rect> - </property> - <property name="windowTitle" > - <string>Form</string> - </property> - <layout class="QGridLayout" > - <item row="0" column="0" colspan="2" > - <widget class="QLabel" name="fileLabel" > - <property name="text" > - <string>Files:</string> - </property> - <property name="wordWrap" > - <bool>true</bool> - </property> - </widget> - </item> - <item rowspan="3" row="1" column="0" > - <widget class="QListWidget" name="fileListWidget" /> - </item> - <item row="1" column="1" > - <widget class="QPushButton" name="removeButton" > - <property name="sizePolicy" > - <sizepolicy vsizetype="Fixed" hsizetype="Maximum" > - <horstretch>0</horstretch> - <verstretch>0</verstretch> - </sizepolicy> - </property> - <property name="text" > - <string>Remove</string> - </property> - </widget> - </item> - <item row="2" column="1" > - <widget class="QPushButton" name="removeAllButton" > - <property name="text" > - <string>Remove All</string> - </property> - </widget> - </item> - <item row="3" column="1" > - <spacer> - <property name="orientation" > - <enum>Qt::Vertical</enum> - </property> - <property name="sizeHint" > - <size> - <width>75</width> - <height>16</height> - </size> - </property> - </spacer> - </item> - <item row="4" column="0" > - <spacer> - <property name="orientation" > - <enum>Qt::Vertical</enum> - </property> - <property name="sizeHint" > - <size> - <width>20</width> - <height>31</height> - </size> - </property> - </spacer> - </item> - </layout> - </widget> - <resources/> - <connections/> -</ui> diff --git a/src/assistant/qhelpconverter/filterpage.cpp b/src/assistant/qhelpconverter/filterpage.cpp deleted file mode 100644 index 0f0e7f1a6..000000000 --- a/src/assistant/qhelpconverter/filterpage.cpp +++ /dev/null @@ -1,134 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#include <QtWidgets/QMessageBox> -#include "filterpage.h" - -QT_BEGIN_NAMESPACE - -FilterPage::FilterPage(QWidget *parent) - : QWizardPage(parent) -{ - setTitle(tr("Filter Settings")); - setSubTitle(tr("Specify the filter attributes for the " - "documentation. If filter attributes are used, " - "also define a custom filter for it. Both the " - "filter attributes and the custom filters are " - "optional.")); - - m_ui.setupUi(this); - m_ui.customFilterWidget->headerItem()->setText(0, tr("Filter Name")); - m_ui.customFilterWidget->headerItem()->setText(1, tr("Filter Attributes")); - m_ui.customFilterWidget->setRootIsDecorated(false); - m_ui.removeButton->setDisabled(true); - connect(m_ui.addButton, &QAbstractButton::clicked, - this, &FilterPage::addFilter); - connect(m_ui.removeButton, &QAbstractButton::clicked, - this, &FilterPage::removeFilter); -} - -bool FilterPage::validatePage() -{ - m_filterAttributes.clear(); - for (const QString &f : m_ui.filterLineEdit->text().split(QLatin1Char(','))) { - if (!f.trimmed().isEmpty()) - m_filterAttributes.append(f.trimmed()); - } - - m_customFilters.clear(); - QSet<QString> names; - QSet<QString> atts; - QString str; - CustomFilter customFilter; - QTreeWidgetItem *item = 0; - for (int i = 0; i < m_ui.customFilterWidget->topLevelItemCount(); ++i) { - item = m_ui.customFilterWidget->topLevelItem(i); - str = item->text(0); - if (str.isEmpty() || names.contains(str)) { - QMessageBox::critical(this, tr("Custom Filters"), - tr("The custom filter \'%1\' is defined multiple times.") - .arg(str)); - return false; - } - names.insert(str); - customFilter.name = str; - - str.clear(); - QStringList lst; - for (const QString &s : item->text(1).split(QLatin1Char(','))) { - const QString st = s.trimmed(); - if (!st.isEmpty()) { - str += QLatin1Char(',') + st; - lst.append(st); - } - } - if (atts.contains(str)) { - QMessageBox::critical(this, tr("Custom Filters"), - tr("The attributes for custom filter \'%1\' are defined multiple times.") - .arg(customFilter.name)); - return false; - } - atts.insert(str); - customFilter.filterAttributes = lst; - m_customFilters.append(customFilter); - } - return true; -} - -QStringList FilterPage::filterAttributes() const -{ - return m_filterAttributes; -} - -QList<CustomFilter> FilterPage::customFilters() const -{ - return m_customFilters; -} - -void FilterPage::addFilter() -{ - QTreeWidgetItem *item = new QTreeWidgetItem(m_ui.customFilterWidget); - item->setFlags(Qt::ItemIsEnabled|Qt::ItemIsEditable|Qt::ItemIsSelectable); - item->setText(0, tr("unfiltered", "list of available documentation")); - item->setText(1, QString()); - m_ui.customFilterWidget->editItem(item, 0); - m_ui.removeButton->setDisabled(false); -} - -void FilterPage::removeFilter() -{ - QModelIndex idx = m_ui.customFilterWidget->currentIndex(); - if (!idx.isValid()) - return; - QTreeWidgetItem *item = m_ui.customFilterWidget->takeTopLevelItem(idx.row()); - delete item; - if (!m_ui.customFilterWidget->topLevelItemCount()) - m_ui.removeButton->setDisabled(true); -} - -QT_END_NAMESPACE diff --git a/src/assistant/qhelpconverter/filterpage.h b/src/assistant/qhelpconverter/filterpage.h deleted file mode 100644 index f6bf7797d..000000000 --- a/src/assistant/qhelpconverter/filterpage.h +++ /dev/null @@ -1,66 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#ifndef FILTERPAGE_H -#define FILTERPAGE_H - -#include <QtWidgets/QWizardPage> -#include "ui_filterpage.h" - -QT_BEGIN_NAMESPACE - -struct CustomFilter -{ - QString name; - QStringList filterAttributes; -}; - -class FilterPage : public QWizardPage -{ - Q_OBJECT - -public: - FilterPage(QWidget *parent = 0); - QStringList filterAttributes() const; - QList<CustomFilter> customFilters() const; - -private slots: - void addFilter(); - void removeFilter(); - -private: - bool validatePage() override; - - Ui::FilterPage m_ui; - QStringList m_filterAttributes; - QList<CustomFilter> m_customFilters; -}; - -QT_END_NAMESPACE - -#endif diff --git a/src/assistant/qhelpconverter/filterpage.ui b/src/assistant/qhelpconverter/filterpage.ui deleted file mode 100644 index 7cda3d9be..000000000 --- a/src/assistant/qhelpconverter/filterpage.ui +++ /dev/null @@ -1,125 +0,0 @@ -<ui version="4.0" > - <class>FilterPage</class> - <widget class="QWidget" name="FilterPage" > - <property name="geometry" > - <rect> - <x>0</x> - <y>0</y> - <width>419</width> - <height>243</height> - </rect> - </property> - <property name="windowTitle" > - <string>Form</string> - </property> - <layout class="QGridLayout" > - <item row="1" column="0" > - <widget class="QLabel" name="label" > - <property name="text" > - <string>Filter attributes for current documentation (comma separated list):</string> - </property> - </widget> - </item> - <item row="2" column="0" > - <widget class="QLineEdit" name="filterLineEdit" /> - </item> - <item row="4" column="0" > - <widget class="QGroupBox" name="groupBox" > - <property name="title" > - <string>Custom Filters</string> - </property> - <layout class="QGridLayout" > - <item rowspan="3" row="0" column="0" > - <widget class="QTreeWidget" name="customFilterWidget" > - <property name="columnCount" > - <number>2</number> - </property> - <column> - <property name="text" > - <string>1</string> - </property> - </column> - <column> - <property name="text" > - <string>2</string> - </property> - </column> - </widget> - </item> - <item row="0" column="1" > - <widget class="QPushButton" name="addButton" > - <property name="text" > - <string>Add</string> - </property> - </widget> - </item> - <item row="1" column="1" > - <widget class="QPushButton" name="removeButton" > - <property name="text" > - <string>Remove</string> - </property> - </widget> - </item> - <item row="2" column="1" > - <spacer> - <property name="orientation" > - <enum>Qt::Vertical</enum> - </property> - <property name="sizeHint" > - <size> - <width>20</width> - <height>40</height> - </size> - </property> - </spacer> - </item> - </layout> - </widget> - </item> - <item row="0" column="0" > - <spacer> - <property name="orientation" > - <enum>Qt::Vertical</enum> - </property> - <property name="sizeHint" > - <size> - <width>20</width> - <height>40</height> - </size> - </property> - </spacer> - </item> - <item row="5" column="0" > - <spacer> - <property name="orientation" > - <enum>Qt::Vertical</enum> - </property> - <property name="sizeHint" > - <size> - <width>20</width> - <height>40</height> - </size> - </property> - </spacer> - </item> - <item row="3" column="0" > - <spacer> - <property name="orientation" > - <enum>Qt::Vertical</enum> - </property> - <property name="sizeType" > - <enum>QSizePolicy::Fixed</enum> - </property> - <property name="sizeHint" > - <size> - <width>20</width> - <height>10</height> - </size> - </property> - </spacer> - </item> - </layout> - </widget> - <resources/> - <connections/> -</ui> diff --git a/src/assistant/qhelpconverter/finishpage.cpp b/src/assistant/qhelpconverter/finishpage.cpp deleted file mode 100644 index 49f1844d8..000000000 --- a/src/assistant/qhelpconverter/finishpage.cpp +++ /dev/null @@ -1,62 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#include <QtWidgets/QTextEdit> -#include <QtWidgets/QLayout> -#include <QtWidgets/QSpacerItem> -#include <QtWidgets/QApplication> - -#include "finishpage.h" - -QT_BEGIN_NAMESPACE - -FinishPage::FinishPage(QWidget *parent) - : QWizardPage(parent) -{ - setTitle(tr("Converting File")); - setSubTitle(tr("Creating the new Qt help files from the old ADP file.")); - setFinalPage(true); - - QVBoxLayout *layout = new QVBoxLayout(this); - layout->addItem(new QSpacerItem(20, 20, QSizePolicy::Minimum, - QSizePolicy::Fixed)); - - m_textEdit = new QTextEdit(); - layout->addWidget(m_textEdit); - - layout->addItem(new QSpacerItem(20, 40, QSizePolicy::Minimum, - QSizePolicy::Expanding)); -} - -void FinishPage::appendMessage(const QString &msg) -{ - m_textEdit->append(msg); - qApp->processEvents(); -} - -QT_END_NAMESPACE diff --git a/src/assistant/qhelpconverter/finishpage.h b/src/assistant/qhelpconverter/finishpage.h deleted file mode 100644 index cae09a687..000000000 --- a/src/assistant/qhelpconverter/finishpage.h +++ /dev/null @@ -1,52 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#ifndef FINISHPAGE_H -#define FINISHPAGE_H - -#include <QtWidgets/QWizardPage> - -QT_BEGIN_NAMESPACE - -class QTextEdit; - -class FinishPage : public QWizardPage -{ - Q_OBJECT - -public: - FinishPage(QWidget *parent = 0); - void appendMessage(const QString &msg); - -private: - QTextEdit *m_textEdit; -}; - -QT_END_NAMESPACE - -#endif diff --git a/src/assistant/qhelpconverter/generalpage.cpp b/src/assistant/qhelpconverter/generalpage.cpp deleted file mode 100644 index f31e5fa53..000000000 --- a/src/assistant/qhelpconverter/generalpage.cpp +++ /dev/null @@ -1,79 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#include <QtWidgets/QMessageBox> -#include "generalpage.h" - -QT_BEGIN_NAMESPACE - -GeneralPage::GeneralPage(QWidget *parent) - : QWizardPage(parent) -{ - setTitle(tr("General Settings")); - setSubTitle(tr("Specify the namespace and the virtual " - "folder for the documentation.")); - - m_ui.setupUi(this); - connect(m_ui.namespaceLineEdit, &QLineEdit::textChanged, - this, &QWizardPage::completeChanged); - connect(m_ui.folderLineEdit, &QLineEdit::textChanged, - this, &QWizardPage::completeChanged); - - m_ui.namespaceLineEdit->setText(QLatin1String("mycompany.com")); - m_ui.folderLineEdit->setText(QLatin1String("product_1.0")); - - registerField(QLatin1String("namespaceName"), m_ui.namespaceLineEdit); - registerField(QLatin1String("virtualFolder"), m_ui.folderLineEdit); -} - -bool GeneralPage::isComplete() const -{ - if (m_ui.namespaceLineEdit->text().isEmpty() - || m_ui.folderLineEdit->text().isEmpty()) - return false; - return true; -} - -bool GeneralPage::validatePage() -{ - QString s = m_ui.namespaceLineEdit->text(); - if (s.contains(QLatin1Char('/')) || s.contains(QLatin1Char('\\'))) { - QMessageBox::critical(this, tr("Namespace Error"), - tr("The namespace contains some invalid characters.")); - return false; - } - s = m_ui.folderLineEdit->text(); - if (s.contains(QLatin1Char('/')) || s.contains(QLatin1Char('\\'))) { - QMessageBox::critical(this, tr("Virtual Folder Error"), - tr("The virtual folder contains some invalid characters.")); - return false; - } - return true; -} - -QT_END_NAMESPACE diff --git a/src/assistant/qhelpconverter/generalpage.h b/src/assistant/qhelpconverter/generalpage.h deleted file mode 100644 index b52cdffb7..000000000 --- a/src/assistant/qhelpconverter/generalpage.h +++ /dev/null @@ -1,53 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#ifndef GENERALPAGE_H -#define GENERALPAGE_H - -#include <QtWidgets/QWizardPage> -#include "ui_generalpage.h" - -QT_BEGIN_NAMESPACE - -class GeneralPage : public QWizardPage -{ - Q_OBJECT - -public: - GeneralPage(QWidget *parent = 0); - -private: - bool validatePage() override; - bool isComplete() const override; - - Ui::GeneralPage m_ui; -}; - -QT_END_NAMESPACE - -#endif diff --git a/src/assistant/qhelpconverter/generalpage.ui b/src/assistant/qhelpconverter/generalpage.ui deleted file mode 100644 index 9c2babb0a..000000000 --- a/src/assistant/qhelpconverter/generalpage.ui +++ /dev/null @@ -1,69 +0,0 @@ -<ui version="4.0" > - <class>GeneralPage</class> - <widget class="QWidget" name="GeneralPage" > - <property name="geometry" > - <rect> - <x>0</x> - <y>0</y> - <width>417</width> - <height>243</height> - </rect> - </property> - <property name="windowTitle" > - <string>Form</string> - </property> - <layout class="QGridLayout" > - <item row="1" column="0" > - <widget class="QLabel" name="label" > - <property name="text" > - <string>Namespace:</string> - </property> - </widget> - </item> - <item row="1" column="1" > - <widget class="QLineEdit" name="namespaceLineEdit" /> - </item> - <item row="2" column="0" > - <widget class="QLabel" name="label_2" > - <property name="text" > - <string>Virtual Folder:</string> - </property> - </widget> - </item> - <item row="2" column="1" > - <widget class="QLineEdit" name="folderLineEdit" /> - </item> - <item row="0" column="1" > - <spacer> - <property name="orientation" > - <enum>Qt::Vertical</enum> - </property> - <property name="sizeType" > - <enum>QSizePolicy::Fixed</enum> - </property> - <property name="sizeHint" > - <size> - <width>20</width> - <height>20</height> - </size> - </property> - </spacer> - </item> - <item row="3" column="1" > - <spacer> - <property name="orientation" > - <enum>Qt::Vertical</enum> - </property> - <property name="sizeHint" > - <size> - <width>20</width> - <height>40</height> - </size> - </property> - </spacer> - </item> - </layout> - </widget> - <resources/> - <connections/> -</ui> diff --git a/src/assistant/qhelpconverter/helpwindow.cpp b/src/assistant/qhelpconverter/helpwindow.cpp deleted file mode 100644 index 3a9a97920..000000000 --- a/src/assistant/qhelpconverter/helpwindow.cpp +++ /dev/null @@ -1,71 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#include <QtCore/QFile> -#include <QtCore/QTextStream> -#include <QtWidgets/QVBoxLayout> -#include <QtWidgets/QLabel> -#include <QtWidgets/QTextEdit> - -#include "helpwindow.h" - -QT_BEGIN_NAMESPACE - -HelpWindow::HelpWindow(QWidget *parent) - : QWidget(parent, 0) -{ - setAutoFillBackground(true); - QVBoxLayout *layout = new QVBoxLayout(this); - layout->setMargin(0); - QFrame *frame = new QFrame(this); - QPalette p = palette(); - p.setColor(QPalette::Background, Qt::white); - setPalette(p); - frame->setFrameStyle(QFrame::Box | QFrame::Plain); - layout->addWidget(frame); - - layout = new QVBoxLayout(frame); - layout->setMargin(2); - QLabel *l = new QLabel(tr("<center><b>Wizard Assistant</b></center>")); - layout->addWidget(l); - m_textEdit = new QTextEdit(); - m_textEdit->setFrameStyle(QFrame::NoFrame); - m_textEdit->setReadOnly(true); - layout->addWidget(m_textEdit); -} - -void HelpWindow::setHelp(const QString &topic) -{ - QLatin1String fileStr(":/qt-project.org/qhelpconverter/doc/%1.html"); - QFile f(QString(fileStr).arg(topic.toLower())); - f.open(QIODevice::ReadOnly); - QTextStream s(&f); - m_textEdit->setText(s.readAll()); -} - -QT_END_NAMESPACE diff --git a/src/assistant/qhelpconverter/helpwindow.h b/src/assistant/qhelpconverter/helpwindow.h deleted file mode 100644 index d6e3ccae1..000000000 --- a/src/assistant/qhelpconverter/helpwindow.h +++ /dev/null @@ -1,52 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#ifndef HELPWINDOW_H -#define HELPWINDOW_H - -#include <QtWidgets/QWidget> - -QT_BEGIN_NAMESPACE - -class QTextEdit; - -class HelpWindow : public QWidget -{ - Q_OBJECT - -public: - HelpWindow(QWidget *parent = 0); - void setHelp(const QString &topic); - -private: - QTextEdit *m_textEdit; -}; - -QT_END_NAMESPACE - -#endif diff --git a/src/assistant/qhelpconverter/identifierpage.cpp b/src/assistant/qhelpconverter/identifierpage.cpp deleted file mode 100644 index fd7597aae..000000000 --- a/src/assistant/qhelpconverter/identifierpage.cpp +++ /dev/null @@ -1,58 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#include "identifierpage.h" - -QT_BEGIN_NAMESPACE - -IdentifierPage::IdentifierPage(QWidget *parent) - : QWizardPage(parent) -{ - setTitle(tr("Identifiers")); - setSubTitle(tr("This page allows you to create identifiers from " - "the keywords found in the .adp or .dcf file.")); - - m_ui.setupUi(this); - - connect(m_ui.identifierCheckBox, &QAbstractButton::toggled, - this, &IdentifierPage::setupButtons); - - registerField(QLatin1String("createIdentifier"), m_ui.identifierCheckBox); - registerField(QLatin1String("globalPrefix"), m_ui.prefixLineEdit); - registerField(QLatin1String("fileNamePrefix"), m_ui.fileNameButton); -} - -void IdentifierPage::setupButtons(bool checked) -{ - m_ui.globalButton->setEnabled(checked); - m_ui.fileNameButton->setEnabled(checked); - m_ui.prefixLineEdit->setEnabled(checked - && m_ui.globalButton->isChecked()); -} - -QT_END_NAMESPACE diff --git a/src/assistant/qhelpconverter/identifierpage.h b/src/assistant/qhelpconverter/identifierpage.h deleted file mode 100644 index 84ba48041..000000000 --- a/src/assistant/qhelpconverter/identifierpage.h +++ /dev/null @@ -1,53 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#ifndef IDENTIFIERPAGE_H -#define IDENTIFIERPAGE_H - -#include <QtWidgets/QWizardPage> -#include "ui_identifierpage.h" - -QT_BEGIN_NAMESPACE - -class IdentifierPage : public QWizardPage -{ - Q_OBJECT - -public: - IdentifierPage(QWidget *parent = 0); - -private slots: - void setupButtons(bool checked); - -private: - Ui::IdentifierPage m_ui; -}; - -QT_END_NAMESPACE - -#endif diff --git a/src/assistant/qhelpconverter/identifierpage.ui b/src/assistant/qhelpconverter/identifierpage.ui deleted file mode 100644 index cd0df7563..000000000 --- a/src/assistant/qhelpconverter/identifierpage.ui +++ /dev/null @@ -1,132 +0,0 @@ -<ui version="4.0" > - <class>IdentifierPage</class> - <widget class="QWidget" name="IdentifierPage" > - <property name="geometry" > - <rect> - <x>0</x> - <y>0</y> - <width>417</width> - <height>242</height> - </rect> - </property> - <property name="windowTitle" > - <string>Form</string> - </property> - <layout class="QGridLayout" > - <item row="0" column="1" > - <spacer> - <property name="orientation" > - <enum>Qt::Vertical</enum> - </property> - <property name="sizeType" > - <enum>QSizePolicy::Fixed</enum> - </property> - <property name="sizeHint" > - <size> - <width>20</width> - <height>20</height> - </size> - </property> - </spacer> - </item> - <item row="1" column="0" colspan="3" > - <widget class="QCheckBox" name="identifierCheckBox" > - <property name="text" > - <string>Create identifiers</string> - </property> - </widget> - </item> - <item row="1" column="3" > - <spacer> - <property name="orientation" > - <enum>Qt::Horizontal</enum> - </property> - <property name="sizeHint" > - <size> - <width>161</width> - <height>20</height> - </size> - </property> - </spacer> - </item> - <item row="2" column="0" > - <spacer> - <property name="orientation" > - <enum>Qt::Horizontal</enum> - </property> - <property name="sizeType" > - <enum>QSizePolicy::Fixed</enum> - </property> - <property name="sizeHint" > - <size> - <width>30</width> - <height>20</height> - </size> - </property> - </spacer> - </item> - <item row="2" column="1" > - <widget class="QRadioButton" name="globalButton" > - <property name="enabled" > - <bool>false</bool> - </property> - <property name="text" > - <string>Global prefix:</string> - </property> - <property name="checked" > - <bool>true</bool> - </property> - </widget> - </item> - <item row="2" column="2" > - <widget class="QLineEdit" name="prefixLineEdit" > - <property name="enabled" > - <bool>false</bool> - </property> - </widget> - </item> - <item row="3" column="1" colspan="2" > - <widget class="QRadioButton" name="fileNameButton" > - <property name="enabled" > - <bool>false</bool> - </property> - <property name="text" > - <string>Inherit prefix from file names</string> - </property> - </widget> - </item> - <item row="4" column="1" > - <spacer> - <property name="orientation" > - <enum>Qt::Vertical</enum> - </property> - <property name="sizeHint" > - <size> - <width>20</width> - <height>31</height> - </size> - </property> - </spacer> - </item> - </layout> - </widget> - <resources/> - <connections> - <connection> - <sender>globalButton</sender> - <signal>toggled(bool)</signal> - <receiver>prefixLineEdit</receiver> - <slot>setEnabled(bool)</slot> - <hints> - <hint type="sourcelabel" > - <x>122</x> - <y>72</y> - </hint> - <hint type="destinationlabel" > - <x>161</x> - <y>71</y> - </hint> - </hints> - </connection> - </connections> -</ui> diff --git a/src/assistant/qhelpconverter/inputpage.cpp b/src/assistant/qhelpconverter/inputpage.cpp deleted file mode 100644 index 471cc9acf..000000000 --- a/src/assistant/qhelpconverter/inputpage.cpp +++ /dev/null @@ -1,90 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#include <QtCore/QFile> -#include <QtCore/QVariant> - -#include <QtWidgets/QLayout> -#include <QtWidgets/QLabel> -#include <QtWidgets/QLineEdit> -#include <QtWidgets/QToolButton> -#include <QtWidgets/QFileDialog> -#include <QtWidgets/QMessageBox> -#include <QtWidgets/QApplication> - -#include "inputpage.h" -#include "adpreader.h" - -QT_BEGIN_NAMESPACE - -InputPage::InputPage(AdpReader *reader, QWidget *parent) - : QWizardPage(parent) -{ - m_adpReader = reader; - setTitle(tr("Input File")); - setSubTitle(tr("Specify the .adp or .dcf file you want " - "to convert to the new Qt help project format and/or " - "collection format.")); - - m_ui.setupUi(this); - connect(m_ui.browseButton, &QAbstractButton::clicked, - this, &InputPage::getFileName); - - registerField(QLatin1String("adpFileName"), m_ui.fileLineEdit); -} - -void InputPage::getFileName() -{ - QString f = QFileDialog::getOpenFileName(this, tr("Open file"), QString(), - tr("Qt Help Files (*.adp *.dcf)")); - if (!f.isEmpty()) - m_ui.fileLineEdit->setText(f); -} - -bool InputPage::validatePage() -{ - QFile f(m_ui.fileLineEdit->text().trimmed()); - if (!f.exists() || !f.open(QIODevice::ReadOnly)) { - QMessageBox::critical(this, tr("File Open Error"), - tr("The specified file could not be opened!")); - return false; - } - - QApplication::setOverrideCursor(QCursor(Qt::WaitCursor)); - m_adpReader->readData(f.readAll()); - QApplication::restoreOverrideCursor(); - if (m_adpReader->hasError()) { - QMessageBox::critical(this, tr("File Parsing Error"), - tr("Parsing error in line %1!").arg(m_adpReader->lineNumber())); - return false; - } - - return true; -} - -QT_END_NAMESPACE diff --git a/src/assistant/qhelpconverter/inputpage.h b/src/assistant/qhelpconverter/inputpage.h deleted file mode 100644 index a52be283a..000000000 --- a/src/assistant/qhelpconverter/inputpage.h +++ /dev/null @@ -1,58 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#ifndef INPUTPAGE_H -#define INPUTPAGE_H - -#include <QtWidgets/QWizardPage> -#include "ui_inputpage.h" - -QT_BEGIN_NAMESPACE - -class AdpReader; - -class InputPage : public QWizardPage -{ - Q_OBJECT - -public: - explicit InputPage(AdpReader *reader, QWidget *parent = 0); - -private slots: - void getFileName(); - -private: - bool validatePage() override; - - Ui::InputPage m_ui; - AdpReader *m_adpReader; -}; - -QT_END_NAMESPACE - -#endif diff --git a/src/assistant/qhelpconverter/inputpage.ui b/src/assistant/qhelpconverter/inputpage.ui deleted file mode 100644 index e7cd3a0fa..000000000 --- a/src/assistant/qhelpconverter/inputpage.ui +++ /dev/null @@ -1,79 +0,0 @@ -<ui version="4.0" > - <class>InputPage</class> - <widget class="QWidget" name="InputPage" > - <property name="geometry" > - <rect> - <x>0</x> - <y>0</y> - <width>417</width> - <height>242</height> - </rect> - </property> - <property name="windowTitle" > - <string>Form</string> - </property> - <layout class="QGridLayout" > - <item row="0" column="2" > - <spacer> - <property name="orientation" > - <enum>Qt::Vertical</enum> - </property> - <property name="sizeType" > - <enum>QSizePolicy::Fixed</enum> - </property> - <property name="sizeHint" > - <size> - <width>20</width> - <height>20</height> - </size> - </property> - </spacer> - </item> - <item row="1" column="0" > - <widget class="QLabel" name="label" > - <property name="sizePolicy" > - <sizepolicy vsizetype="Preferred" hsizetype="Maximum" > - <horstretch>0</horstretch> - <verstretch>0</verstretch> - </sizepolicy> - </property> - <property name="text" > - <string>File name:</string> - </property> - </widget> - </item> - <item row="1" column="1" colspan="2" > - <layout class="QHBoxLayout" > - <property name="spacing" > - <number>0</number> - </property> - <item> - <widget class="QLineEdit" name="fileLineEdit" /> - </item> - <item> - <widget class="QToolButton" name="browseButton" > - <property name="text" > - <string>...</string> - </property> - </widget> - </item> - </layout> - </item> - <item row="2" column="1" > - <spacer> - <property name="orientation" > - <enum>Qt::Vertical</enum> - </property> - <property name="sizeHint" > - <size> - <width>20</width> - <height>31</height> - </size> - </property> - </spacer> - </item> - </layout> - </widget> - <resources/> - <connections/> -</ui> diff --git a/src/assistant/qhelpconverter/main.cpp b/src/assistant/qhelpconverter/main.cpp deleted file mode 100644 index 02fa5ca2f..000000000 --- a/src/assistant/qhelpconverter/main.cpp +++ /dev/null @@ -1,64 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#include <QtCore/QFileInfo> -#include <QtCore/QTranslator> -#include <QtCore/QLocale> -#include <QtCore/QLibraryInfo> -#include <QtWidgets/QApplication> - -#include "conversionwizard.h" - -QT_USE_NAMESPACE - -int main(int argc, char *argv[]) -{ - QApplication app(argc, argv); - QTranslator translator; - QTranslator qtTranslator; - QTranslator qt_helpTranslator; - QString sysLocale = QLocale::system().name(); - QString resourceDir = QLibraryInfo::location(QLibraryInfo::TranslationsPath); - if (translator.load(QLatin1String("assistant_") + sysLocale, resourceDir) - && qtTranslator.load(QLatin1String("qt_") + sysLocale, resourceDir) - && qt_helpTranslator.load(QLatin1String("qt_help_") + sysLocale, resourceDir)) { - app.installTranslator(&translator); - app.installTranslator(&qtTranslator); - app.installTranslator(&qt_helpTranslator); - } - - ConversionWizard w; - if (argc == 2) { - QFileInfo fi(QString::fromLocal8Bit(argv[1])); - if (fi.exists()) - w.setAdpFileName(fi.absoluteFilePath()); - } - w.show(); - return app.exec(); -} - diff --git a/src/assistant/qhelpconverter/outputpage.cpp b/src/assistant/qhelpconverter/outputpage.cpp deleted file mode 100644 index 92948fe24..000000000 --- a/src/assistant/qhelpconverter/outputpage.cpp +++ /dev/null @@ -1,97 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#include <QtCore/QFileInfo> -#include <QtCore/QDir> -#include <QtWidgets/QMessageBox> - -#include "outputpage.h" - -QT_BEGIN_NAMESPACE - -OutputPage::OutputPage(QWidget *parent) - : QWizardPage(parent) -{ - setTitle(tr("Output File Names")); - setSubTitle(tr("Specify the file names for the output files.")); - setButtonText(QWizard::NextButton, tr("Convert...")); - - m_ui.setupUi(this); - connect(m_ui.projectLineEdit, &QLineEdit::textChanged, - this, &QWizardPage::completeChanged); - connect(m_ui.collectionLineEdit, &QLineEdit::textChanged, - this, &QWizardPage::completeChanged); - - registerField(QLatin1String("ProjectFileName"), - m_ui.projectLineEdit); - registerField(QLatin1String("CollectionFileName"), - m_ui.collectionLineEdit); -} - -void OutputPage::setPath(const QString &path) -{ - m_path = path; -} - -void OutputPage::setCollectionComponentEnabled(bool enabled) -{ - m_ui.collectionLineEdit->setEnabled(enabled); - m_ui.label_2->setEnabled(enabled); -} - -bool OutputPage::isComplete() const -{ - if (m_ui.projectLineEdit->text().isEmpty() - || m_ui.collectionLineEdit->text().isEmpty()) - return false; - return true; -} - -bool OutputPage::validatePage() -{ - return checkFile(m_ui.projectLineEdit->text(), - tr("Qt Help Project File")) - && checkFile(m_ui.collectionLineEdit->text(), - tr("Qt Help Collection Project File")); -} - -bool OutputPage::checkFile(const QString &fileName, const QString &title) -{ - QFile fi(m_path + QDir::separator() + fileName); - if (!fi.exists()) - return true; - - if (QMessageBox::warning(this, title, - tr("The specified file %1 already exist.\n\nDo you want to remove it?") - .arg(fileName), tr("Remove"), tr("Cancel")) == 0) { - return fi.remove(); - } - return false; -} - -QT_END_NAMESPACE diff --git a/src/assistant/qhelpconverter/outputpage.h b/src/assistant/qhelpconverter/outputpage.h deleted file mode 100644 index ac7ae9683..000000000 --- a/src/assistant/qhelpconverter/outputpage.h +++ /dev/null @@ -1,58 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#ifndef OUTPUTPAGE_H -#define OUTPUTPAGE_H - -#include <QtWidgets/QWizardPage> -#include "ui_outputpage.h" - -QT_BEGIN_NAMESPACE - -class OutputPage : public QWizardPage -{ - Q_OBJECT - -public: - OutputPage(QWidget *parent = 0); - void setPath(const QString &path); - void setCollectionComponentEnabled(bool enabled); - -private: - bool isComplete() const override; - bool validatePage() override; - bool checkFile(const QString &fileName, - const QString &title); - - Ui::OutputPage m_ui; - QString m_path; -}; - -QT_END_NAMESPACE - -#endif diff --git a/src/assistant/qhelpconverter/outputpage.ui b/src/assistant/qhelpconverter/outputpage.ui deleted file mode 100644 index 755f81808..000000000 --- a/src/assistant/qhelpconverter/outputpage.ui +++ /dev/null @@ -1,95 +0,0 @@ -<ui version="4.0" > - <class>OutputPage</class> - <widget class="QWidget" name="OutputPage" > - <property name="geometry" > - <rect> - <x>0</x> - <y>0</y> - <width>417</width> - <height>242</height> - </rect> - </property> - <property name="windowTitle" > - <string>Form</string> - </property> - <layout class="QGridLayout" > - <item row="0" column="1" > - <spacer> - <property name="orientation" > - <enum>Qt::Vertical</enum> - </property> - <property name="sizeType" > - <enum>QSizePolicy::Fixed</enum> - </property> - <property name="sizeHint" > - <size> - <width>20</width> - <height>20</height> - </size> - </property> - </spacer> - </item> - <item row="1" column="0" > - <widget class="QLabel" name="label" > - <property name="sizePolicy" > - <sizepolicy vsizetype="Preferred" hsizetype="Preferred" > - <horstretch>0</horstretch> - <verstretch>0</verstretch> - </sizepolicy> - </property> - <property name="text" > - <string>Project file name:</string> - </property> - </widget> - </item> - <item row="1" column="1" > - <widget class="QLineEdit" name="projectLineEdit" > - <property name="sizePolicy" > - <sizepolicy vsizetype="Fixed" hsizetype="Expanding" > - <horstretch>0</horstretch> - <verstretch>0</verstretch> - </sizepolicy> - </property> - </widget> - </item> - <item row="2" column="0" > - <widget class="QLabel" name="label_2" > - <property name="sizePolicy" > - <sizepolicy vsizetype="Preferred" hsizetype="Preferred" > - <horstretch>0</horstretch> - <verstretch>0</verstretch> - </sizepolicy> - </property> - <property name="text" > - <string>Collection file name:</string> - </property> - </widget> - </item> - <item row="2" column="1" > - <widget class="QLineEdit" name="collectionLineEdit" > - <property name="sizePolicy" > - <sizepolicy vsizetype="Fixed" hsizetype="Expanding" > - <horstretch>0</horstretch> - <verstretch>0</verstretch> - </sizepolicy> - </property> - </widget> - </item> - <item row="3" column="1" > - <spacer> - <property name="orientation" > - <enum>Qt::Vertical</enum> - </property> - <property name="sizeHint" > - <size> - <width>20</width> - <height>20</height> - </size> - </property> - </spacer> - </item> - </layout> - </widget> - <resources/> - <connections/> -</ui> diff --git a/src/assistant/qhelpconverter/pathpage.cpp b/src/assistant/qhelpconverter/pathpage.cpp deleted file mode 100644 index 261cdd217..000000000 --- a/src/assistant/qhelpconverter/pathpage.cpp +++ /dev/null @@ -1,99 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#include <QtWidgets/QFileDialog> - -#include "pathpage.h" - -QT_BEGIN_NAMESPACE - -PathPage::PathPage(QWidget *parent) - : QWizardPage(parent) -{ - setTitle(tr("Source File Paths")); - setSubTitle(tr("Specify the paths where the sources files " - "are located. By default, all files in those directories " - "matched by the file filter will be included.")); - - m_ui.setupUi(this); - connect(m_ui.addButton, &QAbstractButton::clicked, - this, &PathPage::addPath); - connect(m_ui.removeButton, &QAbstractButton::clicked, - this, &PathPage::removePath); - - m_ui.filterLineEdit->setText(QLatin1String("*.html, *.htm, *.png, *.jpg, *.css")); - - registerField(QLatin1String("sourcePathList"), m_ui.pathListWidget); - m_firstTime = true; -} - -void PathPage::setPath(const QString &path) -{ - if (!m_firstTime) - return; - - m_ui.pathListWidget->addItem(path); - m_firstTime = false; - m_ui.pathListWidget->setCurrentRow(0); -} - -QStringList PathPage::paths() const -{ - QStringList lst; - for (int i = 0; i < m_ui.pathListWidget->count(); ++i) - lst.append(m_ui.pathListWidget->item(i)->text()); - return lst; -} - -QStringList PathPage::filters() const -{ - QStringList lst; - for (const QString &s : m_ui.filterLineEdit->text().split(QLatin1Char(','))) { - lst.append(s.trimmed()); - } - return lst; -} - -void PathPage::addPath() -{ - QString dir = QFileDialog::getExistingDirectory(this, - tr("Source File Path")); - if (!dir.isEmpty()) - m_ui.pathListWidget->addItem(dir); -} - -void PathPage::removePath() -{ - QListWidgetItem *i = m_ui.pathListWidget - ->takeItem(m_ui.pathListWidget->currentRow()); - delete i; - if (!m_ui.pathListWidget->count()) - m_ui.removeButton->setEnabled(false); -} - -QT_END_NAMESPACE diff --git a/src/assistant/qhelpconverter/pathpage.h b/src/assistant/qhelpconverter/pathpage.h deleted file mode 100644 index 0a32f7904..000000000 --- a/src/assistant/qhelpconverter/pathpage.h +++ /dev/null @@ -1,58 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#ifndef PATHPAGE_H -#define PATHPAGE_H - -#include <QtWidgets/QWizardPage> -#include "ui_pathpage.h" - -QT_BEGIN_NAMESPACE - -class PathPage : public QWizardPage -{ - Q_OBJECT - -public: - PathPage(QWidget *parent = 0); - void setPath(const QString &path); - QStringList paths() const; - QStringList filters() const; - -private slots: - void addPath(); - void removePath(); - -private: - Ui::PathPage m_ui; - bool m_firstTime; -}; - -QT_END_NAMESPACE - -#endif diff --git a/src/assistant/qhelpconverter/pathpage.ui b/src/assistant/qhelpconverter/pathpage.ui deleted file mode 100644 index 89083915d..000000000 --- a/src/assistant/qhelpconverter/pathpage.ui +++ /dev/null @@ -1,114 +0,0 @@ -<ui version="4.0" > - <class>PathPage</class> - <widget class="QWidget" name="PathPage" > - <property name="geometry" > - <rect> - <x>0</x> - <y>0</y> - <width>417</width> - <height>243</height> - </rect> - </property> - <property name="windowTitle" > - <string>Form</string> - </property> - <layout class="QGridLayout" > - <item row="0" column="0" > - <widget class="QLabel" name="label_2" > - <property name="sizePolicy" > - <sizepolicy vsizetype="Preferred" hsizetype="Maximum" > - <horstretch>0</horstretch> - <verstretch>0</verstretch> - </sizepolicy> - </property> - <property name="text" > - <string>File filters:</string> - </property> - </widget> - </item> - <item row="0" column="1" colspan="2" > - <widget class="QLineEdit" name="filterLineEdit" /> - </item> - <item row="1" column="1" > - <spacer> - <property name="orientation" > - <enum>Qt::Vertical</enum> - </property> - <property name="sizeType" > - <enum>QSizePolicy::Fixed</enum> - </property> - <property name="sizeHint" > - <size> - <width>20</width> - <height>10</height> - </size> - </property> - </spacer> - </item> - <item row="2" column="0" colspan="3" > - <widget class="QLabel" name="label" > - <property name="text" > - <string>Documentation source file paths:</string> - </property> - </widget> - </item> - <item rowspan="3" row="3" column="0" colspan="3" > - <widget class="QListWidget" name="pathListWidget" /> - </item> - <item row="3" column="3" > - <widget class="QPushButton" name="addButton" > - <property name="sizePolicy" > - <sizepolicy vsizetype="Fixed" hsizetype="Maximum" > - <horstretch>0</horstretch> - <verstretch>0</verstretch> - </sizepolicy> - </property> - <property name="text" > - <string>Add</string> - </property> - </widget> - </item> - <item row="4" column="3" > - <widget class="QPushButton" name="removeButton" > - <property name="sizePolicy" > - <sizepolicy vsizetype="Fixed" hsizetype="Maximum" > - <horstretch>0</horstretch> - <verstretch>0</verstretch> - </sizepolicy> - </property> - <property name="text" > - <string>Remove</string> - </property> - </widget> - </item> - <item row="5" column="3" > - <spacer> - <property name="orientation" > - <enum>Qt::Vertical</enum> - </property> - <property name="sizeHint" > - <size> - <width>20</width> - <height>51</height> - </size> - </property> - </spacer> - </item> - <item row="6" column="2" > - <spacer> - <property name="orientation" > - <enum>Qt::Vertical</enum> - </property> - <property name="sizeHint" > - <size> - <width>20</width> - <height>31</height> - </size> - </property> - </spacer> - </item> - </layout> - </widget> - <resources/> - <connections/> -</ui> diff --git a/src/assistant/qhelpconverter/qhcpwriter.cpp b/src/assistant/qhelpconverter/qhcpwriter.cpp deleted file mode 100644 index 64695921c..000000000 --- a/src/assistant/qhelpconverter/qhcpwriter.cpp +++ /dev/null @@ -1,132 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#include <QtCore/QFile> - -#include "qhcpwriter.h" - -QT_BEGIN_NAMESPACE - -QhcpWriter::QhcpWriter() -{ - setAutoFormatting(true); -} - -void QhcpWriter::setHelpProjectFile(const QString &qhpFile) -{ - m_qhpFile = qhpFile; -} - -void QhcpWriter::setProperties(const QMap<QString, QString> props) -{ - m_properties = props; -} - -void QhcpWriter::setTitlePath(const QString &path) -{ - m_titlePath = path; -} - -bool QhcpWriter::writeFile(const QString &fileName) -{ - QFile out(fileName); - if (!out.open(QIODevice::WriteOnly)) - return false; - - setDevice(&out); - writeStartDocument(); - writeStartElement(QLatin1String("QHelpCollectionProject")); - writeAttribute(QLatin1String("version"), QLatin1String("1.0")); - writeAssistantSettings(); - writeDocuments(); - writeEndDocument(); - return true; -} - -void QhcpWriter::writeAssistantSettings() -{ - if (m_properties.isEmpty()) - return; - - writeStartElement(QLatin1String("assistant")); - - if (m_properties.contains(QLatin1String("title"))) - writeTextElement(QLatin1String("title"), m_properties.value(QLatin1String("title"))); - if (m_properties.contains(QLatin1String("applicationicon"))) - writeTextElement(QLatin1String("applicationIcon"), - m_properties.value(QLatin1String("applicationicon"))); - if (m_properties.contains(QLatin1String("startpage"))) - writeTextElement(QLatin1String("startPage"), m_titlePath + QLatin1String("/") - + m_properties.value(QLatin1String("startpage"))); - if (m_properties.contains(QLatin1String("aboutmenutext"))) { - writeStartElement(QLatin1String("aboutMenuText")); - writeTextElement(QLatin1String("text"), - m_properties.value(QLatin1String("aboutmenutext"))); - writeEndElement(); - } - if (m_properties.contains(QLatin1String("abouturl"))) { - writeStartElement(QLatin1String("aboutDialog")); - writeTextElement(QLatin1String("file"), m_properties.value(QLatin1String("abouturl"))); - writeEndElement(); - } - if (m_properties.contains(QLatin1String("name"))) { - writeTextElement(QLatin1String("cacheDirectory"), - QLatin1String(".") + m_properties.value(QLatin1String("name"))); - } - - writeEndElement(); -} - -void QhcpWriter::writeDocuments() -{ - if (m_qhpFile.isEmpty()) - return; - - QString out = m_qhpFile; - int i = out.indexOf(QLatin1Char('.')); - if (i > -1) - out = out.left(i); - out.append(QLatin1String(".qch")); - - writeStartElement(QLatin1String("docFiles")); - - writeStartElement(QLatin1String("generate")); - writeStartElement(QLatin1String("file")); - writeTextElement(QLatin1String("input"), m_qhpFile); - writeTextElement(QLatin1String("output"), out); - writeEndElement(); - writeEndElement(); - - writeStartElement(QLatin1String("register")); - writeTextElement(QLatin1String("file"), out); - writeEndElement(); - - writeEndElement(); -} - -QT_END_NAMESPACE diff --git a/src/assistant/qhelpconverter/qhcpwriter.h b/src/assistant/qhelpconverter/qhcpwriter.h deleted file mode 100644 index 90b83ba53..000000000 --- a/src/assistant/qhelpconverter/qhcpwriter.h +++ /dev/null @@ -1,57 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#ifndef QHCPWRITER_H -#define QHCPWRITER_H - -#include <QtCore/QXmlStreamWriter> -#include "adpreader.h" - -QT_BEGIN_NAMESPACE - -class QhcpWriter : public QXmlStreamWriter -{ -public: - QhcpWriter(); - bool writeFile(const QString &fileName); - void setHelpProjectFile(const QString &qhpFile); - void setProperties(const QMap<QString, QString> props); - void setTitlePath(const QString &path); - -private: - void writeAssistantSettings(); - void writeDocuments(); - - QString m_qhpFile; - QMap<QString, QString> m_properties; - QString m_titlePath; -}; - -QT_END_NAMESPACE - -#endif diff --git a/src/assistant/qhelpconverter/qhelpconverter.pro b/src/assistant/qhelpconverter/qhelpconverter.pro deleted file mode 100644 index d60aae7cc..000000000 --- a/src/assistant/qhelpconverter/qhelpconverter.pro +++ /dev/null @@ -1,42 +0,0 @@ -QT += help widgets - -SOURCES += conversionwizard.cpp \ - inputpage.cpp \ - generalpage.cpp \ - filterpage.cpp \ - identifierpage.cpp \ - pathpage.cpp \ - filespage.cpp \ - outputpage.cpp \ - finishpage.cpp \ - adpreader.cpp \ - qhpwriter.cpp \ - qhcpwriter.cpp \ - helpwindow.cpp \ - main.cpp - -HEADERS += conversionwizard.h \ - inputpage.h \ - generalpage.h \ - filterpage.h \ - identifierpage.h \ - pathpage.h \ - filespage.h \ - outputpage.h \ - finishpage.h \ - adpreader.h \ - qhcpwriter.h \ - qhpwriter.h \ - helpwindow.h - -FORMS += inputpage.ui \ - generalpage.ui \ - filterpage.ui \ - identifierpage.ui \ - pathpage.ui \ - filespage.ui \ - outputpage.ui - -RESOURCES += qhelpconverter.qrc - -load(qt_app) diff --git a/src/assistant/qhelpconverter/qhelpconverter.qrc b/src/assistant/qhelpconverter/qhelpconverter.qrc deleted file mode 100644 index 982ac7d9c..000000000 --- a/src/assistant/qhelpconverter/qhelpconverter.qrc +++ /dev/null @@ -1,13 +0,0 @@ -<RCC> - <qresource prefix="/qt-project.org/qhelpconverter" > - <file>assistant-128.png</file> - <file>assistant.png</file> - <file>doc/inputpage.html</file> - <file>doc/generalpage.html</file> - <file>doc/filterpage.html</file> - <file>doc/identifierpage.html</file> - <file>doc/pathpage.html</file> - <file>doc/filespage.html</file> - <file>doc/outputpage.html</file> - </qresource> -</RCC> diff --git a/src/assistant/qhelpconverter/qhpwriter.cpp b/src/assistant/qhelpconverter/qhpwriter.cpp deleted file mode 100644 index 446d7d7ce..000000000 --- a/src/assistant/qhelpconverter/qhpwriter.cpp +++ /dev/null @@ -1,171 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#include <QtCore/QFile> - -#include "qhpwriter.h" -#include "adpreader.h" - -QT_BEGIN_NAMESPACE - -QhpWriter::QhpWriter(const QString &namespaceName, - const QString &virtualFolder) -{ - m_namespaceName = namespaceName; - m_virtualFolder = virtualFolder; - setAutoFormatting(true); -} - -void QhpWriter::setAdpReader(AdpReader *reader) -{ - m_adpReader = reader; -} - -void QhpWriter::setFilterAttributes(const QStringList &attributes) -{ - m_filterAttributes = attributes; -} - -void QhpWriter::setCustomFilters(const QList<CustomFilter> filters) -{ - m_customFilters = filters; -} - -void QhpWriter::setFiles(const QStringList &files) -{ - m_files = files; -} - -void QhpWriter::generateIdentifiers(IdentifierPrefix prefix, - const QString prefixString) -{ - m_prefix = prefix; - m_prefixString = prefixString; -} - -bool QhpWriter::writeFile(const QString &fileName) -{ - QFile out(fileName); - if (!out.open(QIODevice::WriteOnly)) - return false; - - setDevice(&out); - writeStartDocument(); - writeStartElement(QLatin1String("QtHelpProject")); - writeAttribute(QLatin1String("version"), QLatin1String("1.0")); - writeTextElement(QLatin1String("namespace"), m_namespaceName); - writeTextElement(QLatin1String("virtualFolder"), m_virtualFolder); - writeCustomFilters(); - writeFilterSection(); - writeEndDocument(); - - out.close(); - return true; -} - -void QhpWriter::writeCustomFilters() -{ - if (!m_customFilters.count()) - return; - - for (const CustomFilter &f : qAsConst(m_customFilters)) { - writeStartElement(QLatin1String("customFilter")); - writeAttribute(QLatin1String("name"), f.name); - for (const QString &a : f.filterAttributes) - writeTextElement(QLatin1String("filterAttribute"), a); - writeEndElement(); - } -} - -void QhpWriter::writeFilterSection() -{ - writeStartElement(QLatin1String("filterSection")); - for (const QString &a : qAsConst(m_filterAttributes)) - writeTextElement(QLatin1String("filterAttribute"), a); - - writeToc(); - writeKeywords(); - writeFiles(); - writeEndElement(); -} - -void QhpWriter::writeToc() -{ - const QList<ContentItem> &list = m_adpReader->contents(); - if (list.isEmpty()) - return; - - int depth = -1; - writeStartElement(QLatin1String("toc")); - for (const ContentItem &i : list) { - while (depth-- >= i.depth) - writeEndElement(); - writeStartElement(QLatin1String("section")); - writeAttribute(QLatin1String("title"), i.title); - writeAttribute(QLatin1String("ref"), i.reference); - depth = i.depth; - } - while (depth-- >= -1) - writeEndElement(); -} - -void QhpWriter::writeKeywords() -{ - const QList<KeywordItem> &list = m_adpReader->keywords(); - if (list.isEmpty()) - return; - - writeStartElement(QLatin1String("keywords")); - for (const KeywordItem &i : list) { - writeEmptyElement(QLatin1String("keyword")); - writeAttribute(QLatin1String("name"), i.keyword); - writeAttribute(QLatin1String("ref"), i.reference); - if (m_prefix == FilePrefix) { - QString str = i.reference.mid( - i.reference.lastIndexOf(QLatin1Char('/')) + 1); - str = str.left(str.lastIndexOf(QLatin1Char('.'))); - writeAttribute(QLatin1String("id"), str + QLatin1String("::") + i.keyword); - } else if (m_prefix == GlobalPrefix) { - writeAttribute(QLatin1String("id"), m_prefixString + i.keyword); - } - } - writeEndElement(); -} - -void QhpWriter::writeFiles() -{ - if (m_files.isEmpty()) - return; - - writeStartElement(QLatin1String("files")); - for (const QString &f : qAsConst(m_files)) - writeTextElement(QLatin1String("file"), f); - writeEndElement(); -} - -QT_END_NAMESPACE diff --git a/src/assistant/qhelpconverter/qhpwriter.h b/src/assistant/qhelpconverter/qhpwriter.h deleted file mode 100644 index 3a7cf4284..000000000 --- a/src/assistant/qhelpconverter/qhpwriter.h +++ /dev/null @@ -1,72 +0,0 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of the Qt Assistant of the Qt Toolkit. -** -** $QT_BEGIN_LICENSE:GPL-EXCEPT$ -** 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. -** -** GNU General Public License Usage -** Alternatively, this file may be used under the terms of the GNU -** General Public License version 3 as published by the Free Software -** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT -** included in the packaging of this file. Please review the following -** information to ensure the GNU General Public License requirements will -** be met: https://www.gnu.org/licenses/gpl-3.0.html. -** -** $QT_END_LICENSE$ -** -****************************************************************************/ - -#ifndef QHPWRITER_H -#define QHPWRITER_H - -#include <QtCore/QXmlStreamWriter> -#include "filterpage.h" - -QT_BEGIN_NAMESPACE - -class AdpReader; - -class QhpWriter : public QXmlStreamWriter -{ -public: - enum IdentifierPrefix {SkipAll, FilePrefix, GlobalPrefix}; - QhpWriter(const QString &namespaceName, - const QString &virtualFolder); - void setAdpReader(AdpReader *reader); - void setFilterAttributes(const QStringList &attributes); - void setCustomFilters(const QList<CustomFilter> filters); - void setFiles(const QStringList &files); - void generateIdentifiers(IdentifierPrefix prefix, - const QString prefixString = QString()); - bool writeFile(const QString &fileName); - -private: - void writeCustomFilters(); - void writeFilterSection(); - void writeToc(); - void writeKeywords(); - void writeFiles(); - - QString m_namespaceName; - QString m_virtualFolder; - AdpReader *m_adpReader; - QStringList m_filterAttributes; - QList<CustomFilter> m_customFilters; - QStringList m_files; - IdentifierPrefix m_prefix; - QString m_prefixString; -}; - -QT_END_NAMESPACE - -#endif diff --git a/src/qdoc/doc/qdoc-manual-qdocconf.qdoc b/src/qdoc/doc/qdoc-manual-qdocconf.qdoc index aad70601c..f60b5d8b5 100644 --- a/src/qdoc/doc/qdoc-manual-qdocconf.qdoc +++ b/src/qdoc/doc/qdoc-manual-qdocconf.qdoc @@ -1218,8 +1218,7 @@ \section1 Overview Qt Assistant uses a system for managing Qt documentation that requires - QDoc to generate inventories of files in a format that is similar to the - old style DCF format, but with additional features. + QDoc to generate inventories of files. QDoc allows configuration variables to be used to specify which pages are to be used in each documentation set it generates. These are specified as |
