TGUI  0.8.5

List view widget. More...

#include <TGUI/Widgets/ListView.hpp>

Inheritance diagram for tgui::ListView:
tgui::Widget tgui::SignalWidgetBase

Classes

struct  Column
 
struct  Item
 

Public Types

enum  ColumnAlignment { ColumnAlignment::Left, ColumnAlignment::Center, ColumnAlignment::Right }
 The text alignment for all texts within a column. More...
 
typedef std::shared_ptr< ListViewPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const ListViewConstPtr
 Shared constant widget pointer.
 
- Public Types inherited from tgui::Widget
typedef std::shared_ptr< WidgetPtr
 Shared widget pointer.
 
typedef std::shared_ptr< const WidgetConstPtr
 Shared constant widget pointer.
 

Public Member Functions

ListViewRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
ListViewRenderergetRenderer ()
 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 deselectItem ()
 Deselects the selected item.
 
int getSelectedItemIndex () const
 Gets the index of the selected item. 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...
 
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 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)
 Changes the text size of the items. More...
 
unsigned int getTextSize () const
 Returns 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...
 
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...
 
- Public Member Functions inherited from tgui::Widget
 Widget ()
 Default constructor.
 
 Widget (const Widget &)
 Copy constructor.
 
 Widget (Widget &&)
 Move constructor.
 
 ~Widget ()
 Destructor.
 
Widgetoperator= (const Widget &)
 Overload of copy assignment operator.
 
Widgetoperator= (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...
 
WidgetRenderergetSharedRenderer ()
 Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
 
WidgetRenderergetRenderer ()
 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...
 
ContainergetParent () const
 Returns a pointer to the parent widget. 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 (tgui::Any userData)
 Stores some data into the widget. More...
 
template<typename 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 FontgetInheritedFont () 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...
 
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...
 
virtual bool canGainFocus () const
 Returns whether the widget can 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.
 
- Public Member Functions inherited from tgui::SignalWidgetBase
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 &..., 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. 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)
 
- Public Attributes inherited from tgui::Widget
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

SignalgetSignal (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...
 
- Protected Member Functions inherited from tgui::Widget
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.
 

Detailed Description

List view widget.

Warning
This widget is new and API stability is not yet guaranteed. Functions and their behavior may still change in newer patch releases, based on feedback.

Member Enumeration Documentation

◆ ColumnAlignment

The text alignment for all texts within a column.

Enumerator
Left 

Place the text on the left side (default)

Center 

Center the text inside the column.

Right 

Place the text on the right side (e.g. for numbers)

Member Function Documentation

◆ addColumn()

std::size_t tgui::ListView::addColumn ( const sf::String &  text,
float  width = 0,
ColumnAlignment  alignment = ColumnAlignment::Left 
)

Adds a column.

Parameters
textThe caption of the new column
widthWidth of the column. Set width to 0 to make it depend on the width of the column caption.
alignmentThe text alignment for all texts in the column
Returns
Index of the added column

◆ addItem() [1/2]

std::size_t tgui::ListView::addItem ( const sf::String &  text)

Adds an item to the list.

Parameters
textThe caption of the item you want to add
Returns
Index of the item that was just added

◆ addItem() [2/2]

std::size_t tgui::ListView::addItem ( const std::vector< sf::String > &  item)

Adds an item with values for multiple columns to the list.

Parameters
itemTexts for each column
Returns
Index of the item that was just added

◆ addMultipleItems()

void tgui::ListView::addMultipleItems ( const std::vector< std::vector< sf::String >> &  items)

Adds multiple items to the list.

Parameters
itemsList of items that should be passed to the addItem

◆ changeItem()

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.

Parameters
indexIndex of the item to update
itemTexts for each column
Returns
True when the item was updated, false when the index was too high

◆ changeSubItem()

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.

Parameters
indexIndex of the item to update
columnIndex of the column to change
itemTexts for the given column for the given item
Returns
True when the item was updated, false when the index was too high

◆ clone()

Widget::Ptr tgui::ListView::clone ( ) const
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.

Returns
Copy of the widget

Implements tgui::Widget.

◆ copy()

static ListView::Ptr tgui::ListView::copy ( ListView::ConstPtr  listView)
static

Makes a copy of another list view.

Parameters
listViewThe other list view
Returns
The new list view

◆ create()

static ListView::Ptr tgui::ListView::create ( )
static

Creates a new list view widget.

Returns
The new list view

◆ draw()

void tgui::ListView::draw ( sf::RenderTarget &  target,
sf::RenderStates  states 
) const
overridevirtual

Draw the widget to a render target.

Parameters
targetRender target to draw to
statesCurrent render states

Implements tgui::Widget.

◆ getAutoScroll()

bool tgui::ListView::getAutoScroll ( ) const

Returns whether the list view scrolls to the bottom when a new item is added.

Returns
Does the list view scroll to the bottom when new items are added

◆ getColumnAlignment()

ColumnAlignment tgui::ListView::getColumnAlignment ( std::size_t  columnIndex) const

Returns the current text alignment within a column.

Parameters
columnIndexIndex of the column to inspect
Returns
Text alignment for all texts in the column

◆ getColumnCount()

std::size_t tgui::ListView::getColumnCount ( ) const

Returns the amount of columns in the list view.

Returns
Number of columns

◆ getColumnText()

sf::String tgui::ListView::getColumnText ( std::size_t  index) const

Returns the text of a column.

Parameters
indexIndex of the column
Returns
Caption of the column

◆ getColumnWidth()

float tgui::ListView::getColumnWidth ( std::size_t  index) const

Returns the width of a column.

Parameters
indexIndex of the column
Returns
Width of the column

◆ getCurrentHeaderHeight()

float tgui::ListView::getCurrentHeaderHeight ( ) const

Returns the height of the header or 0 if no header row is shown.

Returns
getHeaderHeight() + getHeaderSeparatorHeight() or 0 if no header is shown

◆ getExpandLastColumn()

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)

Returns
Is the last column larger to make it fill the list view when the list view isn't full yet?

◆ getGridLinesWidth()

unsigned int tgui::ListView::getGridLinesWidth ( ) const

Returns the width of the grid lines.

Returns
Width of the grid lines

◆ getHeaderHeight()

float tgui::ListView::getHeaderHeight ( ) const

Returns the height of the header row.

Returns
Configured height of the header

◆ getHeaderSeparatorHeight()

unsigned int tgui::ListView::getHeaderSeparatorHeight ( ) const

Returns the height of the separator between the header and the items.

Returns
Height of the line below the header

◆ getHeaderTextSize()

unsigned int tgui::ListView::getHeaderTextSize ( ) const

Returns the text size of the header caption.

Returns
The header text size

◆ getHeaderVisible()

bool tgui::ListView::getHeaderVisible ( ) const

Returns whether the header is shown.

Returns
Whether the header containing the column names is visible

◆ getHorizontalScrollbarPolicy()

Scrollbar::Policy tgui::ListView::getHorizontalScrollbarPolicy ( ) const

Returns when the horizontal scrollbar should be displayed.

Returns
The policy for displaying the horizontal scrollbar

◆ getItem()

sf::String tgui::ListView::getItem ( std::size_t  index) const

Retrieves an item in the list.

Parameters
indexThe index of the item
Returns
Text of the item or an empty string when the index was higher than the amount of items

◆ getItemCount()

std::size_t tgui::ListView::getItemCount ( ) const

Returns the amount of items in the list view.

Returns
Number of items inside the list view

◆ getItemHeight()

unsigned int tgui::ListView::getItemHeight ( ) const

Returns the height of the items in the list view.

Returns
The item height

◆ getItemIcon()

Texture tgui::ListView::getItemIcon ( std::size_t  index) const

Gets the icon displayed in front of the item.

Parameters
indexIndex of the item
Returns
Texture of the item icon

◆ getItemRow()

std::vector<sf::String> tgui::ListView::getItemRow ( std::size_t  index) const

Retrieves the values of all columns for an item in the list.

Parameters
indexThe index of the item
Returns
Texts of the item for each column or an list of empty strings when the index was too high

The returned list has the same length as the amount of columns.

◆ getItemRows()

std::vector<std::vector<sf::String> > tgui::ListView::getItemRows ( ) const

Returns a list of all column values for all items in the list view.

Returns
Texts of the items and their subitems

◆ getItems()

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.

Returns
Texts of the first column of items

◆ getRenderer()

ListViewRenderer* tgui::ListView::getRenderer ( )

Returns the renderer, which gives access to functions that determine how the widget is displayed.

Returns
Temporary pointer to the renderer
Warning
After calling this function, the widget has its own copy of the renderer and it will no longer be shared.

◆ getSelectedItemIndex()

int tgui::ListView::getSelectedItemIndex ( ) const

Gets the index of the selected item.

Returns
The index of the selected item, or -1 when no item was selected

◆ getSeparatorWidth()

unsigned int tgui::ListView::getSeparatorWidth ( ) const

Returns the width of the column separator.

Returns
Width of the line separating the columns

◆ getSharedRenderer()

ListViewRenderer* tgui::ListView::getSharedRenderer ( )

Returns the renderer, which gives access to functions that determine how the widget is displayed.

Returns
Temporary pointer to the renderer that may be shared with other widgets using the same renderer

◆ getShowHorizontalGridLines()

bool tgui::ListView::getShowHorizontalGridLines ( ) const

Returns whether lines are drawn between items.

Returns
Is there a horizontal line to separate items?

◆ getShowVerticalGridLines()

bool tgui::ListView::getShowVerticalGridLines ( ) const

Returns whether lines are drawn between items.

Returns
Is there a horizontal line to separate items?

◆ getSignal()

Signal& tgui::ListView::getSignal ( std::string  signalName)
overrideprotectedvirtual

Retrieves a signal based on its name.

Parameters
signalNameName of the signal
Returns
Signal that corresponds to the name
Exceptions
Exceptionwhen the name does not match any signal

Reimplemented from tgui::Widget.

◆ getTextSize()

unsigned int tgui::ListView::getTextSize ( ) const

Returns the text size of the items.

Returns
The text size

◆ getVerticalScrollbarPolicy()

Scrollbar::Policy tgui::ListView::getVerticalScrollbarPolicy ( ) const

Returns when the vertical scrollbar should be displayed.

Returns
The policy for displaying the vertical scrollbar

◆ mouseOnWidget()

bool tgui::ListView::mouseOnWidget ( Vector2f  pos) const
overridevirtual

Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget.

Returns
Is the mouse on top of the widget?

Implements tgui::Widget.

◆ removeItem()

bool tgui::ListView::removeItem ( std::size_t  index)

Removes the item from the list view.

Parameters
indexIndex of the item in the list view
Returns
True when the item was removed, false when the index was too high

◆ rendererChanged()

void tgui::ListView::rendererChanged ( const std::string &  property)
overrideprotectedvirtual

Function called when one of the properties of the renderer is changed.

Parameters
propertyLowercase name of the property that was changed

Reimplemented from tgui::Widget.

◆ setAutoScroll()

void tgui::ListView::setAutoScroll ( bool  autoScroll)

Changes whether the list view scrolls to the bottom when a new item is added.

Parameters
autoScrollShould list view scroll to the bottom when new items are added?

Auto scrolling is enabled by default.

◆ setColumnAlignment()

void tgui::ListView::setColumnAlignment ( std::size_t  columnIndex,
ColumnAlignment  alignment 
)

Changes the text alignment within a column.

Parameters
columnIndexIndex of the column to change
alignmentThe text alignment for all texts in the column

◆ setColumnText()

void tgui::ListView::setColumnText ( std::size_t  index,
const sf::String &  text 
)

Changes the text of a column.

Parameters
indexIndex of the column to change
textCaption of the column

◆ setColumnWidth()

void tgui::ListView::setColumnWidth ( std::size_t  index,
float  width 
)

Changes the width of a column.

Parameters
indexIndex of the column to change
widthWidth of the column. Set width to 0 to make it depend on the width of the column caption.

◆ setExpandLastColumn()

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)

Parameters
expandMake the last column larger to make it fill the list view when it isn't full yet?

The last column is expanded by default.

◆ setGridLinesWidth()

void tgui::ListView::setGridLinesWidth ( unsigned int  width)

Changes the width of the grid lines.

Parameters
widthWidth of the grid lines

◆ setHeaderHeight()

void tgui::ListView::setHeaderHeight ( float  height)

Changes the height of the header row.

Parameters
heightHeight of the header or 0 to make the header size depend on the row height

◆ setHeaderSeparatorHeight()

void tgui::ListView::setHeaderSeparatorHeight ( unsigned int  height)

Changes the height of the separator between the header and the items.

Parameters
heightHeight of the line below the header

◆ setHeaderTextSize()

void tgui::ListView::setHeaderTextSize ( unsigned int  textSize)

Changes the text size of the header caption.

Parameters
textSizeThe character size of the header text

By default, header text size is the same as the text size of the items.

◆ setHeaderVisible()

void tgui::ListView::setHeaderVisible ( bool  showHeader)

Changes whether the header is shown.

Parameters
showHeaderWhether the header containing the column names shoud be visible

◆ setHorizontalScrollbarPolicy()

void tgui::ListView::setHorizontalScrollbarPolicy ( Scrollbar::Policy  policy)

Changes when the horizontal scrollbar should be displayed.

Parameters
policyThe policy for displaying the horizontal scrollbar

◆ setItemHeight()

void tgui::ListView::setItemHeight ( unsigned int  itemHeight)

Changes the height of the items in the list view.

Parameters
itemHeightThe size of a single item in the list

◆ setItemIcon()

void tgui::ListView::setItemIcon ( std::size_t  index,
const Texture texture 
)

Sets a small icon in front of the item.

Parameters
indexIndex of the item
textureTexture of the item icon

◆ setSelectedItem()

void tgui::ListView::setSelectedItem ( std::size_t  index)

Selects an item in the list view.

Parameters
indexIndex of the item in the list view

◆ setSeparatorWidth()

void tgui::ListView::setSeparatorWidth ( unsigned int  width)

Changes the width of the column separator.

Parameters
widthWidth of the line separating the columns

◆ setShowHorizontalGridLines()

void tgui::ListView::setShowHorizontalGridLines ( bool  showGridLines)

Changes whether lines are drawn between items.

Parameters
showGridLinesIs there a horizontal line to separate items?

Horizontal grid lines are hidden by default.

◆ setShowVerticalGridLines()

void tgui::ListView::setShowVerticalGridLines ( bool  showGridLines)

Changes whether lines are drawn between columns.

Parameters
showGridLinesIs there a vertical line to separate columns?

Vertical grid lines are shown by default.

◆ setSize() [1/3]

void tgui::ListView::setSize ( const Layout2d size)
overridevirtual

Changes the size of the list view.

Parameters
sizeThe new size of the list view

Reimplemented from tgui::Widget.

◆ setSize() [2/3]

void tgui::Widget::setSize
inline

Changes the size of the widget.

Parameters
widthWidth of the widget
heightHeight of the widget
Warning
This setSize overload must never be used from internal TGUI code or by custom widget implementations

◆ setSize() [3/3]

virtual void tgui::Widget::setSize

Changes the size of the widget.

Parameters
sizeSize of the widget

Usage examples:

// Give the widget an exact size
widget->setSize({40, 30});
// Give the widget a size relative to the size of its parent
widget->setSize({"20%", "5%"});
// Make the widget 50 pixels higher than some other widget and automatically resize it when the other widget resizes
widget->setSize({200, tgui::bindHeight(otherWidget) + 50});

◆ setTextSize()

void tgui::ListView::setTextSize ( unsigned int  textSize)

Changes the text size of the items.

Parameters
textSizeThe 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.

See also
setItemHeight

◆ setVerticalScrollbarPolicy()

void tgui::ListView::setVerticalScrollbarPolicy ( Scrollbar::Policy  policy)

Changes when the vertical scrollbar should be displayed.

Parameters
policyThe policy for displaying the vertical scrollbar

The documentation for this class was generated from the following file: