Widget.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_WIDGETS_HPP
#define TGUI_WIDGETS_HPP


#include <TGUI/Global.hpp>
#include <TGUI/ConfigFile.hpp>
#include <TGUI/Callback.hpp>
#include <TGUI/Transformable.hpp>
#include <TGUI/SharedWidgetPtr.hpp>


namespace tgui
{
 class Container;

 class TGUI_API Widget : public sf::Drawable, public Transformable, public CallbackManager
 {
 public:

 typedef SharedWidgetPtr<Widget> Ptr;


 Widget();


 Widget(const Widget& copy);


 virtual ~Widget();


 Widget& operator= (const Widget& right);


 // Makes a copy of the widget by just calling the copy constructor.
 virtual Widget* clone() = 0;


 virtual sf::Vector2f getAbsolutePosition() const;


 virtual void show();


 virtual void hide();


 bool isVisible() const;


 virtual void enable();


 virtual void disable();


 bool isEnabled() const;


 bool isDisabled() const;


 bool isLoaded() const;


 virtual void focus();


 virtual void unfocus();


 bool isFocused() const;


 WidgetTypes getWidgetType() const;


 Container* getParent() const;


 virtual void setTransparency(unsigned char transparency);


 unsigned char getTransparency() const;


 virtual void moveToFront();


 virtual void moveToBack();


 void setCallbackId(unsigned int callbackId);


 unsigned int getCallbackId();


 // This function is called right after the elapsed time is changed.
 // The elapsed time is only changed when the widget has set m_AnimatedWidget to true.
 virtual void update();


 // The widgets use this function to send their callbacks to their parent and/or to a callback function.
 void addCallback();


 // 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();


 virtual bool mouseOnWidget(float x, float y) = 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 mouseNotOnWidget();

 virtual void mouseNoLongerDown();


 // This function is a (slow) way to set properties on the widget, no matter what type it is.
 // When the requested property doesn't exist in the widget then the functions will return false.
 virtual bool setProperty(std::string property, const std::string& value);

 // This function is a (slow) way to get properties of the widget, no matter what type it is.
 // When the requested property doesn't exist in the widget then the functions will return false.
 virtual bool getProperty(std::string property, std::string& value) const;


 // Returns a list of all properties that can be used in setProperty and getProperty.
 // The second value in the pair is the type of the property (e.g. int, uint, string, ...).
 virtual std::list< std::pair<std::string, std::string> > getPropertyList() const;


 private:

 // This function is called when the widget is added to a container.
 virtual void initialize(Container *const container);


 public:

 enum WidgetCallbacks
 {
 None = 0, 
 Focused = 1, 
 Unfocused = 2, 
 MouseEntered = 4, 
 MouseLeft = 8, 
 WidgetCallbacksCount = 16
 };


 protected:

 // When a widget is disabled, it will no longer receive events
 bool m_Enabled;

 // Is the widget visible? When it is invisible it will not receive events and it won't be drawn.
 bool m_Visible;

 // This bool will be true from the moment that the load function is completed successfully.
 bool m_Loaded;

 // This will store the different phases that the widget can have
 // e.g. if there isn't a mouse down image then a button should not try to change its image on mouse down
 unsigned char m_WidgetPhase;

 // This will point to our parent widget. If there is no parent then this will be nullptr.
 Container* m_Parent;

 // How transparent is the widget
 unsigned char m_Opacity;

 // Is the mouse on top of the widget? Did the mouse go down on the widget?
 bool m_MouseHover;
 bool m_MouseDown;

 // Are you focused on the widget?
 bool m_Focused;

 // Can the widget be focused?
 bool m_AllowFocus;

 // Keep track of the elapsed time.
 bool m_AnimatedWidget;
 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;

 // This is set to true for widgets that store other widgets inside them
 bool m_ContainerWidget;



 friend class Container;
 };


 class TGUI_API WidgetBorders
 {
 public:

 WidgetBorders();


 virtual ~WidgetBorders();


 virtual void setBorders(unsigned int leftBorder = 0, unsigned int topBorder = 0,
 unsigned int rightBorder = 0, unsigned int bottomBorder = 0) = 0;


 virtual Borders getBorders() const;


 protected:

 unsigned int m_LeftBorder;
 unsigned int m_TopBorder;
 unsigned int m_RightBorder;
 unsigned int m_BottomBorder;

 };

}


#endif // TGUI_WIDGETS_HPP