itom  4.1.0
helpDockWidget.h
1 /* ********************************************************************
2  itom software
3  URL: http://www.uni-stuttgart.de/ito
4  Copyright (C) 2020, Institut fuer Technische Optik (ITO),
5  Universitaet Stuttgart, Germany
6 
7  This file is part of itom.
8 
9  itom is free software; you can redistribute it and/or modify it
10  under the terms of the GNU Library General Public Licence as published by
11  the Free Software Foundation; either version 2 of the Licence, or (at
12  your option) any later version.
13 
14  itom is distributed in the hope that it will be useful, but
15  WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library
17  General Public Licence for more details.
18 
19  You should have received a copy of the GNU Library General Public License
20  along with itom. If not, see <http://www.gnu.org/licenses/>.
21 *********************************************************************** */
22 
23 #ifndef HELPDOCKWIDGET_H
24 #define HELPDOCKWIDGET_H
25 
26 #include "abstractDockWidget.h"
27 
28 #include <qwidget.h>
29 #include <qaction.h>
30 #include <qwidgetaction.h>
31 #include <qtoolbar.h>
32 
33 #include <qtreewidget.h>
34 
35 class HelpTreeDockWidget;
36 
37 namespace ito
38 {
40  {
41  Q_OBJECT
42 
43  public:
44  HelpDockWidget(const QString &title, const QString &objName, QWidget *parent = NULL, bool docked = true, bool isDockAvailable = true, tFloatingStyle floatingStyle = floatingNone, tMovingStyle movingStyle = movingEnabled);
45  ~HelpDockWidget();
46 
47  protected:
48 
49  void createActions();
50  void createMenus();
51  void createToolBars();
52  void createStatusBar(){};
53  void updateActions();
54  void updatePythonActions(){ updateActions(); }
55 
56  private:
57  QAction *m_pActBackward;
58  QAction *m_pActForward;
59  QAction *m_pActExpand;
60  QAction *m_pActCollapse;
61  QWidgetAction *m_pActChanged;
62  QToolBar *m_pMainToolbar;
63  QLineEdit *m_pFilterEdit;
64 
65 
66  HelpTreeDockWidget *m_pHelpWidget;
67 
68  signals:
69  void showPluginInfo(QString name, HelpTreeDockWidget::HelpItemType type, const QModelIndex modelIndex, bool fromLink);
70 
71  private slots:
72 
73 
74  public slots:
75  void mnuShowInfo(QString name, HelpTreeDockWidget::HelpItemType type);
76 
77  };
78 
79 } //end namespace ito
80 
81 #endif
Definition: helpDockWidget.h:39
Definition: apiFunctionsGraph.cpp:39
Definition: helpTreeDockWidget.h:23
abstract dock widget class which inherits QDockWidget. The content of QDockWidget consists of an inst...
Definition: abstractDockWidget.h:54
tFloatingStyle
The floating style of a widget, derived from AbstractDockWidget.
Definition: abstractDockWidget.h:88
Definition: abstractDockWidget.h:90
Definition: abstractDockWidget.h:99
bool docked() const
Definition: abstractDockWidget.h:128
tMovingStyle
The configuration if a docked AbstractDockWidget can be moved from one docking area to another one...
Definition: abstractDockWidget.h:96