Gui.hpp

//
// TGUI - Texus's Graphical User Interface
// Copyright (C) 2012-2015 Bruno Van de Velde (vdv_b@tgui.eu)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
// you must not claim that you wrote the original software.
// If you use this software in a product, an acknowledgment
// in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
// and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//


#ifndef TGUI_WINDOW_HPP
#define TGUI_WINDOW_HPP


#include <queue>

#include <TGUI/Container.hpp>


namespace tgui
{

 class TGUI_API Gui : public sf::NonCopyable
 {
 public:

 Gui();


 Gui(sf::RenderWindow& window);


 Gui(sf::RenderTarget& window);


 void setWindow(sf::RenderWindow& window);


 void setWindow(sf::RenderTarget& window);


 sf::RenderTarget* getWindow() const;


 bool handleEvent(sf::Event event, bool resetView = true);


 void draw(bool resetView = true);


 bool pollCallback(Callback& callback);


 bool hasFocus() const;


 sf::Vector2f getSize() const;


 Container& getContainer();


 bool setGlobalFont(const std::string& filename);


 void setGlobalFont(const sf::Font& font);


 const sf::Font& getGlobalFont() const;


 const std::vector< Widget::Ptr >& getWidgets();


 const std::vector<sf::String>& getWidgetNames();


 void add(const Widget::Ptr& widgetPtr, const sf::String& widgetName = "");


 Widget::Ptr get(const sf::String& widgetName, bool recursive = false) const;


 template <class T>
 typename T::Ptr get(const sf::String& widgetName, bool recursive = false) const
 {
 return m_Container.get<T>(widgetName, recursive);
 }


 Widget::Ptr copy(const Widget::Ptr& oldWidget, const sf::String& newWidgetName = "");


 void remove(const Widget::Ptr& widget);


 void removeAllWidgets();


 bool setWidgetName(const Widget::Ptr& widget, const std::string& name);


 bool getWidgetName(const Widget::Ptr& widget, std::string& name) const;


 void focusWidget(Widget::Ptr& widget);


 void focusNextWidget();


 void focusPreviousWidget();


 void unfocusWidgets();


 void uncheckRadioButtons();


 void moveWidgetToFront(Widget::Ptr& widget);


 void moveWidgetToBack(Widget::Ptr& widget);


 void bindGlobalCallback(std::function<void(const Callback&)> func);


 template <typename T>
 void bindGlobalCallback(void (T::*func)(const Callback&), const T* const classPtr)
 {
 m_Container.bindGlobalCallback(func, classPtr);
 }


 void unbindGlobalCallback();


 bool loadWidgetsFromFile(const std::string& filename);


 bool saveWidgetsToFile(const std::string& filename);


 // Update the internal clock to make animation possible. This function is called automatically by the draw function.
 // You will thus only need to call it yourself when you are drawing everything manually.
 void updateTime(const sf::Time& elapsedTime);


 // TGUI uses this function internally to handle widget callbacks.
 // When you tell a widget to send its callbacks to its parent then this function is called.
 //
 // When one or more global callback functions were set then these functions will be called.
 // Otherwise, the callback will be added to the callback queue and you will be able to poll it later with pollCallback.
 //
 // You can use this function to fake a widget callback.
 void addChildCallback(const Callback& callback);


 protected:

 // This will store all widget callbacks until you pop them with getCallback
 std::queue<Callback> m_Callback;

 // The internal clock which is used for animation of widgets
 sf::Clock m_Clock;

 // The sfml window or other target to draw on
 sf::RenderTarget* m_Window;

 // Does m_Window contains a sf::RenderWindow?
 bool m_accessToWindow;

 // Internal container to store all widgets
 GuiContainer m_Container;



 template<class T>
 friend class SharedWidgetPtr;

 };


}


#endif // TGUI_WINDOW_HPP