Container.hpp

 
//
// TGUI - Texus's Graphical User Interface
// Copyright (C) 2012-2017 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_CONTAINER_HPP
#define TGUI_CONTAINER_HPP
 
 
#include <list>
 
#include <TGUI/Widget.hpp>
 
 
namespace tgui
{
 class TGUI_API Container : public Widget
 {
 public:
 
 typedef std::shared_ptr<Container> Ptr; 
 typedef std::shared_ptr<const Container> ConstPtr; 
 
 
 // Default constructor
 Container();
 
 
 Container(const Container& copy);
 
 
 Container& operator= (const Container& right);
 
 
 virtual void setFont(const Font& font) override;
 
 
 const std::vector<Widget::Ptr>& getWidgets()
 {
 return m_widgets;
 }
 
 
 const std::vector<sf::String>& getWidgetNames()
 {
 return m_objName;
 }
 
 
 virtual 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 std::dynamic_pointer_cast<T>(get(widgetName, recursive));
 }
 
 
 virtual bool remove(const Widget::Ptr& widget);
 
 
 virtual void removeAllWidgets();
 
 
 bool setWidgetName(const Widget::Ptr& widget, const std::string& name);
 
 
 std::string getWidgetName(const Widget::Ptr& widget) const;
 
 
 void focusWidget(const Widget::Ptr& widget);
 
 
 void focusWidget(Widget *const widget);
 
 
 void focusNextWidget();
 
 
 void focusPreviousWidget();
 
 
 void unfocusWidgets();
 
 
 void uncheckRadioButtons();
 
 
 virtual void setOpacity(float opacity) override;
 
 
 virtual sf::Vector2f getChildWidgetsOffset() const
 {
 return sf::Vector2f{0, 0};
 }
 
 
 void loadWidgetsFromFile(const std::string& filename);
 
 
 void saveWidgetsToFile(const std::string& filename);
 
 
 void loadWidgetsFromStream(std::stringstream& stream);
 
 
 void saveWidgetsToStream(std::stringstream& stream);
 
 
 virtual void leftMousePressed(float x, float y) override;
 
 virtual void leftMouseReleased(float x, float y) override;
 
 virtual void mouseMoved(float x, float y) override;
 
 virtual void keyPressed(const sf::Event::KeyEvent& event) override;
 
 virtual void textEntered(sf::Uint32 key) override;
 
 virtual void mouseWheelMoved(int delta, int x, int y) override;
 
 virtual void mouseNoLongerOnWidget() override;
 
 virtual void mouseNoLongerDown() override;
 
 virtual void widgetUnfocused() override;
 
 
 // Show the tool tip when the widget is located below the mouse.
 // Returns its tool tip or the tool tip from a child widget if the mouse is on top of the widget.
 // A nullptr is returned when the mouse is not on top of the widget or when the tool tip is empty.
 virtual Widget::Ptr askToolTip(sf::Vector2f mousePos) override;
 
 
 protected:
 
 void moveWidgetToFront(Widget *const widget);
 
 
 void moveWidgetToBack(Widget *const widget);
 
 
 // This function is called every frame with the time passed since the last frame.
 virtual void update(sf::Time elapsedTime) override;
 
 
 // When this function is called then all the widgets receive the event (if there are widgets).
 // The function returns true when the event is consumed and false when the event was ignored by all widgets.
 bool handleEvent(sf::Event& event);
 
 
 // Focuses the next widget in the container. If the last widget was focused then all widgets will be unfocused and
 // this function will return false.
 bool focusNextWidgetInContainer();
 
 
 // When the tab key is pressed then this function is called. The focus will move to the next widget (if there is one).
 // This function will only work when tabKeyUsageEnabled is true.
 // The function will return true when another widget was focused.
 bool tabKeyPressed();
 
 
 // Checks above which widget the mouse is standing.
 // If there is no widget below the mouse then this function will return a null pointer.
 Widget::Ptr mouseOnWhichWidget(float x, float y);
 
 
 // This function will call the draw function from all the widgets.
 virtual void drawWidgetContainer(sf::RenderTarget* target, const sf::RenderStates& states = sf::RenderStates::Default) const;
 
 
 protected:
 
 std::vector<Widget::Ptr> m_widgets;
 std::vector<sf::String> m_objName;
 
 Widget::Ptr m_widgetBelowMouse;
 
 // The id of the focused widget
 std::size_t m_focusedWidget = 0;
 
 // Did we enter handleEvent directly or because we got a MouseReleased event?
 bool m_handingMouseReleased = false;
 
 
 friend class Widget;
 
 };
 
 
 class TGUI_API GuiContainer : public Container
 {
 public:
 
 typedef std::shared_ptr<GuiContainer> Ptr; 
 typedef std::shared_ptr<const GuiContainer> ConstPtr; 
 
 
 GuiContainer();
 
 
 virtual void setSize(const Layout2d& size) override;
 using Transformable::setSize;
 
 
 virtual bool mouseOnWidget(float x, float y) const override;
 
 
 private:
 
 // Returns a nullptr.
 virtual Widget::Ptr clone() const override
 {
 return nullptr;
 }
 
 
 // This function does nothing.
 virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
 
 
 protected:
 
 sf::RenderTarget* m_window = nullptr;
 
 
 friend class Gui;
 
 
 };
 
 
}
 
 
#endif // TGUI_CONTAINER_HPP