QT/Serial-Studio
1
0
Fork 0
mirror of https://github.com/Serial-Studio/Serial-Studio.git synced 2025-01-31 17:42:55 +08:00
Code Issues Projects Releases Wiki Activity

Add documentation for WidgetLoader.cpp

Browse Source
This commit is contained in:
Alex Spataru 2021-10-01 04:14:34 -05:00
parent 92b0a0193e
commit 24518d5552
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/Widgets/WidgetLoader.cpp
View File

@ -185,6 +185,13 @@ QString WidgetLoader::widgetTitle() const
return tr("Invalid"); return tr("Invalid");
} }
/**
* If set to @c true, then the widget visibility shall be controlled
* directly by the QML interface.
*
* If set to @c false, then the widget visbility shall be controlled
* by the UI::Dashboard class via the SIGNAL/SLOT system.
*/
bool WidgetLoader::isExternalWindow() const bool WidgetLoader::isExternalWindow() const
{ {
return m_isExternalWindow; return m_isExternalWindow;
@ -198,6 +205,9 @@ UI::Dashboard::WidgetType WidgetLoader::widgetType() const
return UI::Dashboard::getInstance()->widgetType(widgetIndex()); return UI::Dashboard::getInstance()->widgetType(widgetIndex());
} }
/**
* Changes the visibility & enabled status of the widget
*/
void WidgetLoader::setVisible(const bool visible) void WidgetLoader::setVisible(const bool visible)
{ {
if (m_widget) if (m_widget)
@ -269,6 +279,15 @@ void WidgetLoader::setWidgetIndex(const int index)
} }
} }
/**
* Changes the widget visibility controller source.
*
* If set to @c true, then the widget visibility shall be controlled
* directly by the QML interface.
*
* If set to @c false, then the widget visbility shall be controlled
* by the UI::Dashboard class via the SIGNAL/SLOT system.
*/
void WidgetLoader::setIsExternalWindow(const bool isWindow) void WidgetLoader::setIsExternalWindow(const bool isWindow)
{ {
m_isExternalWindow = isWindow; m_isExternalWindow = isWindow;