helpWidget.hh 4.4 KB
Newer Older
1
/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
2
3
*                                                                            *
*                              OpenFlipper                                   *
Martin Schultz's avatar
Martin Schultz committed
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           *
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,       *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR        *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              *
Jan Möbius's avatar
Jan Möbius committed
39
*                                                                            *
40
41
\*===========================================================================*/

42

43

44
45
46
#ifndef HELPWIDGET_HH_
#define HELPWIDGET_HH_

47
#include "ui_helpWidget.h"
48
49
50
51

#include <QtHelp>
#include <QTextDocument>

52
53
54
#include <QHelpSearchEngine>
#include <QTabWidget>

55
56
57
58
59
60
61
62
63
64
#include <iostream>

#include "helpBrowser.hh"

class HelpWidget : public QMainWindow, public Ui::HelpWidget
{
  Q_OBJECT

  public:

65
	  HelpWidget(QWidget* parent = 0, const QString& _homeSite = "", const bool _loadHomeSite = true);
66

Mike Kremer's avatar
Mike Kremer committed
67
68
	  virtual ~HelpWidget();

69
70
	  void setHomeSite(const QString& _homeSite);

71
72
private slots:

73
74
	void startSearch();

75
76
77
78
	void goBack();

	void goForward();

79
80
	void goHome();

81
82
	void showSearchWidget();

83
	//the entry was already selected by user
84
85
	void linkActivated(const QUrl& _url);

86
87
88
	//activate the url and jump to the entry
	void activateLink(const QUrl& _url);

89
90
91
	void showFoundSite(const QUrl& _url);

	void showResults(int _hits);
92

93
94
	// updates the buttons an the content widget
	// the content widget is synchronized with the helpBrowser
95
	void update(const QUrl& url);
96
97
98

	void openFoundSite(QListWidgetItem* _item);

99
	//updates only the buttons (for/back)
100
101
	void updateButtons();

102
103
  private:

104
105
	// For the search popup
	QDockWidget* searchWidget_;
106
107

	QTabWidget* tabWidget_;
108
109
110
111

	HelpBrowser* textWindow_;

	QHelpEngine* helpEngine_;
112
	QHelpSearchEngine* searchEngine_;
113

114
115
	QString homeSite_;

116
117
	int homeIndex_;

118
119
120
121
};


#endif /* HELPWIDGET_HH_ */