helpWidget.cc 8.14 KB
Newer Older
1
/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
2
3
*                                                                            *
*                              OpenFlipper                                   *
Jan Möbius's avatar
Jan Möbius committed
4
*      Copyright (C) 2001-2011 by Computer Graphics Group, RWTH Aachen       *
Jan Möbius's avatar
Jan Möbius committed
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
*                           www.openflipper.org                              *
*                                                                            *
*--------------------------------------------------------------------------- *
*  This file is part of OpenFlipper.                                         *
*                                                                            *
*  OpenFlipper is free software: you can redistribute it and/or modify       *
*  it under the terms of the GNU Lesser General Public License as            *
*  published by the Free Software Foundation, either version 3 of            *
*  the License, or (at your option) any later version with the               *
*  following exceptions:                                                     *
*                                                                            *
*  If other files instantiate templates or use macros                        *
*  or inline functions from this file, or you compile this file and          *
*  link it with other files to produce an executable, this file does         *
*  not by itself cause the resulting executable to be covered by the         *
*  GNU Lesser General Public License. This exception does not however        *
*  invalidate any other reasons why the executable file might be             *
*  covered by the GNU Lesser General Public License.                         *
*                                                                            *
*  OpenFlipper 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 Lesser General Public License for more details.                       *
*                                                                            *
*  You should have received a copy of the GNU LesserGeneral Public           *
*  License along with OpenFlipper. If not,                                   *
*  see <http://www.gnu.org/licenses/>.                                       *
*                                                                            *
33
34
35
\*===========================================================================*/

/*===========================================================================*\
Jan Möbius's avatar
Jan Möbius committed
36
37
38
39
40
*                                                                            *
*   $Revision$                                                       *
*   $LastChangedBy$                                                *
*   $Date$                     *
*                                                                            *
41
42
43
\*===========================================================================*/


44
45
46
47
48
49
50
51
52
53
54
55
56
57
/*
 * helpWidget.cc
 *
 *  Created on: Apr 7, 2009
 *      Author: kremer
 */

#include "helpWidget.hh"

#include <OpenFlipper/common/GlobalOptions.hh>

#include <iostream>

#include <QTextStream>
58
#include <QDir>
59

60
HelpWidget::HelpWidget(QWidget* parent, const QString& _homeSite)
61
62
63
64
65
66
  : QMainWindow(parent),
  searchWidget_(0),
  tabWidget_(0),
  textWindow_(0),
  helpEngine_(0),
  searchEngine_(0) {
67

68
  setupUi(this);
69

70
  homeSite_ = _homeSite;
71

72
73
74
75
76
77
  QString filename = QString( OpenFlipper::Options::configDirStr() );
  filename += OpenFlipper::Options::dirSeparator();
  filename += "Help.qhc";
    
  QDir helpDir = QDir(OpenFlipper::Options::helpDirStr());
  QStringList helpFiles = helpDir.entryList(QStringList("*.qch"),QDir::Files);
78

79
  QString iconPath = QString(OpenFlipper::Options::iconDirStr());
80
#ifdef WIN32
81
  iconPath += "\\";
82
#else
83
  iconPath += "/";
84
85
#endif

86
87
88
89
90
  // Set Buttons
  backButton_->setIcon(QIcon(iconPath+"arrow-left.png"));
  forwardButton_->setIcon(QIcon(iconPath+"arrow-right.png"));
  homeButton_->setIcon(QIcon(iconPath+"go-home.png"));
  searchButton_->setIcon(QIcon(iconPath+"edit-find.png"));
91

92
  tabWidget_ = new QTabWidget(this);
93

94
95
96
97
98
99
  helpEngine_ = new QHelpEngine(filename, this);
  
  helpEngine_->setupData();
  
  for ( int i = 0 ; i < helpFiles.size() ; ++i ) 
    if ( !helpEngine_->registerDocumentation( helpDir.path()+ QDir::separator() + helpFiles[i]) ) 
100
101
102
      std::cerr << helpFiles[i].toStdString() << " :" << helpEngine_->error().toStdString() << std::endl;
    else 
      std::cerr << "Loaded Help file : " << helpFiles[i].toStdString() << std::endl;
103

104
  searchEngine_ = new QHelpSearchEngine(helpEngine_, this);
105

106
  textWindow_ = new HelpBrowser(helpEngine_, this);
107

108
  homeIndex_ = tabWidget_->addTab(textWindow_, tr("Home"));
109

110
111
  gridLayout_->addWidget(helpEngine_->contentWidget(), 1, 0);
  gridLayout_->addWidget(tabWidget_, 1, 1);
112

113
114
  gridLayout_->setColumnStretch(0, 1);
  gridLayout_->setColumnStretch(1, 3);
115

116
117
118
  // Search popup at bottom of window
  searchWidget_ = new QDockWidget(tr("Search results"), this);
  searchWidget_->setFeatures( QDockWidget::DockWidgetClosable );
119

120
  searchWidget_->resize(this->size().width(), floor( double(this->size().height() / 3)) );
121

122
123
  searchWidget_->setWidget(searchEngine_->queryWidget());
  //searchWidget_->setWidget(results_);
124

125
126
  searchWidget_->hide();
  addDockWidget(Qt::BottomDockWidgetArea, searchWidget_);
127
128


129
130
131
  // Entry in tree view has been clicked
  connect(helpEngine_->contentWidget(), SIGNAL(linkActivated(const QUrl&)),
          this, SLOT(linkActivated(const QUrl&)));
132

133

134
135
  // Search button
  connect(searchButton_, SIGNAL(clicked()), this, SLOT(showSearchWidget()));
136

137
138
  // Search button
  connect(searchEngine_->queryWidget(), SIGNAL(search()), this, SLOT(startSearch()));
139

140
141
  // Show results if search is finished
  connect(searchEngine_, SIGNAL(searchingFinished(int)), this, SLOT(showResults(int)));
142

143
144
145
  // Show results if search is finished
  connect(searchEngine_->resultWidget(), SIGNAL(requestShowLink(const QUrl&)),
              this, SLOT(showFoundSite(const QUrl&)));
146

147
148
  // Back button
  connect(backButton_, SIGNAL(clicked()), this, SLOT(goBack()));
149

150
151
  // Forward button
  connect(forwardButton_, SIGNAL(clicked()), this, SLOT(goForward()));
152

153
154
  // Forward button
  connect(homeButton_, SIGNAL(clicked()), this, SLOT(goHome()));
155

156
157
  // Source has been reloaded
  connect(textWindow_, SIGNAL(urlChanged(const QUrl&)), this, SLOT(update(const QUrl&)));
158

159
160
  // Register documentation
  helpEngine_->registerDocumentation(filename);
161

162
163
  // Load main page
  textWindow_->open(QUrl(homeSite_));
164
165
}

166
167
void HelpWidget::linkActivated(const QUrl& _url) {

168
169
  textWindow_->open(_url);
  tabWidget_->setCurrentIndex(homeIndex_);
170
171
}

172
173
void HelpWidget::startSearch() {

174
  searchEngine_->search(searchEngine_->queryWidget()->query());
175
176
177
178
}

void HelpWidget::setHomeSite(const QString& _homeSite) {

179
  homeSite_ = _homeSite;
180
181
}

182
183
void HelpWidget::showFoundSite(const QUrl& _url) {

184
185
  textWindow_->open(_url);
  tabWidget_->setCurrentIndex(homeIndex_);
186
187
}

188
void HelpWidget::update(const QUrl& /* url */) {
189

190
  updateButtons();
191
192
193
194
}

void HelpWidget::goForward() {

195
  textWindow_->forward();
196

197
  tabWidget_->setCurrentIndex(homeIndex_);
198

199
  updateButtons();
200
201
202
203
}

void HelpWidget::goBack() {

204
  textWindow_->backward();
205

206
  tabWidget_->setCurrentIndex(homeIndex_);
207

208
  updateButtons();
209
210
}

211
212
void HelpWidget::goHome() {

213
  textWindow_->open(homeSite_);
214

215
  tabWidget_->setCurrentIndex(homeIndex_);
216

217
  updateButtons();
218
219
}

220
221
void HelpWidget::updateButtons() {

222
223
224
225
226
227
228
229
230
231
232
  if(!textWindow_->isBackwardAvailable()) {
          backButton_->setEnabled(false);
  } else {
          backButton_->setEnabled(true);
  }

  if(!textWindow_->isForwardAvailable()) {
          forwardButton_->setEnabled(false);
  } else {
          forwardButton_->setEnabled(true);
  }
233
234
}

235
void HelpWidget::showSearchWidget() {
236

237
  searchWidget_->show();
238
}
239

240
void HelpWidget::showResults(int /*_hits*/) {
241

242
  searchWidget_->hide();
243

244
245
  int resultsTabIndex_ = tabWidget_->addTab(searchEngine_->resultWidget(), tr("Results") );
  tabWidget_->setCurrentIndex(resultsTabIndex_);
246
247
}

Jan Möbius's avatar
Jan Möbius committed
248
void HelpWidget::openFoundSite(QListWidgetItem* /*_item*/) {
249
250

}
Mike Kremer's avatar
Mike Kremer committed
251
252
253

HelpWidget::~HelpWidget() {

254
255
  delete searchWidget_;
  delete textWindow_;
Mike Kremer's avatar
Mike Kremer committed
256
}