1 #ifndef HELPTREEDOCKWIDGET_H
2 #define HELPTREEDOCKWIDGET_H
4 #include "../../common/sharedStructures.h"
7 #include <qstandarditemmodel.h>
9 #include <qfuturewatcher.h>
12 #include "../widgets/abstractDockWidget.h"
14 #include "ui_helpTreeDockWidget.h"
21 class LeafFilterProxyModel;
29 Q_PROPERTY(QColor backgroundColorHeading READ backgroundColorHeading WRITE setBackgroundColorHeading)
30 Q_PROPERTY(QColor textColorHeading READ textColorHeading WRITE setTextColorHeading)
31 Q_PROPERTY(QColor linkColor READ linkColor WRITE setLinkColor);
32 Q_PROPERTY(QColor backgroundParamName READ backgroundParamName WRITE setBackgroundParamName);
33 Q_PROPERTY(QColor textColorSection READ textColorSection WRITE setTextColorSection);
34 Q_PROPERTY(QColor backgroundColorSection READ backgroundColorSection WRITE setBackgroundColorSection);
57 iconPluginFilter = 102,
59 iconPluginDataIO = 104,
60 iconPluginGrabber = 105,
62 iconPluginRawIO = 107,
63 iconPluginActuator = 108
70 stateContentLoaded = 0x02
72 Q_DECLARE_FLAGS(States, State)
75 QColor backgroundColorHeading()
const;
76 void setBackgroundColorHeading(
const QColor &color);
78 QColor textColorHeading()
const;
79 void setTextColorHeading(
const QColor &color);
81 QColor backgroundColorSection()
const;
82 void setBackgroundColorSection(
const QColor &color);
84 QColor textColorSection()
const;
85 void setTextColorSection(
const QColor &color);
87 QColor linkColor()
const;
88 void setLinkColor(
const QColor &color);
90 QColor backgroundParamName()
const;
91 void setBackgroundParamName(
const QColor &color);
96 void navigateBackwards();
97 void navigateForwards();
103 void showPluginInfo(
const QString &name, HelpItemType type,
const QModelIndex &modelIndex,
bool fromLink);
107 void on_splitter_splitterMoved (
int pos,
int index );
108 void on_helpTreeContent_anchorClicked(
const QUrl & link);
112 void on_treeView_expanded(
const QModelIndex &index);
113 void on_treeView_collapsed(
const QModelIndex &index);
115 void selectedItemChanged(
const QModelIndex ¤t,
const QModelIndex &previous);
119 static void createFilterWidgetNode(
int fOrW, QStandardItemModel* model,
const QMap<int,QIcon> *iconGallery);
125 ito::RetVal highlightContent(
const QString &prefix ,
const QString &name ,
const QString ¶m ,
const QString &shortDesc,
const QString &helpText,
const QString &error, QTextDocument *document,
const QMap<QString, QImage> &images);
126 QModelIndex
findIndexByPath(
const int type, QStringList path,
const QStandardItem* current);
132 void loadAndProcessCssStyleSheet();
135 static const int rolePath = Qt::UserRole + 1;
136 static const int roleType = Qt::UserRole + 2;
137 static const int roleFilename = Qt::UserRole + 3;
139 QString
minText(
int minimum)
const;
140 QString
minText(
double minimum)
const;
141 QString
minText(
char minimum)
const;
142 QString
maxText(
int minimum)
const;
143 QString
maxText(
double minimum)
const;
144 QString
maxText(
char minimum)
const;
150 Ui::HelpTreeDockWidget ui;
156 QMap<int, QIcon> m_iconGallery;
167 QString m_filterTextPending;
168 int m_filterTextPendingTimer;
170 QColor m_backgroundColorHeading;
171 QColor m_textColorHeading;
173 QColor m_backgroundParamName;
174 QColor m_textColorSection;
175 QColor m_backgroundColorSection;
177 QFutureWatcher<ito::RetVal> m_loaderWatcher;
178 QMutex m_dbLoaderMutex;
181 void showEvent(QShowEvent *event);
182 void timerEvent(QTimerEvent *event);
187 #endif // HELPTREEDOCKWIDGET_H
Class for managing status values (like errors or warning)
Definition: retVal.h:54
class for parameter handling e.g. to pass paramters to plugins
Definition: param.h:283
Definition: apiFunctionsGraph.cpp:39
This class provides a special search function to the help model. The normal filtermodel hides nodes i...
Definition: leafFilterProxyModel.h:31