vaikene.ee Git - evaf/blob - src/libs/Gui/panel.h

   1 /**
   2  * @file Gui/panel.h
   3  * @brief Version information for eVaf modules
   4  * @author Enar Vaikene
   5  *
   6  * Copyright (c) 2011-2019 Enar Vaikene
   7  *
   8  * This file is part of the eVaf C++ cross-platform application development framework.
   9  *
  10  * This file can be used under the terms of the GNU General Public License
  11  * version 3.0 as published by the Free Software Foundation and appearing in
  12  * the file LICENSE included in the packaging of this file. Please review the
  13  * the following information to ensure the GNU General Public License version
  14  * 3.0 requirements will be met: http://www.gnu.org/copyleft/gpl.html.
  15  *
  16  * Alternatively, this file may be used in accordance with the Commercial License
  17  * Agreement provided with the Software.
  18  */
  19
  20 #ifndef __GUI_PANEL_H
  21 #  define __GUI_PANEL_H
  22
  23 #include "libgui.h"
  24
  25 #include <QWidget>
  26
  27 namespace eVaf {
  28
  29 /**
  30  * Common eVaf GUI library.
  31  *
  32  * This library contains common Graphical User Interface functions and classes for eVaf applications.
  33  * This library is a required dependency for all the eVaf modules that implement elements of the GUI.
  34  */
  35 namespace Gui {
  36
  37 /**
  38  * eVaf GUI panel class.
  39  * @code#include <Gui/Panel>@endcode
  40  *
  41  * The Gui::Panel class is the generic widget for eVaf GUI applications. It is an empty
  42  * widget that can be filled with actual user interface elements like labels, edit boxes etc.
  43  * Gui::Panel acts like a normal widget, which can be shown as a stand-alone window or added to other
  44  * user interface layouts.
  45  *
  46  * The main purpose of Gui::Panel is that it can be added to one of the eVaf document interface
  47  * managers.
  48  */
  49 class GUI_EXPORT Panel : public QWidget
  50 {
  51     Q_OBJECT
  52
  53 public:
  54
  55     Panel(QWidget * parent = nullptr, Qt::WindowFlags f = Qt::WindowFlags());
  56
  57     virtual ~Panel();
  58
  59 };
  60
  61 } // namespace eVaf::Gui
  62 } // namespace eVaf
  63
  64
  65 #endif // panel.h