gemrb/core/WindowMgr.h

   1 /* GemRB - Infinity Engine Emulator
   2  * Copyright (C) 2003 The GemRB Project
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  *
  18  *
  19  */
  20
  21 /**
  22  * @file WindowMgr.h
  23  * Declares WindowMgr class, abstract loader for GUI windows and controls
  24  * @author The GemRB Project
  25  */
  26
  27 #ifndef WINDOWMGR_H
  28 #define WINDOWMGR_H
  29
  30 #include "DataStream.h"
  31 #include "Plugin.h"
  32 #include "Window.h"
  33
  34 /**
  35  * @class WindowMgr
  36  * Abstract loader for GUI windows (and controls with them).
  37  * Contrary to its name, it does not work as a window manager
  38  */
  39
  40 class GEM_EXPORT WindowMgr : public Plugin {
  41 public:
  42         WindowMgr();
  43         virtual ~WindowMgr();
  44         /** This function loads all available windows from the 'stream' parameter. */
  45         virtual bool Open(DataStream* stream, bool autoFree = true) = 0;
  46         /** Returns the i-th window in the Previously Loaded Stream */
  47         virtual Window* GetWindow(unsigned int i) = 0;
  48         /** Returns the number of available windows */
  49         virtual unsigned int GetWindowsCount() = 0;
  50 };
  51
  52 #endif