#include <juce_TableListBox.h>
Classes | |
| class | RowComp |
| class | Header |
Private Member Functions | |
| std::unique_ptr< AccessibilityHandler > | createAccessibilityHandler () override |
| void | updateColumnComponents () const |
| Private Member Functions inherited from juce::ListBoxModel | |
| virtual | ~ListBoxModel ()=default |
| virtual String | getNameForRow (int rowNumber) |
| virtual void | listBoxItemClicked (int row, const MouseEvent &) |
| virtual void | listBoxItemDoubleClicked (int row, const MouseEvent &) |
| virtual var | getDragSourceDescription (const SparseSet< int > &rowsToDescribe) |
| virtual String | getTooltipForRow (int row) |
| virtual MouseCursor | getMouseCursorForRow (int row) |
| Private Member Functions inherited from juce::TableHeaderComponent::Listener | |
| Listener ()=default | |
| virtual | ~Listener ()=default |
Private Attributes | |
| TableHeaderComponent * | header = nullptr |
| TableListBoxModel * | model |
| int | columnIdNowBeingDragged = 0 |
| bool | autoSizeOptionsShown = true |
Detailed Description
A table of cells, using a TableHeaderComponent as its header.
This component makes it easy to create a table by providing a TableListBoxModel as the data source.
- See also
- TableListBoxModel, TableHeaderComponent
@tags{GUI}
Constructor & Destructor Documentation
◆ TableListBox()
| juce::TableListBox::TableListBox | ( | const String & | componentName = String(), |
| TableListBoxModel * | model = nullptr ) |
Creates a TableListBox.
The model pointer passed-in can be null, in which case you can set it later with setModel(). The TableListBox does not take ownership of the model - it's the caller's responsibility to manage its lifetime and make sure it doesn't get deleted while still being used.
◆ ~TableListBox()
|
override |
Destructor.
Member Function Documentation
◆ autoSizeAllColumns()
| void juce::TableListBox::autoSizeAllColumns | ( | ) |
Calls autoSizeColumn() for all columns in the table.
◆ autoSizeColumn()
Resizes a column to fit its contents.
This uses TableListBoxModel::getColumnAutoSizeWidth() to find the best width, and applies that to the column.
- See also
- autoSizeAllColumns, TableHeaderComponent::setColumnWidth
◆ backgroundClicked()
|
overridevirtual |
This can be overridden to react to the user clicking on a part of the list where there are no rows.
- See also
- listBoxItemClicked
Reimplemented from juce::ListBoxModel.
◆ createAccessibilityHandler()
|
overrideprivatevirtual |
Override this method to return a custom AccessibilityHandler for this component.
The default implementation creates and returns a AccessibilityHandler object with an unspecified role, meaning that it will be visible to accessibility clients but without a specific role, action callbacks or interfaces. To control how accessibility clients see and interact with your component subclass AccessibilityHandler, implement the desired behaviours, and return an instance of it from this method in your component subclass.
The accessibility handler you return here is guaranteed to be destroyed before its Component, so it's safe to store and use a reference back to the Component inside the AccessibilityHandler if necessary.
- See also
- getAccessibilityHandler
Reimplemented from juce::ListBox.
◆ deleteKeyPressed()
Override this to be informed when the delete key is pressed.
If no rows are selected when they press the key, this won't be called.
- Parameters
-
lastRowSelected the last row that had been selected when they pressed the key - if there are multiple selections, this might not be very useful
Reimplemented from juce::ListBoxModel.
◆ getCellComponent()
Returns the component that currently represents a given cell. If the component for this cell is off-screen or if the position is out-of-range, this may return nullptr.
- See also
- getCellPosition
◆ getCellPosition()
| Rectangle< int > juce::TableListBox::getCellPosition | ( | int | columnId, |
| int | rowNumber, | ||
| bool | relativeToComponentTopLeft ) const |
Returns the position of one of the cells in the table.
If relativeToComponentTopLeft is true, the coordinates are relative to the table component's top-left. The row number isn't checked to see if it's in-range, but the column ID must exist or this will return an empty rectangle.
If relativeToComponentTopLeft is false, the coordinates are relative to the top-left of the table's top-left cell.
◆ getHeader()
|
inlinenoexcept |
Returns the header component being used in this table.
◆ getHeaderHeight()
|
noexcept |
Returns the height of the table header.
- See also
- setHeaderHeight
◆ getModel()
|
inlinenoexcept |
Returns the model currently in use.
◆ getNumRows()
|
overridevirtual |
This has to return the number of items in the list.
- See also
- ListBox::getNumRows()
Implements juce::ListBoxModel.
◆ isAutoSizeMenuOptionShown()
|
inlinenoexcept |
True if the auto-size options should be shown on the menu.
- See also
- setAutoSizeMenuOptionShown
◆ listWasScrolled()
|
overridevirtual |
Override this to be informed when the list is scrolled.
This might be caused by the user moving the scrollbar, or by programmatic changes to the list position.
Reimplemented from juce::ListBoxModel.
◆ paintListBoxItem()
|
overridevirtual |
This method must be implemented to draw a row of the list. Note that the rowNumber value may be greater than the number of rows in your list, so be careful that you don't assume it's less than getNumRows().
Implements juce::ListBoxModel.
◆ refreshComponentForRow()
|
overridevirtual |
This is used to create or update a custom component to go in a row of the list.
Any row may contain a custom component, or can just be drawn with the paintListBoxItem() method and handle mouse clicks with listBoxItemClicked().
This method will be called whenever a custom component might need to be updated - e.g. when the list is changed, or ListBox::updateContent() is called.
If you don't need a custom component for the specified row, then return nullptr. (Bear in mind that even if you're not creating a new component, you may still need to delete existingComponentToUpdate if it's non-null).
If you do want a custom component, and the existingComponentToUpdate is null, then this method must create a suitable new component and return it.
If the existingComponentToUpdate is non-null, it will be a pointer to a component previously created by this method. In this case, the method must either update it to make sure it's correctly representing the given row (which may be different from the one that the component was created for), or it can delete this component and return a new one.
The component that your method returns will be deleted by the ListBox when it is no longer needed.
Bear in mind that if you put a custom component inside the row but still want the listbox to automatically handle clicking, selection, etc, then you'll need to make sure your custom component doesn't intercept all the mouse events that land on it, e.g by using Component::setInterceptsMouseClicks().
Reimplemented from juce::ListBoxModel.
◆ resized()
|
overridevirtual |
Called when this component's size has been changed.
A component can implement this method to do things such as laying out its child components when its width or height changes.
The method is called synchronously as a result of the setBounds or setSize methods, so repeatedly changing a components size will repeatedly call its resized method (unlike things like repainting, where multiple calls to repaint are coalesced together).
If the component is a top-level window on the desktop, its size could also be changed by operating-system factors beyond the application's control.
- See also
- moved, setSize
Reimplemented from juce::ListBox.
◆ returnKeyPressed()
Override this to be informed when the return key is pressed.
If no rows are selected when they press the key, this won't be called.
- Parameters
-
lastRowSelected the last row that had been selected when they pressed the key - if there are multiple selections, this might not be very useful
Reimplemented from juce::ListBoxModel.
◆ scrollToEnsureColumnIsOnscreen()
Scrolls horizontally if necessary to make sure that a particular column is visible.
- See also
- ListBox::scrollToEnsureRowIsOnscreen
◆ selectedRowsChanged()
Override this to be informed when rows are selected or deselected.
This will be called whenever a row is selected or deselected. If a range of rows is selected all at once, this will just be called once for that event.
- Parameters
-
lastRowSelected the last row that the user selected. If no rows are currently selected, this may be -1.
Reimplemented from juce::ListBoxModel.
◆ setAutoSizeMenuOptionShown()
|
noexcept |
Enables or disables the auto size options on the popup menu. By default, these are enabled.
◆ setHeader()
| void juce::TableListBox::setHeader | ( | std::unique_ptr< TableHeaderComponent > | newHeader | ) |
Sets the header component to use for the table. The table will take ownership of the component that you pass in, and will delete it when it's no longer needed. The pointer passed in may not be null.
◆ setHeaderHeight()
Changes the height of the table header component.
- See also
- getHeaderHeight
◆ setModel()
| void juce::TableListBox::setModel | ( | TableListBoxModel * | newModel | ) |
Changes the TableListBoxModel that is being used for this table. The TableListBox does not take ownership of the model - it's the caller's responsibility to manage its lifetime and make sure it doesn't get deleted while still being used.
◆ tableColumnDraggingChanged()
|
overridevirtual |
This is called when the user begins or ends dragging one of the columns around.
When the user starts dragging a column, this is called with the ID of that column. When they finish dragging, it is called again with 0 as the ID.
Reimplemented from juce::TableHeaderComponent::Listener.
◆ tableColumnsChanged()
|
overridevirtual |
This is called when some of the table's columns are added, removed, hidden, or rearranged.
Implements juce::TableHeaderComponent::Listener.
◆ tableColumnsResized()
|
overridevirtual |
This is called when one or more of the table's columns are resized.
Implements juce::TableHeaderComponent::Listener.
◆ tableSortOrderChanged()
|
overridevirtual |
This is called when the column by which the table should be sorted is changed.
Implements juce::TableHeaderComponent::Listener.
◆ updateColumnComponents()
|
private |
Member Data Documentation
◆ autoSizeOptionsShown
|
private |
◆ columnIdNowBeingDragged
|
private |
◆ header
|
private |
◆ model
|
private |
The documentation for this class was generated from the following files:
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/widgets/juce_TableListBox.h
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/widgets/juce_TableListBox.cpp
Generated on for LMMS by
1.16.1