ListBox.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_LIST_BOX_HPP
#define TGUI_LIST_BOX_HPP
 
 
#include <TGUI/Widgets/Scrollbar.hpp>
 
 
namespace tgui
{
 class Label;
 class ListBoxRenderer;
 
 class TGUI_API ListBox : public Widget
 {
 public:
 
 typedef std::shared_ptr<ListBox> Ptr; 
 typedef std::shared_ptr<const ListBox> ConstPtr; 
 
 
 // Default constructor
 ListBox();
 
 
 ListBox(const ListBox& copy);
 
 
 ListBox& operator= (const ListBox& right);
 
 
 static ListBox::Ptr create();
 
 
 static ListBox::Ptr copy(ListBox::ConstPtr listBox);
 
 
 std::shared_ptr<ListBoxRenderer> getRenderer() const
 {
 return std::static_pointer_cast<ListBoxRenderer>(m_renderer);
 }
 
 
 virtual void setPosition(const Layout2d& position) override;
 using Transformable::setPosition;
 
 
 void setSize(const Layout2d& size) override;
 using Transformable::setSize;
 
 
 virtual sf::Vector2f getFullSize() const override;
 
 
 virtual void setFont(const Font& font) override;
 
 
 bool addItem(const sf::String& itemName, const sf::String& id = "");
 
 
 bool setSelectedItem(const sf::String& itemName);
 
 
 bool setSelectedItemById(const sf::String& id);
 
 
 bool setSelectedItemByIndex(std::size_t index);
 
 
 void deselectItem();
 
 
 bool removeItem(const sf::String& itemName);
 
 
 bool removeItemById(const sf::String& id);
 
 
 bool removeItemByIndex(std::size_t index);
 
 
 void removeAllItems();
 
 
 sf::String getItemById(const sf::String& id) const;
 
 
 sf::String getSelectedItem() const;
 
 
 sf::String getSelectedItemId() const;
 
 
 int getSelectedItemIndex() const;
 
 
 bool changeItem(const sf::String& originalValue, const sf::String& newValue);
 
 
 bool changeItemById(const sf::String& id, const sf::String& newValue);
 
 
 bool changeItemByIndex(std::size_t index, const sf::String& newValue);
 
 
 std::size_t getItemCount()
 {
 return m_items.size();
 }
 
 
 std::vector<sf::String> getItems();
 
 
 const std::vector<sf::String>& getItemIds();
 
 
 void setScrollbar(Scrollbar::Ptr scrollbar);
 
 
 Scrollbar::Ptr getScrollbar() const;
 
 
 void setItemHeight(unsigned int itemHeight);
 
 
 unsigned int getItemHeight() const;
 
 
 void setTextSize(unsigned int textSize);
 
 
 unsigned int getTextSize() const;
 
 
 void setMaximumItems(std::size_t maximumItems = 0);
 
 
 std::size_t getMaximumItems() const
 {
 return m_maxItems;
 }
 
 
 void setAutoScroll(bool autoScroll);
 
 
 bool getAutoScroll() const
 {
 return m_autoScroll;
 }
 
 
 virtual void setOpacity(float opacity) override;
 
 
 virtual sf::Vector2f getWidgetOffset() const override;
 
 
 virtual bool mouseOnWidget(float x, float y) const override;
 
 virtual void leftMousePressed(float x, float y) override;
 
 virtual void leftMouseReleased(float x, float y) override;
 
 virtual void mouseMoved(float x, float y) override;
 
 virtual void mouseWheelMoved(int delta, int x, int y) override;
 
 virtual void mouseNoLongerOnWidget() override;
 
 virtual void mouseNoLongerDown() override;
 
 
 protected:
 
 // Update the color of the items
 void updateItemColors();
 
 
 virtual void reload(const std::string& primary = "", const std::string& secondary = "", bool force = false) override;
 
 
 // Makes a copy of the widget
 virtual Widget::Ptr clone() const override
 {
 return std::make_shared<ListBox>(*this);
 }
 
 
 // This function is called every frame with the time passed since the last frame.
 virtual void update(sf::Time elapsedTime) override;
 
 
 // Draws the widget on the render target.
 virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
 
 
 protected:
 
 // This contains the different items in the list box
 std::vector<Label> m_items;
 std::vector<sf::String> m_itemIds;
 
 // What is the index of the selected item?
 // This is also used by combo box, so it can't just be changed to a pointer!
 int m_selectedItem = -1;
 
 int m_hoveringItem = -1;
 
 // The size must be stored
 unsigned int m_itemHeight = 22;
 unsigned int m_requestedTextSize = 0;
 unsigned int m_textSize = 18;
 
 // This will store the maximum number of items in the list box (zero by default, meaning that there is no limit)
 std::size_t m_maxItems = 0;
 
 // When there are too many items a scrollbar will be shown
 Scrollbar::Ptr m_scroll = std::make_shared<Scrollbar>();
 
 // Will be set to true after the first click, but gets reset to false when the second click does not occur soon after
 bool m_possibleDoubleClick = false;
 
 bool m_autoScroll = true;
 
 // ComboBox contains a list box internally and it should be able to adjust it.
 friend class ComboBox;
 friend class ListBoxRenderer;
 
 };
 
 
 
 class TGUI_API ListBoxRenderer : public WidgetRenderer, public WidgetBorders, public WidgetPadding
 {
 public:
 
 ListBoxRenderer(ListBox* listBox) : m_listBox{listBox} {}
 
 
 virtual void setProperty(std::string property, const std::string& value) override;
 
 
 virtual void setProperty(std::string property, ObjectConverter&& value) override;
 
 
 virtual ObjectConverter getProperty(std::string property) const override;
 
 
 virtual std::map<std::string, ObjectConverter> getPropertyValuePairs() const override;
 
 
 void setBackgroundColor(const Color& backgroundColor);
 
 
 void setTextColor(const Color& textColor);
 
 
 void setTextColorNormal(const Color& color);
 
 
 void setTextColorHover(const Color& color);
 
 
 void setHoverBackgroundColor(const Color& hoverBackgroundColor);
 
 
 void setSelectedBackgroundColor(const Color& selectedBackgroundColor);
 
 
 void setSelectedTextColor(const Color& selectedTextColor);
 
 
 void setBorderColor(const Color& borderColor);
 
 
 void setBackgroundTexture(const Texture& texture);
 
 
 virtual void setPadding(const Padding& padding) override;
 using WidgetPadding::setPadding;
 
 
 // Draws the widget on the render target.
 void draw(sf::RenderTarget& target, sf::RenderStates states) const;
 
 
 private:
 
 // Returns the padding, which is possibly scaled with the background image.
 Padding getScaledPadding() const;
 
 
 // Makes a copy of the renderer
 virtual std::shared_ptr<WidgetRenderer> clone(Widget* widget) override;
 
 
 protected:
 
 ListBox* m_listBox;
 
 Texture m_backgroundTexture;
 
 sf::Color m_backgroundColor;
 sf::Color m_textColor;
 sf::Color m_hoverBackgroundColor;
 sf::Color m_hoverTextColor;
 sf::Color m_selectedBackgroundColor;
 sf::Color m_selectedTextColor;
 sf::Color m_borderColor;
 
 friend class ListBox;
 friend class ComboBox;
 friend class ComboBoxRenderer;
 
 };
 
}
 
 
#endif // TGUI_LIST_BOX_HPP