helpbrowser.h

/*
For general Scribus (>=1.3.2) copyright and licensing information please refer
to the COPYING file provided with the program. Following this notice may exist
a copyright and/or license notice that predates the release of Scribus 1.3.2
for which a new license (GPL+exception) is in place.
*/
/***************************************************************************
*   Copyright (C) 2004 by Craig Bradney                                   *
*   cbradney@zip.com.au                                                   *
*   Copyright (C) 2005 by Petr Vanek                                      *
*   petr@yarpen.cz                                                        *
*                                                                         *
*   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, Fifth Floor, Boston, MA  02110-1301, USA.             *
***************************************************************************/

#ifndef HELPBROWSER_H
#define HELPBROWSER_H

#include <QAction>
#include <QItemSelection>
#include <QList>
#include <QMainWindow>
#include <QMenu>
#include <QMenuBar>
#include <QPair>
#include <QProgressBar>
#include <QString>
#include <QToolBar>
#include <QTreeWidgetItem>
#include <QUrl>
#include <QVariant>
#include <QWidget>

class QEvent;

#include "ui_helpbrowser.h"
#include "scribusapi.h"
#include "scconfig.h"
#include "scpaths.h"
#include "prefsmanager.h"
#include "prefsfile.h"
#include "schelptreemodel.h"

class HelpNavigation;

struct histd2 {
    QString url;
    QString title;
};

class SCRIBUS_API HelpBrowser : public QMainWindow, Ui::HelpBrowser
{
    Q_OBJECT

public:
    HelpBrowser(QWidget* parent);
    HelpBrowser(QWidget* parent, const QString& caption, const QString& guiLangage="en", const QString& jumpToSection="", const QString& jumpToFile="");
    ~HelpBrowser();
    
    
    virtual void changeEvent(QEvent *e);

    QMenu* histMenu;
    QMap<QAction*, histd2> mHistory;
    void setHtml(const QString& str);

    static bool firstRun;

public slots:
    void jumpToHelpSection(const QString& jumpToSection, const QString& jumpToFile="", bool dontChangeIfAlreadyLoaded=false);

protected:
    void closeEvent(QCloseEvent * event);

    void setupLocalUI();
    void readBookmarks();
    void searchingInDirectory(const QString&);

    void readHistory();

    void displayNoHelp();

    HelpNavigation * helpNav;
    
    QMenu* fileMenu;
    QMenu* editMenu;
    QMenu* bookMenu;
    QAction* filePrint;
    QAction* fileExit;
    QAction* editFind;
    QAction* editFindNext;
    QAction* editFindPrev;
    QAction* bookAdd;
    QAction* bookDel;
    QAction* bookDelAll;
    QAction* goHome;
    QAction* goBack;
    QAction* goFwd;

    QProgressBar * progressBar;

    QString language;
    QString finalBaseDir;
    QString findText;
    PrefsContext* prefs;
    ScHelpTreeModel* menuModel;
    QMap<QString, QString> quickHelpIndex;
    QMap<QString, QPair<QString, QString> > bookmarkIndex;
    
protected slots:
    virtual void languageChange();
    void histChosen(QAction* i);
    void loadHelp(const QString& filename);
    void loadMenu();
//  void showLinkContents(const QString &link);
    QString bookmarkFile();
    QString historyFile();

    void itemSelected(const QItemSelection & selected, const QItemSelection & deselected);

    void itemSearchSelected(QTreeWidgetItem *, int);

    void itemBookmarkSelected(QTreeWidgetItem *, int);

    void searchingButton_clicked();

    void find();

    void findNext();

    void findPrevious();

    void print();

    void bookmarkButton_clicked();

    void deleteBookmarkButton_clicked();

    void deleteAllBookmarkButton_clicked();

signals:
    void closed();

};

#endif // HELPBROWSER_H