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_JADE_GUI_GUI_H
#define ENGINES_JADE_GUI_GUI_H

#include "src/common/scopedptr.h"

#include "src/aurora/types.h"
#include "src/aurora/gff3file.h"

#include "src/graphics/aurora/types.h"
#include "src/graphics/aurora/highlightable.h"

#include "src/engines/aurora/gui.h"

#include "src/engines/jade/gui/guibackground.h"

namespace Engines {

class KotORJadeWidget;

class WidgetPanel;
class WidgetLabel;
class WidgetProtoItem;
class WidgetButton;
class WidgetCheckBox;
class WidgetSlider;
class WidgetScrollbar;
class WidgetProgressbar;
class WidgetListBox;

namespace Jade {

class GUI : public Engines::GUI {
public:
    GUI(::Engines::Console *console = 0);
    ~GUI();

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

    void convertToXoreos(float &x, float &y, const float widgetHeight) const;
    void convertToGUI(float &x, float &y, const float widgetHeight) const;

    Common::UString getName() const;

protected:
    enum WidgetType {
        kWidgetTypeInvalid     = - 1,
        kWidgetTypePanel       =   2,
        kWidgetTypeLabel       =   4,
        kWidgetTypeProtoItem   =   5,
        kWidgetTypeButton      =   6,
        kWidgetTypeCheckBox    =   7,
        kWidgetTypeSlider      =   8,
        kWidgetTypeScrollbar   =   9,
        kWidgetTypeProgressbar =  10,
        kWidgetTypeListBox     =  11
    };

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

    void load(const Common::UString &resref);

    virtual void initWidget(Widget &widget);

    WidgetPanel       *getPanel      (const Common::UString &tag, bool vital = false);
    WidgetLabel       *getLabel      (const Common::UString &tag, bool vital = false);
    WidgetProtoItem   *getProtoItem  (const Common::UString &tag, bool vital = false);
    WidgetButton      *getButton     (const Common::UString &tag, bool vital = false);
    WidgetCheckBox    *getCheckBox   (const Common::UString &tag, bool vital = false);
    WidgetSlider      *getSlider     (const Common::UString &tag, bool vital = false);
    WidgetScrollbar   *getScrollbar  (const Common::UString &tag, bool vital = false);
    WidgetProgressbar *getProgressbar(const Common::UString &tag, bool vital = false);
    WidgetListBox     *getListBox    (const Common::UString &tag, bool vital = false);

    void addBackground(const Common::UString &background, bool front = false);

    void setCheckBoxState(const Common::UString &tag, bool state);
    bool getCheckBoxState(const Common::UString &tag);

private:
    struct WidgetContext {
        const Aurora::GFF3Struct *strct;

        WidgetType type;

        Common::UString tag;
        KotORJadeWidget *widget;

        Widget *parent;

        WidgetContext(const Aurora::GFF3Struct &s, Widget *p);
    };

    float _widgetZ;

    float _guiHeight;
    float _guiWidth;

    Common::ScopedPtr<GUIBackground> _background;

    Common::ScopedPtr<Aurora::GFF3File> _gff;

    Common::UString _name;

    void loadWidget(const Aurora::GFF3Struct &strct, Widget *parent);

    void createWidget(WidgetContext &ctx);
};

} // End of namespace Jade

} // End of namespace Engines

#endif // ENGINES_JADE_GUI_GUI_H