cxHelpWidget.h

Go to the documentation of this file.

/*=========================================================================
This file is part of CustusX, an Image Guided Therapy Application.
                 
Copyright (c) SINTEF Department of Medical Technology.
All rights reserved.
                 
CustusX is released under a BSD 3-Clause license.
                 
See Lisence.txt (https://github.com/SINTEFMedtek/CustusX/blob/master/License.txt) for details.
=========================================================================*/
#ifndef CXHELPWIDGET_H
#define CXHELPWIDGET_H

#include "cxBaseWidget.h"
#include "boost/shared_ptr.hpp"
#include "org_custusx_help_Export.h"
class QTabWidget;
class QAction;
class QSplitter;

namespace cx
{
typedef boost::shared_ptr<class HelpEngine> HelpEnginePtr;
class HelpSearchWidget;
class HelpIndexWidget;

class org_custusx_help_EXPORT HelpWidget : public BaseWidget
{
        Q_OBJECT

public:
        explicit HelpWidget(HelpEnginePtr engine, QWidget* parent = NULL);
        virtual ~HelpWidget();

        HelpEnginePtr engine() { return mEngine; }
        virtual QSize sizeHint() const;

signals:
        void requestShowLink(const QUrl&);

private slots:
        void toggleShowNavigationControls();
        void backSlot();
        void forwardSlot();
        void onGotoDocumentation();
private:
        template<class T>
        QAction* createAction2(QObject* parent, QIcon iconName, QString text, QString tip, T slot, QLayout* layout=NULL, QToolButton* button = new QToolButton())
        {
                if (tip.isEmpty())
                        tip = text;
          QAction* action = new QAction(iconName, text, parent);
          action->setStatusTip(tip);
          action->setWhatsThis(tip);
          action->setToolTip(tip);
          connect(action, &QAction::triggered, this, slot);
          if (layout)
          {
                  button->setDefaultAction(action);
                  layout->addWidget(button);
          }
          return action;
        }

        virtual void showEvent(QShowEvent* event); 
        virtual void hideEvent(QHideEvent* event);
        virtual void prePaintEvent();
        void setup();
        void addSearchWidget(QTabWidget* tabWidget, QBoxLayout* buttonLayout);
        void addIndexWidget(QTabWidget* tabWidget, QBoxLayout* buttonLayout);
        void addContentWidget(QTabWidget* tabWidget, QBoxLayout* buttonLayout);
        void addToggleTabWidgetButton(QBoxLayout* buttonLayout);
        void addWebNavigationButtons(QBoxLayout* buttonLayout);
        void addWebButton(QBoxLayout* buttonLayout);

        QVBoxLayout* mVerticalLayout;
        QTabWidget* mTabWidget;
        HelpEnginePtr mEngine;

        HelpSearchWidget* mSearchWidget;
        HelpIndexWidget* mIndexWidget;
        class HelpBrowser *mBrowser ;

        QAction* mShowNavigationControlsAction;
        QSplitter* mSplitter;

};

}//end namespace cx

#endif // CXHELPWIDGET_H