Tab.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_TAB_HPP
#define TGUI_TAB_HPP


#include <TGUI/Widget.hpp>


namespace tgui
{

 class TGUI_API Tab : public Widget
 {
 public:

 typedef SharedWidgetPtr<Tab> Ptr;


 Tab();


 Tab(const Tab& copy);


 virtual ~Tab();


 Tab& operator= (const Tab& right);


 // Makes a copy of the widget by calling the copy constructor.
 // This function calls new and if you use this function then you are responsible for calling delete.
 virtual Tab* clone();


 bool load(const std::string& configFileFilename, const std::string& sectionName = "Tab");


 const std::string& getLoadedConfigFile() const;


 virtual void setSize(float width, float height);


 virtual sf::Vector2f getSize() const;


 unsigned int add(const sf::String& name, bool select = true);


 void select(const sf::String& name);


 void select(unsigned int index);


 void deselect();


 void remove(const sf::String& name);


 void remove(unsigned int index);


 void removeAll();


 sf::String getSelected() const;


 int getSelectedIndex() const;


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


 const sf::Font* getTextFont() const;


 void setTextColor(const sf::Color& color);


 const sf::Color& getTextColor() const;


 void setSelectedTextColor(const sf::Color& color);


 const sf::Color& getSelectedTextColor() const;


 void setTextSize(unsigned int size);


 unsigned int getTextSize() const;


 void setTabHeight(unsigned int height);


 unsigned int getTabHeight() const;


 void setMaximumTabWidth(unsigned int maximumWidth);


 unsigned int getMaximumTabWidth() const;


 void setDistanceToSide(unsigned int distanceToSide);


 unsigned int getDistanceToSide() const;


 virtual void setTransparency(unsigned char transparency);


 virtual bool mouseOnWidget(float x, float y);

 virtual void leftMousePressed(float x, float y);


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


 protected:

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


 // Draws the widget on the render target.
 virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const;


 public:

 enum TabCallbacks
 {
 TabChanged = WidgetCallbacksCount * 1, 
 AllTabCallbacks = WidgetCallbacksCount * 2 - 1, 
 TabCallbacksCount = WidgetCallbacksCount * 2
 };


 protected:

 std::string m_LoadedConfigFile;

 bool m_SplitImage;
 bool m_SeparateSelectedImage;

 unsigned int m_TabHeight;
 unsigned int m_TextSize;

 sf::Color m_TextColor;
 sf::Color m_SelectedTextColor;

 unsigned int m_MaximumTabWidth;

 // The distance between the side of the tab and the text that is drawn on top of the tab.
 unsigned int m_DistanceToSide;

 int m_SelectedTab;

 std::vector<sf::String> m_TabNames;
 std::vector<float> m_NameWidth;

 Texture m_TextureNormal_L;
 Texture m_TextureNormal_M;
 Texture m_TextureNormal_R;
 Texture m_TextureSelected_L;
 Texture m_TextureSelected_M;
 Texture m_TextureSelected_R;

 sf::Text m_Text;


 };

}



#endif // TGUI_TAB_HPP