1
2
3
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
|
/*
* Stellarium
* Copyright (C) 2007 Matthew Gates
*
* This program 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.
*
* This program 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 this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA 02110-1335, USA.
*/
#include <QString>
#include <QTextBrowser>
#include <QVBoxLayout>
#include <QWidget>
#include <QFrame>
#include <QSettings>
#include <QResizeEvent>
#include <QSize>
#include <QMultiMap>
#include <QList>
#include <QSet>
#include <QPair>
#include <QtAlgorithms>
#include <QDebug>
#include "ui_helpDialogGui.h"
#include "HelpDialog.hpp"
#include "StelApp.hpp"
#include "StelFileMgr.hpp"
#include "StelGui.hpp"
#include "StelGuiItems.hpp"
#include "StelLocaleMgr.hpp"
#include "StelLogger.hpp"
#include "StelShortcutGroup.hpp"
#include "StelShortcutMgr.hpp"
#include "StelStyle.hpp"
HelpDialog::HelpDialog() : keyMgr(0)
{
ui = new Ui_helpDialogForm;
keyMgr = StelApp::getInstance().getStelShortcutManager();
Q_ASSERT(keyMgr);
}
HelpDialog::~HelpDialog()
{
delete ui;
ui = NULL;
}
void HelpDialog::retranslate()
{
if (dialog)
{
ui->retranslateUi(dialog);
updateText();
}
}
void HelpDialog::styleChanged()
{
if (dialog)
{
updateText();
}
}
void HelpDialog::updateIconsColor()
{
QPixmap pixmap(50, 50);
QStringList icons;
icons << "help" << "info" << "logs";
bool redIcon = false;
if (StelApp::getInstance().getVisionModeNight())
redIcon = true;
foreach(const QString &iconName, icons)
{
pixmap.load(":/graphicGui/tabicon-" + iconName +".png");
if (redIcon)
pixmap = StelButton::makeRed(pixmap);
ui->stackListWidget->item(icons.indexOf(iconName))->setIcon(QIcon(pixmap));
}
}
void HelpDialog::createDialogContent()
{
ui->setupUi(dialog);
connect(&StelApp::getInstance(), SIGNAL(languageChanged()), this, SLOT(retranslate()));
connect(&StelApp::getInstance(), SIGNAL(colorSchemeChanged(QString)), this, SLOT(updateIconsColor()));
ui->stackedWidget->setCurrentIndex(0);
updateIconsColor();
ui->stackListWidget->setCurrentRow(0);
connect(ui->closeStelWindow, SIGNAL(clicked()), this, SLOT(close()));
// Help page
updateText();
connect(ui->editShortcutsButton, SIGNAL(clicked()),
this, SLOT(showShortcutsWindow()));
// Log page
ui->logPathLabel->setText(QString("%1/log.txt:").arg(StelFileMgr::getUserDir()));
connect(ui->stackedWidget, SIGNAL(currentChanged(int)), this, SLOT(updateLog(int)));
connect(ui->refreshButton, SIGNAL(clicked()), this, SLOT(refreshLog()));
connect(ui->stackListWidget, SIGNAL(currentItemChanged(QListWidgetItem *, QListWidgetItem *)), this, SLOT(changePage(QListWidgetItem *, QListWidgetItem*)));
}
void HelpDialog::showShortcutsWindow()
{
QAction* action =
keyMgr->getGuiAction("actionShow_Shortcuts_Window_Global");
if (action)
{
if (action->isChecked())
action->setChecked(false);
action->setChecked(true);
}
}
void HelpDialog::updateLog(int)
{
if (ui->stackedWidget->currentWidget() == ui->pageLog)
refreshLog();
}
void HelpDialog::refreshLog()
{
ui->logBrowser->setPlainText(StelLogger::getLog());
}
QString HelpDialog::getHelpText(void)
{
QString htmlText = "<html><head><title>";
htmlText += Qt::escape(q_("Stellarium Help"));
htmlText += "</title></head><body>\n";
// WARNING! Section titles are re-used below!
htmlText += "<p align=\"center\"><a href=\"#keys\">" +
Qt::escape(q_("Keys")) +
"</a> • <a href=\"#links\">" +
Qt::escape(q_("Further Reading")) +
"</a></p>\n";
htmlText += "<h2 id='keys'>" + Qt::escape(q_("Keys")) + "</h2>\n";
htmlText += "<table cellpadding=\"10%\">\n";
// Describe keys for those keys which do not have actions.
// navigate
htmlText += "<tr><td>" + Qt::escape(q_("Pan view around the sky")) + "</td>";
htmlText += "<td><b>" + Qt::escape(q_("Arrow keys & left mouse drag")) + "</b></td></tr>\n";
// zoom in/out
htmlText += "<tr><td rowspan='2'>" + Qt::escape(q_("Zoom in/out")) +
"</td>";
htmlText += "<td><b>" + Qt::escape(q_("Page Up/Down")) +
"</b></td></tr>\n";
htmlText += "<tr><td><b>" + Qt::escape(q_("CTRL + Up/Down")) +
"</b></td></tr>\n";
// select object
htmlText += "<tr><td>" + Qt::escape(q_("Select object")) + "</td>";
htmlText += "<td><b>" + Qt::escape(q_("Left click")) + "</b></td></tr>\n";
// clear selection
htmlText += "<tr>";
#ifdef Q_OS_MAC
htmlText += "<td rowspan='2'>";
#else
htmlText += "<td>";
#endif
htmlText += Qt::escape(q_("Clear selection")) + "</td>";
htmlText += "<td><b>" + Qt::escape(q_("Right click")) + "</b></td></tr>\n";
#ifdef Q_OS_MAC
htmlText += "<tr><td><b>" + Qt::escape(q_("CTRL + Left click")) + "</b></td></tr>\n";
//htmlText += "<td>" + Qt::escape(q_("Clear selection")) + "</td>";
#endif
htmlText += "</table>\n<p>" +
Qt::escape(
q_("Below are listed only the actions with assigned keys. Further actions may be available via the \"%1\" button.")
.arg(ui->editShortcutsButton->text())
) +
"</p><table cellpadding=\"10%\">\n";
QList<StelShortcutGroup*> groups = keyMgr->getGroupList();
foreach (const StelShortcutGroup* group, groups)
{
QString groupName= group->getText();
if (groupName.isEmpty())
groupName = group->getId();
QList< KeyDescription > descriptions;
QList<StelShortcut*> shortcuts = group->getActionList();
if (shortcuts.isEmpty())
continue;
foreach (const StelShortcut* shortcut, shortcuts)
{
QString text = q_(shortcut->getText());
QKeySequence primary = shortcut->getPrimaryKey();
if (primary.isEmpty())
{
// TODO: Decide whether to display undefined actions.
continue;
}
QString keyString = primary.toString(QKeySequence::NativeText);
descriptions.append(KeyDescription(text, keyString));
}
if (descriptions.isEmpty())
continue;
// Sort by translated description:
// - on one hand, pre-determined order is lost
// - on the other, easier for the users
qSort(descriptions);
htmlText += "<tr></tr><tr><td><b><u>" + Qt::escape(q_(groupName)) +
":</u></b></td></tr>\n";
foreach (const KeyDescription& desc, descriptions)
{
htmlText += "<tr><td>" + Qt::escape(desc.first) + "</td>";
htmlText += "<td><b>" + Qt::escape(desc.second) +
"</b></td></tr>\n";
}
}
// edit shortcuts
// htmlText += "<tr><td><b>" + Qt::escape(q_("F7")) + "</b></td>";
// htmlText += "<td>" + Qt::escape(q_("Show and edit all keyboard shortcuts")) + "</td></tr>\n";
htmlText += "</table>";
// Regexp to replace {text} with an HTML link.
QRegExp a_rx = QRegExp("[{]([^{]*)[}]");
// WARNING! Section titles are re-used above!
htmlText += "<h2 id=\"links\">" + Qt::escape(q_("Further Reading")) + "</h2>\n";
htmlText += Qt::escape(q_("The following links are external web links, and will launch your web browser:\n"));
htmlText += "<p><a href=\"http://stellarium.org/wiki/index.php/Category:User%27s_Guide\">" + Qt::escape(q_("The Stellarium User Guide")) + "</a>";
htmlText += "<p>";
// TRANSLATORS: The text between braces is the text of an HTML link.
htmlText += Qt::escape(q_("{Frequently Asked Questions} about Stellarium. Answers too.")).replace(a_rx, "<a href=\"http://www.stellarium.org/wiki/index.php/FAQ\">\\1</a>");
htmlText += "</p>\n";
htmlText += "<p>";
// TRANSLATORS: The text between braces is the text of an HTML link.
htmlText += Qt::escape(q_("{The Stellarium Wiki} - General information. You can also find user-contributed landscapes and scripts here.")).replace(a_rx, "<a href=\"http://stellarium.org/wiki/\">\\1</a>");
htmlText += "</p>\n";
htmlText += "<p>";
// TRANSLATORS: The text between braces is the text of an HTML link.
htmlText += Qt::escape(q_("{Support ticket system} - if you need help using Stellarium, post a support request here and we'll try to help.")).replace(a_rx, "<a href=\"http://answers.launchpad.net/stellarium/+addquestion\">\\1</a>");
htmlText += "</p>\n";
htmlText += "<p>";
// TRANSLATORS: The text between braces is the text of an HTML link.
htmlText += Qt::escape(q_("{Bug reporting and feature request system} - if something doesn't work properly or is missing and is not listed in the tracker, you can open bug reports here.")).replace(a_rx, "<a href=\"http://bugs.launchpad.net/stellarium/\">\\1</a>");
htmlText += "</p>\n";
htmlText += "<p>";
// TRANSLATORS: The text between braces is the text of an HTML link.
htmlText += Qt::escape(q_("{Forums} - discuss Stellarium with other users.")).replace(a_rx, "<a href=\"http://sourceforge.net/forum/forum.php?forum_id=278769\">\\1</a>");
htmlText += "</p>\n";
htmlText += "</body></html>\n";
return htmlText;
}
void HelpDialog::updateText(void)
{
QString newHtml = getHelpText();
ui->helpBrowser->clear();
StelGui* gui = dynamic_cast<StelGui*>(StelApp::getInstance().getGui());
Q_ASSERT(gui);
ui->helpBrowser->document()->setDefaultStyleSheet(QString(gui->getStelStyle().htmlStyleSheet));
ui->helpBrowser->insertHtml(newHtml);
ui->helpBrowser->scrollToAnchor("top");
// populate About tab
newHtml = "<h1>" + StelUtils::getApplicationName() + "</h1>";
// Note: this legal notice is not suitable for traslation
newHtml += "<h3>Copyright © 2000-2013 Stellarium Developers</h3>";
newHtml += "<p>This program is free software; you can redistribute it and/or ";
newHtml += "modify it under the terms of the GNU General Public License ";
newHtml += "as published by the Free Software Foundation; either version 2 ";
newHtml += "of the License, or (at your option) any later version.</p>";
newHtml += "<p>This program is distributed in the hope that it will be useful, ";
newHtml += "but WITHOUT ANY WARRANTY; without even the implied ";
newHtml += "warranty of MERCHANTABILITY or FITNESS FOR A ";
newHtml += "PARTICULAR PURPOSE. See the GNU General Public ";
newHtml += "License for more details.</p>";
newHtml += "<p>You should have received a copy of the GNU General Public ";
newHtml += "License along with this program; if not, write to:</p>";
newHtml += "<pre>Free Software Foundation, Inc.\n";
newHtml += "51 Franklin Street, Suite 500\n";
newHtml += "Boston, MA 02110-1335, USA.\n</pre>";
newHtml += "<p><a href=\"http://www.fsf.org\">www.fsf.org</a></p>";
newHtml += "<h3>" + Qt::escape(q_("Developers")) + "</h3><ul>";
newHtml += "<li>" + Qt::escape(q_("Project coordinator & lead developer: %1").arg(QString("Fabien Ch%1reau").arg(QChar(0x00E9)))) + "</li>";
newHtml += "<li>" + Qt::escape(q_("Doc author/developer: %1").arg(QString("Matthew Gates"))) + "</li>";
newHtml += "<li>" + Qt::escape(q_("Developer: %1").arg(QString("Bogdan Marinov"))) + "</li>";
newHtml += "<li>" + Qt::escape(q_("Developer: %1").arg(QString("Timothy Reaves"))) + "</li>";
newHtml += "<li>" + Qt::escape(q_("Developer: %1").arg(QString("Guillaume Ch%1reau").arg(QChar(0x00E9)))) + "</li>";
newHtml += "<li>" + Qt::escape(q_("Developer: %1").arg(QString("Georg Zotti"))) + "</li>";
newHtml += "<li>" + Qt::escape(q_("Developer: %1").arg(QString("Alexander Wolf"))) + "</li>";
newHtml += "<li>" + Qt::escape(q_("Continuous Integration: %1").arg(QString("Hans Lambermont"))) + "</li>";
newHtml += "<li>" + Qt::escape(q_("Tester: %1").arg(QString("Barry Gerdes"))) + "</li>";
newHtml += "<li>" + Qt::escape(q_("Tester: %1").arg(QString("Khalid AlAjaji"))) + "</li></ul>";
newHtml += "<h3>" + Qt::escape(q_("Past Developers")) + "</h3>";
newHtml += "<p>" + Qt::escape(q_("Several people have made significant contributions, but are no longer active. Their work has made a big difference to the project:")) + "</p><ul>";
newHtml += "<li>" + Qt::escape(q_("Graphic/other designer: %1").arg(QString("Johan Meuris"))) + "</li>";
newHtml += "<li>" + Qt::escape(q_("Developer: %1").arg(QString("Johannes Gajdosik"))) + "</li>";
newHtml += "<li>" + Qt::escape(q_("Developer: %1").arg(QString("Rob Spearman"))) + "</li>";
newHtml += "<li>" + Qt::escape(q_("Developer: %1").arg(QString("Andr%1s Mohari").arg(QChar(0x00E1)))) + "</li>";
newHtml += "<li>" + Qt::escape(q_("Developer: %1").arg(QString("Mike Storm"))) + "</li>";
newHtml += "<li>" + Qt::escape(q_("OSX Developer: %1").arg(QString("Nigel Kerr"))) + "</li>";
newHtml += "<li>" + Qt::escape(q_("OSX Developer: %1").arg(QString("Diego Marcos"))) + "</li></ul>";
newHtml += "<p>";
ui->aboutBrowser->clear();
ui->aboutBrowser->document()->setDefaultStyleSheet(QString(gui->getStelStyle().htmlStyleSheet));
ui->aboutBrowser->insertHtml(newHtml);
ui->aboutBrowser->scrollToAnchor("top");
}
void HelpDialog::changePage(QListWidgetItem *current, QListWidgetItem *previous)
{
if (!current)
current = previous;
ui->stackedWidget->setCurrentIndex(ui->stackListWidget->row(current));
}
|