|
| ListView (const char *typeName=StaticWidgetType, bool initRenderer=true) |
|
ListViewRenderer * | getSharedRenderer () |
| Returns the renderer, which gives access to functions that determine how the widget is displayed. More...
|
|
const ListViewRenderer * | getSharedRenderer () const |
|
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 String &text, float width=0, ColumnAlignment alignment=ColumnAlignment::Left) |
| Adds a column. More...
|
|
void | setColumnText (std::size_t index, const String &text) |
| Changes the text of a column. More...
|
|
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 String &text) |
| Adds an item to the list. More...
|
|
std::size_t | addItem (const std::vector< String > &item) |
| Adds an item with values for multiple columns to the list. More...
|
|
void | addMultipleItems (const std::vector< std::vector< String > > &items) |
| Adds multiple items to the list. More...
|
|
void | insertItem (std::size_t index, const String &text) |
| Inserts an item into the list. More...
|
|
void | insertItem (std::size_t index, const std::vector< String > &item) |
| Inserts an item into the list. More...
|
|
void | insertMultipleItems (std::size_t index, const std::vector< std::vector< String > > &items) |
| Inserts multiple items into the list. More...
|
|
bool | changeItem (std::size_t index, const std::vector< 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 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 | 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 | setItemData (std::size_t index, Any data) |
| Store some user data with the item. More...
|
|
template<typename T > |
T | getItemData (std::size_t index) const |
| Returns user data stored in the 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...
|
|
String | getItem (std::size_t index) const |
| Retrieves an item in the list. More...
|
|
std::vector< String > | getItemRow (std::size_t index) const |
| Retrieves the values of all columns for an item in the list. More...
|
|
String | getItemCell (std::size_t rowIndex, std::size_t columnIndex) const |
| Retrieves the value for a cell in the list. More...
|
|
std::vector< 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< 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 String &, const 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 | 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...
|
|
void | setFixedIconSize (Vector2f iconSize) |
| Sets a size to which all icons should be scaled. More...
|
|
Vector2f | getFixedIconSize () const |
| Returns to which size all icons should be scaled. More...
|
|
void | setResizableColumns (bool resizable) |
| Changes whether the user can resize the columns by dragging the border between columns. More...
|
|
bool | getResizableColumns () const |
| Returns whether the user can resize the columns by dragging the border between columns. More...
|
|
bool | isMouseOnWidget (Vector2f pos) const override |
| Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
|
|
void | leftMousePressed (Vector2f pos) override |
|
void | leftMouseReleased (Vector2f pos) override |
|
void | rightMousePressed (Vector2f pos) override |
|
void | mouseMoved (Vector2f pos) override |
|
bool | mouseWheelScrolled (float delta, Vector2f pos) override |
|
void | mouseNoLongerOnWidget () override |
|
void | leftMouseButtonNoLongerDown () override |
|
void | keyPressed (const Event::KeyEvent &event) override |
|
void | draw (BackendRenderTarget &target, 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 (const char *typeName, bool initRenderer) |
|
| Widget (const Widget &) |
| Copy constructor.
|
|
| Widget (Widget &&) noexcept |
| Move constructor.
|
|
virtual | ~Widget () |
| Destructor.
|
|
Widget & | operator= (const Widget &) |
| Overload of copy assignment operator.
|
|
Widget & | operator= (Widget &&) noexcept |
| 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...
|
|
const WidgetRenderer * | getSharedRenderer () const |
|
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...
|
|
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...
|
|
void | setWidth (Layout width) |
| Changes the width of the widget. More...
|
|
void | setHeight (Layout height) |
| Changes the height 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 top-left point 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...
|
|
void | setOrigin (float x, float y) |
| Sets the origin point on which the position, scale and rotation is based. More...
|
|
void | setOrigin (Vector2f origin) |
| Sets the origin point on which the position, scale and rotation is based. More...
|
|
Vector2f | getOrigin () const |
| Returns the relative origin point on which the position, scale and rotation is based. More...
|
|
void | setScale (Vector2f scaleFactors) |
| Sets the scaling to be applied to the widget. More...
|
|
void | setScale (Vector2f scaleFactors, Vector2f origin) |
| Sets the scaling to be applied to the widget. More...
|
|
void | setScale (float scaleFactor) |
| Sets the scaling to be applied to the widget. More...
|
|
void | setScale (float scaleFactor, Vector2f origin) |
| Sets the scaling to be applied to the widget. More...
|
|
Vector2f | getScale () const |
| Returns the scaling to be applied to the widget. More...
|
|
Vector2f | getScaleOrigin () const |
| Returns the origin used for scaling. More...
|
|
void | setRotation (float angle) |
| Sets the rotation to be applied to the widget. More...
|
|
void | setRotation (float angle, Vector2f origin) |
| Sets the rotation to be applied to the widget. More...
|
|
float | getRotation () const |
| Returns the rotation to be applied to the widget. More...
|
|
Vector2f | getRotationOrigin () const |
| Returns the origin used for rotations. More...
|
|
void | showWithEffect (ShowEffectType type, Duration duration) |
| Shows the widget by introducing it with an animation. More...
|
|
void | hideWithEffect (ShowEffectType type, Duration duration) |
| Hides the widget by making it leave with an animation. More...
|
|
void | moveWithAnimation (Layout2d position, Duration duration) |
| Moves the widget from its current position to the given position, over a given duration. More...
|
|
void | resizeWithAnimation (Layout2d size, Duration duration) |
| Resizes the widget from its current size to the given size, over a given duration. 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 String & | getWidgetType () const |
| Returns the type of the widget. More...
|
|
Container * | getParent () const |
| Returns a pointer to the parent widget. More...
|
|
BackendGui * | getParentGui () const |
| Returns a pointer to the gui to which this widget belongs. More...
|
|
bool | isAnimationPlaying () const |
| Returns whether there is an active animation (started with showWithEffect or hideWithEffect) More...
|
|
void | moveToFront () |
| Places the widget before all other widgets. More...
|
|
void | moveToBack () |
| Places the widget behind all other widgets. More...
|
|
void | setUserData (Any userData) |
| Stores some data into the widget. More...
|
|
template<typename T > |
T | getUserData () const |
| Returns data stored in the widget. More...
|
|
bool | hasUserData () const |
| Returns whether 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...
|
|
void | setTextSize (unsigned int size) |
| Changes the character size of text in this widget if it uses text. More...
|
|
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 String &name) |
| Changes the name of a widget. More...
|
|
String | getWidgetName () const |
| Returns the name of a widget. More...
|
|
void | setMouseCursor (Cursor::Type cursor) |
| Changes which mouse cursor is shown when hovering over the widget. More...
|
|
Cursor::Type | getMouseCursor () const |
| Returns which mouse cursor is shown when hovering over the 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...
|
|
void | finishAllAnimations () |
| Makes all animations of the widget finish immediately.
|
|
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...
|
|
bool | isDraggableWidget () const |
| Returns whether the widget has something to drag (e.g. slider or scrollbar thumbs) More...
|
|
bool | isMouseDown () const |
| Returns whether the left mouse button has been pressed on top of the widget. More...
|
|
virtual Signal & | getSignal (String signalName) |
| Retrieves a signal based on its name. More...
|
|
virtual void | setParent (Container *parent) |
|
virtual bool | updateTime (Duration elapsedTime) |
|
virtual bool | isMouseOnWidget (Vector2f pos) const =0 |
| Returns whether the mouse position (which is relative to the parent widget) lies on top of the widget. More...
|
|
virtual void | leftMousePressed (Vector2f pos) |
|
virtual void | leftMouseReleased (Vector2f pos) |
|
virtual void | rightMousePressed (Vector2f pos) |
|
virtual void | rightMouseReleased (Vector2f pos) |
|
virtual void | mousePressed (Event::MouseButton button, Vector2f pos) |
|
virtual void | mouseReleased (Event::MouseButton button, Vector2f pos) |
|
virtual void | mouseMoved (Vector2f pos) |
|
virtual void | keyPressed (const Event::KeyEvent &event) |
|
virtual void | textEntered (char32_t key) |
|
virtual bool | mouseWheelScrolled (float delta, Vector2f pos) |
|
virtual void | mouseNoLongerOnWidget () |
|
virtual void | leftMouseButtonNoLongerDown () |
|
virtual void | rightMouseButtonNoLongerDown () |
|
virtual Widget::Ptr | askToolTip (Vector2f mousePos) |
|
const Layout2d & | getPositionLayout () const |
|
const Layout2d & | getSizeLayout () const |
|
void | bindPositionLayout (Layout *layout) |
|
void | unbindPositionLayout (Layout *layout) |
|
void | bindSizeLayout (Layout *layout) |
|
void | unbindSizeLayout (Layout *layout) |
|
virtual void | draw (BackendRenderTarget &target, RenderStates states) const =0 |
| Draw the widget to a render target. More...
|
|
template<typename WidgetType > |
std::shared_ptr< const WidgetType > | cast () const |
| Downcast const widget.
|
|
template<typename WidgetType > |
std::shared_ptr< WidgetType > | cast () |
| Downcast widget.
|
|
virtual Widget::Ptr | clone () const =0 |
| Makes a copy of the widget if you don't know its exact type. More...
|
|
void | rendererChangedCallback (const String &property) |
|
virtual void | updateTextSize () |
|
|
Signal & | getSignal (String signalName) override |
| Retrieves a signal based on its name. More...
|
|
void | rendererChanged (const 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. More...
|
|
void | load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) override |
| Loads the widget from a tree of nodes. More...
|
|
void | mouseEnteredWidget () override |
| This function is called when the mouse enters the widget. More...
|
|
void | mouseLeftWidget () override |
| This function is called when the mouse leaves the widget. More...
|
|
void | updateTextSize () override |
| Called when the text size is changed (either by setTextSize or via the renderer) More...
|
|
Vector2f | getInnerSize () const |
|
Text | createText (const String &caption) |
|
Text | createHeaderText (const String &caption) |
|
virtual void | setItemColor (std::size_t index, const Color &color) |
|
float | calculateAutoColumnWidth (const Text &text) |
|
void | updateSelectedAndhoveredItemColors () |
|
void | updateItemColors () |
|
void | updateHeaderTextsColor () |
|
void | updateHoveredItem (int item) |
|
void | updateSelectedItem (int item) |
|
void | selectRangeFromEvent (std::size_t item) |
|
bool | updateLastColumnMaxItemWidth () |
|
bool | updateLastColumnMaxItemWidthWithNewItem (const Item &item) |
|
bool | updateLastColumnMaxItemWidthWithModifiedItem (const Item &modifiedItem, float oldDesiredWidthInLastColumn) |
|
void | addSelectedItem (int item) |
|
void | removeSelectedItem (std::size_t item) |
|
void | updateHoveredItemByMousePos (Vector2f mousePos) |
|
unsigned int | getTotalSeparatorWidth () const |
|
float | getItemTotalWidth (const Item &item, std::size_t columnIndex) const |
|
int | getColumnIndexBelowMouse (float mouseLeft) |
|
bool | findBorderBelowMouse (Vector2f pos, std::size_t &columnIndex, float &pixelOffset) const |
|
void | updateScrollbars () |
|
void | updateVerticalScrollbarMaximum () |
|
void | updateHorizontalScrollbarMaximum () |
|
void | drawHeaderText (BackendRenderTarget &target, RenderStates states, float columnWidth, float headerHeight, std::size_t column) const |
|
void | drawColumn (BackendRenderTarget &target, RenderStates states, std::size_t firstItem, std::size_t lastItem, std::size_t column, float columnWidth) const |
|
bool | updateTime (Duration elapsedTime) override |
|
Widget::Ptr | clone () const override |
| Makes a copy of the widget if you don't know its exact type. More...
|
|
virtual void | rendererChanged (const String &property) |
| Function called when one of the properties of the renderer is changed. More...
|
|
virtual std::unique_ptr< DataIO::Node > | save (SavingRenderersMap &renderers) const |
| Saves the widget as a tree node in order to save it to a file. More...
|
|
virtual void | load (const std::unique_ptr< DataIO::Node > &node, const LoadingRenderersMap &renderers) |
| Loads the widget from a tree of nodes. More...
|
|
virtual void | mouseEnteredWidget () |
| This function is called when the mouse enters the widget. More...
|
|
virtual void | mouseLeftWidget () |
| This function is called when the mouse leaves the widget. More...
|
|