Fraxinus  17.12-rc3
An IGT application
cxHelpWidget.h
Go to the documentation of this file.
1 /*=========================================================================
2 This file is part of CustusX, an Image Guided Therapy Application.
3 
4 Copyright (c) 2008-2014, SINTEF Department of Medical Technology
5 All rights reserved.
6 
7 Redistribution and use in source and binary forms, with or without
8 modification, are permitted provided that the following conditions are met:
9 
10 1. Redistributions of source code must retain the above copyright notice,
11  this list of conditions and the following disclaimer.
12 
13 2. Redistributions in binary form must reproduce the above copyright notice,
14  this list of conditions and the following disclaimer in the documentation
15  and/or other materials provided with the distribution.
16 
17 3. Neither the name of the copyright holder nor the names of its contributors
18  may be used to endorse or promote products derived from this software
19  without specific prior written permission.
20 
21 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
22 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
25 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
27 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
28 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 =========================================================================*/
32 #ifndef CXHELPWIDGET_H
33 #define CXHELPWIDGET_H
34 
35 #include "cxBaseWidget.h"
36 #include "boost/shared_ptr.hpp"
37 #include "org_custusx_help_Export.h"
38 class QTabWidget;
39 class QAction;
40 class QSplitter;
41 
42 namespace cx
43 {
44 typedef boost::shared_ptr<class HelpEngine> HelpEnginePtr;
45 class HelpSearchWidget;
46 class HelpIndexWidget;
47 
56 class org_custusx_help_EXPORT HelpWidget : public BaseWidget
57 {
58  Q_OBJECT
59 
60 public:
61  explicit HelpWidget(HelpEnginePtr engine, QWidget* parent = NULL);
62  virtual ~HelpWidget();
63 
64  HelpEnginePtr engine() { return mEngine; }
65  virtual QSize sizeHint() const;
66 
67 signals:
68  void requestShowLink(const QUrl&);
69 
70 private slots:
71  void toggleShowNavigationControls();
72  void backSlot();
73  void forwardSlot();
74  void onGotoDocumentation();
75 private:
80  template<class T>
81  QAction* createAction2(QObject* parent, QIcon iconName, QString text, QString tip, T slot, QLayout* layout=NULL, QToolButton* button = new QToolButton())
82  {
83  if (tip.isEmpty())
84  tip = text;
85  QAction* action = new QAction(iconName, text, parent);
86  action->setStatusTip(tip);
87  action->setWhatsThis(tip);
88  action->setToolTip(tip);
89  connect(action, &QAction::triggered, this, slot);
90  if (layout)
91  {
92  button->setDefaultAction(action);
93  layout->addWidget(button);
94  }
95  return action;
96  }
97 
98  virtual void showEvent(QShowEvent* event);
99  virtual void hideEvent(QHideEvent* event);
100  virtual void prePaintEvent();
101  void setup();
102  void addSearchWidget(QTabWidget* tabWidget, QBoxLayout* buttonLayout);
103  void addIndexWidget(QTabWidget* tabWidget, QBoxLayout* buttonLayout);
104  void addContentWidget(QTabWidget* tabWidget, QBoxLayout* buttonLayout);
105  void addToggleTabWidgetButton(QBoxLayout* buttonLayout);
106  void addWebNavigationButtons(QBoxLayout* buttonLayout);
107  void addWebButton(QBoxLayout* buttonLayout);
108 
109  QVBoxLayout* mVerticalLayout;
110  QTabWidget* mTabWidget;
111  HelpEnginePtr mEngine;
112 
113  HelpSearchWidget* mSearchWidget;
114  HelpIndexWidget* mIndexWidget;
115  class HelpBrowser *mBrowser ;
116 
117  QAction* mShowNavigationControlsAction;
118  QSplitter* mSplitter;
119 
120 };
121 
122 }//end namespace cx
123 
124 #endif // CXHELPWIDGET_H
HelpEnginePtr engine()
Definition: cxHelpWidget.h:64
Interface for QWidget which handles widgets uniformly for the system.
Definition: cxBaseWidget.h:109
boost::shared_ptr< HelpEngine > HelpEnginePtr
Definition: cxHelpEngine.h:82
Namespace for all CustusX production code.