TGUI
0.8.9
|
List view widget. More...
#include <TGUI/Widgets/ListView.hpp>
Classes | |
struct | Column |
struct | Item |
Public Types | |
enum class | ColumnAlignment { Left , Center , Right } |
The text alignment for all texts within a column. More... | |
typedef std::shared_ptr< ListView > | Ptr |
Shared widget pointer. | |
typedef std::shared_ptr< const ListView > | ConstPtr |
Shared constant widget pointer. | |
![]() | |
typedef std::shared_ptr< Widget > | Ptr |
Shared widget pointer. | |
typedef std::shared_ptr< const Widget > | ConstPtr |
Shared constant widget pointer. | |
Public Member Functions | |
ListViewRenderer * | getSharedRenderer () |
Returns the renderer, which gives access to functions that determine how the widget is displayed. More... | |
ListViewRenderer * | getRenderer () |
Returns the renderer, which gives access to functions that determine how the widget is displayed. More... | |
void | setSize (const Layout2d &size) override |
Changes the size of the list view. More... | |
std::size_t | addColumn (const sf::String &text, float width=0, ColumnAlignment alignment=ColumnAlignment::Left) |
Adds a column. More... | |
void | setColumnText (std::size_t index, const sf::String &text) |
Changes the text of a column. More... | |
sf::String | getColumnText (std::size_t index) const |
Returns the text of a column. More... | |
void | setColumnWidth (std::size_t index, float width) |
Changes the width of a column. More... | |
float | getColumnWidth (std::size_t index) const |
Returns the width of a column. More... | |
void | setColumnAlignment (std::size_t columnIndex, ColumnAlignment alignment) |
Changes the text alignment within a column. More... | |
ColumnAlignment | getColumnAlignment (std::size_t columnIndex) const |
Returns the current text alignment within a column. More... | |
void | removeAllColumns () |
Removes all columns. | |
std::size_t | getColumnCount () const |
Returns the amount of columns in the list view. More... | |
void | setHeaderHeight (float height) |
Changes the height of the header row. More... | |
float | getHeaderHeight () const |
Returns the height of the header row. More... | |
float | getCurrentHeaderHeight () const |
Returns the height of the header or 0 if no header row is shown. More... | |
void | setHeaderVisible (bool showHeader) |
Changes whether the header is shown. More... | |
bool | getHeaderVisible () const |
Returns whether the header is shown. More... | |
std::size_t | addItem (const sf::String &text) |
Adds an item to the list. More... | |
std::size_t | addItem (const std::vector< sf::String > &item) |
Adds an item with values for multiple columns to the list. More... | |
void | addMultipleItems (const std::vector< std::vector< sf::String > > &items) |
Adds multiple items to the list. More... | |
bool | changeItem (std::size_t index, const std::vector< sf::String > &item) |
Changes an item with values for multiple columns to the list. More... | |
bool | changeSubItem (std::size_t index, std::size_t column, const sf::String &item) |
Changes the caption of a single value in the item. More... | |
bool | removeItem (std::size_t index) |
Removes the item from the list view. More... | |
void | removeAllItems () |
Removes all items from the list. | |
void | setSelectedItem (std::size_t index) |
Selects an item in the list view. More... | |
void | setSelectedItems (const std::set< std::size_t > &indices) |
Selects items in the list view. More... | |
void | deselectItem () |
Deselects the selected item or all of them. | |
void | deselectItems () |
Deselects the selected items. | |
int | getSelectedItemIndex () const |
Gets the index of the selected item. More... | |
std::set< std::size_t > | getSelectedItemIndices () const |
Gets the indices of the selected items. More... | |
void | setMultiSelect (bool multiSelect) |
Allow multi selection of the items. More... | |
bool | getMultiSelect () const |
Returns multi selection of the items is allowed. More... | |
void | setItemIcon (std::size_t index, const Texture &texture) |
Sets a small icon in front of the item. More... | |
Texture | getItemIcon (std::size_t index) const |
Gets the icon displayed in front of the item. More... | |
std::size_t | getItemCount () const |
Returns the amount of items in the list view. More... | |
sf::String | getItem (std::size_t index) const |
Retrieves an item in the list. More... | |
std::vector< sf::String > | getItemRow (std::size_t index) const |
Retrieves the values of all columns for an item in the list. More... | |
sf::String | getItemCell (std::size_t rowIndex, std::size_t columnIndex) const |
Retrieves the value for a cell in the list. More... | |
std::vector< sf::String > | getItems () const |
Returns a list of the texts in the first column for all items in the list view. More... | |
std::vector< std::vector< sf::String > > | getItemRows () const |
Returns a list of all column values for all items in the list view. More... | |
void | sort (std::size_t index, const std::function< bool(const sf::String &, const sf::String &)> &cmp) |
Sort items. More... | |
void | setItemHeight (unsigned int itemHeight) |
Changes the height of the items in the list view. More... | |
unsigned int | getItemHeight () const |
Returns the height of the items in the list view. More... | |
void | setTextSize (unsigned int textSize) override |
Changes the text size of the items. More... | |
void | setHeaderTextSize (unsigned int textSize) |
Changes the text size of the header caption. More... | |
unsigned int | getHeaderTextSize () const |
Returns the text size of the header caption. More... | |
void | setSeparatorWidth (unsigned int width) |
Changes the width of the column separator. More... | |
unsigned int | getSeparatorWidth () const |
Returns the width of the column separator. More... | |
void | setHeaderSeparatorHeight (unsigned int height) |
Changes the height of the separator between the header and the items. More... | |
unsigned int | getHeaderSeparatorHeight () const |
Returns the height of the separator between the header and the items. More... | |
void | setGridLinesWidth (unsigned int width) |
Changes the width of the grid lines. More... | |
unsigned int | getGridLinesWidth () const |
Returns the width of the grid lines. More... | |
void | setAutoScroll (bool autoScroll) |
Changes whether the list view scrolls to the bottom when a new item is added. More... | |
bool | getAutoScroll () const |
Returns whether the list view scrolls to the bottom when a new item is added. More... | |
void | setShowVerticalGridLines (bool showGridLines) |
Changes whether lines are drawn between columns. More... | |
bool | getShowVerticalGridLines () const |
Returns whether lines are drawn between items. More... | |
void | setShowHorizontalGridLines (bool showGridLines) |
Changes whether lines are drawn between items. More... | |
bool | getShowHorizontalGridLines () const |
Returns whether lines are drawn between items. More... | |
void | setExpandLastColumn (bool expand) |
Changes whether the last column is expanded to fill the list view (if all columns fit inside the list view) More... | |
bool | getExpandLastColumn () const |
Returns whether the last column is expanded to fill the list view (if all columns fit inside the list view) More... | |
void | setVerticalScrollbarPolicy (Scrollbar::Policy policy) |
Changes when the vertical scrollbar should be displayed. More... | |
Scrollbar::Policy | getVerticalScrollbarPolicy () const |
Returns when the vertical scrollbar should be displayed. More... | |
void | setHorizontalScrollbarPolicy (Scrollbar::Policy policy) |
Changes when the horizontal scrollbar should be displayed. More... | |
Scrollbar::Policy | getHorizontalScrollbarPolicy () const |
Returns when the horizontal scrollbar should be displayed. More... | |
void | setVerticalScrollbarValue (unsigned int value) |
Changes the thumb position of the vertical scrollbar. More... | |
unsigned int | getVerticalScrollbarValue () const |
Returns the thumb position of the vertical scrollbar. More... | |
void | setHorizontalScrollbarValue (unsigned int value) |
Changes the thumb position of the horizontal scrollbar. More... | |
unsigned int | getHorizontalScrollbarValue () const |
Returns the thumb position of the horizontal scrollbar. More... | |
bool | mouseOnWidget (Vector2f pos) const override |
Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More... | |
void | draw (sf::RenderTarget &target, sf::RenderStates states) const override |
Draw the widget to a render target. More... | |
virtual void | setSize (const Layout2d &size) |
Changes the size of the widget. More... | |
void | setSize (Layout width, Layout height) |
Changes the size of the widget. More... | |
![]() | |
Widget () | |
Default constructor. | |
Widget (const Widget &) | |
Copy constructor. | |
Widget (Widget &&) | |
Move constructor. | |
~Widget () | |
Destructor. | |
Widget & | operator= (const Widget &) |
Overload of copy assignment operator. | |
Widget & | operator= (Widget &&) |
Move assignment. | |
void | setRenderer (std::shared_ptr< RendererData > rendererData) |
Sets a new renderer for the widget. The renderer determines how the widget looks. More... | |
WidgetRenderer * | getSharedRenderer () |
Returns the renderer, which gives access to functions that determine how the widget is displayed. More... | |
WidgetRenderer * | getRenderer () |
Returns the renderer, which gives access to functions that determine how the widget is displayed. More... | |
virtual void | setPosition (const Layout2d &position) |
sets the position of the widget More... | |
void | setPosition (Layout x, Layout y) |
Sets the position of the widget. More... | |
Vector2f | getPosition () const |
Gets the position of the widget. More... | |
void | setSize (Layout width, Layout height) |
Changes the size of the widget. More... | |
Vector2f | getSize () const |
Returns the size of the widget. More... | |
virtual Vector2f | getFullSize () const |
Returns the entire size that the widget is using. More... | |
virtual Vector2f | getAbsolutePosition () const |
Get the absolute position of the widget instead of the relative position to its parent. More... | |
virtual Vector2f | getWidgetOffset () const |
Returns the distance between the position where the widget is drawn and where the widget is placed. More... | |
virtual void | showWithEffect (ShowAnimationType type, sf::Time duration) |
Shows the widget by introducing it with an animation. More... | |
virtual void | hideWithEffect (ShowAnimationType type, sf::Time duration) |
Hides the widget by making it leave with an animation. More... | |
virtual void | setVisible (bool visible) |
Shows or hides a widget. More... | |
bool | isVisible () const |
Returns true when the widget is visible. More... | |
virtual void | setEnabled (bool enabled) |
Enables or disables the widget. More... | |
bool | isEnabled () const |
Returns true when the widget is enabled. More... | |
virtual void | setFocused (bool focused) |
Focus or unfocus the widget. More... | |
bool | isFocused () const |
Returns true when the widget is focused and false otherwise. More... | |
const std::string & | getWidgetType () const |
Returns the type of the widget. More... | |
Container * | getParent () const |
Returns a pointer to the parent widget. More... | |
bool | isAnimationPlaying () const |
Returns whether there is an active animation (started with showWithEffect or hideWithEffect) More... | |
virtual void | moveToFront () |
Places the widget before all other widgets. More... | |
virtual void | moveToBack () |
Places the widget behind all other widgets. More... | |
void | setUserData (std::any userData) |
Stores some data into the widget. More... | |
template<typename T > | |
T | getUserData () const |
Returns data stored in the widget. More... | |
void | setInheritedFont (const Font &font) |
Sets the font of the widget that is used when no font is set in the renderer. More... | |
const Font & | getInheritedFont () const |
Returns the font of the widget that is used when no font is set in the renderer. More... | |
void | setInheritedOpacity (float opacity) |
Sets the opacity of the widget that will be multiplied with the opacity set in the renderer. More... | |
float | getInheritedOpacity () const |
Returns the opacity of the widget that is multiplied with the opacity set in the renderer. More... | |
virtual unsigned int | getTextSize () const |
Returns the character size of text in this widget. More... | |
void | setToolTip (Widget::Ptr toolTip) |
Sets the tool tip that should be displayed when hovering over the widget. More... | |
Widget::Ptr | getToolTip () const |
Returns the tool tip that is displayed when hovering over the widget. More... | |
void | setWidgetName (const sf::String &name) |
Changes the name of a widget. More... | |
sf::String | getWidgetName () const |
Returns the name of a widget. More... | |
void | setFocusable (bool focusable) |
Changes whether a widget could be focused. More... | |
bool | isFocusable () const |
Returns whether a widget could be focused. More... | |
virtual bool | canGainFocus () const |
Returns whether the widget can currently gain focus. More... | |
bool | isContainer () const |
Returns whether the widget is a container widget or not. More... | |
template<typename WidgetType > | |
std::shared_ptr< const WidgetType > | cast () const |
Downcast const widget. | |
template<typename WidgetType > | |
std::shared_ptr< WidgetType > | cast () |
Downcast widget. | |
![]() | |
template<typename Func , typename... Args, typename std::enable_if< std::is_convertible< Func, std::function< void(const Args &...)> >::value >::type * = nullptr> | |
unsigned int | connect (std::string signalName, Func &&handler, const Args &... args) |
Connects a signal handler that will be called when this signal is emitted. More... | |
template<typename Func , typename... BoundArgs, typename std::enable_if<!std::is_convertible< Func, std::function< void(const BoundArgs &...)> >::value &&std::is_convertible< Func, std::function< void(const BoundArgs &..., std::shared_ptr< Widget >, const std::string &)> >::value , ::type * = nullptr> | |
unsigned int | connect (std::string signalName, Func &&handler, BoundArgs &&... args) |
Connects a signal handler that will be called when this signal is emitted. More... | |
template<typename Func , typename... BoundArgs, typename std::enable_if<!std::is_convertible< Func, std::function< void(const BoundArgs &...)> >::value &&!std::is_convertible< Func, std::function< void(const BoundArgs &..., std::shared_ptr< Widget >, const std::string &)> >::value , ::type * = nullptr> | |
unsigned int | connect (std::string signalName, Func &&handler, BoundArgs &&... args) |
Connects a signal handler that will be called when this signal is emitted. More... | |
template<typename Func , typename... BoundArgs> | |
unsigned int | connect (std::initializer_list< std::string > signalNames, Func &&handler, BoundArgs &&... args) |
Connect a signal handler to multiple signals. More... | |
bool | disconnect (unsigned int id) |
Disconnects a signal handler. More... | |
void | disconnectAll (std::string signalName) |
Disconnects all signal handler from a certain signal. More... | |
void | disconnectAll () |
Disconnects all signal handlers from signals. | |
Static Public Member Functions | |
static ListView::Ptr | create () |
Creates a new list view widget. More... | |
static ListView::Ptr | copy (ListView::ConstPtr listView) |
Makes a copy of another list view. More... | |
Public Attributes | |
SignalInt | onItemSelect = {"ItemSelected"} |
An item was selected in the list view (only used when MultiSelect is false). Optional parameter: selected item index (-1 when deselecting) | |
SignalInt | onDoubleClick = {"DoubleClicked"} |
An item was double clicked. Optional parameter: selected item index. | |
SignalInt | onRightClick = {"RightClicked"} |
Right mouse clicked. Optional parameter: index of item below mouse (-1 when not on top of item) | |
SignalInt | onHeaderClick = {"HeaderClicked"} |
The header was clicked. Optional parameter: column index. | |
![]() | |
SignalVector2f | onPositionChange = {"PositionChanged"} |
The position of the widget changed. Optional parameter: new position. | |
SignalVector2f | onSizeChange = {"SizeChanged"} |
The size of the widget changed. Optional parameter: new size. | |
Signal | onFocus = {"Focused"} |
The widget was focused. | |
Signal | onUnfocus = {"Unfocused"} |
The widget was unfocused. | |
Signal | onMouseEnter = {"MouseEntered"} |
The mouse entered the widget. | |
Signal | onMouseLeave = {"MouseLeft"} |
The mouse left the widget. | |
SignalAnimation | onAnimationFinished = {"AnimationFinished"} |
A show or hide animation finished. Optional parameters: animation type, new widget visibility or both. | |
Protected Member Functions | |
Signal & | getSignal (std::string signalName) override |
Retrieves a signal based on its name. More... | |
void | rendererChanged (const std::string &property) override |
Function called when one of the properties of the renderer is changed. More... | |
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. | |
void | load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override |
Loads the widget from a tree of nodes. | |
Widget::Ptr | clone () const override |
Makes a copy of the widget if you don't know its exact type. More... | |
![]() | |
virtual void | mouseEnteredWidget () |
This function is called when the mouse enters the widget. | |
virtual void | mouseLeftWidget () |
This function is called when the mouse leaves the widget. | |
List view widget.
When no columns are added, the list view acts like a ListBox with a few extra functionalities.
|
strong |
std::size_t tgui::ListView::addColumn | ( | const sf::String & | text, |
float | width = 0 , |
||
ColumnAlignment | alignment = ColumnAlignment::Left |
||
) |
Adds a column.
text | The caption of the new column |
width | Width of the column. Set width to 0 to make it depend on the width of the column caption. |
alignment | The text alignment for all texts in the column |
std::size_t tgui::ListView::addItem | ( | const sf::String & | text | ) |
Adds an item to the list.
text | The caption of the item you want to add |
std::size_t tgui::ListView::addItem | ( | const std::vector< sf::String > & | item | ) |
Adds an item with values for multiple columns to the list.
item | Texts for each column |
void tgui::ListView::addMultipleItems | ( | const std::vector< std::vector< sf::String > > & | items | ) |
Adds multiple items to the list.
items | List of items that should be passed to the addItem |
bool tgui::ListView::changeItem | ( | std::size_t | index, |
const std::vector< sf::String > & | item | ||
) |
Changes an item with values for multiple columns to the list.
index | Index of the item to update |
item | Texts for each column |
bool tgui::ListView::changeSubItem | ( | std::size_t | index, |
std::size_t | column, | ||
const sf::String & | item | ||
) |
Changes the caption of a single value in the item.
index | Index of the item to update |
column | Index of the column to change |
item | Texts for the given column for the given item |
|
inlineoverrideprotectedvirtual |
Makes a copy of the widget if you don't know its exact type.
This function should only be used when you don't know the type of the widget. If you know what kind of widget you are copying, you should use the copy function.
Implements tgui::Widget.
|
static |
Makes a copy of another list view.
listView | The other list view |
|
static |
Creates a new list view widget.
|
overridevirtual |
Draw the widget to a render target.
target | Render target to draw to |
states | Current render states |
Implements tgui::Widget.
bool tgui::ListView::getAutoScroll | ( | ) | const |
Returns whether the list view scrolls to the bottom when a new item is added.
ColumnAlignment tgui::ListView::getColumnAlignment | ( | std::size_t | columnIndex | ) | const |
Returns the current text alignment within a column.
columnIndex | Index of the column to inspect |
std::size_t tgui::ListView::getColumnCount | ( | ) | const |
Returns the amount of columns in the list view.
sf::String tgui::ListView::getColumnText | ( | std::size_t | index | ) | const |
Returns the text of a column.
index | Index of the column |
float tgui::ListView::getColumnWidth | ( | std::size_t | index | ) | const |
Returns the width of a column.
index | Index of the column |
float tgui::ListView::getCurrentHeaderHeight | ( | ) | const |
Returns the height of the header or 0 if no header row is shown.
bool tgui::ListView::getExpandLastColumn | ( | ) | const |
Returns whether the last column is expanded to fill the list view (if all columns fit inside the list view)
unsigned int tgui::ListView::getGridLinesWidth | ( | ) | const |
Returns the width of the grid lines.
float tgui::ListView::getHeaderHeight | ( | ) | const |
Returns the height of the header row.
unsigned int tgui::ListView::getHeaderSeparatorHeight | ( | ) | const |
Returns the height of the separator between the header and the items.
unsigned int tgui::ListView::getHeaderTextSize | ( | ) | const |
Returns the text size of the header caption.
bool tgui::ListView::getHeaderVisible | ( | ) | const |
Returns whether the header is shown.
Scrollbar::Policy tgui::ListView::getHorizontalScrollbarPolicy | ( | ) | const |
Returns when the horizontal scrollbar should be displayed.
unsigned int tgui::ListView::getHorizontalScrollbarValue | ( | ) | const |
Returns the thumb position of the horizontal scrollbar.
sf::String tgui::ListView::getItem | ( | std::size_t | index | ) | const |
Retrieves an item in the list.
index | The index of the item |
sf::String tgui::ListView::getItemCell | ( | std::size_t | rowIndex, |
std::size_t | columnIndex | ||
) | const |
Retrieves the value for a cell in the list.
rowIndex | The index of the row |
columnIndex | The index of the column |
std::size_t tgui::ListView::getItemCount | ( | ) | const |
Returns the amount of items in the list view.
unsigned int tgui::ListView::getItemHeight | ( | ) | const |
Returns the height of the items in the list view.
Texture tgui::ListView::getItemIcon | ( | std::size_t | index | ) | const |
Gets the icon displayed in front of the item.
index | Index of the item |
std::vector< sf::String > tgui::ListView::getItemRow | ( | std::size_t | index | ) | const |
Retrieves the values of all columns for an item in the list.
index | The index of the item |
The returned list has the same length as the amount of columns.
std::vector< std::vector< sf::String > > tgui::ListView::getItemRows | ( | ) | const |
Returns a list of all column values for all items in the list view.
std::vector< sf::String > tgui::ListView::getItems | ( | ) | const |
Returns a list of the texts in the first column for all items in the list view.
bool tgui::ListView::getMultiSelect | ( | ) | const |
Returns multi selection of the items is allowed.
ListViewRenderer * tgui::ListView::getRenderer | ( | ) |
Returns the renderer, which gives access to functions that determine how the widget is displayed.
int tgui::ListView::getSelectedItemIndex | ( | ) | const |
Gets the index of the selected item.
std::set< std::size_t > tgui::ListView::getSelectedItemIndices | ( | ) | const |
Gets the indices of the selected items.
unsigned int tgui::ListView::getSeparatorWidth | ( | ) | const |
Returns the width of the column separator.
ListViewRenderer * tgui::ListView::getSharedRenderer | ( | ) |
Returns the renderer, which gives access to functions that determine how the widget is displayed.
bool tgui::ListView::getShowHorizontalGridLines | ( | ) | const |
Returns whether lines are drawn between items.
bool tgui::ListView::getShowVerticalGridLines | ( | ) | const |
Returns whether lines are drawn between items.
|
overrideprotectedvirtual |
Retrieves a signal based on its name.
signalName | Name of the signal |
Exception | when the name does not match any signal |
Reimplemented from tgui::Widget.
Scrollbar::Policy tgui::ListView::getVerticalScrollbarPolicy | ( | ) | const |
Returns when the vertical scrollbar should be displayed.
unsigned int tgui::ListView::getVerticalScrollbarValue | ( | ) | const |
Returns the thumb position of the vertical scrollbar.
|
overridevirtual |
Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.
Implements tgui::Widget.
bool tgui::ListView::removeItem | ( | std::size_t | index | ) |
Removes the item from the list view.
index | Index of the item in the list view |
|
overrideprotectedvirtual |
Function called when one of the properties of the renderer is changed.
property | Lowercase name of the property that was changed |
Reimplemented from tgui::Widget.
void tgui::ListView::setAutoScroll | ( | bool | autoScroll | ) |
Changes whether the list view scrolls to the bottom when a new item is added.
autoScroll | Should list view scroll to the bottom when new items are added? |
Auto scrolling is enabled by default.
void tgui::ListView::setColumnAlignment | ( | std::size_t | columnIndex, |
ColumnAlignment | alignment | ||
) |
Changes the text alignment within a column.
columnIndex | Index of the column to change |
alignment | The text alignment for all texts in the column |
void tgui::ListView::setColumnText | ( | std::size_t | index, |
const sf::String & | text | ||
) |
Changes the text of a column.
index | Index of the column to change |
text | Caption of the column |
void tgui::ListView::setColumnWidth | ( | std::size_t | index, |
float | width | ||
) |
Changes the width of a column.
index | Index of the column to change |
width | Width of the column. Set width to 0 to make it depend on the width of the column caption. |
void tgui::ListView::setExpandLastColumn | ( | bool | expand | ) |
Changes whether the last column is expanded to fill the list view (if all columns fit inside the list view)
expand | Make the last column larger to make it fill the list view when it isn't full yet? |
The last column is expanded by default.
void tgui::ListView::setGridLinesWidth | ( | unsigned int | width | ) |
Changes the width of the grid lines.
width | Width of the grid lines |
void tgui::ListView::setHeaderHeight | ( | float | height | ) |
Changes the height of the header row.
height | Height of the header or 0 to make the header size depend on the row height |
void tgui::ListView::setHeaderSeparatorHeight | ( | unsigned int | height | ) |
Changes the height of the separator between the header and the items.
height | Height of the line below the header |
void tgui::ListView::setHeaderTextSize | ( | unsigned int | textSize | ) |
Changes the text size of the header caption.
textSize | The character size of the header text |
By default, header text size is the same as the text size of the items.
void tgui::ListView::setHeaderVisible | ( | bool | showHeader | ) |
Changes whether the header is shown.
showHeader | Whether the header containing the column names shoud be visible |
void tgui::ListView::setHorizontalScrollbarPolicy | ( | Scrollbar::Policy | policy | ) |
Changes when the horizontal scrollbar should be displayed.
policy | The policy for displaying the horizontal scrollbar |
void tgui::ListView::setHorizontalScrollbarValue | ( | unsigned int | value | ) |
Changes the thumb position of the horizontal scrollbar.
value | New value of the horizontal scrollbar |
void tgui::ListView::setItemHeight | ( | unsigned int | itemHeight | ) |
Changes the height of the items in the list view.
itemHeight | The size of a single item in the list |
void tgui::ListView::setItemIcon | ( | std::size_t | index, |
const Texture & | texture | ||
) |
Sets a small icon in front of the item.
index | Index of the item |
texture | Texture of the item icon |
void tgui::ListView::setMultiSelect | ( | bool | multiSelect | ) |
Allow multi selection of the items.
multiSelect | Whether several items can be selected |
void tgui::ListView::setSelectedItem | ( | std::size_t | index | ) |
Selects an item in the list view.
index | Index of the item in the list view |
void tgui::ListView::setSelectedItems | ( | const std::set< std::size_t > & | indices | ) |
Selects items in the list view.
indices | Indices of the items in the list view |
void tgui::ListView::setSeparatorWidth | ( | unsigned int | width | ) |
Changes the width of the column separator.
width | Width of the line separating the columns |
void tgui::ListView::setShowHorizontalGridLines | ( | bool | showGridLines | ) |
Changes whether lines are drawn between items.
showGridLines | Is there a horizontal line to separate items? |
Horizontal grid lines are hidden by default.
void tgui::ListView::setShowVerticalGridLines | ( | bool | showGridLines | ) |
Changes whether lines are drawn between columns.
showGridLines | Is there a vertical line to separate columns? |
Vertical grid lines are shown by default.
|
virtual |
Changes the size of the widget.
size | Size of the widget |
Usage examples:
Reimplemented from tgui::Widget.
|
overridevirtual |
Changes the size of the list view.
size | The new size of the list view |
Reimplemented from tgui::Widget.
Changes the size of the widget.
width | Width of the widget |
height | Height of the widget |
|
overridevirtual |
Changes the text size of the items.
textSize | The character size of the text |
This will not change the height that each item has. When passing 0 to this function, the text will be auto-sized to nicely fit inside this item height.
Reimplemented from tgui::Widget.
void tgui::ListView::setVerticalScrollbarPolicy | ( | Scrollbar::Policy | policy | ) |
Changes when the vertical scrollbar should be displayed.
policy | The policy for displaying the vertical scrollbar |
void tgui::ListView::setVerticalScrollbarValue | ( | unsigned int | value | ) |
Changes the thumb position of the vertical scrollbar.
value | New value of the vertical scrollbar |
void tgui::ListView::sort | ( | std::size_t | index, |
const std::function< bool(const sf::String &, const sf::String &)> & | cmp | ||
) |
Sort items.
cmp | The comparator |
index | The index of the column for sorting |