Developer Documentation

helpWidget.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4 * Copyright (c) 2001-2015, RWTH-Aachen University *
5 * Department of Computer Graphics and Multimedia *
6 * All rights reserved. *
7 * www.openflipper.org *
8 * *
9 *---------------------------------------------------------------------------*
10 * This file is part of OpenFlipper. *
11 *---------------------------------------------------------------------------*
12 * *
13 * Redistribution and use in source and binary forms, with or without *
14 * modification, are permitted provided that the following conditions *
15 * are met: *
16 * *
17 * 1. Redistributions of source code must retain the above copyright notice, *
18 * this list of conditions and the following disclaimer. *
19 * *
20 * 2. Redistributions in binary form must reproduce the above copyright *
21 * notice, this list of conditions and the following disclaimer in the *
22 * documentation and/or other materials provided with the distribution. *
23 * *
24 * 3. Neither the name of the copyright holder nor the names of its *
25 * contributors may be used to endorse or promote products derived from *
26 * this software without specific prior written permission. *
27 * *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41
42
43
44 #ifndef HELPWIDGET_HH_
45 #define HELPWIDGET_HH_
46
47 #include "ui_helpWidget.h"
48
49 #include <QtHelp>
50 #include <QTextDocument>
51
52 #include <QHelpSearchEngine>
53 #include <QTabWidget>
54
55 #include <iostream>
56
57 #include "helpBrowser.hh"
58
59 class HelpWidget : public QMainWindow, public Ui::HelpWidget
60 {
61 Q_OBJECT
62
63 public:
64
65 HelpWidget(QWidget* parent = 0, const QString& _homeSite = "", const bool _loadHomeSite = true);
66
67 virtual ~HelpWidget();
68
69 void setHomeSite(const QString& _homeSite);
70
71 private slots:
72
73 void startSearch();
74
75 void goBack();
76
77 void goForward();
78
79 void goHome();
80
81 void showSearchWidget();
82
83 //the entry was already selected by user
84 void linkActivated(const QUrl& _url);
85
86 //activate the url and jump to the entry
87 void activateLink(const QUrl& _url);
88
89 void showFoundSite(const QUrl& _url);
90
91 void showResults(int _hits);
92
93 // updates the buttons an the content widget
94 // the content widget is synchronized with the helpBrowser
95 void update(const QUrl& url);
96
97 void openFoundSite(QListWidgetItem* _item);
98
99 //updates only the buttons (for/back)
100 void updateButtons();
101
102 private:
103
104 // For the search popup
105 QDockWidget* searchWidget_;
106
107 QTabWidget* tabWidget_;
108
109 HelpBrowser* textWindow_;
110
111 QHelpEngine* helpEngine_;
112 QHelpSearchEngine* searchEngine_;
113
114 QString homeSite_;
115
116 int homeIndex_;
117
118 };
119
120
121 #endif /* HELPWIDGET_HH_ */
HelpWidget
Definition: helpWidget.hh:59
HelpBrowser
Definition: helpBrowser.hh:56