TGUI  1.0-alpha
ListBox.hpp
1
2//
3// TGUI - Texus' Graphical User Interface
4// Copyright (C) 2012-2022 Bruno Van de Velde (vdv_b@tgui.eu)
5//
6// This software is provided 'as-is', without any express or implied warranty.
7// In no event will the authors be held liable for any damages arising from the use of this software.
8//
9// Permission is granted to anyone to use this software for any purpose,
10// including commercial applications, and to alter it and redistribute it freely,
11// subject to the following restrictions:
12//
13// 1. The origin of this software must not be misrepresented;
14// you must not claim that you wrote the original software.
15// If you use this software in a product, an acknowledgment
16// in the product documentation would be appreciated but is not required.
17//
18// 2. Altered source versions must be plainly marked as such,
19// and must not be misrepresented as being the original software.
20//
21// 3. This notice may not be removed or altered from any source distribution.
22//
24
25
26#ifndef TGUI_LIST_BOX_HPP
27#define TGUI_LIST_BOX_HPP
28
29
30#include <TGUI/CopiedSharedPtr.hpp>
31#include <TGUI/Widgets/Scrollbar.hpp>
32#include <TGUI/Renderers/ListBoxRenderer.hpp>
33#include <TGUI/Text.hpp>
34
36
37namespace tgui
38{
42 class TGUI_API ListBox : public Widget
43 {
44 public:
45
46 typedef std::shared_ptr<ListBox> Ptr;
47 typedef std::shared_ptr<const ListBox> ConstPtr;
48
49
53 enum class TextAlignment
54 {
55 Left,
56 Center,
57 Right
58 };
59
60
68 ListBox(const char* typeName = "ListBox", bool initRenderer = true);
69
70
78
79
89
90
96 const ListBoxRenderer* getSharedRenderer() const;
97
104
105
112 void setSize(const Layout2d& size) override;
113 using Widget::setSize;
114
115
126 std::size_t addItem(const String& itemName, const String& id = "");
127
128
143 bool setSelectedItem(const String& itemName);
144
145
161
162
176 bool setSelectedItemByIndex(std::size_t index);
177
178
184
185
198 bool removeItem(const String& itemName);
199
200
213 bool removeItemById(const String& id);
214
215
229 bool removeItemByIndex(std::size_t index);
230
231
237
238
249 String getItemById(const String& id) const;
250
251
259 String getItemByIndex(std::size_t index) const;
260
261
271 int getIndexById(const String& id) const;
272
273
281 String getIdByIndex(std::size_t index) const;
282
283
292
293
302
303
311
312
326 bool changeItem(const String& originalValue, const String& newValue);
327
328
342 bool changeItemById(const String& id, const String& newValue);
343
344
356 bool changeItemByIndex(std::size_t index, const String& newValue);
357
358
365 std::size_t getItemCount() const;
366
367
374 std::vector<String> getItems() const;
375
376
385 std::vector<String> getItemIds() const;
386
387
400 void setItemData(std::size_t index, Any data);
401
402
409 template <typename T>
410 T getItemData(std::size_t index) const
411 {
412 if (index < m_items.size())
413 return AnyCast<T>(m_items[index].data);
414 else
415 throw std::bad_cast();
416 }
417
426 void setItemHeight(unsigned int itemHeight);
427
428
435 unsigned int getItemHeight() const;
436
437
447 void setMaximumItems(std::size_t maximumItems = 0);
448
449
457 std::size_t getMaximumItems() const;
458
459
468 void setAutoScroll(bool autoScroll);
469
470
475 bool getAutoScroll() const;
476
477
486
487
494
495
503 bool contains(const String& item) const;
504
505
513 bool containsId(const String& id) const;
514
515
521 void setScrollbarValue(unsigned int value);
522
523
529 unsigned int getScrollbarValue() const;
530
531
538 bool isMouseOnWidget(Vector2f pos) const override;
539
543 void leftMousePressed(Vector2f pos) override;
544
548 void leftMouseReleased(Vector2f pos) override;
549
553 void mouseMoved(Vector2f pos) override;
554
558 bool mouseWheelScrolled(float delta, Vector2f pos) override;
559
563 void mouseNoLongerOnWidget() override;
564
568 void leftMouseButtonNoLongerDown() override;
569
573 void keyPressed(const Event::KeyEvent& event) override;
574
575
583 void draw(BackendRenderTarget& target, RenderStates states) const override;
584
585
587 protected:
588
598 Signal& getSignal(String signalName) override;
599
600
607 void rendererChanged(const String& property) override;
608
609
613 std::unique_ptr<DataIO::Node> save(SavingRenderersMap& renderers) const override;
614
615
619 void load(const std::unique_ptr<DataIO::Node>& node, const LoadingRenderersMap& renderers) override;
620
621
625 void updateTextSize() override;
626
627
629 // Returns the size without the borders
631 Vector2f getInnerSize() const;
632
633
635 // Updates the position of the items and the scrollbar
637 void updateItemPositions();
638
639
641 // Update the colors and text style of the selected and hovered items
643 void updateSelectedAndHoveringItemColorsAndStyle();
644
645
647 // Update the color and text style of all the items
649 void updateItemColorsAndStyle();
650
651
653 // Update on which item the mouse is standing
655 void updateHoveringItem(int item);
656
657
659 // Update which item is selected
661 void updateSelectedItem(int item);
662
663
665 // Checks whether the scrollbar value was changed and emit the onScroll event if it did
667 void triggerOnScroll();
668
669
671 // This function is called every frame with the time passed since the last frame.
673 bool updateTime(Duration elapsedTime) override;
674
675
677 // Makes a copy of the widget
679 Widget::Ptr clone() const override;
680
681
683 public:
684
685 SignalItem onItemSelect = {"ItemSelected"};
686 SignalItem onMousePress = {"MousePressed"};
687 SignalItem onMouseRelease = {"MouseReleased"};
688 SignalItem onDoubleClick = {"DoubleClicked"};
689 SignalUInt onScroll = {"Scrolled"};
690
691
693 protected:
694
695 struct Item
696 {
697 Text text;
698 Any data;
699 String id;
700 };
701
702 std::vector<Item> m_items;
703
704 // What is the index of the selected item?
705 // This is also used by combo box, so it can't just be changed to a pointer!
706 int m_selectedItem = -1;
707
708 int m_hoveringItem = -1;
709
710 unsigned int m_itemHeight = 0;
711
712 // This will store the maximum number of items in the list box (zero by default, meaning that there is no limit)
713 std::size_t m_maxItems = 0;
714
715 // When there are too many items a scrollbar will be shown
717 unsigned int m_lastScrollbarValue = 0;
718
719 // Will be set to true after the first click, but gets reset to false when the second click does not occur soon after
720 bool m_possibleDoubleClick = false;
721
722 bool m_autoScroll = true;
724
725 Sprite m_spriteBackground;
726
727 // Cached renderer properties
728 Borders m_bordersCached;
729 Borders m_paddingCached;
730 Color m_borderColorCached;
731 Color m_backgroundColorCached;
732 Color m_backgroundColorHoverCached;
733 Color m_selectedBackgroundColorCached;
734 Color m_selectedBackgroundColorHoverCached;
735 Color m_textColorCached;
736 Color m_textColorHoverCached;
737 Color m_selectedTextColorCached;
738 Color m_selectedTextColorHoverCached;
739 TextStyles m_textStyleCached;
740 TextStyles m_selectedTextStyleCached;
741
743 };
744
746}
747
749
750#endif // TGUI_LIST_BOX_HPP
Base class for render targets.
Definition: BackendRenderTarget.hpp:48
Wrapper for colors.
Definition: Color.hpp:63
Definition: CopiedSharedPtr.hpp:40
Wrapper for durations.
Definition: Duration.hpp:52
Class to store the position or size of a widget.
Definition: Layout.hpp:284
Definition: ListBoxRenderer.hpp:37
List box widget.
Definition: ListBox.hpp:43
std::vector< String > getItemIds() const
Returns a copy of the item ids in the list box.
bool changeItem(const String &originalValue, const String &newValue)
Changes an item with name originalValue to newValue.
void setItemHeight(unsigned int itemHeight)
Changes the height of the items in the list box.
std::size_t getItemCount() const
Returns the amount of items in the list box.
std::shared_ptr< ListBox > Ptr
Shared widget pointer.
Definition: ListBox.hpp:46
bool changeItemByIndex(std::size_t index, const String &newValue)
Changes the name of an item at the given index to newValue.
bool changeItemById(const String &id, const String &newValue)
Changes the name of an item with the given id to newValue.
unsigned int getScrollbarValue() const
Returns the thumb position of the scrollbar.
unsigned int getItemHeight() const
Returns the height of the items in the list box.
std::vector< String > getItems() const
Returns a copy of the items in the list box.
TextAlignment
The horizontal text alignment.
Definition: ListBox.hpp:54
@ Left
Put the text on the left side (default)
void setItemData(std::size_t index, Any data)
Store some user data with the item.
String getItemById(const String &id) const
Returns the item name of the item with the given id.
void updateTextSize() override
Called when the text size is changed (either by setTextSize or via the renderer)
void deselectItem()
Deselects the selected item.
std::shared_ptr< const ListBox > ConstPtr
Shared constant widget pointer.
Definition: ListBox.hpp:47
void setMaximumItems(std::size_t maximumItems=0)
Changes the maximum items that the list box can contain.
void draw(BackendRenderTarget &target, RenderStates states) const override
Draw the widget to a render target.
static ListBox::Ptr copy(ListBox::ConstPtr listBox)
Makes a copy of another list box.
void setTextAlignment(TextAlignment alignment)
Changes the horizontal text alignment.
String getSelectedItemId() const
Gets the id of the selected item.
static ListBox::Ptr create()
Creates a new list box widget.
bool contains(const String &item) const
Returns whether the list box contains the given item.
void removeAllItems()
Removes all items from the list.
TextAlignment getTextAlignment() const
Gets the current horizontal text alignment.
bool removeItemByIndex(std::size_t index)
Removes the item from the list box.
ListBoxRenderer * getRenderer()
Returns the renderer, which gives access to functions that determine how the widget is displayed.
Signal & getSignal(String signalName) override
Retrieves a signal based on its name.
void load(const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override
Loads the widget from a tree of nodes.
bool removeItemById(const String &id)
Removes the item that were added with the given id.
T getItemData(std::size_t index) const
Returns user data stored in the item.
Definition: ListBox.hpp:410
String getIdByIndex(std::size_t index) const
Returns the id of the item at the given index.
bool setSelectedItemById(const String &id)
Selects an item in the list box.
bool setSelectedItem(const String &itemName)
Selects an item in the list box.
void setScrollbarValue(unsigned int value)
Changes the thumb position of the scrollbar.
Widget::Ptr clone() const override
Makes a copy of the widget if you don't know its exact type.
bool removeItem(const String &itemName)
Removes the item from the list with the given name.
void setSize(const Layout2d &size) override
Changes the size of the list box.
bool containsId(const String &id) const
Returns whether the list box contains an item with the given id.
String getItemByIndex(std::size_t index) const
Returns the item name of the item at the given index.
std::size_t addItem(const String &itemName, const String &id="")
Adds an item to the list.
bool getAutoScroll() const
Returns whether the list box scrolls to the bottom when a new item is added.
bool isMouseOnWidget(Vector2f pos) const override
Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget...
int getSelectedItemIndex() const
Gets the index of the selected item.
void rendererChanged(const String &property) override
Function called when one of the properties of the renderer is changed.
void setAutoScroll(bool autoScroll)
Changes whether the list box scrolls to the bottom when a new item is added.
std::size_t getMaximumItems() const
Returns the maximum items that the list box can contain.
bool setSelectedItemByIndex(std::size_t index)
Selects an item in the list box.
ListBoxRenderer * getSharedRenderer()
Returns the renderer, which gives access to functions that determine how the widget is displayed.
std::unique_ptr< DataIO::Node > save(SavingRenderersMap &renderers) const override
Saves the widget as a tree node in order to save it to a file.
int getIndexById(const String &id) const
Returns the index of the item with the given id.
String getSelectedItem() const
Returns the currently selected item.
Definition: Outline.hpp:39
Signal to which the user can subscribe to get callbacks from.
Definition: Signal.hpp:556
Signal to which the user can subscribe to get callbacks from.
Definition: Signal.hpp:58
Definition: Sprite.hpp:45
Wrapper class to store strings.
Definition: String.hpp:79
Wrapper for text styles.
Definition: TextStyle.hpp:58
Definition: Text.hpp:48
The parent class for every widget.
Definition: Widget.hpp:70
std::shared_ptr< Widget > Ptr
Shared widget pointer.
Definition: Widget.hpp:73
virtual void setSize(const Layout2d &size)
Changes the size of the widget.
Namespace that contains all TGUI functions and classes.
Definition: AbsoluteOrRelativeValue.hpp:36
KeyPressed event parameters.
Definition: Event.hpp:167
Definition: ListBox.hpp:696
States used for drawing.
Definition: RenderStates.hpp:39