GUIFacade.h

Go to the documentation of this file.

/*
 * i6engine
 * Copyright (2016) Daniel Bonrath, Michael Baer, All rights reserved.
 *
 * This file is part of i6engine; i6engine 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 __I6ENGINE_API_GUIFACADE_H__
#define __I6ENGINE_API_GUIFACADE_H__

#include <map>

#include "i6engine/api/KeyCodes.h"

#include "boost/function.hpp"

namespace i6e {
namespace api {
namespace gui {
        enum class Alignment;
} /* namespace gui */

        class GUIWidget;

        class ISIXE_MODULES_API GUIFacade {
        public:
                GUIFacade();

                ~GUIFacade() {
                }

                void startGUI(const std::string & strScheme, const std::string & strFont, const std::string & strDefaultFont, const std::string & strDefaultMouseImageSet, const std::string & strDefaultMouseImageName) const;

                void addToRootWindow(const std::string & child_window) const;

                void setMouseVisibility(const bool visibility) const;

                void clearAllWindows() const;

                void subscribeEvent(const std::string & windowname, const std::string & eventType, const boost::function<void(void)> & ptrEventMethod) const;

                void changeEvent(const std::string & windowname, bool b) const;

                void setMouseCursorImage(const std::string & image) const;

                void addImageset(const std::string & imageset) const;

                void loadCanvas(const std::string & name, const std::string & file) const;

                void addPrint(const std::string & name, const std::string & type, const double x, const double y, const std::string & message, gui::Alignment alignment, const int64_t lifetime = -1) const;

                void addProgressBar(const std::string & name, const std::string & type, const double x, const double y, const double w, const double h) const;

                void addEditbox(const std::string & name, const std::string & type, double x, double y, double w, double h, const std::string & defaultText, const std::function<void(std::string)> & enterCallback) const;

                void addTextButton(const std::string & name, const std::string & type, double x, double y, double w, double h, const std::string & text) const;

                void addImageButton(const std::string & name, const std::string & type, double x, double y, double w, double h, const std::string & normalImage, const std::string & hoverImage, const std::string & pushedImage) const;

                void addToggleButton(const std::string & name, const std::string & type, double x, double y, double w, double h, bool selected, const std::function<void(bool)> & selectedCallback) const;

                void addStatusList(const std::string & name, const std::string & type, const double x, const double y, const int64_t lifetime) const;

                void addImage(const std::string & name, const std::string & type, const std::string & imageSetName, const std::string & imageName, const double x, const double y, const double w, const double h) const;

                void addMultiColumnList(const std::string & name, const std::string & type, const double x, const double y, const double w, const double h) const;

                void addComboBox(const std::string & name, const std::string & type, const double x, const double y, const double w, const double h, const std::function<void(std::string)> & selectedCallback) const;

                void addChat(const std::string & name, const std::string & type, const double x, const double y, const double w, const double h, const std::function<std::string(std::string)> & acceptedCallback) const;

                void setText(const std::string & name, const std::string & text) const;

                void setPosition(const std::string & name, const double x, const double y) const;

                void setSize(const std::string & name, const double w, const double h) const;

                void setVisibility(const std::string & windowname, const bool visibility) const;

                void setAmount(const std::string & name, const uint32_t amount) const;

                void setColour(const std::string & name, double alpha, double red, double green, double blue) const;

                void setFont(const std::string & name, const std::string & font) const;

                void setLifetime(const std::string & name, const int64_t time) const;

                void setAlignment(const std::string & name, gui::Alignment alignment) const;

                void enableDropTarget(const std::string & name, bool target, const std::function<bool(std::string)> & func) const;

                void setDragable(const std::string & name, bool enabled) const;

                void setDropCallback(const std::string & name, const std::function<void(const std::string &, const std::string &)> & callback) const;

                void setProgress(const std::string & name, const double progress) const;

                void addRowToList(const std::string & name) const;

                void addRowEntry(const std::string & name, const uint32_t row, const uint32_t column, const std::string & entry) const;

                void addColumn(const std::string & name, const std::string & columnHeader, uint32_t column, double width) const;

                void clearWidget(const std::string & name) const;

                void setImage(const std::string & name, const std::string & imageSetName, const std::string & imageSet) const;

                void setEnterTextCallback(const std::string & name, const std::function<void(std::string)> & enterCallback) const;

                void setProperty(const std::string & name, const std::string & prop, const std::string & value) const;

                void setSelected(const std::string & name, bool selected) const;

                void setSelectedCallback(const std::string & name, const std::function<void(bool)> & selectedCallback) const;

                void setAcceptedTextCallback(const std::string & name, const std::function<std::string(std::string)> & acceptedCallback) const;

                void setTooltip(const std::string & name, const std::string & tooltip) const;

                void addTextToWidget(const std::string & name, const std::string & text) const;

                void setSelectedStringCallback(const std::string & name, const std::function<void(std::string)> & selectedCallback) const;

                void playAnimation(const std::string & name, const std::string & animation) const;

                void stopAnimation(const std::string & name, const std::string & animation) const;

                void pauseAnimation(const std::string & name, const std::string & animation) const;

                void unpauseAnimation(const std::string & name, const std::string & animation) const;

                void setAutoLineBreak(const std::string & name, bool enabled) const;

                void registerWidgetTemplate(const std::string & name, const boost::function<api::GUIWidget * (const std::string & name, const std::string & style)> & createFunc) const;

                void createWidget(const std::string & name, const std::string & type, const std::string & style) const;

                void deleteWidget(const std::string & name) const;

                void addTicker(GUIWidget * widget);

                void removeTicker(GUIWidget * widget);

                void registerAddTickerCallback(const boost::function<void(GUIWidget *)> & func);

                void registerRemoveTickerCallback(const boost::function<void(GUIWidget *)> & func);

                void resetSubSystem();

                void setInputCaptured(bool captured) {
                        _captured = captured;
                }

                bool getInputCaptured() const {
                        return _captured;
                }

                void setOnWindow(bool onWindow) {
                        _onWindow = onWindow;
                }

                bool getOnWindow() const {
                        return _onWindow;
                }

                void setDefaultFont(const std::string & font) const;

                void addWidgetAsChildTo(const std::string & child, const std::string & parent) const;

        private:
                bool _onWindow;
                bool _captured;

                GUIFacade(const GUIFacade &) = delete;

                GUIFacade & operator=(const GUIFacade &) = delete;

                boost::function<void(GUIWidget *)> _addTickerCallback;

                boost::function<void(GUIWidget *)> _removeTickerCallback;
        };

} /* namespace api */
} /* namespace i6e */

#endif /* __I6ENGINE_API_GUIFACADE_H__ */