PanelListBox.hpp

 
//
// TGUI - Texus' Graphical User Interface
// Copyright (C) 2012-2024 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_PANEL_LIST_BOX_HPP
#define TGUI_PANEL_LIST_BOX_HPP
 
#include <TGUI/Widgets/ScrollablePanel.hpp>
#include <TGUI/Renderers/PanelListBoxRenderer.hpp>
 
 
TGUI_MODULE_EXPORT namespace tgui
{
 
 class TGUI_API PanelListBox : public ScrollablePanel
 {
 public:
 using Ptr = std::shared_ptr<PanelListBox>; 
 using ConstPtr = std::shared_ptr<const PanelListBox>; 
 
 static constexpr const char StaticWidgetType[] = "PanelListBox"; 
 
 
 PanelListBox(const char* typeName = StaticWidgetType, bool initRenderer = true);
 
 
 static Ptr create();
 
 
 static Ptr copy(const ConstPtr& panelListBox);
 
 
 TGUI_NODISCARD PanelListBoxRenderer* getSharedRenderer() override;
 TGUI_NODISCARD const PanelListBoxRenderer* getSharedRenderer() const override;
 
 
 TGUI_NODISCARD PanelListBoxRenderer* getRenderer() override;
 
 
 void setSize(const Layout2d& size) override;
 using ScrollablePanel::setSize;
 
 
 Panel::Ptr addItem(const String& id = {}, int index = -1);
 
 
 TGUI_NODISCARD Panel::Ptr getPanelTemplate();
 
 
 TGUI_NODISCARD Layout getItemsWidth() const;
 
 
 void setItemsHeight(const Layout& height);
 
 
 TGUI_NODISCARD Layout getItemsHeight() const;
 
 
 bool setSelectedItem(const Panel::Ptr& panelPtr);
 
 
 bool setSelectedItemById(const String& id);
 
 
 bool setSelectedItemByIndex(std::size_t index);
 
 
 void deselectItem();
 
 
 bool removeItem(const Panel::Ptr& panelPtr);
 
 
 bool removeItemById(const String& id);
 
 
 bool removeItemByIndex(std::size_t index);
 
 
 void removeAllItems();
 
 
 TGUI_NODISCARD Panel::Ptr getItemById(const String& id) const;
 
 
 TGUI_NODISCARD Panel::Ptr getItemByIndex(std::size_t index) const;
 
 
 int getIndexById(const String& id) const;
 
 
 int getIndexByItem(const Panel::Ptr& panelPtr) const;
 
 
 String getIdByIndex(std::size_t index) const;
 
 
 Panel::Ptr getSelectedItem() const;
 
 
 String getSelectedItemId() const;
 
 
 int getSelectedItemIndex() const;
 
 
 TGUI_NODISCARD std::size_t getItemCount() const;
 
 
 TGUI_NODISCARD std::vector<Panel::Ptr> getItems() const;
 
 
 TGUI_NODISCARD std::vector<String> getItemIds() const;
 
 
 void setMaximumItems(std::size_t maximumItems = 0);
 
 
 TGUI_NODISCARD std::size_t getMaximumItems() const;
 
 
 bool contains(const Panel::Ptr& panelPtr) const;
 
 
 bool containsId(const String& id) const;
 
 
 void mouseMoved(Vector2f pos) override;
 
 
 void mouseNoLongerOnWidget() override;
 
 
 bool leftMousePressed(Vector2f pos) override;
 
 
 protected:
 
 TGUI_NODISCARD Signal& getSignal(String signalName) override;
 
 
 void rendererChanged(const String& property) override;
 
 
 TGUI_NODISCARD std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;
 
 
 void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
 
 
 // Updates the position of the items
 void updateItemsPositions() const;
 
 
 // Updates the size of the items
 void updateItemsSize() const;
 
 
 // Returns all items height
 TGUI_NODISCARD float getAllItemsHeight() const;
 
 
 // Returns height of the items
 //
 TGUI_NODISCARD float getItemsHeightUpToIndex(std::size_t index) const;
 
 
 // Update which item is selected
 void updateSelectedItem(int item);
 
 
 // Update on which item the mouse is standing
 void updateHoveringItem(int item);
 
 
 // Update the colors and style of the selected and hovered items
 void updateSelectedAndHoveringItemColorsAndStyle() const;
 
 
 // Clear item style
 //
 void clearItemStyle(int item) const;
 
 
 // Clear all items style
 void clearAllItemsStyle() const;
 
 
 // Makes a copy of the widget
 TGUI_NODISCARD Widget::Ptr clone() const override;
 
 
 public:
 
 SignalPanelListBoxItem onItemSelect = {"ItemSelected"}; 
 
 
 protected:
 struct Item
 {
 Panel::Ptr panel;
 String id;
 };
 
 std::vector<Item> m_items;
 std::size_t m_maxItems;
 Panel::Ptr m_panelTemplate;
 
 int m_selectedItem;
 int m_hoveringItem;
 
 // Cached renderer properties
 Color m_itemsBackgroundColorCached;
 Color m_itemsBackgroundColorHoverCached;
 Color m_selectedItemsBackgroundColorCached;
 Color m_selectedItemsBackgroundColorHoverCached;
 
 };
 
}
 
 
#endif // TGUI_PANEL_LIST_BOX_HPP