ListBox.hpp

//
// TGUI - Texus's Graphical User Interface
// Copyright (C) 2012 Bruno Van de Velde (VDV_B@hotmail.com)
//
// 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_LISTBOX_INCLUDED_
#define _TGUI_LISTBOX_INCLUDED_



namespace tgui
{

 struct TGUI_API ListBox : public OBJECT, OBJECT_BORDERS
 {
 ListBox();


 ListBox(const ListBox& copy);


 virtual ~ListBox();


 ListBox& operator= (const ListBox& right);


 virtual void initialize();


 virtual ListBox* clone();


 virtual bool load(unsigned int width,
 unsigned int height,
 const std::string& scrollbarPathname = "",
 unsigned int itemHeight = 0);


 virtual void setSize(float width, float height);


 virtual Vector2u getSize() const;


 virtual Vector2f getScaledSize() const;


 virtual std::string getLoadedScrollbarPathname() const;


 virtual 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);

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

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

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

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

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


 virtual const sf::Color& getBackgroundColor() const;

 virtual const sf::Color& getTextColor() const;

 virtual const sf::Color& getSelectedBackgroundColor() const;

 virtual const sf::Color& getSelectedTextColor() const;

 virtual const sf::Color& getBorderColor() const;


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


 virtual const sf::Font* getTextFont() const;


 virtual unsigned int addItem(const sf::String& itemName);


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

 virtual bool setSelectedItem(unsigned int id);


 virtual void removeItem(unsigned int id);


 virtual void removeItem(const sf::String& itemName);


 virtual void removeAllItems();


 virtual sf::String getItem(unsigned int id) const;


 virtual unsigned int getItemID(const sf::String& itemName) const;


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


 virtual sf::String getSelectedItem() const;


 virtual unsigned int getSelectedItemID() const;


 virtual bool setScrollbar(const std::string& scrollbarPathname);


 virtual void removeScrollbar();


 virtual void setItemHeight(unsigned int itemHeight);

 virtual unsigned int getItemHeight() const;


 virtual void setMaximumItems(unsigned int maximumItems = 0);

 virtual unsigned int getMaximumItems() const;


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


 // These functions are used to receive callback from the EventManager.
 // You normally don't need them, but you can use them to simulate an event.
 virtual bool mouseOnObject(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);
 virtual void mouseNotOnObject();
 virtual void mouseNoLongerDown();


 protected:

 // Because this struct is derived from sf::Drawable, you can just call the draw function from your sf::RenderTarget.
 // This function will be called and it will draw the list box on the render target.
 virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const;


 protected:

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

 // What is the id of the selected item?
 unsigned int m_SelectedItem;

 // The size must be stored
 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;

 // The pathname of the loaded scrollbar (if there is one)
 std::string m_LoadedScrollbarPathname;

 // 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
 sf::Font m_TextFont;

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

 };

}


#endif //_TGUI_LISTBOX_INCLUDED_