guichanmanager.h

/***************************************************************************
 *   Copyright (C) 2005-2011 by the FIFE team                              *
 *   http://www.fifengine.net                                              *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE is free software; you can redistribute it and/or                 *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
 ***************************************************************************/

#ifndef FIFE_VIDEO_GUI_GUICHANMANAGER_H
#define FIFE_VIDEO_GUI_GUICHANMANAGER_H

// Standard C++ library includes
#include <set>

// 3rd party library includes
#include <guichan.hpp>

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder
#include "util/base/fife_stdint.h"
#include "util/base/singleton.h"
#include "eventchannel/sdl/ec_isdleventlistener.h"

#include "gui/guimanager.h"

namespace gcn {

    class Gui;
    class Container;
    class Widget;
    class SDLInput;
    class FocusHandler;

}


namespace FIFE {

    class GuiImageLoader;
    class Console;
    class KeyEvent;
    class MouseEvent;
    class IFont;
    class GuiFont;


    /* GUI Chan Manager.
     *
     * This class controls the GUI system in FIFE.
     */
    class GUIChanManager :
        public IGUIManager,
        public DynamicSingleton<GUIChanManager>
         {
        public:
            GUIChanManager();
            virtual ~GUIChanManager();

            gcn::Gui* getGuichanGUI() const;

            virtual void turn();

            void init(const std::string& backend, int32_t screenWidth, int32_t  screenHeight);

            void resizeTopContainer(uint32_t x, uint32_t y, uint32_t width, uint32_t height);

            void add(gcn::Widget* widget);
            void remove(gcn::Widget* widget);
            gcn::Container* getTopContainer() const { return m_gcn_topcontainer; }

            Console* getConsole() const { return m_console; };

            GuiFont* setDefaultFont(const std::string& path, uint32_t size, const std::string& glyphs);

            GuiFont* getDefaultFont() { return m_defaultfont; };

            GuiFont* createFont(const std::string& path = "", uint32_t size = 0, const std::string& glyphs = "");

            void releaseFont(GuiFont* font);

            void invalidateFonts();

            virtual bool onSdlEvent(SDL_Event& evt);

            KeyEvent translateKeyEvent(const gcn::KeyEvent& evt);
            MouseEvent translateMouseEvent(const gcn::MouseEvent& evt);

        protected:
            static int32_t convertGuichanKeyToFifeKey(int32_t value);

        private:
            // The Guichan GUI.
            gcn::Gui* m_gcn_gui;
            // GUIChan Graphics
            gcn::Graphics* m_gui_graphics;
            // Focus handler for input management
            gcn::FocusHandler* m_focushandler;
            // The top container of the GUI.
            gcn::Container* m_gcn_topcontainer;
            // The imageloader.
            GuiImageLoader* m_imgloader;
            // The input controller.
            gcn::SDLInput *m_input;
            // The console.
            Console       *m_console;
            //The default font
            GuiFont* m_defaultfont;
            // The fonts used
            std::vector<GuiFont*> m_fonts;
            // Added widgets
            std::set<gcn::Widget*> m_widgets;

            // Used to accept mouse motion events that leave widget space
            bool m_had_mouse;
            bool m_had_widget;

            // default font settings
            std::string m_fontpath;
            std::string m_fontglyphs;
            int32_t m_fontsize;

            // true, if guichan logic has already been executed for this round
            bool m_logic_executed;
    };

}

#endif