Widget.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_WIDGETS_HPP
#define TGUI_WIDGETS_HPP
 
 
#include <TGUI/Global.hpp>
#include <TGUI/Signal.hpp>
#include <TGUI/Transformable.hpp>
#include <TGUI/Texture.hpp>
#include <TGUI/Color.hpp>
#include <TGUI/Font.hpp>
#include <TGUI/Loading/Deserializer.hpp>
 
 
namespace tgui
{
 class BaseTheme;
 class Container;
 class WidgetRenderer;
 
 enum class ShowAnimationType;
 namespace priv
 {
 class Animation;
 }
 
 
 class TGUI_API Widget : public sf::Drawable, public Transformable, public SignalWidgetBase, public std::enable_shared_from_this<Widget>
 {
 public:
 
 typedef std::shared_ptr<Widget> Ptr; 
 typedef std::shared_ptr<const Widget> ConstPtr; 
 
 
 Widget();
 
 
 Widget(const Widget& copy);
 
 
 ~Widget();
 
 
 Widget& operator= (const Widget& right);
 
 
 std::shared_ptr<WidgetRenderer> getRenderer() const
 {
 return m_renderer;
 }
 
 
 virtual void setPosition(const Layout2d& position) override;
 using Transformable::setPosition;
 
 
 virtual void setSize(const Layout2d& size) override;
 using Transformable::setSize;
 
 
 virtual sf::Vector2f getAbsolutePosition() const;
 
 
 virtual void show();
 
 
 virtual void showWithEffect(ShowAnimationType type, sf::Time duration);
 
 
 virtual void hide();
 
 
 virtual void hideWithEffect(ShowAnimationType type, sf::Time duration);
 
 
 bool isVisible() const
 {
 return m_visible;
 }
 
 
 virtual void enable();
 
 
 virtual void disable(bool blockMouseEvents = true);
 
 
 bool isEnabled() const
 {
 return m_enabled;
 }
 
 
 virtual void focus();
 
 
 virtual void unfocus();
 
 
 bool isFocused() const
 {
 return m_focused;
 }
 
 
 const std::string& getWidgetType() const
 {
 return m_callback.widgetType;
 }
 
 
 Container* getParent() const
 {
 return m_parent;
 }
 
 
 virtual void setOpacity(float opacity);
 
 
 float getOpacity() const
 {
 return m_opacity;
 }
 
 
 virtual void moveToFront();
 
 
 virtual void moveToBack();
 
 
 void setToolTip(Widget::Ptr toolTip);
 
 
 Widget::Ptr getToolTip();
 
 
 virtual void setFont(const Font& font);
 
 
 std::shared_ptr<sf::Font> getFont() const;
 
 
 void detachTheme();
 
 
 std::shared_ptr<BaseTheme> getTheme() const
 {
 return m_theme;
 }
 
 
 std::string getPrimaryLoadingParameter() const
 {
 return m_primaryLoadingParameter;
 }
 
 
 std::string getSecondaryLoadingParameter() const
 {
 return m_secondaryLoadingParameter;
 }
 
 
 virtual sf::Vector2f getWidgetOffset() const
 {
 return sf::Vector2f{0, 0};
 }
 
 
 virtual void setParent(Container* parent);
 
 
 virtual void update(sf::Time elapsedTime);
 
 
 virtual bool mouseOnWidget(float x, float y) const = 0;
 
 virtual void leftMousePressed(float x, float y);
 
 virtual void leftMouseReleased(float x, float y);
 
 virtual void mouseMoved(float x, float y);
 
 virtual void keyPressed(const sf::Event::KeyEvent& event);
 
 virtual void textEntered(sf::Uint32 key);
 
 virtual void mouseWheelMoved(int delta, int x, int y);
 
 virtual void widgetFocused();
 
 virtual void widgetUnfocused();
 
 virtual void mouseNoLongerOnWidget();
 
 virtual void mouseNoLongerDown();
 
 
 // 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);
 
 
 virtual Widget::Ptr clone() const = 0;
 
 
 protected:
 
 void attachTheme(std::shared_ptr<BaseTheme> theme);
 
 
 virtual void reload(const std::string& primary = "", const std::string& secondary = "", bool force = false);
 
 
 // This function is called when the mouse enters the widget. If requested, a callback will be send.
 virtual void mouseEnteredWidget();
 
 
 // This function is called when the mouse leaves the widget. If requested, a callback will be send.
 virtual void mouseLeftWidget();
 
 
 // Check if the widget blocks mouse events when disabled
 bool isDisabledBlockingMouseEvents() const;
 
 
 protected:
 
 // Block mouse events when the widget is disabled or let them pass to the widget behind it?
 bool m_disabledBlockingMouseEvents = true;
 
 // When a widget is disabled, it will no longer receive events
 bool m_enabled = true;
 
 // Is the widget visible? When it is invisible it will not receive events and it won't be drawn.
 bool m_visible = true;
 
 // This will point to our parent widget. If there is no parent then this will be nullptr.
 Container* m_parent = nullptr;
 
 // How transparent is the widget
 float m_opacity = 1;
 
 // Is the mouse on top of the widget? Did the mouse go down on the widget?
 bool m_mouseHover = false;
 bool m_mouseDown = false;
 
 // Are you focused on the widget?
 bool m_focused = false;
 
 // Can the widget be focused?
 bool m_allowFocus = false;
 
 // Keep track of the elapsed time.
 sf::Time m_animationTimeElapsed;
 
 // This is set to true for widgets that have something to be dragged around (e.g. sliders and scrollbars)
 bool m_draggableWidget = false;
 
 // This is set to true for widgets that store other widgets inside them
 bool m_containerWidget = false;
 
 // The tool tip connected to the widget
 Widget::Ptr m_toolTip = nullptr;
 
 // The font that the widget can use
 std::shared_ptr<sf::Font> m_font = nullptr;
 
 // Renderer of the widget
 std::shared_ptr<WidgetRenderer> m_renderer = nullptr;
 
 // Theme object that loaded this widget (if any)
 std::shared_ptr<BaseTheme> m_theme = nullptr;
 std::string m_primaryLoadingParameter;
 std::string m_secondaryLoadingParameter;
 
 // Show animations
 std::vector<std::shared_ptr<priv::Animation>> m_showAnimations;
 
 
 friend class Container;
 friend class BaseTheme;
 };
 
 
 class TGUI_API WidgetRenderer
 {
 public:
 
 virtual ~WidgetRenderer() {};
 
 
 virtual void setProperty(std::string property, const std::string& value);
 
 
 virtual void setProperty(std::string property, ObjectConverter&& value);
 
 
 virtual ObjectConverter getProperty(std::string property) const;
 
 
 virtual std::map<std::string, ObjectConverter> getPropertyValuePairs() const;
 
 
 private:
 
 // Makes a copy of the renderer
 virtual std::shared_ptr<WidgetRenderer> clone(Widget* widget) = 0;
 
 
 
 friend class Widget;
 };
 
 
}
 
 
#endif // TGUI_WIDGETS_HPP