gui.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 *
 * xoreos 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ENGINES_AURORA_GUI_H
#define ENGINES_AURORA_GUI_H

#include <list>
#include <map>

#include <boost/noncopyable.hpp>

#include "src/common/ustring.h"

#include "src/events/types.h"

namespace Engines {

class Widget;
class Console;

class GUI : boost::noncopyable {
public:
    static const uint32 kStartCodeNone   = 0;
    static const uint32 kReturnCodeNone  = 0;
    static const uint32 kReturnCodeAbort = 0xFFFFFFFF;


    GUI(Console *console = 0);
    virtual ~GUI();

    virtual void show(); 
    virtual void hide(); 

    uint32 run(uint32 startCode = kStartCodeNone);
    virtual void abort();

    void addEvent(const Events::Event &event);
    uint32 processEventQueue();

    virtual Common::UString getName() const;


protected:
    Console *_console;

    Widget *_currentWidget; 

    uint32 _startCode;  
    uint32 _returnCode; 

    GUI *_sub; 


    void addWidget(Widget *widget);
    void removeWidget(Widget *widget);

    void clearWidgets();
    bool empty();

    bool hasWidget(const Common::UString &tag) const;

    Widget *getWidget(const Common::UString &tag, bool vital = false);
    const Widget *getWidget(const Common::UString &tag, bool vital = false) const;

    void declareGroup(const std::list<Widget *> &group);

    void removeFocus();

    void updateMouse();

    virtual void mouseUp();
    virtual void mouseDown();

    uint32 sub(GUI &gui, uint32 startCode = kStartCodeNone, bool showSelf = true, bool hideSelf = true);

    void setPosition(float x, float y, float z);

    void getPosition(float &x, float &y, float &z) const;

    virtual void callbackRun();
    virtual void callbackActive(Widget &widget);
    virtual void callbackTextInput(const Common::UString &text);
    virtual void callbackKeyInput(const Events::Key &key, const Events::EventType &type);

    void addChild(GUI *gui);
    void removeChild(GUI *gui);

private:
    typedef std::list<Widget *> WidgetList;
    typedef std::map<Common::UString, Widget *> WidgetMap;

    std::list<GUI *> _childGUIs;

    WidgetList _widgets;   
    WidgetMap  _widgetMap; 

    float _x; 
    float _y; 
    float _z; 

    std::list<Events::Event> _eventQueue; 

    Widget *getWidgetAt(float x, float y);

    void changedWidget(Widget *widget);     
    void checkWidgetActive(Widget *widget); 

    void mouseMove(const Events::Event &event); 
    void mouseDown(const Events::Event &event); 
    void mouseUp(const Events::Event &event);   
    void mouseWheel(const Events::Event &event); 
    void textInput(const Events::Event &event); 
    void keyDown(const Events::Event &event); 
    void keyUp(const Events::Event &event); 

    float toGUIX(int x); // Convert an event X coordinate to a GUI X coordinate
    float toGUIY(int y); // Convert an event Y coordinate to a GUI Y coordinate

    void mouseMove(Widget *widget, const Events::Event &event);
    void mouseDown(Widget *widget, const Events::Event &event);
    void mouseUp(Widget *widget, const Events::Event &event);
    void mouseWheel(Widget *widget, const Events::Event &event);

    friend class Widget;
};

} // End of namespace Engines

#endif // ENGINES_AURORA_GUI_H