ComboBox.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_COMBO_BOX_HPP
#define TGUI_COMBO_BOX_HPP
 
 
#include <TGUI/Widgets/Label.hpp>
#include <TGUI/Widgets/ListBox.hpp>
 
 
namespace tgui
{
 class ComboBoxRenderer;
 
 class TGUI_API ComboBox : public Widget
 {
 public:
 
 typedef std::shared_ptr<ComboBox> Ptr; 
 typedef std::shared_ptr<const ComboBox> ConstPtr; 
 
 
 // Default constructor
 ComboBox();
 
 
 ComboBox(const ComboBox& copy);
 
 
 ComboBox& operator= (const ComboBox& right);
 
 
 static ComboBox::Ptr create();
 
 
 static ComboBox::Ptr copy(ComboBox::ConstPtr comboBox);
 
 
 std::shared_ptr<ComboBoxRenderer> getRenderer() const
 {
 return std::static_pointer_cast<ComboBoxRenderer>(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;
 
 
 void setItemsToDisplay(std::size_t nrOfItemsInListToDisplay);
 
 
 std::size_t getItemsToDisplay() const
 {
 return m_nrOfItemsToDisplay;
 }
 
 
 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
 {
 return m_listBox->getItemById(id);
 }
 
 
 sf::String getSelectedItem() const
 {
 return m_listBox->getSelectedItem();
 }
 
 
 sf::String getSelectedItemId() const
 {
 return m_listBox->getSelectedItemId();
 }
 
 
 int getSelectedItemIndex() const
 {
 return m_listBox->getSelectedItemIndex();
 }
 
 
 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_listBox->getItemCount();
 }
 
 
 std::vector<sf::String> getItems();
 
 
 const std::vector<sf::String>& getItemIds();
 
 
 void setScrollbar(Scrollbar::Ptr scrollbar);
 
 
 Scrollbar::Ptr getScrollbar() const;
 
 
 void setListBox(ListBox::Ptr listBox);
 
 
 ListBox::Ptr getListBox() const;
 
 
 void setMaximumItems(std::size_t maximumItems = 0);
 
 
 std::size_t getMaximumItems() const;
 
 
 void setTextSize(unsigned int textSize);
 
 
 unsigned int getTextSize() const;
 
 
 virtual void setOpacity(float opacity) override;
 
 
 virtual sf::Vector2f getWidgetOffset() const override;
 
 
 virtual void setParent(Container* parent) override;
 
 
 virtual bool mouseOnWidget(float x, float y) const override;
 
 virtual void leftMousePressed(float x, float y) override;
 
 virtual void mouseWheelMoved(int delta, int x, int y) override;
 
 
 protected:
 
 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<ComboBox>(*this);
 }
 
 
 // Shows the list of items.
 void showListBox();
 
 
 // Hides the list of items.
 void hideListBox();
 
 
 // Initialize the internal list box
 void initListBox();
 
 
 // Called by the internal ListBox when a different item is selected.
 void newItemSelectedCallbackFunction();
 
 
 // Called by the internal ListBox when it gets unfocused.
 void listBoxUnfocusedCallbackFunction();
 
 
 // Draws the widget on the render target.
 virtual void draw(sf::RenderTarget& target, sf::RenderStates states) const override;
 
 
 protected:
 
 // The number of items to display. If there is a scrollbar then you can scroll to see the other.
 // If there is no scrollbar then this will be the maximum amount of items.
 std::size_t m_nrOfItemsToDisplay = 0;
 
 // Internally a list box is used to store all items
 ListBox::Ptr m_listBox = std::make_shared<ListBox>();
 
 Label m_text;
 
 friend class ComboBoxRenderer;
 
 };
 
 
 
 class TGUI_API ComboBoxRenderer : public WidgetRenderer, public WidgetBorders, public WidgetPadding
 {
 public:
 
 ComboBoxRenderer(ComboBox* comboBox) : m_comboBox{comboBox} {}
 
 
 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 setArrowBackgroundColor(const Color& color);
 
 
 void setArrowBackgroundColorNormal(const Color& color);
 
 
 void setArrowBackgroundColorHover(const Color& color);
 
 
 void setArrowColor(const Color& color);
 
 
 void setArrowColorNormal(const Color& color);
 
 
 void setArrowColorHover(const Color& color);
 
 
 void setTextColor(const Color& textColor);
 
 
 void setBorderColor(const Color& borderColor);
 
 
 void setBackgroundTexture(const Texture& texture);
 
 
 void setArrowUpTexture(const Texture& texture);
 
 
 void setArrowDownTexture(const Texture& texture);
 
 
 void setArrowUpHoverTexture(const Texture& texture);
 
 
 void setArrowDownHoverTexture(const Texture& texture);
 
 
 virtual void setBorders(const Borders& borders) override;
 using WidgetBorders::setBorders;
 
 
 virtual void setPadding(const Padding& padding) override;
 using WidgetPadding::setPadding;
 
 
 std::shared_ptr<ListBoxRenderer> getListBox() const;
 
 
 // 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:
 
 ComboBox* m_comboBox;
 
 Texture m_backgroundTexture;
 
 Texture m_textureArrowUpNormal;
 Texture m_textureArrowUpHover;
 Texture m_textureArrowDownNormal;
 Texture m_textureArrowDownHover;
 
 sf::Color m_textColor;
 sf::Color m_arrowBackgroundColorNormal;
 sf::Color m_arrowBackgroundColorHover;
 sf::Color m_arrowColorNormal;
 sf::Color m_arrowColorHover;
 
 friend class ComboBox;
 
 };
 
}
 
 
#endif // TGUI_COMBO_BOX_HPP