helpBrowser.hh

/*===========================================================================*\
*                                                                            *
*                              OpenFlipper                                   *
 *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
 *           Department of Computer Graphics and Multimedia                  *
 *                          All rights reserved.                             *
 *                            www.openflipper.org                            *
 *                                                                           *
 *---------------------------------------------------------------------------*
 * This file is part of OpenFlipper.                                         *
 *---------------------------------------------------------------------------*
 *                                                                           *
 * Redistribution and use in source and binary forms, with or without        *
 * modification, are permitted provided that the following conditions        *
 * are met:                                                                  *
 *                                                                           *
 * 1. Redistributions of source code must retain the above copyright notice, *
 *    this list of conditions and the following disclaimer.                  *
 *                                                                           *
 * 2. Redistributions in binary form must reproduce the above copyright      *
 *    notice, this list of conditions and the following disclaimer in the    *
 *    documentation and/or other materials provided with the distribution.   *
 *                                                                           *
 * 3. Neither the name of the copyright holder nor the names of its          *
 *    contributors may be used to endorse or promote products derived from   *
 *    this software without specific prior written permission.               *
 *                                                                           *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS       *
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A           *
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,  *
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,       *
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR        *
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF    *
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING      *
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS        *
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.              *
*                                                                            *
\*===========================================================================*/
 
#ifndef HELPBROWSER_HH_
#define HELPBROWSER_HH_
 
 
#include <QtWidgets>
#include <QTextBrowser>
#include <QtHelp>
 
class HelpBrowser : public QTextBrowser {
        Q_OBJECT
 
public:
 
        HelpBrowser(QHelpEngine* _helpEngine, QWidget* parent = 0);
 
        virtual ~HelpBrowser();
 
        QVariant loadResource ( int _type, const QUrl& _name );
 
        bool isBackwardAvailable();
 
        bool isForwardAvailable();
 
        QUrl resolveUrl(const QUrl &_url);
 
signals:
/*
 * is emitted, when the page history was changed.
 * it is not equal to the signal 'sourceChanged'
 * because saving in the history can be skipped
 */
   void historyChanged(const QUrl&);
 
public slots:
 
        void open(const QString& _url);
 
        void open(const QUrl& _url, bool _skipSave = false);
 
        void backward();
 
        void forward();
 
private:
 
        QUrl getCurrentDir(const QUrl& _url);
 
        void updateNameSpaceAndFolder (const QUrl& _url);
 
private slots:
        void rememberHistory (const QUrl& _url);
private:
 
        QHelpEngine* helpEngine_;
 
        QList<QUrl> visitedPages_;
 
        int currentPage_;
 
        QString currentVirtualFolder_;
 
        QString currentNameSpace_;
 
};
 
 
#endif /* HELPBROWSER_HH_ */