Renamed Gui::Window to a more generic Gui::Panel, which can be a window, but also...

[evaf] / src / libs / Gui / panel.h

diff --git a/src/libs/Gui/window.h b/src/libs/Gui/panel.h
similarity index 62%
rename from src/libs/Gui/window.h
rename to src/libs/Gui/panel.h
index 15c426a9864b287b984035a7962e8f15ecc396cb..8c70ba615c0e9645dc62f611d6f521d14e298c36 100644 (file)
--- a/src/libs/Gui/window.h
+++ b/src/libs/Gui/panel.h
@@ -1,5 +1,5 @@
 /**
- * @file Gui/window.h
+ * @file Gui/panel.h
  * @brief Version information for eVaf modules
  * @author Enar Vaikene
  *
@@ -17,8 +17,8 @@
  * Agreement provided with the Software.
  */
 
-#ifndef __GUI_WINDOW_H
-#  define __GUI_WINDOW_H
+#ifndef __GUI_PANEL_H
+#  define __GUI_PANEL_H
 
 #include "libgui.h"
 
@@ -35,21 +35,26 @@ namespace eVaf {
 namespace Gui {
 
 /**
- * eVaf GUI window class.
- * @code#include <Gui/Window>@endcode
+ * eVaf GUI panel class.
+ * @code#include <Gui/Panel>@endcode
  *
- * The Gui::Window class is a common ancestor for all the eVaf windows. eVaf applications can have different window managers
- * that manage Gui::Window objects.
+ * The Gui::Panel class is the generic widget for eVaf GUI applications. It is an empty
+ * widget that can be filled with actual user interface elements like labels, edit boxes etc.
+ * Gui::Panel acts like a normal widget, which can be shown as a stand-alone window or added to other
+ * user interface layouts.
+ *
+ * The main purpose of Gui::Panel is that it can be added to one of the eVaf document interface
+ * managers.
  */
-class GUI_EXPORT Window : public QWidget
+class GUI_EXPORT Panel : public QWidget
 {
     Q_OBJECT
 
 public:
 
-    Window(QWidget * parent = 0);
+    Panel(QWidget * parent = 0, Qt::WindowFlags f = 0);
 
-    virtual ~Window();
+    virtual ~Panel();
 
 };
 
@@ -57,4 +62,4 @@ public:
 } // namespace eVaf
 
 
-#endif // window.h
+#endif // panel.h