2 * @file SdiWindow/isdiwindow.h
3 * @brief eVaf SDI window interface
6 * Copyright (c) 2011-2019 Enar Vaikene
8 * This file is part of the eVaf C++ cross-platform application development framework.
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.
16 * Alternatively, this file may be used in accordance with the Commercial License
17 * Agreement provided with the Software.
20 #ifndef __SDIWINDOW_ISDIWINDOW_H
21 # define __SDIWINDOW_ISDIWINDOW_H
23 #include "libsdiwindow.h"
35 } // namespace eVaf::Gui
40 * Single Document Interface window manager for eVaf applications.
42 * The iSdiWindow interface implements an SDI window manager.
44 struct SDIWINDOW_EXPORT iSdiWindow
47 * Returns the iSdiWindow interface instance
48 * @return The iSdiWindow interface or zero if not available
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.
54 static iSdiWindow
* instance();
57 * Empty virtual destructor
59 virtual ~iSdiWindow() {}
62 * Adds a panel to the SDI window manager
63 * @param name Name of the panel
64 * @param panel The panel
66 * This function adds a panel to the SDI window manager. The ownership of the panel
67 * is transferred to the window manager and it is the responsibility of the window
68 * manager to delete it.
70 virtual void addPanel(QString
const & name
, Gui::Panel
* panel
) = 0;
73 * Returns a panel by the name
74 * @param name Name of the panel
75 * @return Pointer to the panel or 0 if failed
77 * This function returns a panel identified by the name.
79 virtual Gui::Panel
* panel(QString
const & name
) const = 0;
83 * @param name Name of the panel
84 * @return True if succeeded; false if not
86 * This function shows the panel.
88 virtual bool showPanel(QString
const & name
) = 0;
92 } // namespace eVaf::SdiWindow
95 Q_DECLARE_INTERFACE(eVaf::SdiWindow::iSdiWindow
, "eVaf.SdiWindow.iSdiWindow/1.1")
97 #endif // isdiwindow.h