Merge lp:~b-eltzner/qpdfview/searchable-help into lp:qpdfview

[Benjamin Eltzner]

The help dialog is now treated as a separate class to facilitate extension. This was done in a very simplistic way, so the code might need some additional care.

[Adam Reichold (adamreichold)]

Hello Benjamin,

Thanks for the change! Will fix a few empty lines and then merge it. Afterwards, we can discuss extending the help dialog.

Best regards, Adam.

review: Approve

[Adam Reichold (adamreichold)]

By the way, there seems to be the small issue of the accidentally added binary file which I'll just remove...

[Benjamin Eltzner (b-eltzner)]

> By the way, there seems to be the small issue of the accidentally added binary
> file which I'll just remove...

Oh, sorry about that. Thanks for cleaning it up.

[lp:~b-eltzner/qpdfview/searchable-help]

1258. By Adam Reichold on 2013-09-06

merge help dialog that was refactored for further extension

=== added file 'qpdfview'
Binary files qpdfview	1970-01-01 00:00:00 +0000 and qpdfview	2013-09-06 16:42:02 +0000 differ
=== modified file 'qpdfview-application.pro'
--- qpdfview-application.pro	2013-09-02 09:25:38 +0000
+++ qpdfview-application.pro	2013-09-06 16:42:02 +0000
@@ -24,7 +24,8 @@
     sources/recentlyusedmenu.h \
     sources/bookmarkmenu.h \
     sources/database.h \
-    sources/mainwindow.h
+    sources/mainwindow.h \
+    sources/helpdialog.h
 
 SOURCES += \
     sources/settings.cpp \
@@ -42,7 +43,8 @@
     sources/bookmarkmenu.cpp \
     sources/database.cpp \
     sources/mainwindow.cpp \
-    sources/main.cpp
+    sources/main.cpp \
+    sources/helpdialog.cpp
 
 DEFINES += APPLICATION_VERSION=\\\"$${APPLICATION_VERSION}\\\"
 

=== added file 'sources/helpdialog.cpp'
--- sources/helpdialog.cpp	1970-01-01 00:00:00 +0000
+++ sources/helpdialog.cpp	2013-09-06 16:42:02 +0000
@@ -0,0 +1,43 @@
+/*
+
+Copyright 2013 Benjamin Eltzner
+Copyright 2013 Adam Reichold
+
+This file is part of qpdfview.
+
+qpdfview is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+
+qpdfview is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with qpdfview.  If not, see <http://www.gnu.org/licenses/>.
+
+*/
+
+#include "helpdialog.h"
+
+#include <QApplication>
+#include <QDir>
+#include <QVBoxLayout>
+
+HelpDialog::HelpDialog(QWidget* parent) : QDialog(parent)
+{
+    m_textBrowser = new QTextBrowser(this);
+    m_textBrowser->setSearchPaths(QStringList() << QDir(QApplication::applicationDirPath()).filePath("data") << DATA_INSTALL_PATH);
+    m_textBrowser->setSource(QUrl("help.html"));
+
+    m_dialogButtonBox = new QDialogButtonBox(QDialogButtonBox::Ok, Qt::Horizontal, this);
+    connect(m_dialogButtonBox, SIGNAL(accepted()), this, SLOT(accept()));
+    connect(m_dialogButtonBox, SIGNAL(rejected()), this, SLOT(reject()));
+
+    this->setLayout(new QVBoxLayout(this));
+    this->layout()->addWidget(m_textBrowser);
+    this->layout()->addWidget(m_dialogButtonBox);
+
+}

=== added file 'sources/helpdialog.h'
--- sources/helpdialog.h	1970-01-01 00:00:00 +0000
+++ sources/helpdialog.h	2013-09-06 16:42:02 +0000
@@ -0,0 +1,48 @@
+/*
+
+Copyright 2013 Benjamin Eltzner
+Copyright 2013 Adam Reichold
+
+This file is part of qpdfview.
+
+qpdfview is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 2 of the License, or
+(at your option) any later version.
+
+qpdfview is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with qpdfview.  If not, see <http://www.gnu.org/licenses/>.
+
+*/
+
+#ifndef HELPDIALOG_H
+#define HELPDIALOG_H
+
+#include <QDialog>
+#include <QTextBrowser>
+#include <QDialogButtonBox>
+
+class HelpDialog : public QDialog
+{
+    Q_OBJECT
+
+public:
+    explicit HelpDialog(QWidget* parent = 0);
+    
+signals:
+    
+public slots:
+
+private:
+    QTextBrowser* m_textBrowser;
+
+    QDialogButtonBox* m_dialogButtonBox;
+
+};
+
+#endif // HELPDIALOG_H

=== modified file 'sources/mainwindow.cpp'
--- sources/mainwindow.cpp	2013-09-06 14:26:01 +0000
+++ sources/mainwindow.cpp	2013-09-06 16:42:02 +0000
@@ -59,6 +59,7 @@
 #include "pageitem.h"
 #include "documentview.h"
 #include "miscellaneous.h"
+#include "helpdialog.h"
 #include "printdialog.h"
 #include "settingsdialog.h"
 #include "recentlyusedmenu.h"
@@ -1485,22 +1486,11 @@
 
 void MainWindow::on_contents_triggered()
 {
-    QDialog* dialog = new QDialog(this);
-
-    QTextBrowser* textBrowser = new QTextBrowser(dialog);
-    textBrowser->setSearchPaths(QStringList() << QDir(QApplication::applicationDirPath()).filePath("data") << DATA_INSTALL_PATH);
-    textBrowser->setSource(QUrl("help.html"));
-
-    QDialogButtonBox* dialogButtonBox = new QDialogButtonBox(QDialogButtonBox::Ok, Qt::Horizontal, dialog);
-    connect(dialogButtonBox, SIGNAL(accepted()), dialog, SLOT(accept()));
-    connect(dialogButtonBox, SIGNAL(rejected()), dialog, SLOT(reject()));
-
-    dialog->setLayout(new QVBoxLayout(dialog));
-    dialog->layout()->addWidget(textBrowser);
-    dialog->layout()->addWidget(dialogButtonBox);
+    HelpDialog* dialog = new HelpDialog(this);
 
     dialog->resize(s_settings->mainWindow().contentsDialogSize(dialog->sizeHint()));
     dialog->exec();
+
     s_settings->mainWindow().setContentsDialogSize(dialog->size());
 
     delete dialog;