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
|
/*
* Copyright (c) 2002-2006 Samit Basu
*
* 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
#include "helpwidget.hpp"
#include "Interpreter.hpp"
#include <QtGui>
#include <QDebug>
HelpSearcher::HelpSearcher(QWidget *parent, QString basepath, HelpWindow *mgr) : QWidget(parent) {
QVBoxLayout *vlayout = new QVBoxLayout;
QWidget *pane = new QWidget;
QHBoxLayout *hlayout = new QHBoxLayout;
hlayout->addWidget(new QLabel("Search Text:"));
m_search_word = new QLineEdit;
hlayout->addWidget(m_search_word);
pane->setLayout(hlayout);
vlayout->addWidget(pane);
m_results_list = new QListWidget;
vlayout->addWidget(m_results_list);
setLayout(vlayout);
connect(m_search_word,SIGNAL(returnPressed()),this,SLOT(updateSearch()));
connect(m_results_list,SIGNAL(itemDoubleClicked(QListWidgetItem*)),
mgr,SLOT(activateModuleSearch(QListWidgetItem*)));
connect(m_results_list,SIGNAL(itemActivated(QListWidgetItem*)),
mgr,SLOT(activateModuleSearch(QListWidgetItem*)));
m_basepath = basepath;
searchString = &mgr->searchString;
}
void HelpSearcher::updateSearch() {
m_results_list->clear();
*searchString = m_search_word->text();
/* Todo: add ? and * search ability */
QRegExp search_pattern("\\b" + m_search_word->text() + "\\b");
// Get a list of all .html files
QDir dir(m_basepath);
dir.setNameFilters(QStringList() << "*.html");
QFileInfoList list = dir.entryInfoList();
bool isFound = false;
for (int i=0;i<list.size();i++) {
QFileInfo fileInfo = list.at(i);
QFile f(fileInfo.absoluteFilePath());
if (f.open(QIODevice::ReadOnly)) {
QTextStream str(&f);
QString helpText(str.readAll());
if (helpText.count(search_pattern) > 0) {
QString entry(fileInfo.fileName());
QRegExp reg("(\\w*)_(\\w*)");
if (reg.indexIn(entry) > -1) {
if (reg.cap(1) != "sec") {
new QListWidgetItem(reg.cap(2) + " (" + reg.cap(1) + ")",m_results_list);
isFound = true;
}
}
}
}
}
if (!isFound)
QMessageBox::warning(this, "helpwin",
"Cannot find help document for '" + m_search_word->text() + "'\n",
QMessageBox::Ok,QMessageBox::NoButton,QMessageBox::NoButton);
}
void HelpWindow::activateModule(QListWidgetItem* item) {
QString name_and_section(item->text());
QRegExp modname_pattern("^\\s*(\\b\\w+\\b)\\s*\\((\\b\\w+\\b)\\)");
if (modname_pattern.indexIn(name_and_section) < 0)
return;
}
void HelpWindow::activateModuleSearch(QListWidgetItem* item) {
QString name_and_section(item->text());
QRegExp modname_pattern("^\\s*(\\b\\w+\\b)\\s*\\((\\b\\w+\\b)\\)");
if (modname_pattern.indexIn(name_and_section) < 0)
return;
}
void HelpWindow::activateModule(QTreeWidgetItem* item, int) {
QString fulltext(item->text(0));
QRegExp modname("^\\s*(\\b[\\w]+\\b)");
if (modname.indexIn(fulltext) < 0)
return;
QString module(modname.cap(1).toLower());
}
void HelpWindow::helpText(QString fulltext) {
QList<QListWidgetItem *> items = m_helpwidget->m_flist->findItems(fulltext.toLower(),Qt::MatchStartsWith);
if (items.isEmpty()) {
QMessageBox::warning(this, "helpwin",
"Cannot find help document for '" + fulltext + "'\n",
QMessageBox::Ok,QMessageBox::NoButton,QMessageBox::NoButton);
return;
}
QListWidgetItem* item = items.at(0);
QString name_and_section(item->text());
QRegExp modname_pattern("^\\s*(\\b\\w+\\b)\\s*\\((\\b\\w+\\b)\\)");
if (modname_pattern.indexIn(name_and_section) < 0)
return;
m_helpwidget->m_flist->setCurrentItem(item);
}
HelpWidget::HelpWidget(QString url, HelpWindow *mgr) {
setObjectName("helpwidget");
m_browser = new QTabWidget(this);
setWidget(m_browser);
m_flist = new QListWidget;
// Populate the list widget
QFile *file = new QFile(url + "/modules.txt");
if (!file->open(QFile::ReadOnly | QIODevice::Text))
QMessageBox::warning(this,"Cannot Find Module List","The file modules.txt is missing from the directory "+url+" where I think help files should be. The Topic List widget will not function properly.",QMessageBox::Ok,QMessageBox::NoButton,QMessageBox::NoButton);
else {
QTextStream t(file);
while (!t.atEnd()) {
QString line(t.readLine());
new QListWidgetItem(line,m_flist);
}
}
delete file;
connect(m_flist,SIGNAL(itemDoubleClicked(QListWidgetItem*)),
mgr,SLOT(activateModule(QListWidgetItem*)));
connect(m_flist,SIGNAL(itemActivated(QListWidgetItem*)),
mgr,SLOT(activateModule(QListWidgetItem*)));
m_browser->addTab(m_flist,"Topic List");
m_browser->addTab(new HelpSearcher(m_browser,url,mgr),"Search");
}
HelpWindow::HelpWindow(QString url) {
setWindowIcon(QPixmap(":/images/freemat_help_small_mod_64.png"));
setWindowTitle(QString(Interpreter::getVersionString()) + " Online Help");
m_initial = url;
m_helpwidget = new HelpWidget(url,this);
addDockWidget(Qt::LeftDockWidgetArea,m_helpwidget);
createActions();
createMenus();
createToolBars();
createStatusBar();
readSettings();
}
void HelpWindow::closeEvent(QCloseEvent* ce) {
writeSettings();
ce->accept();
}
void HelpWindow::writeSettings() {
QSettings settings("FreeMat", Interpreter::getVersionString());
settings.setValue("helpwindow/state",saveState());
settings.setValue("helpwindow/pos", pos());
settings.setValue("helpwindow/size", size());
}
void HelpWindow::readSettings() {
QSettings settings("FreeMat", Interpreter::getVersionString());
QPoint pos = settings.value("helpwindow/pos", QPoint(200, 200)).toPoint();
QSize size = settings.value("helpwindow/size", QSize(500, 300)).toSize();
resize(size);
move(pos);
QByteArray state = settings.value("helpwindow/state").toByteArray();
restoreState(state);
}
void HelpWindow::createActions() {
QList<QKeySequence> stemp;
stemp.clear();
zoominAct = new QAction(QIcon(":/images/zoomin.png"),"Zoom &In",this);
zoominAct->setShortcut(Qt::Key_Plus | Qt::CTRL);
zoomoutAct = new QAction(QIcon(":/images/zoomout.png"),"Zoom &Out",this);
zoomoutAct->setShortcut(Qt::Key_Minus | Qt::CTRL);
copyAct = new QAction(QIcon(":/images/copy.png"),"&Copy Selection",this);
stemp.clear();
stemp.push_back(QKeySequence(Qt::Key_C | Qt::CTRL));
stemp.push_back(QKeySequence(Qt::Key_Insert | Qt::CTRL));
copyAct->setShortcuts(stemp);
exitAct = new QAction(QIcon(":/images/quit.png"),"&Exit Help",this);
exitAct->setShortcut(Qt::Key_Q | Qt::CTRL);
connect(exitAct,SIGNAL(triggered()),this,SLOT(close()));
forwardAct = new QAction(QIcon(":/images/next.png"),"&Next",this);
forwardAct->setShortcut(Qt::Key_Right | Qt::Key_Alt);
backAct = new QAction(QIcon(":/images/previous.png"),"&Previous",this);
backAct->setShortcut(Qt::Key_Left | Qt::Key_Alt);
homeAct = new QAction(QIcon(":/images/home.png"),"&Home",this);
homeAct->setShortcut(Qt::Key_Home | Qt::CTRL);
executeSelectionAct = new QAction(QIcon(":/images/player_playselection.png"),"&Execute Selection",this);
executeSelectionAct->setShortcut(Qt::Key_F9);
connect(executeSelectionAct,SIGNAL(triggered()),this,SLOT(execSelected()));
helpOnSelectionAct = new QAction(QIcon(":/images/help_onselection.png"), "&Help on Selection",this);
helpOnSelectionAct->setShortcut(Qt::Key_F2);
connect(helpOnSelectionAct,SIGNAL(triggered()),this,SLOT(helpOnSelection()));
forwardAct->setEnabled(false);
backAct->setEnabled(false);
}
void HelpWindow::createMenus() {
fileMenu = menuBar()->addMenu("&File");
fileMenu->addAction(exitAct);
editMenu = menuBar()->addMenu("&Edit");
editMenu->addAction(copyAct);
editMenu->addAction(helpOnSelectionAct);
editMenu->addAction(executeSelectionAct);
editMenu->addAction(zoominAct);
editMenu->addAction(zoomoutAct);
goMenu = menuBar()->addMenu("&Go");
goMenu->addAction(forwardAct);
goMenu->addAction(backAct);
goMenu->addAction(homeAct);
}
void HelpWindow::createToolBars() {
goToolBar = addToolBar("Go");
goToolBar->setObjectName("GoToolBar");
goToolBar->addAction(backAct);
goToolBar->addAction(forwardAct);
goToolBar->addAction(homeAct);
editToolBar = addToolBar("Edit");
editToolBar->setObjectName("EditToolBar");
editToolBar->addAction(copyAct);
editToolBar->addAction(helpOnSelectionAct);
editToolBar->addAction(executeSelectionAct);
editToolBar->addAction(zoominAct);
editToolBar->addAction(zoomoutAct);
}
void HelpWindow::createStatusBar() {
statusBar()->showMessage("Ready");
}
void HelpWindow::execSelected() {
}
void HelpWindow::helpOnSelection() {
}
|