itom
4.1.0
|
Public Slots | |
void | navigateBackwards () |
void | navigateForwards () |
void | expandTree () |
void | collapseTree () |
void | reloadHelpResources () |
Reload different help resources and clear search-edit and start the new thread. More... | |
void | liveFilter (const QString &filterText) |
slot invoked by toolbar More... | |
void | propertiesChanged () |
(Re)load the help resources if some properties have changed | |
void | showPluginInfo (const QString &name, HelpItemType type, const QModelIndex &modelIndex, bool fromLink) |
slot invoked by different widgets to display a help page from extern More... | |
ito::RetVal | showFilterWidgetPluginHelp (const QString &filtername, HelpItemType type) |
Get the DocString from a Filter and parse is to html. More... | |
Public Member Functions | |
HelpTreeDockWidget (QWidget *parent, ito::AbstractDockWidget *dock=0, Qt::WindowFlags flags=0) | |
QColor | backgroundColorHeading () const |
void | setBackgroundColorHeading (const QColor &color) |
QColor | textColorHeading () const |
void | setTextColorHeading (const QColor &color) |
QColor | backgroundColorSection () const |
void | setBackgroundColorSection (const QColor &color) |
QColor | textColorSection () const |
void | setTextColorSection (const QColor &color) |
QColor | linkColor () const |
void | setLinkColor (const QColor &color) |
QColor | backgroundParamName () const |
void | setBackgroundParamName (const QColor &color) |
Protected Member Functions | |
void | showEvent (QShowEvent *event) |
void | timerEvent (QTimerEvent *event) |
Properties | |
QColor | backgroundColorHeading |
QColor | textColorHeading |
QColor | linkColor |
QColor | backgroundParamName |
QColor | textColorSection |
QColor | backgroundColorSection |
Private Slots | |
void | on_splitter_splitterMoved (int pos, int index) |
void | on_helpTreeContent_anchorClicked (const QUrl &link) |
void | loadHelpResourcesFinished (int index) |
This slot is called when the loading thread is finished. More... | |
void | on_treeView_expanded (const QModelIndex &index) |
void | on_treeView_collapsed (const QModelIndex &index) |
void | selectedItemChanged (const QModelIndex ¤t, const QModelIndex &previous) |
Private Member Functions | |
void | storeSettings () |
Save Gui positions to Main-ini-File. | |
void | restoreSettings () |
Load Gui positions to Main-ini-File. | |
QStringList | separateLink (const QUrl &link) |
Returns a list containing the protocol[0] and the real link[1]. More... | |
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) |
QModelIndex | findIndexByPath (const int type, QStringList path, const QStandardItem *current) |
finds a Modelindex related to MainModel (not FilterModel)belonging to an Itemname More... | |
QString | parseFilterWidgetContent (const QString &input) |
Reformats all help strings that come from the widgets and plugins. More... | |
ito::RetVal | parseParamVector (const QString §ionname, const QVector< ito::Param > ¶mVector, QString &content) |
Creates the Parameter- and Return- sections in html-Code. More... | |
QString | parseParam (const QString &tmpl, const ito::Param ¶m) |
Parses a single Parameter to html code (called by parseParamVector) More... | |
void | loadAndProcessCssStyleSheet () |
QString | minText (int minimum) const |
This function detects if a range minimum of a variable is equal to the minimum of the type. More... | |
QString | minText (double minimum) const |
This function detects if a range minimum of a variable is equal to the minimum of the type. More... | |
QString | minText (char minimum) const |
This function detects if a range minimum of a variable is equal to the minimum of the type. More... | |
QString | maxText (int minimum) const |
This function detects if a range maximum of a variable is equal to the maximum of the type. More... | |
QString | maxText (double minimum) const |
This function detects if a range maximum of a variable is equal to the maximum of the type. More... | |
QString | maxText (char minimum) const |
This function detects if a range maximum of a variable is equal to the maximum of the type. More... | |
QString | minmaxText (int value) const |
This function detects if a range minimum or maximum of a variable is equal to the minimum or maximum of the type. More... | |
QString | minmaxText (double value) const |
This function detects if a range minimum or maximum of a variable is equal to the minimum or maximum of the type. More... | |
QString | minmaxText (char value) const |
This function detects if a range minimum or maximum of a variable is equal to the minimum or maximum of the type. More... | |
Static Private Member Functions | |
static void | createFilterWidgetNode (int fOrW, QStandardItemModel *model, const QMap< int, QIcon > *iconGallery) |
Get The Filters and put them into a node of the Tree. More... | |
static ito::RetVal | loadHelpResources (QStandardItemModel *mainModel, const QMap< int, QIcon > *iconGallery) |
Load help resources from various plugins in a different thread. More... | |
Private Attributes | |
Ui::HelpTreeDockWidget | ui |
QStandardItemModel * | m_pMainModel |
LeafFilterProxyModel * | m_pMainFilterModel |
ito::AbstractDockWidget * | m_pParent |
QList< QModelIndex > | m_history |
QMovie * | m_previewMovie |
QMap< int, QIcon > | m_iconGallery |
int | m_historyIndex |
int | m_autoCollTime |
double | m_treeWidthVisible |
double | m_treeWidthInvisible |
bool | m_treeVisible |
bool | m_plaintext |
bool | m_autoCollTree |
bool | m_internalCall |
bool | m_doingExpandAll |
States | m_state |
QString | m_filterTextPending |
int | m_filterTextPendingTimer |
QColor | m_backgroundColorHeading |
QColor | m_textColorHeading |
QColor | m_linkColor |
QColor | m_backgroundParamName |
QColor | m_textColorSection |
QColor | m_backgroundColorSection |
QFutureWatcher< ito::RetVal > | m_loaderWatcher |
QMutex | m_dbLoaderMutex |
Static Private Attributes | |
static const int | rolePath = Qt::UserRole + 1 |
static const int | roleType = Qt::UserRole + 2 |
static const int | roleFilename = Qt::UserRole + 3 |
|
staticprivate |
Get The Filters and put them into a node of the Tree.
fOrW | |
model | |
iconGallery |
|
private |
finds a Modelindex related to MainModel (not FilterModel)belonging to an Itemname
type | of the item (for more information see type enumeration in header file) |
path | path to the item splitted into a list |
current | item whose children are searched |
|
slot |
slot invoked by toolbar
This is the Slot is called by the toolbar when the user enters a filter into the search edit.
filterText | the text that the model is filtered with. |
|
staticprivate |
Load help resources from various plugins in a different thread.
This function parses the information pages for both algorithm and hardware plugins.
mainModel | pointer to the mainModel |
iconGallery | the gallery is passed to createFilterWidgetNode |
|
privateslot |
This slot is called when the loading thread is finished.
When this slot is called, the database is loaded and the main model created
|
private |
This function detects if a range maximum of a variable is equal to the maximum of the type.
For example if a range is max 255 and it�s a byte, this function returns inf
maximum |
|
private |
This function detects if a range maximum of a variable is equal to the maximum of the type.
For example if a range is max 255 and it�s a byte, this function returns inf
maximum |
|
private |
This function detects if a range maximum of a variable is equal to the maximum of the type.
For example if a range is max 255 and it�s a byte, this function returns inf
maximum |
|
private |
This function detects if a range minimum or maximum of a variable is equal to the minimum or maximum of the type.
For example if a range is max 255 and it�s a byte, this function returns inf
value |
|
private |
This function detects if a range minimum or maximum of a variable is equal to the minimum or maximum of the type.
For example if a range is max 255 and it�s a byte, this function returns inf
value |
|
private |
This function detects if a range minimum or maximum of a variable is equal to the minimum or maximum of the type.
For example if a range is max 255 and it�s a byte, this function returns inf
value |
|
private |
This function detects if a range minimum of a variable is equal to the minimum of the type.
For example if a range is min 0 and it�s a byte, this function returns -inf
minimum |
|
private |
This function detects if a range minimum of a variable is equal to the minimum of the type.
For example if a range is min 0 and it�s a byte, this function returns -inf
minimum |
|
private |
This function detects if a range minimum of a variable is equal to the minimum of the type.
For example if a range is min 0 and it�s a byte, this function returns -inf
minimum |
|
private |
Reformats all help strings that come from the widgets and plugins.
All newLine characters are replaced by the html tag
input | The text that is supposed to be reformated |
|
private |
Parses a single Parameter to html code (called by parseParamVector)
tmpl | |
param |
|
private |
Creates the Parameter- and Return- sections in html-Code.
sectionname | |
paramVector | |
content |
|
slot |
Reload different help resources and clear search-edit and start the new thread.
This function starts a new thread that loads the help resources.
< will be unlocked again if QtConcurrent run is finished.
|
private |
Returns a list containing the protocol[0] and the real link[1].
This functions looks for different protocols in the links that can be clicked inside the textBrowser
link | link link that is analysed |
|
slot |
Get the DocString from a Filter and parse is to html.
This function puts all information of a Widget or Plugin together and builds the html help text.
filterpath | path with all parents |
type | the enumeration itemType is defined in the header file helpTreeDockWidget.h |
|
slot |
slot invoked by different widgets to display a help page from extern
This is the Slot that can be externally called by other widgets to display filter or widget help ... i.a. AIManagerWidget
name | name of the function that is supposed to be displayed |
type | it decides wheather the help is stored in a database (1) or calls showFilterWidgetPluginHelp(...) (2-8) |
modelIndex | that was clicked. If it's empty, it's a call from a link or from extern |
fromLink | if true, a link called that slot |
|
private |
after this time the tree automatically becomes smaller
|
private |
if expand all is executed from somewhere, the slots on_treeView_expanded or on_treeView_collapsed should not be called to avoid crazy never-ending loops in Qt5, debug.
|
private |
List to store the adresses of the last visited pages
|
private |
If a page is called by the history buttons, this bool prevents from that this page is stored in the historylist again
|
private |
true: html code is displayed, false: normal help with style is displayed
|
private |
Filtered Tree Model (between the model and the tree
|
private |
Model to store the tree with all database entries
|
private |
pointer to helpDockWidget with Toolbar
|
private |
turning circle to show "wait" status
|
private |
stateIdle if the widget is not visible yet and no content has been loaded, stateVisible if it became visible for the first time, stateContentLoaded if all contents have been loaded.
|
private |
width of tree while small (in percent of the total width)
|
private |
width of tree while visible (in percent of the total width)