GUIInterface.h

Go to the documentation of this file.

/*
Copyright (c) 2018 DIVIDE-Studio
Copyright (c) 2009 Ionut Cava
 
This file is part of DIVIDE Framework.
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software
and associated documentation files (the "Software"), to deal in the Software
without restriction,
including without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so,
subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
IN CONNECTION WITH THE SOFTWARE
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
*/
 
#pragma once
#ifndef DVD_GUI_INTERFACE_H_
#define DVD_GUI_INTERFACE_H_
 
#include "GUIElement.h"
#include "Core/Math/Headers/Dimension.h"
 
namespace CEGUI {
    class String;
};
 
namespace Divide {
 
class GUI;
class GUIText;
class GUIFlash;
class GUIButton;
class GUIMessageBox;
 
class GUIInterface {
public:
    using GUIMap = hashMap<U64, std::pair<GUIElement*, bool/*last state*/>>;
    using ButtonCallback = DELEGATE<void, I64>;
 
public:
    explicit GUIInterface(GUI& context);
    virtual ~GUIInterface();
 
    void onLanguageChange(std::string_view newLanguage);
 
    GUI& getParentContext() noexcept { return *_context; }
    const GUI& getParentContext() const noexcept { return *_context; }
    template <typename T> requires std::is_base_of_v<GUIElement, T>
    T* getGUIElement(const U64 elementName) const {
        return static_cast<T*>(getGUIElementImpl(elementName, T::Type));
    }
 
    template <typename T> requires std::is_base_of_v<GUIElement, T>
    T* getGUIElement(const I64 elementID) const {
        return static_cast<T*>(getGUIElementImpl(elementID, T::Type));
    }
 
    virtual GUIText* addText(const char* name,
                             const RelativePosition2D& position,
                             const string& font,
                             const UColour4& colour,
                             const string& text,
                             bool multiLine = false,
                             U8 fontSize = 16u);
 
    virtual GUIText* modifyText(const char* name, const string& text, bool multiLine);
 
    virtual GUIMessageBox* addMsgBox(const char* name,
                                     const string& title,
                                     const string& message,
                                     vec2<I32> offsetFromCentre = vec2<I32>(0));
 
    virtual GUIButton* addButton(const char* name,
                                 const string& text,
                                 const RelativePosition2D& offset,
                                 const RelativeScale2D& size,
                                 const string& rootSheetID = "");
 
    virtual GUIFlash* addFlash(const char* name,
                               const RelativePosition2D& position,
                               const RelativeScale2D& size);
 
    virtual CEGUI::Window* createWindow(const CEGUI::String& type, const CEGUI::String& name);
    virtual CEGUI::Window* loadWindowFromLayoutFile(const char* layoutFileName);
    virtual bool unloadWindow(CEGUI::Window*& window);
 
protected:
    void addElement(U64 id, GUIElement* element);
    virtual GUIElement* getGUIElementImpl(U64 elementName, GUIType type) const;
    virtual GUIElement* getGUIElementImpl(I64 elementID, GUIType type) const;
 
protected:
    GUI* _context;
 
    std::array<GUIMap, to_base(GUIType::COUNT)> _guiElements;
};
 
}; //namespace Divide
 
#endif //DVD_GUI_INTERFACE_H_