HelpDialog Class Reference

#include <helpdialog.h>

Inheritance diagram for HelpDialog:

[legend]Collaboration diagram for HelpDialog:

[legend]List of all members.

---

Detailed Description

Definition at line 69 of file helpdialog.h.

Public Slots
void	initialize ()
void	startSearch ()
void	addBookmark ()
void	currentTabChanged (int index)
void	locateContents (const QString &link)
Signals
void	showLink (const QString &s)
void	showSearchLink (const QString &s, const QStringList &terms)
Public Member Functions
	HelpDialog (QWidget *parent, MainWindow *h)
QTabWidget *	tabWidget () const
QString	titleOfLink (const QString &link)
bool	eventFilter (QObject *, QEvent *)
bool	lastWindowClosed ()
void	timerEvent (QTimerEvent *e)
Static Public Member Functions
static QString	removeAnchorFromLink (const QString &link)
Private Types
typedef QList< ContentItem >	ContentList
Private Slots
void	on_buttonAdd_clicked ()
void	on_buttonRemove_clicked ()
void	on_termsEdit_returnPressed ()
void	on_helpButton_clicked ()
void	on_searchButton_clicked ()
void	on_resultBox_itemActivated (QListWidgetItem *)
void	showResultPage (QListWidgetItem *)
void	showTopic (QTreeWidgetItem *)
void	loadIndexFile ()
void	insertContents ()
void	setupFullTextIndex ()
void	showTopic ()
void	searchInIndex (const QString &s)
void	toggleContents ()
void	toggleIndex ()
void	toggleBookmarks ()
void	toggleSearch ()
void	lastWinClosed ()
void	setIndexingProgress (int prog)
void	showListItemMenu (const QPoint &pos)
void	showIndexItemMenu (const QPoint &pos)
void	showTreeItemMenu (const QPoint &pos)
void	insertBookmarks ()
void	processEvents ()
Private Member Functions
void	removeOldCacheFiles (bool onlyFulltextSearchIndex=false)
void	buildKeywordDB ()
quint32	getFileAges ()
void	showIndexTopic ()
void	showBookmarkTopic ()
void	setupTitleMap ()
void	saveBookmarks ()
void	showContentsTopic ()
void	showInitDoneMessage ()
void	buildContentDict ()
QTreeWidgetItem *	locateLink (QTreeWidgetItem *item, const QString &link)
void	getAllContents ()
Private Attributes
Ui::HelpDialog	ui
IndexListModel *	indexModel
QMap< QString, QString >	titleMap
bool	indexDone
bool	bookmarksInserted
bool	titleMapDone
bool	contentsInserted
bool	lwClosed
MainWindow *	help
QString	documentationPath
Index *	fullTextIndex
QStringList	terms
QStringList	foundDocs
bool	initDoneMsgShown
QList< QPair< QString, ContentList > >	contentList
QMenu *	itemPopup
QString	cacheFilesPath
QStringList	keywordDocuments
QAction *	actionOpenCurrentTab
QAction *	actionOpenLinkInNewWindow
QAction *	actionOpenLinkInNewTab

---

Member Typedef Documentation

typedef QList<ContentItem> HelpDialog::ContentList [private]

Definition at line 125 of file helpdialog.h.

---

Constructor & Destructor Documentation

HelpDialog::HelpDialog	(	QWidget *	parent,
		MainWindow *	h
	)

Definition at line 216 of file helpdialog.cpp.

References QListView::Batched, indexModel, QHeaderView::ResizeToContents, and ui.

    : QWidget(parent), lwClosed(false), help(h)
{
    ui.setupUi(this);
    ui.listContents->setUniformRowHeights(true);
    ui.listContents->header()->setStretchLastSection(false);
    ui.listContents->header()->setResizeMode(QHeaderView::ResizeToContents);
    ui.listBookmarks->setUniformRowHeights(true);
    ui.listBookmarks->header()->setStretchLastSection(false);
    ui.listBookmarks->header()->setResizeMode(QHeaderView::ResizeToContents);

    indexModel = new IndexListModel(this);
    ui.listIndex->setModel(indexModel);
    ui.listIndex->setLayoutMode(QListView::Batched);
    ui.listBookmarks->setItemHidden(ui.listBookmarks->headerItem(), true);
    ui.listContents->setItemHidden(ui.listContents->headerItem(), true);
}

---

Member Function Documentation

QTabWidget* HelpDialog::tabWidget

(

)

const [inline]

Definition at line 75 of file helpdialog.h.

References ui.

Referenced by MainWindow::saveSettings(), and MainWindow::setup().

    { return ui.tabWidget; }

QString HelpDialog::titleOfLink

(

const QString &

link

)

Definition at line 693 of file helpdialog.cpp.

References removeAnchorFromLink(), s, and titleMap.

Referenced by addBookmark(), showIndexItemMenu(), and showIndexTopic().

{
    QString s = HelpDialog::removeAnchorFromLink(link);
    s = titleMap[s];
    if (s.isEmpty())
        return link;
    return s;
}

Here is the call graph for this function:

bool HelpDialog::eventFilter	(	QObject *	o,
		QEvent *	e
	)			[virtual]

Filters events if this object has been installed as an event filter for the watched object.

In your reimplementation of this function, if you want to filter the event out, i.e. stop it being handled further, return true; otherwise return false.

Example:

        class MainWindow : public QMainWindow
        {
        public:
            MainWindow();

        protected:
            bool eventFilter(QObject *obj, QEvent *ev);

        private:
            QTextEdit *textEdit;
        };

        MainWindow::MainWindow()
        {
            textEdit = new QTextEdit;
            setCentralWidget(textEdit);

            textEdit->installEventFilter(this);
        }

        bool MainWindow::eventFilter(QObject *obj, QEvent *event)
        {
            if (obj == textEdit) {
                if (event->type() == QEvent::KeyPress) {
                    QKeyEvent *keyEvent = static_cast<QKeyEvent*>(event);
                    qDebug() << "Ate key press" << keyEvent->key();
                    return true;
                } else {
                    return false;
                }
            } else {
                // pass the event on to the parent class
                return QMainWindow::eventFilter(obj, event);
            }
        }

Notice in the example above that unhandled events are passed to the base class's eventFilter() function, since the base class might have reimplemented eventFilter() for its own internal purposes.

Warning:

If you delete the receiver object in this function, be sure to return true. Otherwise, Qt will forward the event to the deleted object and the program might crash.

See also:

installEventFilter()

Reimplemented from QObject.

Definition at line 702 of file helpdialog.cpp.

References QObject::eventFilter(), key, Qt::Key_Down, Qt::Key_PageDown, Qt::Key_PageUp, Qt::Key_Up, QEvent::KeyPress, Qt::LeftButton, QEvent::MouseButtonRelease, o, QCoreApplication::sendEvent(), showTopic(), QEvent::type(), and ui.

{
    if (o == ui.editIndex && e->type() == QEvent::KeyPress) {
        switch (static_cast<QKeyEvent*>(e)->key()) {
            case Qt::Key_Up:
            case Qt::Key_Down:
            case Qt::Key_PageDown:
            case Qt::Key_PageUp:
                QApplication::sendEvent(ui.listIndex, e);
                break;

            default:
                break;
        }
    } else if (o == ui.listContents->viewport())
        if (e->type() == QEvent::MouseButtonRelease) {
        QMouseEvent *me = static_cast<QMouseEvent*>(e);
        if (me->button() == Qt::LeftButton) {
            QTreeWidgetItem *item = ui.listContents->itemAt(me->pos());
            if (item)
                showTopic(item);
        }
    }

    return QWidget::eventFilter(o, e);
}

Here is the call graph for this function:

bool HelpDialog::lastWindowClosed

(

)

[inline]

Definition at line 80 of file helpdialog.h.

References lwClosed.

Referenced by initialize().

{ return lwClosed; }

void HelpDialog::timerEvent

(

QTimerEvent *

e

)

[virtual]

This event handler can be reimplemented in a subclass to receive timer events for the object.

QTimer provides a higher-level interface to the timer functionality, and also more general information about timers. The timer event is passed in the event parameter.

See also:

startTimer(), killTimer(), event()

Reimplemented from QObject.

Definition at line 325 of file helpdialog.cpp.

References help, qApp, and QWidget::setWindowOpacity().

{
    Q_UNUSED(e);
    static int opacity = 255;
    help->setWindowOpacity((opacity-=4)/255.0);
    if (opacity<=0)
        qApp->quit();
}

Here is the call graph for this function:

QString HelpDialog::removeAnchorFromLink

(

const QString &

link

)

[static]

Definition at line 1273 of file helpdialog.cpp.

References i, j, l, QString::lastIndexOf(), QString::left(), QString::length(), QString::mid(), and QDir::separator().

Referenced by HelpNavigationListItem::addLink(), loadIndexFile(), setupFullTextIndex(), and titleOfLink().

{
    int i = link.length();
  int j = link.lastIndexOf('/');
    int l = link.lastIndexOf(QDir::separator());
    if (l > j)
        j = l;
  if (j > -1) {
    QString fileName = link.mid(j+1);
    int k = fileName.lastIndexOf('#');
    if (k > -1)
      i = j + k + 1;
  }
  return link.left(i);
}

Here is the call graph for this function:

void HelpDialog::showLink

(

const QString &

s

)

[signal]

Referenced by on_helpButton_clicked(), showBookmarkTopic(), showContentsTopic(), and showIndexTopic().

void HelpDialog::showSearchLink	(	const QString &	s,
		const QStringList &	terms
	)			[signal]

Referenced by showResultPage().

void HelpDialog::initialize

(

)

[slot]

Definition at line 234 of file helpdialog.cpp.

References actionOpenCurrentTab, actionOpenLinkInNewTab, actionOpenLinkInNewWindow, QMenu::addAction(), bookmarksInserted, cacheFilesPath, QObject::connect(), contentList, contentsInserted, currentTabChanged(), QWidget::customContextMenuRequested(), Qt::ElideNone, fullTextIndex, QDir::homePath(), indexDone, initDoneMsgShown, itemPopup, lastWinClosed(), lastWindowClosed(), qApp, searchInIndex(), QAction::setText(), setupTitleMap(), showIndexItemMenu(), showListItemMenu(), showTopic(), showTreeItemMenu(), SIGNAL, SLOT, titleMapDone, and ui.

Referenced by MainWindow::setup().

{
    connect(ui.tabWidget, SIGNAL(currentChanged(int)), this, SLOT(currentTabChanged(int)));

    connect(ui.listContents, SIGNAL(itemActivated(QTreeWidgetItem*,int)), this, SLOT(showTopic(QTreeWidgetItem*)));
    connect(ui.listContents, SIGNAL(customContextMenuRequested(QPoint)), this, SLOT(showTreeItemMenu(QPoint)));
    ui.listContents->viewport()->installEventFilter(this);

    connect(ui.editIndex, SIGNAL(returnPressed()), this, SLOT(showTopic()));
    connect(ui.editIndex, SIGNAL(textEdited(QString)), this, SLOT(searchInIndex(QString)));

    connect(ui.listIndex, SIGNAL(activated(QModelIndex)), this, SLOT(showTopic()));
    connect(ui.listIndex, SIGNAL(customContextMenuRequested(QPoint)), this, SLOT(showIndexItemMenu(QPoint)));

    connect(ui.listBookmarks, SIGNAL(itemActivated(QTreeWidgetItem*,int)), this, SLOT(showTopic(QTreeWidgetItem*)));
    connect(ui.listBookmarks, SIGNAL(customContextMenuRequested(QPoint)), this, SLOT(showTreeItemMenu(QPoint)));

    connect(ui.resultBox, SIGNAL(customContextMenuRequested(QPoint)), this, SLOT(showListItemMenu(QPoint)));

    cacheFilesPath = QDir::homePath() + QLatin1String("/.assistant"); //### Find a better location for the dbs

    ui.editIndex->installEventFilter(this);

    ui.framePrepare->hide();
    connect(qApp, SIGNAL(lastWindowClosed()), SLOT(lastWinClosed()));

    ui.termsEdit->setValidator(new SearchValidator(ui.termsEdit));

    actionOpenCurrentTab = new QAction(this);
    actionOpenCurrentTab->setText(tr("Open Link in Current Tab"));

    actionOpenLinkInNewWindow = new QAction(this);
    actionOpenLinkInNewWindow->setText(tr("Open Link in New Window"));

    actionOpenLinkInNewTab = new QAction(this);
    actionOpenLinkInNewTab->setText(tr("Open Link in New Tab"));

    itemPopup = new QMenu(this);
    itemPopup->addAction(actionOpenCurrentTab);
    itemPopup->addAction(actionOpenLinkInNewWindow);
    itemPopup->addAction(actionOpenLinkInNewTab);

    ui.tabWidget->setElideMode(Qt::ElideNone);

    contentList.clear();

    initDoneMsgShown = false;
    fullTextIndex = 0;
    indexDone = false;
    titleMapDone = false;
    contentsInserted = false;
    bookmarksInserted = false;
    setupTitleMap();

}

void HelpDialog::startSearch

(

)

[slot]

Definition at line 1076 of file helpdialog.cpp.

References QString::arg(), Qt::ArrowCursor, QList< T >::begin(), buf, QList< T >::clear(), QString::contains(), QString::count(), QList< T >::count(), QList< T >::end(), foundDocs, QString::fromLatin1(), fullTextIndex, Index::getDocumentTitle(), help, i, QString::indexOf(), int, QList< QString >::iterator, QString::mid(), Index::query(), QString::replace(), s, QWidget::setCursor(), QStatusBar::showMessage(), QString::simplified(), QString::split(), QMainWindow::statusBar(), terms, QString::toUtf8(), ui, Qt::WaitCursor, and QMessageBox::warning().

Referenced by on_searchButton_clicked(), and on_termsEdit_returnPressed().

{
    QString str = ui.termsEdit->text();
    str = str.simplified();
    str = str.replace(QLatin1String("\'"), QLatin1String("\""));
    str = str.replace(QLatin1String("`"), QLatin1String("\""));
    QString buf = str;
    str = str.replace(QLatin1String("-"), QLatin1String(" "));
    str = str.replace(QRegExp(QLatin1String("\\s[\\S]?\\s")), QLatin1String(" "));
    terms = str.split(QLatin1Char(' '));
    QStringList termSeq;
    QStringList seqWords;
    QStringList::iterator it = terms.begin();
    for (; it != terms.end(); ++it) {
        (*it) = (*it).simplified();
        (*it) = (*it).toLower();
        (*it) = (*it).replace(QLatin1String("\""), QLatin1String(""));
    }
    if (str.contains(QLatin1Char('\"'))) {
        if ((str.count(QLatin1Char('\"')))%2 == 0) {
            int beg = 0;
            int end = 0;
            QString s;
            beg = str.indexOf(QLatin1Char('\"'), beg);
            while (beg != -1) {
                beg++;
                end = str.indexOf(QLatin1Char('\"'), beg);
                s = str.mid(beg, end - beg);
                s = s.toLower();
                s = s.simplified();
                if (s.contains(QLatin1Char('*'))) {
                    QMessageBox::warning(this, tr("Full Text Search"),
                        tr("Using a wildcard within phrases is not allowed."));
                    return;
                }
                seqWords += s.split(QLatin1Char(' '));
                termSeq << s;
                beg = str.indexOf(QLatin1Char('\"'), end + 1);
            }
        } else {
            QMessageBox::warning(this, tr("Full Text Search"),
                tr("The closing quotation mark is missing."));
            return;
        }
    }
    setCursor(Qt::WaitCursor);
    foundDocs.clear();
    foundDocs = fullTextIndex->query(terms, termSeq, seqWords);
    QString msg = QString::fromLatin1("%1 documents found.").arg(foundDocs.count());
    help->statusBar()->showMessage(tr(msg.toUtf8()), 3000);
    ui.resultBox->clear();
    for (it = foundDocs.begin(); it != foundDocs.end(); ++it)
        ui.resultBox->addItem(fullTextIndex->getDocumentTitle(*it));

    terms.clear();
    bool isPhrase = false;
    QString s;
    for (int i = 0; i < (int)buf.length(); ++i) {
        if (buf[i] == QLatin1Char('\"')) {
            isPhrase = !isPhrase;
            s = s.simplified();
            if (!s.isEmpty())
                terms << s;
            s = QLatin1String("");
        } else if (buf[i] == QLatin1Char(' ') && !isPhrase) {
            s = s.simplified();
            if (!s.isEmpty())
                terms << s;
            s = QLatin1String("");
        } else
            s += buf[i];
    }
    if (!s.isEmpty())
        terms << s;

    setCursor(Qt::ArrowCursor);
}

void HelpDialog::addBookmark

(

)

[slot]

Definition at line 729 of file helpdialog.cpp.

References bookmarksInserted, MainWindow::browsers(), TabbedBrowser::currentBrowser(), QTextEdit::documentTitle(), help, i, insertBookmarks(), QString::isEmpty(), LinkRole, saveBookmarks(), QTextBrowser::source(), titleOfLink(), QUrl::toString(), ui, and MainWindow::updateBookmarkMenu().

Referenced by on_buttonAdd_clicked().

{
    if (!bookmarksInserted)
        insertBookmarks();
    QString link = help->browsers()->currentBrowser()->source().toString();
    QString title = help->browsers()->currentBrowser()->documentTitle();
    if (title.isEmpty())
        title = titleOfLink(link);

    QTreeWidgetItem *i = new QTreeWidgetItem(ui.listBookmarks, 0);
    i->setText(0, title);
    i->setData(0, LinkRole, link);
    saveBookmarks();
    help->updateBookmarkMenu();
}

void HelpDialog::currentTabChanged

(

int

index

)

[slot]

Definition at line 598 of file helpdialog.cpp.

References insertBookmarks(), insertContents(), loadIndexFile(), s, setupFullTextIndex(), QTimer::singleShot(), SLOT, stripAmpersand(), and ui.

Referenced by initialize(), and MainWindow::setup().

{
    QString s = ui.tabWidget->tabText(index);
    if (stripAmpersand(s).contains(tr("Index")))
        QTimer::singleShot(0, this, SLOT(loadIndexFile()));
    else if (stripAmpersand(s).contains(tr("Bookmarks")))
        insertBookmarks();
    else if (stripAmpersand(s).contains(tr("Contents")))
        QTimer::singleShot(0, this, SLOT(insertContents()));
    else if (stripAmpersand(s).contains(tr("Search")))
        QTimer::singleShot(0, this, SLOT(setupFullTextIndex()));
}

void HelpDialog::locateContents

(

const QString &

link

)

[slot]

Definition at line 923 of file helpdialog.cpp.

References Qt::CaseInsensitive, Qt::CaseSensitive, QString::contains(), contentsInserted, QTreeWidgetItem::data(), i, insertContents(), LinkRole, locateLink(), QString::replace(), QString::startsWith(), QVariant::toString(), and ui.

Referenced by MainWindow::on_actionSyncToc_triggered().

{
    //ensure the TOC is filled
    if (!contentsInserted)
        insertContents();
#ifdef Q_OS_WIN
    Qt::CaseSensitivity checkCase = Qt::CaseInsensitive;
#else
    Qt::CaseSensitivity checkCase = Qt::CaseSensitive;
#endif
    QString findLink(link);
    //Installations on a windows local drive will give the 'link' as <file:///C:/xxx>
    //and the contents in the TOC will be <file:C:/xxx>.
    //But on others the 'link' of format <file:///root/xxx>
    //and the contents in the TOC will be <file:/root/xxx>.
    if (findLink.contains("file:///")) {
        if (findLink[9] == QChar(':')) //on windows drives
            findLink.replace(0, 8, "file:");
        else
            findLink.replace(0, 8, "file:/");
    }
    QTreeWidgetItem *item = 0;
    int i = 0, totalItems = ui.listContents->topLevelItemCount();
    for (i = 0; i < totalItems; i++ ) {
        item = (QTreeWidgetItem*)ui.listContents->topLevelItem(i);
        if (findLink.startsWith(item->data(0, LinkRole).toString(), checkCase))
            break;
        item = locateLink(item, findLink);
        if (item)
            break;
    }
    if ( i!= totalItems){
        //remove the old selection
        QList<QTreeWidgetItem *> selected = ui.listContents->selectedItems();
        QTreeWidgetItem *sel;
        foreach(sel, selected)
            ui.listContents->setItemSelected(sel, false);
        //set the TOC item and show.
        ui.listContents->setItemSelected(item, true);
        ui.listContents->scrollToItem(item);
        ui.tabWidget->setCurrentIndex(0);
    }
}

void HelpDialog::on_buttonAdd_clicked

(

)

[private, slot]

Definition at line 745 of file helpdialog.cpp.

References addBookmark().

{
    addBookmark();
}

void HelpDialog::on_buttonRemove_clicked

(

)

[private, slot]

Definition at line 750 of file helpdialog.cpp.

References help, saveBookmarks(), ui, and MainWindow::updateBookmarkMenu().

{
    if (!ui.listBookmarks->currentItem())
        return;

    delete ui.listBookmarks->currentItem();
    saveBookmarks();
    if (ui.listBookmarks->topLevelItemCount() != 0) {
        ui.listBookmarks->setCurrentItem(ui.listBookmarks->topLevelItem(0));
    }
    help->updateBookmarkMenu();
}

void HelpDialog::on_termsEdit_returnPressed

(

)

[private, slot]

Definition at line 1263 of file helpdialog.cpp.

References startSearch().

{
    startSearch();
}

void HelpDialog::on_helpButton_clicked

(

)

[private, slot]

Definition at line 1154 of file helpdialog.cpp.

References Config::configuration(), emit, showLink(), and MainWindow::urlifyFileName().

{
    emit showLink(MainWindow::urlifyFileName(
                  Config::configuration()->assistantDocPath() +
                  QLatin1String("/assistant-manual.html#full-text-searching")));
}

void HelpDialog::on_searchButton_clicked

(

)

[private, slot]

Definition at line 1268 of file helpdialog.cpp.

References startSearch().

{
    startSearch();
}

void HelpDialog::on_resultBox_itemActivated

(

QListWidgetItem *

)

[private, slot]

Definition at line 1161 of file helpdialog.cpp.

References showResultPage().

{
    showResultPage(item);
}

void HelpDialog::showResultPage

(

QListWidgetItem *

)

[private, slot]

Definition at line 1166 of file helpdialog.cpp.

References emit, foundDocs, showSearchLink(), terms, and ui.

Referenced by on_resultBox_itemActivated(), and showListItemMenu().

{
    if (item)
        emit showSearchLink(foundDocs[ui.resultBox->row(item)], terms);
}

void HelpDialog::showTopic

(

QTreeWidgetItem *

)

[private, slot]

Definition at line 619 of file helpdialog.cpp.

References showTopic().

{
    if (item)
        showTopic();
}

void HelpDialog::loadIndexFile

(

)

[private, slot]

Definition at line 335 of file helpdialog.cpp.

References IndexListModel::addLink(), Qt::ArrowCursor, buildKeywordDB(), cacheFilesPath, QList< T >::clear(), QFile::close(), Config::configuration(), getFileAges(), help, i, indexDone, indexModel, keywordDocuments, lwClosed, QProgressBar::maximum(), QFile::open(), processEvents(), IndexListModel::publish(), QIODevice::ReadOnly, removeAnchorFromLink(), QDir::separator(), QWidget::setCursor(), QDataStream::setDevice(), QProgressBar::setMaximum(), QProgressBar::setValue(), showInitDoneMessage(), QObject::startTimer(), ui, Qt::WaitCursor, and QMessageBox::warning().

Referenced by currentTabChanged(), and setupFullTextIndex().

{
    if (indexDone)
        return;

    setCursor(Qt::WaitCursor);
    indexDone = true;
    ui.labelPrepare->setText(tr("Prepare..."));
    ui.framePrepare->show();
    processEvents();

    QProgressBar *bar = ui.progressPrepare;
    bar->setMaximum(100);
    bar->setValue(0);

    keywordDocuments.clear();
    QList<IndexKeyword> lst;
    QFile indexFile(cacheFilesPath + QDir::separator() + QLatin1String("indexdb40.") +
                     Config::configuration()->profileName());
    if (!indexFile.open(QFile::ReadOnly)) {
        buildKeywordDB();
        processEvents();
        if(lwClosed)
            return;
        if (!indexFile.open(QFile::ReadOnly)) {
            QMessageBox::warning(help, tr("Qt Assistant"), tr("Failed to load keyword index file\n"
                                                              "Assistant will not work!"));
#if defined Q_WS_WIN || defined Q_WS_MACX
            startTimer(50);
#endif
            return;
        }
    }

    QDataStream ds(&indexFile);
    quint32 fileAges;
    ds >> fileAges;
    if (fileAges != getFileAges()) {
        indexFile.close();
        buildKeywordDB();
        if (!indexFile.open(QFile::ReadOnly)) {
            QMessageBox::warning(help, tr("Qt Assistant"),
                tr("Cannot open the index file %1").arg(QFileInfo(indexFile).absoluteFilePath()));
            return;
        }
        ds.setDevice(&indexFile);
        ds >> fileAges;
    }
    ds >> lst;
    indexFile.close();

    bar->setValue(bar->maximum());
    processEvents();

    for (int i=0; i<lst.count(); ++i) {
        const IndexKeyword &idx = lst.at(i);
        indexModel->addLink(idx.keyword, idx.link);

        keywordDocuments << HelpDialog::removeAnchorFromLink(idx.link);
    }

    indexModel->publish();

    ui.framePrepare->hide();
    showInitDoneMessage();
    setCursor(Qt::ArrowCursor);
}

void HelpDialog::insertContents

(

)

[private, slot]

Definition at line 819 of file helpdialog.cpp.

References Qt::ArrowCursor, QVector< T >::clear(), QList< T >::constBegin(), QList< T >::constEnd(), contentList, contentsInserted, QPaintDevice::depth(), getAllContents(), j, LinkRole, QStack< T >::pop(), processEvents(), QStack< T >::push(), QWidget::setCursor(), QTreeWidgetItem::setData(), QTreeWidgetItem::setText(), setupTitleMap(), showInitDoneMessage(), titleMapDone, QStack< T >::top(), ui, and Qt::WaitCursor.

Referenced by currentTabChanged(), and locateContents().

{
#ifdef Q_WS_MAC
    static const QLatin1String IconPath(":/trolltech/assistant/images/win/book.png");
#else
    static const QLatin1String IconPath(":/trolltech/assistant/images/win/book.png");
#endif
    if (contentsInserted)
        return;

    if (contentList.isEmpty())
        getAllContents();

    contentsInserted = true;
    ui.listContents->clear();
    setCursor(Qt::WaitCursor);
    if (!titleMapDone)
        setupTitleMap();

#if 0 // ### port me
    ui.listContents->setSorting(-1);
#endif

    for(QList<QPair<QString, ContentList> >::Iterator it = contentList.begin(); it != contentList.end(); ++it) {
        QTreeWidgetItem *newEntry;

        QTreeWidgetItem *contentEntry;
        QStack<QTreeWidgetItem*> stack;
        stack.clear();
        int depth = 0;
        bool root = false;

        QTreeWidgetItem *lastItem[64];
        for(int j = 0; j < 64; ++j)
            lastItem[j] = 0;

        ContentList lst = (*it).second;
        for (ContentList::ConstIterator it = lst.constBegin(); it != lst.constEnd(); ++it) {
            ContentItem item = *it;
            if (item.depth == 0) {
                newEntry = new QTreeWidgetItem(ui.listContents, 0);
                newEntry->setIcon(0, QIcon(IconPath));
                newEntry->setText(0, item.title);
                newEntry->setData(0, LinkRole, item.reference);
                stack.push(newEntry);
                depth = 1;
                root = true;
            }
            else{
                if((item.depth > depth) && root) {
                    depth = item.depth;
                    stack.push(contentEntry);
                }
                if(item.depth == depth) {
                    contentEntry = new QTreeWidgetItem(stack.top(), lastItem[ depth ]);
                    lastItem[ depth ] = contentEntry;
                    contentEntry->setText(0, item.title);
                    contentEntry->setData(0, LinkRole, item.reference);
                }
                else if(item.depth < depth) {
                    stack.pop();
                    depth--;
                    item = *(--it);
                }
            }
        }
        processEvents();
    }
    setCursor(Qt::ArrowCursor);
    showInitDoneMessage();
}

void HelpDialog::setupFullTextIndex

(

)

[private, slot]

Definition at line 1008 of file helpdialog.cpp.

References Qt::ArrowCursor, QList< T >::begin(), cacheFilesPath, QList< T >::clear(), QStatusBar::clearMessage(), Config::configuration(), QObject::connect(), QMap< Key, T >::constBegin(), QMap< Key, T >::constEnd(), QList< T >::end(), QFile::exists(), fullTextIndex, help, QDir::homePath(), QSet< T >::insert(), QMap< Key, T >::key(), keywordDocuments, loadIndexFile(), Index::makeIndex(), processEvents(), Config::profileName(), Index::readDict(), removeAnchorFromLink(), QDir::separator(), QWidget::setCursor(), Index::setDictionaryFile(), Index::setDocList(), Index::setDocListFile(), setIndexingProgress(), showInitDoneMessage(), QStatusBar::showMessage(), SIGNAL, SLOT, QMainWindow::statusBar(), titleMap, QSet< T >::toList(), ui, verifyDirectory(), Qt::WaitCursor, QMessageBox::warning(), and Index::writeDict().

Referenced by currentTabChanged().

{
    if (fullTextIndex)
        return;

    QString pname = Config::configuration()->profileName();
    fullTextIndex = new Index(QStringList(), QDir::homePath()); // ### Is this correct ?
    if (!verifyDirectory(cacheFilesPath)) {
        QMessageBox::warning(help, tr("Qt Assistant"),
                             tr("Failed to save fulltext search index\n"
                                "Assistant will not work!"));
        return;
    }
    fullTextIndex->setDictionaryFile(cacheFilesPath + QDir::separator() + QLatin1String("indexdb40.dict.") + pname);
    fullTextIndex->setDocListFile(cacheFilesPath + QDir::separator() + QLatin1String("indexdb40.doc.") + pname);
    processEvents();

    connect(fullTextIndex, SIGNAL(indexingProgress(int)),
             this, SLOT(setIndexingProgress(int)));
    QFile f(cacheFilesPath + QDir::separator() + QLatin1String("indexdb40.dict.") + pname);
    if (!f.exists()) {
        QString doc;
        QSet<QString> documentSet;
        QMap<QString, QString>::ConstIterator it = titleMap.constBegin();
        for (; it != titleMap.constEnd(); ++it) {
            doc = HelpDialog::removeAnchorFromLink(it.key());
            if (!doc.isEmpty())
                documentSet.insert(doc);
        }
        loadIndexFile();
        for ( QStringList::Iterator it = keywordDocuments.begin(); it != keywordDocuments.end(); ++it ) {
            if (!(*it).isEmpty())
                documentSet.insert(*it);
        }
        fullTextIndex->setDocList( documentSet.toList() );

        help->statusBar()->clearMessage();
        setCursor(Qt::WaitCursor);
        ui.labelPrepare->setText(tr("Indexing files..."));
        ui.progressPrepare->setMaximum(100);
        ui.progressPrepare->reset();
        ui.progressPrepare->show();
        ui.framePrepare->show();
        processEvents();
        if (fullTextIndex->makeIndex() == -1)
            return;
        fullTextIndex->writeDict();
        ui.progressPrepare->setValue(100);
        ui.framePrepare->hide();
        setCursor(Qt::ArrowCursor);
        showInitDoneMessage();
    } else {
        setCursor(Qt::WaitCursor);
        help->statusBar()->showMessage(tr("Reading dictionary..."));
        processEvents();
        fullTextIndex->readDict();
        help->statusBar()->showMessage(tr("Done"), 3000);
        setCursor(Qt::ArrowCursor);
    }
    keywordDocuments.clear();
}

void HelpDialog::showTopic

(

)

[private, slot]

Definition at line 625 of file helpdialog.cpp.

References showBookmarkTopic(), showContentsTopic(), showIndexTopic(), stripAmpersand(), and ui.

Referenced by eventFilter(), initialize(), showIndexItemMenu(), and showTopic().

{
    QString text = ui.tabWidget->tabText(ui.tabWidget->currentIndex());

    if (stripAmpersand(text).contains(tr("Index")))
        showIndexTopic();
    else if (stripAmpersand(text).contains(tr("Bookmarks")))
        showBookmarkTopic();
    else if (stripAmpersand(text).contains(tr("Contents")))
        showContentsTopic();
}

void HelpDialog::searchInIndex

(

const QString &

s

)

[private, slot]

Definition at line 670 of file helpdialog.cpp.

References QString::contains(), QString::count(), IndexListModel::filter(), indexModel, QString::indexOf(), match(), QString::mid(), start, and ui.

Referenced by initialize().

{
    QRegExp atoz("[A-Z]");
    int matches = searchString.count(atoz);
    if (matches > 0 && !searchString.contains(".*"))
    {
        int start = 0;
        QString newSearch;
        for (; matches > 0; --matches) {
            int match = searchString.indexOf(atoz, start+1);
            if (match <= start)
                continue;
            newSearch += searchString.mid(start, match-start);
            newSearch += ".*";
            start = match;
        }
        newSearch += searchString.mid(start);
        ui.listIndex->setCurrentIndex(indexModel->filter(newSearch, searchString));
    }
    else
        ui.listIndex->setCurrentIndex(indexModel->filter(searchString, searchString));
}

void HelpDialog::toggleContents

(

)

[private, slot]

Definition at line 967 of file helpdialog.cpp.

References QWidget::hide(), QWidget::isVisible(), QWidget::parentWidget(), QWidget::show(), and ui.

{
    if (!isVisible() || ui.tabWidget->currentIndex() != 0) {
        ui.tabWidget->setCurrentIndex(0);
        parentWidget()->show();
    }
    else
        parentWidget()->hide();
}

void HelpDialog::toggleIndex

(

)

[private, slot]

Definition at line 977 of file helpdialog.cpp.

References QWidget::hide(), QWidget::isVisible(), QWidget::parentWidget(), QWidget::show(), and ui.

{
    if (!isVisible() || ui.tabWidget->currentIndex() != 1 || !ui.editIndex->hasFocus()) {
        ui.tabWidget->setCurrentIndex(1);
        parentWidget()->show();
        ui.editIndex->setFocus();
    }
    else
        parentWidget()->hide();
}

void HelpDialog::toggleBookmarks

(

)

[private, slot]

Definition at line 988 of file helpdialog.cpp.

References QWidget::hide(), QWidget::isVisible(), QWidget::parentWidget(), QWidget::show(), and ui.

{
    if (!isVisible() || ui.tabWidget->currentIndex() != 2) {
        ui.tabWidget->setCurrentIndex(2);
        parentWidget()->show();
    }
    else
        parentWidget()->hide();
}

void HelpDialog::toggleSearch

(

)

[private, slot]

Definition at line 998 of file helpdialog.cpp.

References QWidget::hide(), QWidget::isVisible(), QWidget::parentWidget(), QWidget::show(), and ui.

{
    if (!isVisible() || ui.tabWidget->currentIndex() != 3) {
        ui.tabWidget->setCurrentIndex(3);
        parentWidget()->show();
    }
    else
        parentWidget()->hide();
}

void HelpDialog::lastWinClosed

(

)

[private, slot]

Definition at line 296 of file helpdialog.cpp.

References lwClosed.

Referenced by initialize().

{
    lwClosed = true;
}

void HelpDialog::setIndexingProgress

(

int

prog

)

[private, slot]

Definition at line 1070 of file helpdialog.cpp.

References processEvents(), and ui.

Referenced by setupFullTextIndex().

{
    ui.progressPrepare->setValue(prog);
    processEvents();
}

void HelpDialog::showListItemMenu

(

const QPoint &

pos

)

[private, slot]

Definition at line 1214 of file helpdialog.cpp.

References actionOpenCurrentTab, actionOpenLinkInNewWindow, MainWindow::browsers(), TabbedBrowser::currentBrowser(), QMenu::exec(), foundDocs, help, QListWidget::itemAt(), itemPopup, QWidget::mapToGlobal(), HelpWindow::openLinkInNewPage(), HelpWindow::openLinkInNewWindow(), QWidget::pos(), QObject::sender(), showResultPage(), ui, and QAbstractScrollArea::viewport().

Referenced by initialize().

{
    QListWidget *listWidget = qobject_cast<QListWidget*>(sender());
    if (!listWidget)
        return;
    QListWidgetItem *item = listWidget->itemAt(pos);
    if (!item)
        return;

    QAction *action = itemPopup->exec(listWidget->viewport()->mapToGlobal(pos));
    if (action == actionOpenCurrentTab) {
        showResultPage(item);
    } else if (action) {
        HelpWindow *hw = help->browsers()->currentBrowser();
        QString link = foundDocs[ui.resultBox->row(item)];
        if (action == actionOpenLinkInNewWindow)
            hw->openLinkInNewWindow(link);
        else
            hw->openLinkInNewPage(link);
    }
}

void HelpDialog::showIndexItemMenu

(

const QPoint &

pos

)

[private, slot]

Definition at line 1172 of file helpdialog.cpp.

References actionOpenCurrentTab, actionOpenLinkInNewWindow, QList< T >::begin(), MainWindow::browsers(), QList< T >::count(), TabbedBrowser::currentBrowser(), QModelIndex::data(), QList< T >::end(), QMenu::exec(), QList< T >::first(), TopicChooser::getLink(), help, QListView::indexAt(), indexModel, QString::isEmpty(), QModelIndex::isValid(), itemPopup, IndexListModel::links(), QWidget::mapToGlobal(), HelpWindow::openLinkInNewPage(), HelpWindow::openLinkInNewWindow(), QWidget::pos(), QModelIndex::row(), QObject::sender(), showTopic(), titleOfLink(), QVariant::toString(), ui, and QAbstractScrollArea::viewport().

Referenced by initialize().

{
    QListView *listView = qobject_cast<QListView*>(sender());
    if (!listView)
        return;

    QModelIndex idx = listView->indexAt(pos);
    if (!idx.isValid())
        return;

    QAction *action = itemPopup->exec(listView->viewport()->mapToGlobal(pos));
    if (action == actionOpenCurrentTab) {
        showTopic();
    } else if (action) {
        HelpWindow *hw = help->browsers()->currentBrowser();
        QString itemName = idx.data().toString();
        ui.editIndex->setText(itemName);
        QStringList links = indexModel->links(idx.row());
        if (links.count() == 1) {
            if (action == actionOpenLinkInNewWindow)
                hw->openLinkInNewWindow(links.first());
            else
                hw->openLinkInNewPage(links.first());
        } else {
            QStringList::Iterator it = links.begin();
            QStringList linkList;
            QStringList linkNames;
            for (; it != links.end(); ++it) {
                linkList << *it;
                linkNames << titleOfLink(*it);
            }
            QString link = TopicChooser::getLink(this, linkNames, linkList, itemName);
            if (!link.isEmpty()) {
                if (action == actionOpenLinkInNewWindow)
                    hw->openLinkInNewWindow(link);
                else
                    hw->openLinkInNewPage(link);
            }
        }
    }
}

void HelpDialog::showTreeItemMenu

(

const QPoint &

pos

)

[private, slot]

Definition at line 1236 of file helpdialog.cpp.

References actionOpenCurrentTab, actionOpenLinkInNewWindow, MainWindow::browsers(), QString::contains(), TabbedBrowser::currentBrowser(), QMenu::exec(), help, i, QTreeWidget::itemAt(), itemPopup, LinkRole, QWidget::mapToGlobal(), HelpWindow::openLinkInNewPage(), HelpWindow::openLinkInNewWindow(), QWidget::pos(), QObject::sender(), showBookmarkTopic(), showContentsTopic(), stripAmpersand(), ui, and QAbstractScrollArea::viewport().

Referenced by initialize().

{
    QTreeWidget *treeWidget = qobject_cast<QTreeWidget*>(sender());

    if (!treeWidget)
        return;

    QTreeWidgetItem *item = treeWidget->itemAt(pos);

    if (!item)
        return;

    QAction *action = itemPopup->exec(treeWidget->viewport()->mapToGlobal(pos));
    if (action == actionOpenCurrentTab) {
        if (stripAmpersand(ui.tabWidget->tabText(ui.tabWidget->currentIndex())).contains(tr("Contents")))
            showContentsTopic();
        else
            showBookmarkTopic();
    } else if (action) {
        QTreeWidgetItem *i = (QTreeWidgetItem*)item;
        if (action == actionOpenLinkInNewWindow)
            help->browsers()->currentBrowser()->openLinkInNewWindow(i->data(0, LinkRole).toString());
        else
            help->browsers()->currentBrowser()->openLinkInNewPage(i->data(0, LinkRole).toString());
    }
}

void HelpDialog::insertBookmarks

(

)

[private, slot]

Definition at line 763 of file helpdialog.cpp.

References QTextStream::atEnd(), bookmarksInserted, cacheFilesPath, Config::configuration(), help, i, LinkRole, QFile::open(), QTextStream::readLine(), QIODevice::ReadOnly, QDir::separator(), showInitDoneMessage(), ui, and MainWindow::updateBookmarkMenu().

Referenced by addBookmark(), and currentTabChanged().

{
    if (bookmarksInserted)
        return;
    bookmarksInserted = true;
    ui.listBookmarks->clear();
    QFile f(cacheFilesPath + QDir::separator() + QLatin1String("bookmarks.")
    + Config::configuration()->profileName());
    if (!f.open(QFile::ReadOnly))
        return;
    QTextStream ts(&f);
    while (!ts.atEnd()) {
        QTreeWidgetItem *i = new QTreeWidgetItem(ui.listBookmarks, 0);
        i->setText(0, ts.readLine());
        i->setData(0, LinkRole, ts.readLine());
    }
    help->updateBookmarkMenu();
    showInitDoneMessage();
}

void HelpDialog::processEvents

(

)

[private, slot]

Definition at line 290 of file helpdialog.cpp.

References QEventLoop::ExcludeUserInputEvents, and qApp.

Referenced by buildKeywordDB(), getAllContents(), insertContents(), loadIndexFile(), setIndexingProgress(), setupFullTextIndex(), and setupTitleMap().

{
    qApp->processEvents(QEventLoop::ExcludeUserInputEvents);
}

void HelpDialog::removeOldCacheFiles

(

bool

onlyFulltextSearchIndex = false

)

[private]

Definition at line 301 of file helpdialog.cpp.

References QList< T >::begin(), cacheFilesPath, Config::configuration(), QList< T >::end(), QFile::exists(), QList< QString >::iterator, Config::profileName(), qWarning(), QFile::remove(), QDir::separator(), and verifyDirectory().

Referenced by getAllContents(), and setupTitleMap().

{
    if (!verifyDirectory(cacheFilesPath)) {
        qWarning("Failed to created assistant directory");
        return;
    }
    QString pname = QLatin1String(".") + Config::configuration()->profileName();

    QStringList fileList;
    fileList << QLatin1String("indexdb40.dict")
        << QLatin1String("indexdb40.doc");

    if (!onlyFulltextSearchIndex)
        fileList << QLatin1String("indexdb40") << QLatin1String("contentdb40");

    QStringList::iterator it = fileList.begin();
    for (; it != fileList.end(); ++it) {
    if (QFile::exists(cacheFilesPath + QDir::separator() + *it + pname)) {
            QFile f(cacheFilesPath + QDir::separator() + *it + pname);
            f.remove();
        }
    }
}

Here is the call graph for this function:

void HelpDialog::buildKeywordDB

(

)

[private]

Definition at line 418 of file helpdialog.cpp.

References QList< T >::append(), QString::arg(), QList< T >::begin(), cacheFilesPath, Config::configuration(), DocuParser::createParser(), QMessageBox::critical(), Config::docFiles(), QList< T >::end(), QString::fromLatin1(), handler, i, QList< T >::isEmpty(), QList< QString >::iterator, IndexItem::keyword, lwClosed, QFile::open(), processEvents(), qSort(), IndexItem::reference, s, QDir::separator(), QString::toUtf8(), ui, verifyDirectory(), QMessageBox::warning(), and QIODevice::WriteOnly.

Referenced by loadIndexFile().

{
    QStringList addDocuFiles = Config::configuration()->docFiles();
    QStringList::iterator i = addDocuFiles.begin();

    // Set up an indeterminate progress bar.
    ui.labelPrepare->setText(tr("Prepare..."));
    ui.progressPrepare->setMaximum(0);
    ui.progressPrepare->setMinimum(0);
    ui.progressPrepare->setValue(0);
    processEvents();

    QList<IndexKeyword> lst;
    quint32 fileAges = 0;
    for(i = addDocuFiles.begin(); i != addDocuFiles.end(); i++){
        QFile file(*i);
        if (!file.exists()) {
            QMessageBox::warning(this, tr("Warning"),
                tr("Documentation file %1 does not exist!\n"
                    "Skipping file.").arg(QFileInfo(file).absoluteFilePath()));
            continue;
        }
        fileAges += QFileInfo(file).lastModified().toTime_t();
        DocuParser *handler = DocuParser::createParser(*i);
        bool ok = handler->parse(&file);
        file.close();
        if(!ok){
            QString msg = QString::fromLatin1("In file %1:\n%2")
                          .arg(QFileInfo(file).absoluteFilePath())
                          .arg(handler->errorProtocol());
            QMessageBox::critical(this, tr("Parse Error"), tr(msg.toUtf8()));
            delete handler;
            continue;
        }

        QList<IndexItem*> indLst = handler->getIndexItems();
        int counter = 0;
        foreach (IndexItem *indItem, indLst) {
            QFileInfo fi(indItem->reference);
            lst.append(IndexKeyword(indItem->keyword, indItem->reference));

            if(++counter%100 == 0) {
                if (ui.progressPrepare)
                    ui.progressPrepare->setValue(counter);
                processEvents();
                if(lwClosed) {
                    return;
                }
            }
        }
        delete handler;
    }
    if (!lst.isEmpty())
        qSort(lst);

    QFile indexout(cacheFilesPath + QDir::separator() + QLatin1String("indexdb40.")
    + Config::configuration()->profileName());
    if (verifyDirectory(cacheFilesPath) && indexout.open(QFile::WriteOnly)) {
        QDataStream s(&indexout);
        s << fileAges;
        s << lst;
        indexout.close();
    }
}

Here is the call graph for this function:

quint32 HelpDialog::getFileAges

(

)

[private]

Definition at line 403 of file helpdialog.cpp.

References Config::configuration(), QList< QString >::const_iterator, QList< T >::constBegin(), QList< T >::constEnd(), Config::docFiles(), and i.

Referenced by getAllContents(), and loadIndexFile().

{
    QStringList addDocuFiles = Config::configuration()->docFiles();
    QStringList::const_iterator i = addDocuFiles.constBegin();

    quint32 fileAges = 0;
    for(; i != addDocuFiles.constEnd(); ++i) {
        QFileInfo fi(*i);
        if (fi.exists())
            fileAges += fi.lastModified().toTime_t();
    }

    return fileAges;
}

Here is the call graph for this function:

void HelpDialog::showIndexTopic

(

)

[private]

Definition at line 637 of file helpdialog.cpp.

References QList< T >::count(), IndexListModel::description(), emit, QList< T >::first(), TopicChooser::getLink(), QAbstractListModel::index(), indexModel, QStringList::indexOf(), QString::isEmpty(), IndexListModel::links(), QAbstractItemView::PositionAtTop, qSort(), row, QStringListModel::rowCount(), showLink(), QStringListModel::stringList(), titleOfLink(), and ui.

Referenced by showTopic().

{
    int row = ui.listIndex->currentIndex().row();
    if (row == -1 || row >= indexModel->rowCount())
        return;

    QString description = indexModel->description(row);
    QStringList links = indexModel->links(row);

    bool blocked = ui.editIndex->blockSignals(true);
    ui.editIndex->setText(description);
    ui.editIndex->blockSignals(blocked);

    if (links.count() == 1) {
        emit showLink(links.first());
    } else {
        qSort(links);
        QStringList::Iterator it = links.begin();
        QStringList linkList;
        QStringList linkNames;
        for (; it != links.end(); ++it) {
            linkList << *it;
            linkNames << titleOfLink(*it);
        }
        QString link = TopicChooser::getLink(this, linkNames, linkList, description);
        if (!link.isEmpty())
            emit showLink(link);
    }

    ui.listIndex->setCurrentIndex(indexModel->index(indexModel->stringList().indexOf(description)));
    ui.listIndex->scrollTo(ui.listIndex->currentIndex(), QAbstractItemView::PositionAtTop);
}

Here is the call graph for this function:

void HelpDialog::showBookmarkTopic

(

)

[private]

Definition at line 783 of file helpdialog.cpp.

References emit, i, LinkRole, showLink(), and ui.

Referenced by showTopic(), and showTreeItemMenu().

{
    if (!ui.listBookmarks->currentItem())
        return;

    QTreeWidgetItem *i = (QTreeWidgetItem*)ui.listBookmarks->currentItem();
    emit showLink(i->data(0, LinkRole).toString());
}

void HelpDialog::setupTitleMap

(

)

[private]

Definition at line 483 of file helpdialog.cpp.

References QList< T >::begin(), QMap< Key, T >::clear(), Config::configuration(), contentList, Profile::createDefaultProfile(), Config::docFiles(), QList< T >::end(), QFile::exists(), getAllContents(), Config::loadDefaultProfile(), processEvents(), profile, ContentItem::reference, removeOldCacheFiles(), Config::saveProfile(), Config::setDocRebuild(), ContentItem::title, titleMap, titleMapDone, and QString::trimmed().

Referenced by initialize(), and insertContents().

{
    if (titleMapDone)
        return;

    bool needRebuild = false;
    if (Config::configuration()->profileName() == QLatin1String("default")) {
        const QStringList docuFiles = Config::configuration()->docFiles();
        for(QStringList::ConstIterator it = docuFiles.begin(); it != docuFiles.end(); it++) {
            if (!QFile::exists(*it)) {
                Config::configuration()->saveProfile(Profile::createDefaultProfile());
                Config::configuration()->loadDefaultProfile();
                needRebuild = true;
                break;
            }
        }
    }

    if (Config::configuration()->docRebuild() || needRebuild) {
        removeOldCacheFiles();
        Config::configuration()->setDocRebuild(false);
        Config::configuration()->saveProfile(Config::configuration()->profile());
    }
    if (contentList.isEmpty())
        getAllContents();

    titleMapDone = true;
    titleMap.clear();
    for(QList<QPair<QString, ContentList> >::Iterator it = contentList.begin(); it != contentList.end(); ++it) {
        ContentList lst = (*it).second;
        foreach (ContentItem item, lst) {
            titleMap[item.reference] = item.title.trimmed();
        }
    }
    processEvents();
}

Here is the call graph for this function:

void HelpDialog::saveBookmarks

(

)

[private]

Definition at line 807 of file helpdialog.cpp.

References cacheFilesPath, Config::configuration(), QFile::open(), QDir::separator(), store(), ui, and QIODevice::WriteOnly.

Referenced by addBookmark(), and on_buttonRemove_clicked().

{
    QFile f(cacheFilesPath + QDir::separator() + QLatin1String("bookmarks.")
    + Config::configuration()->profileName());
    if (!f.open(QFile::WriteOnly))
        return;

    QTextStream ts(&f);
    store(ui.listBookmarks, ts);
    f.close();
}

Here is the call graph for this function:

void HelpDialog::showContentsTopic

(

)

[private]

Definition at line 891 of file helpdialog.cpp.

References emit, i, LinkRole, showLink(), and ui.

Referenced by showTopic(), and showTreeItemMenu().

{
    QTreeWidgetItem *i = (QTreeWidgetItem*)ui.listContents->currentItem();
    if (!i)
        return;
    emit showLink(i->data(0, LinkRole).toString());
}

void HelpDialog::showInitDoneMessage

(

)

[private]

Definition at line 611 of file helpdialog.cpp.

References help, initDoneMsgShown, QStatusBar::showMessage(), and QMainWindow::statusBar().

Referenced by insertBookmarks(), insertContents(), loadIndexFile(), and setupFullTextIndex().

{
    if (initDoneMsgShown)
        return;
    initDoneMsgShown = true;
    help->statusBar()->showMessage(tr("Done"), 3000);
}

Here is the call graph for this function:

void HelpDialog::buildContentDict

(

)

[private]

Definition at line 551 of file helpdialog.cpp.

References QString::arg(), QList< T >::begin(), cacheFilesPath, Config::configuration(), contentList, DocuParser::createParser(), QMessageBox::critical(), Config::docFiles(), QList< T >::end(), QString::fromLatin1(), handler, QList< QString >::iterator, QFile::open(), qMakePair(), s, QDir::separator(), QString::toUtf8(), QMessageBox::warning(), and QIODevice::WriteOnly.

Referenced by getAllContents().

{
    QStringList docuFiles = Config::configuration()->docFiles();

    quint32 fileAges = 0;
    for(QStringList::iterator it = docuFiles.begin(); it != docuFiles.end(); it++) {
        QFile file(*it);
        if (!file.exists()) {
            QMessageBox::warning(this, tr("Warning"),
            tr("Documentation file %1 does not exist!\n"
                "Skipping file.").arg(QFileInfo(file).absoluteFilePath()));
            continue;
        }
        fileAges += QFileInfo(file).lastModified().toTime_t();
        DocuParser *handler = DocuParser::createParser(*it);
        if(!handler) {
            QMessageBox::warning(this, tr("Warning"),
            tr("Documentation file %1 is not compatible!\n"
                "Skipping file.").arg(QFileInfo(file).absoluteFilePath()));
            continue;
        }
        bool ok = handler->parse(&file);
        file.close();
        if(ok) {
            contentList += qMakePair(*it, QList<ContentItem>(handler->getContentItems()));
            delete handler;
        } else {
            QString msg = QString::fromLatin1("In file %1:\n%2")
                          .arg(QFileInfo(file).absoluteFilePath())
                          .arg(handler->errorProtocol());
            QMessageBox::critical(this, tr("Parse Error"), tr(msg.toUtf8()));
            continue;
        }
    }

    QFile contentOut(cacheFilesPath + QDir::separator() + QLatin1String("contentdb40.")
    + Config::configuration()->profileName());
    if (contentOut.open(QFile::WriteOnly)) {
        QDataStream s(&contentOut);
        s << fileAges;
        for(QList<QPair<QString, ContentList> >::Iterator it = contentList.begin(); it != contentList.end(); ++it) {
            s << *it;
        }
        contentOut.close();
    }
}

Here is the call graph for this function:

QTreeWidgetItem * HelpDialog::locateLink	(	QTreeWidgetItem *	item,
		const QString &	link
	)			[private]

Definition at line 899 of file helpdialog.cpp.

References Qt::CaseInsensitive, Qt::CaseSensitive, QTreeWidgetItem::child(), QTreeWidgetItem::childCount(), QTreeWidgetItem::data(), i, LinkRole, QString::startsWith(), and QVariant::toString().

Referenced by locateContents().

{
    QTreeWidgetItem *child = 0;
#ifdef Q_OS_WIN
    Qt::CaseSensitivity checkCase = Qt::CaseInsensitive;
#else
    Qt::CaseSensitivity checkCase = Qt::CaseSensitive;
#endif
    for(int i = 0, childCount = item->childCount(); i<childCount; i++) {
        child = item->child(i);
        if (link.startsWith(child->data(0, LinkRole).toString(), checkCase))
            break;
        //check if the link is a child of this item
        else if(child->childCount()) {
            child = locateLink(child, link);
            if (child)
                break;
        }
        child = 0;
    }
    return child;
}

Here is the call graph for this function:

void HelpDialog::getAllContents

(

)

[private]

Definition at line 520 of file helpdialog.cpp.

References QDataStream::atEnd(), buildContentDict(), cacheFilesPath, QFile::close(), Config::configuration(), contentList, getFileAges(), key, QFile::open(), processEvents(), qMakePair(), QIODevice::ReadOnly, removeOldCacheFiles(), and QDir::separator().

Referenced by insertContents(), and setupTitleMap().

{
    QFile contentFile(cacheFilesPath + QDir::separator() + QLatin1String("contentdb40.")
    + Config::configuration()->profileName());
    contentList.clear();
    if (!contentFile.open(QFile::ReadOnly)) {
        buildContentDict();
        return;
    }

    QDataStream ds(&contentFile);
    quint32 fileAges;
    ds >> fileAges;
    if (fileAges != getFileAges()) {
        contentFile.close();
        removeOldCacheFiles(true);
        buildContentDict();
        return;
    }
    QString key;
    QList<ContentItem> lst;
    while (!ds.atEnd()) {
        ds >> key;
        ds >> lst;
        contentList += qMakePair(key, QList<ContentItem>(lst));
    }
    contentFile.close();
    processEvents();

}

Here is the call graph for this function:

---

Member Data Documentation

Ui::HelpDialog HelpDialog::ui [private]

Definition at line 139 of file helpdialog.h.

Referenced by addBookmark(), buildKeywordDB(), currentTabChanged(), eventFilter(), HelpDialog(), initialize(), insertBookmarks(), insertContents(), loadIndexFile(), locateContents(), on_buttonRemove_clicked(), saveBookmarks(), searchInIndex(), setIndexingProgress(), setupFullTextIndex(), showBookmarkTopic(), showContentsTopic(), showIndexItemMenu(), showIndexTopic(), showListItemMenu(), showResultPage(), showTopic(), showTreeItemMenu(), startSearch(), tabWidget(), toggleBookmarks(), toggleContents(), toggleIndex(), and toggleSearch().

IndexListModel* HelpDialog::indexModel [private]

Definition at line 141 of file helpdialog.h.

Referenced by HelpDialog(), loadIndexFile(), searchInIndex(), showIndexItemMenu(), and showIndexTopic().

QMap<QString, QString> HelpDialog::titleMap [private]

Definition at line 142 of file helpdialog.h.

Referenced by setupFullTextIndex(), setupTitleMap(), and titleOfLink().

bool HelpDialog::indexDone [private]

Definition at line 143 of file helpdialog.h.

Referenced by initialize(), and loadIndexFile().

bool HelpDialog::bookmarksInserted [private]

Definition at line 143 of file helpdialog.h.

Referenced by addBookmark(), initialize(), and insertBookmarks().

bool HelpDialog::titleMapDone [private]

Definition at line 143 of file helpdialog.h.

Referenced by initialize(), insertContents(), and setupTitleMap().

bool HelpDialog::contentsInserted [private]

Definition at line 143 of file helpdialog.h.

Referenced by initialize(), insertContents(), and locateContents().

bool HelpDialog::lwClosed [private]

Definition at line 144 of file helpdialog.h.

Referenced by buildKeywordDB(), lastWinClosed(), lastWindowClosed(), and loadIndexFile().

MainWindow* HelpDialog::help [private]

Definition at line 145 of file helpdialog.h.

Referenced by addBookmark(), insertBookmarks(), loadIndexFile(), on_buttonRemove_clicked(), setupFullTextIndex(), showIndexItemMenu(), showInitDoneMessage(), showListItemMenu(), showTreeItemMenu(), startSearch(), and timerEvent().

QString HelpDialog::documentationPath [private]

Definition at line 146 of file helpdialog.h.

Index* HelpDialog::fullTextIndex [private]

Definition at line 147 of file helpdialog.h.

Referenced by initialize(), setupFullTextIndex(), and startSearch().

QStringList HelpDialog::terms [private]

Definition at line 148 of file helpdialog.h.

Referenced by showResultPage(), and startSearch().

QStringList HelpDialog::foundDocs [private]

Definition at line 148 of file helpdialog.h.

Referenced by showListItemMenu(), showResultPage(), and startSearch().

bool HelpDialog::initDoneMsgShown [private]

Definition at line 149 of file helpdialog.h.

Referenced by initialize(), and showInitDoneMessage().

QList<QPair<QString, ContentList> > HelpDialog::contentList [private]

Definition at line 151 of file helpdialog.h.

Referenced by buildContentDict(), getAllContents(), initialize(), insertContents(), and setupTitleMap().

QMenu* HelpDialog::itemPopup [private]

Definition at line 152 of file helpdialog.h.

Referenced by initialize(), showIndexItemMenu(), showListItemMenu(), and showTreeItemMenu().

QString HelpDialog::cacheFilesPath [private]

Definition at line 153 of file helpdialog.h.

Referenced by buildContentDict(), buildKeywordDB(), getAllContents(), initialize(), insertBookmarks(), loadIndexFile(), removeOldCacheFiles(), saveBookmarks(), and setupFullTextIndex().

QStringList HelpDialog::keywordDocuments [private]

Definition at line 154 of file helpdialog.h.

Referenced by loadIndexFile(), and setupFullTextIndex().

QAction* HelpDialog::actionOpenCurrentTab [private]

Definition at line 156 of file helpdialog.h.

Referenced by initialize(), showIndexItemMenu(), showListItemMenu(), and showTreeItemMenu().

QAction* HelpDialog::actionOpenLinkInNewWindow [private]

Definition at line 157 of file helpdialog.h.

Referenced by initialize(), showIndexItemMenu(), showListItemMenu(), and showTreeItemMenu().

QAction* HelpDialog::actionOpenLinkInNewTab [private]

Definition at line 158 of file helpdialog.h.

Referenced by initialize().

---

The documentation for this class was generated from the following files:

• tools/assistant/helpdialog.h
• tools/assistant/helpdialog.cpp

---