ListBox.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_LIST_BOX_HPP
#define TGUI_LIST_BOX_HPP


#include <TGUI/Widget.hpp>


namespace tgui
{
 class Scrollbar;


 class TGUI_API ListBox : public Widget, public WidgetBorders
 {
 public:

 typedef SharedWidgetPtr<ListBox> Ptr;


 ListBox();


 ListBox(const ListBox& copy);


 virtual ~ListBox();


 ListBox& operator= (const ListBox& 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 ListBox* clone();


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


 const std::string& getLoadedConfigFile() const;


 void setSize(float width, float height);


 virtual sf::Vector2f getSize() const;


 virtual sf::Vector2f getFullSize() const;


 void changeColors(const sf::Color& backgroundColor = sf::Color::White,
 const sf::Color& textColor = sf::Color::Black,
 const sf::Color& selectedBackgroundColor = sf::Color(50, 100, 200),
 const sf::Color& selectedTextColor = sf::Color::White,
 const sf::Color& borderColor = sf::Color::Black);


 void setBackgroundColor(const sf::Color& backgroundColor);


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


 void setSelectedBackgroundColor(const sf::Color& selectedBackgroundColor);


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


 void setBorderColor(const sf::Color& borderColor);


 const sf::Color& getBackgroundColor() const;


 const sf::Color& getTextColor() const;


 const sf::Color& getSelectedBackgroundColor() const;


 const sf::Color& getSelectedTextColor() const;


 const sf::Color& getBorderColor() const;


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


 const sf::Font* getTextFont() const;


 int addItem(const sf::String& itemName, int id = 0);


 bool setSelectedItem(const sf::String& itemName);


 bool setSelectedItem(int index);


 void deselectItem();


 bool removeItem(unsigned int index);


 bool removeItem(const sf::String& itemName);


 unsigned int removeItemsById(int id);


 void removeAllItems();


 sf::String getItem(unsigned int index) const;


 int getItemIndex(const sf::String& itemName) const;


 std::vector<sf::String>& getItems();


 sf::String getSelectedItem() const;


 int getSelectedItemIndex() const;


 int getSelectedItemId() const;


 bool changeItem(unsigned int index, const sf::String& newValue);


 unsigned int changeItems(const sf::String& originalValue, const sf::String& newValue);


 unsigned int changeItemsById(int id, const sf::String& newValue);


 bool setScrollbar(const std::string& scrollbarConfigFileFilename);


 void removeScrollbar();


 void setItemHeight(unsigned int itemHeight);


 unsigned int getItemHeight() const;


 void setMaximumItems(unsigned int maximumItems = 0);


 unsigned int getMaximumItems() const;


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


 virtual void setTransparency(unsigned char transparency);


 virtual bool mouseOnWidget(float x, float y);

 virtual void leftMousePressed(float x, float y);

 virtual void leftMouseReleased(float x, float y);

 virtual void mouseMoved(float x, float y);

 virtual void mouseWheelMoved(int delta, int x, int y);

 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;


 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 ListBoxCallbacks
 {
 ItemSelected = WidgetCallbacksCount * 1, 
 AllListBoxCallbacks = WidgetCallbacksCount * 2 - 1, 
 ListBoxCallbacksCount = WidgetCallbacksCount * 2
 };


 protected:

 std::string m_LoadedConfigFile;

 // This contains the different items in the list box
 std::vector<sf::String> m_Items;
 std::vector<int> m_ItemIds;

 // What is the index of the selected item?
 int m_SelectedItem;

 // The size must be stored
 sf::Vector2u m_Size;
 unsigned int m_ItemHeight;
 unsigned int m_TextSize;

 // This will store the maximum number of items in the list box (zero by default, meaning that there is no limit)
 unsigned int m_MaxItems;

 // When there are too many items a scrollbar will be shown
 Scrollbar* m_Scroll;

 // These colors are used to draw the list box
 sf::Color m_BackgroundColor;
 sf::Color m_TextColor;
 sf::Color m_SelectedBackgroundColor;
 sf::Color m_SelectedTextColor;
 sf::Color m_BorderColor;

 // The font used to draw the text
 const sf::Font* m_TextFont;

 // ComboBox contains a list box internally and it should be able to adjust it.
 friend class ComboBox;

 };

}


#endif // TGUI_LIST_BOX_HPP