| public |
Inheritance Graph
graph BT
ListView
ListView --> Container
click ListView "classGUI_1_1ListView"
click Container "classGUI_1_1Container"
Description
Classes
| class | GUI::ListView::ListViewClientArea |
MAIN
| const flag_t | AT_LEAST_ONE_MARKING |
| const flag_t | AT_MOST_ONE_MARKING |
| ListView( GUI_Manager & gui, flag_t flags) | |
| ~ListView() | |
| Container * | getContentContainer() const |
| float | getEntryHeight() const |
| void | doLayout() |
| void | setEntryHeight(float h) |
| size_t | getNumVisibleEntries() const |
Children
| void | addContent(const Ref & child) |
| void | clearContents() |
| std::vector< Component * > | getContents() |
| Component * | getEntry(size_t i) const Return entry with given index or nullptr if there is no such entry. |
| void | insertAfter(const Ref & child, const Ref & after) |
| void | insertBefore(const Ref & child, const Ref & after) |
| size_t | getContentsCount() const |
| void | removeContent(const Ref & child) |
Cursor
| Component * | getCursorEntry() const |
| size_t | getCursorIndex() const |
| void | moveCursor(int delta) |
| void | scrollToCursor() |
| void | setCursorIndex(size_t i) |
Event handling
| | ——: | —————– |
Marking
| typedef std::set< Component * > | markingSet_t |
| typedef std::list< Component * > | markingList_t |
| void | addMarking( Component * c) Add a marking to the given component and call marking changed. |
| void | clearMarkings(bool forced) |
| const markingList_t & | getMarkings() const |
| bool | isMarked( Component * c) const |
| void | markingChanged() |
| void | removeMarking( Component * c, bool forced) |
| void | setMarking( Component * c) |
| void | setMarkings(const markingList_t & markings) |
Scrolling
| void | scrollTo(const Geometry::Vec2 & pos, float duration) |
| void | setScrollingPosition(const Geometry::Vec2 & pos) |
| const Geometry::Vec2 & | getScrollPos() const |
Documentation
variable
GUI::ListView::AT_LEAST_ONE_MARKING
| public | static |
| const flag_t AT_LEAST_ONE_MARKING |
Defined in GUI/Components/ListView.h:35
variable
GUI::ListView::AT_MOST_ONE_MARKING
| public | static |
| const flag_t AT_MOST_ONE_MARKING |
Defined in GUI/Components/ListView.h:36
function
GUI::ListView::ListView
| public |
| ListView( | GUI_Manager & | gui, |
| flag_t | flags | |
| ) |
Defined in GUI/Components/ListView.h:38
function
GUI::ListView::~ListView
| public | virtual |
| ~ListView( | ) |
Defined in GUI/Components/ListView.h:39
function
GUI::ListView::getContentContainer
| public | const | inline |
| Container * getContentContainer( | ) const |
Defined in GUI/Components/ListView.h:42
function
GUI::ListView::getEntryHeight
| public | const | inline |
| float getEntryHeight( | ) const |
Defined in GUI/Components/ListView.h:43
function
GUI::ListView::doLayout
| public | virtual |
| void doLayout( | ) |
Defined in GUI/Components/ListView.h:46
function
GUI::ListView::setEntryHeight
| public | inline |
| void setEntryHeight( | float | h ) |
Defined in GUI/Components/ListView.h:48
function
GUI::ListView::getNumVisibleEntries
| public | const | inline |
| size_t getNumVisibleEntries( | ) const |
Defined in GUI/Components/ListView.h:53
function
GUI::ListView::addContent
| public | virtual |
| void addContent( | const Ref & | child ) |
Defined in GUI/Components/ListView.h:88
function
GUI::ListView::clearContents
| public | virtual |
| void clearContents( | ) |
Defined in GUI/Components/ListView.h:90
function
GUI::ListView::getContents
| public | inline | virtual |
| std::vector< Component * > getContents( | ) |
Defined in GUI/Components/ListView.h:92
function
GUI::ListView::getEntry
| public | const | inline |
| Component * getEntry( | size_t | i ) const |
Return entry with given index or nullptr if there is no such entry.
Defined in GUI/Components/ListView.h:95
function
GUI::ListView::insertAfter
| public | virtual |
| void insertAfter( | const Ref & | child, |
| const Ref & | after | |
| ) |
Defined in GUI/Components/ListView.h:98
function
GUI::ListView::insertBefore
| public | virtual |
| void insertBefore( | const Ref & | child, |
| const Ref & | after | |
| ) |
Defined in GUI/Components/ListView.h:100
function
GUI::ListView::getContentsCount
| public | const | inline | virtual |
| size_t getContentsCount( | ) const |
Defined in GUI/Components/ListView.h:102
function
GUI::ListView::removeContent
| public | virtual |
| void removeContent( | const Ref & | child ) |
Defined in GUI/Components/ListView.h:104
function
GUI::ListView::getCursorEntry
| public | const | inline |
| Component * getCursorEntry( | ) const |
Defined in GUI/Components/ListView.h:124
function
GUI::ListView::getCursorIndex
| public | const | inline |
| size_t getCursorIndex( | ) const |
Defined in GUI/Components/ListView.h:125
function
GUI::ListView::moveCursor
| public |
| void moveCursor( | int | delta ) |
Defined in GUI/Components/ListView.h:126
function
GUI::ListView::scrollToCursor
| public |
| void scrollToCursor( | ) |
Defined in GUI/Components/ListView.h:127
function
GUI::ListView::setCursorIndex
| public | inline |
| void setCursorIndex( | size_t | i ) |
Defined in GUI/Components/ListView.h:128
typedef
GUI::ListView::markingSet_t
| public |
| typedef std::set< Component * > markingSet_t |
Defined in GUI/Components/ListView.h:152
typedef
GUI::ListView::markingList_t
| public |
| typedef std::list< Component * > markingList_t |
Defined in GUI/Components/ListView.h:153
function
GUI::ListView::addMarking
| public |
| void addMarking( | Component * | c ) |
Add a marking to the given component and call marking changed.
Defined in GUI/Components/ListView.h:156
function
GUI::ListView::clearMarkings
| public |
| void clearMarkings( | bool | forced ) |
Defined in GUI/Components/ListView.h:157
function
GUI::ListView::getMarkings
| public | const | inline |
| const markingList_t & getMarkings( | ) const |
Defined in GUI/Components/ListView.h:158
function
GUI::ListView::isMarked
| public | const | inline |
| bool isMarked( | Component * | c ) const |
Defined in GUI/Components/ListView.h:159
function
GUI::ListView::markingChanged
| public | virtual |
| void markingChanged( | ) |
Defined in GUI/Components/ListView.h:161
function
GUI::ListView::removeMarking
| public |
| void removeMarking( | Component * | c, |
| bool | forced | |
| ) |
Defined in GUI/Components/ListView.h:162
function
GUI::ListView::setMarking
| public |
| void setMarking( | Component * | c ) |
Defined in GUI/Components/ListView.h:163
function
GUI::ListView::setMarkings
| public |
| void setMarkings( | const markingList_t & | markings ) |
Defined in GUI/Components/ListView.h:164
function
GUI::ListView::scrollTo
| public |
| void scrollTo( | const Geometry::Vec2 & | pos, |
| float | duration | |
| ) |
Defined in GUI/Components/ListView.h:182
function
GUI::ListView::setScrollingPosition
| public |
| void setScrollingPosition( | const Geometry::Vec2 & | pos ) |
Defined in GUI/Components/ListView.h:183
function
GUI::ListView::getScrollPos
| public | const | inline |
| const Geometry::Vec2 & getScrollPos( | ) const |
Defined in GUI/Components/ListView.h:184