vaikene.ee Git - evaf/blob - src/plugins/SdiWindow/isdiwindow.h

   1 /**
   2  * @file SdiWindow/isdiwindow.h
   3  * @brief eVaf SDI window interface
   4  * @author Enar Vaikene
   5  *
   6  * Copyright (c) 2011 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 __SDIWINDOW_ISDIWINDOW_H
  21 #  define __SDIWINDOW_ISDIWINDOW_H
  22
  23 #include "libsdiwindow.h"
  24
  25 #include <QString>
  26 #include <QtPlugin>
  27
  28 class QWidget;
  29 class QLayout;
  30
  31 namespace eVaf {
  32
  33 namespace Gui {
  34     class Window;
  35 } // namespace eVaf::Gui
  36
  37 namespace SdiWindow {
  38
  39 /**
  40  * Single Document Interface window manager for eVaf applications.
  41  *
  42  * The iSdiWindow interface implements an SDI window manager.
  43  */
  44 struct SDIWINDOW_EXPORT iSdiWindow
  45 {
  46     /**
  47      * Returns the iSdiWindow interface instance
  48      * @return The iSdiWindow interface or zero if not available
  49      *
  50      * This function returns the global iSdiWindow interface instance. Using this function
  51      * is not mandatory and modules can use the iRegistry interface instead. Using the iRegistry
  52      * interface has the advantage that modules do not need to link against this library.
  53      */
  54     static iSdiWindow * instance();
  55
  56     /**
  57      * Adds the window to the main SDI window
  58      * @param window The window
  59      *
  60      * This function adds a window to the main SDI layout.
  61      */
  62     virtual void addWindow(Gui::Window * window) = 0;
  63
  64 };
  65
  66 } // namespace eVaf::SdiWindow
  67 } // namespace eVaf
  68
  69 Q_DECLARE_INTERFACE(eVaf::SdiWindow::iSdiWindow, "eVaf.SdiWindow.iSdiWindow/1.1")
  70
  71 #endif // isdiwindow.h