#include <juce_ListBox.h>
Classes | |
| class | RowComponent |
| class | ListViewport |
Public Types | |
| enum | ColourIds { backgroundColourId = 0x1002800 , outlineColourId = 0x1002810 , textColourId = 0x1002820 } |
| Public Types inherited from juce::Component | |
| enum class | FocusContainerType { none , focusContainer , keyboardFocusContainer } |
| enum | FocusChangeType { focusChangedByMouseClick , focusChangedByTabKey , focusChangedDirectly } |
Private Member Functions | |
| void | assignModelPtr (ListBoxModel *) |
| void | checkModelPtrIsValid () const |
| std::unique_ptr< AccessibilityHandler > | createAccessibilityHandler () override |
| bool | hasAccessibleHeaderComponent () const |
| void | selectRowInternal (int rowNumber, bool dontScrollToShowThisRow, bool deselectOthersFirst, bool isMouseClick) |
Private Attributes | |
| ListBoxModel * | model = nullptr |
| std::unique_ptr< ListViewport > | viewport |
| std::unique_ptr< Component > | headerComponent |
| std::unique_ptr< MouseListener > | mouseMoveSelector |
| SparseSet< int > | selected |
| int | totalItems = 0 |
| int | rowHeight = 22 |
| int | minimumRowWidth = 0 |
| int | outlineThickness = 0 |
| int | lastRowSelected = -1 |
| bool | multipleSelection = false |
| bool | alwaysFlipSelection = false |
| bool | hasDoneInitialUpdate = false |
| bool | selectOnMouseDown = true |
| std::weak_ptr< ListBoxModel::Empty > | weakModelPtr |
Friends | |
| class | ListViewport |
| class | TableListBox |
Detailed Description
A list of items that can be scrolled vertically.
To create a list, you'll need to create a subclass of ListBoxModel. This can either paint each row of the list and respond to events via callbacks, or for more specialised tasks, it can supply a custom component to fill each row.
- See also
- ComboBox, TableListBox
@tags{GUI}
Member Enumeration Documentation
◆ ColourIds
| enum juce::ListBox::ColourIds |
A set of colour IDs to use to change the colour of various aspects of the label.
These constants can be used either via the Component::setColour(), or LookAndFeel::setColour() methods.
- See also
- Component::setColour, Component::findColour, LookAndFeel::setColour, LookAndFeel::findColour
Constructor & Destructor Documentation
◆ ListBox()
| juce::ListBox::ListBox | ( | const String & | componentName = String(), |
| ListBoxModel * | model = nullptr ) |
Creates a ListBox.
The model pointer passed-in can be null, in which case you can set it later with setModel().
The ListBoxModel instance must stay alive for as long as the ListBox holds a pointer to it. Be careful to destroy the ListBox before the ListBoxModel, or to call ListBox::setModel (nullptr) before destroying the ListBoxModel.
◆ ~ListBox()
|
override |
Destructor.
Member Function Documentation
◆ assignModelPtr()
|
private |
◆ checkModelPtrIsValid()
|
private |
◆ colourChanged()
|
overridevirtual |
This method is called when a colour is changed by the setColour() method.
- See also
- setColour, findColour
Reimplemented from juce::Component.
◆ 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::Component.
Reimplemented in juce::TableListBox.
◆ createSnapshotOfRows()
|
virtual |
This fairly obscure method creates an image that shows the row components specified in rows (for example, these could be the currently selected row components).
It's a handy method for doing drag-and-drop, as it can be passed to the DragAndDropContainer for use as the drag image.
Note that it will make the row components temporarily invisible, so if you're using custom components this could affect them if they're sensitive to that sort of thing.
- See also
- Component::createComponentSnapshot
◆ deselectAllRows()
| void juce::ListBox::deselectAllRows | ( | ) |
Deselects any currently selected rows.
- See also
- deselectRow
◆ deselectRow()
Deselects a row. If it's not currently selected, this will do nothing.
- See also
- selectRow, deselectAllRows
◆ flipRowSelection()
Selects or deselects a row. If the row's currently selected, this deselects it, and vice-versa.
◆ getComponentForRowNumber()
Finds the row component for a given row in the list.
The component returned will have been created using ListBoxModel::refreshComponentForRow().
If the component for this row is off-screen or if the row is out-of-range, this will return nullptr.
- See also
- getRowContainingPosition
◆ getHeaderComponent()
|
inlinenoexcept |
Returns whatever header component was set with setHeaderComponent().
◆ getHorizontalScrollBar()
|
noexcept |
Returns a reference to the horizontal scrollbar.
◆ getInsertionIndexForPosition()
Finds a row index that would be the most suitable place to insert a new item for a given position.
This is useful when the user is e.g. dragging and dropping onto the listbox, because it lets you easily choose the best position to insert the item that they drop, based on where they drop it.
If the position is out of range, this will return -1. If the position is beyond the end of the list, it will return getNumRows() to indicate the end of the list.
- See also
- getComponentForRowNumber
◆ getLastRowSelected()
| int juce::ListBox::getLastRowSelected | ( | ) | const |
Returns the last row that the user selected.
This isn't the same as the highest row number that is currently selected - if the user had multiply-selected rows 10, 5 and then 6 in that order, this would return 6.
If nothing is selected, it will return -1.
◆ getModel()
|
inlinenoexcept |
Returns the current list model.
◆ getNumRowsOnScreen()
|
noexcept |
Returns the number of rows actually visible.
This is the number of whole rows which will fit on-screen, so the value might be more than the actual number of rows in the list.
◆ getNumSelectedRows()
| int juce::ListBox::getNumSelectedRows | ( | ) | const |
Returns the number of rows that are currently selected.
- See also
- getSelectedRow, isRowSelected, getLastRowSelected
◆ getOutlineThickness()
|
inlinenoexcept |
Returns the thickness of outline that will be drawn around the listbox.
- See also
- setOutlineColour
◆ getRowContainingPosition()
Finds the row index that contains a given x,y position. The position is relative to the ListBox's top-left. If no row exists at this position, the method will return -1.
- See also
- getComponentForRowNumber
◆ getRowHeight()
|
inlinenoexcept |
Returns the height of a row in the list.
- See also
- setRowHeight
◆ getRowNumberOfComponent()
Returns the row number that the given component represents. If the component isn't one of the list's rows, this will return -1.
◆ getRowPosition()
|
noexcept |
Returns the position of one of the rows, relative to the top-left of the listbox.
This may be off-screen, and the range of the row number that is passed-in is not checked to see if it's a valid row.
◆ getSelectedRow()
Returns the row number of a selected row.
This will return the row number of the Nth selected row. The row numbers returned will be sorted in order from low to high.
- Parameters
-
index the index of the selected row to return, (from 0 to getNumSelectedRows() - 1)
- Returns
- the row number, or -1 if the index was out of range or if there aren't any rows selected
- See also
- getNumSelectedRows, isRowSelected, getLastRowSelected
◆ getSelectedRows()
Returns a sparse set indicating the rows that are currently selected.
- See also
- setSelectedRows
◆ getVerticalPosition()
| double juce::ListBox::getVerticalPosition | ( | ) | const |
Returns the current vertical position as a proportion of the total.
This can be used in conjunction with setVerticalPosition() to save and restore the list's position. It returns a value in the range 0 to 1.
- See also
- setVerticalPosition
◆ getVerticalScrollBar()
|
noexcept |
Returns a reference to the vertical scrollbar.
◆ getViewport()
|
noexcept |
Returns the viewport that this ListBox uses.
You may need to use this to change parameters such as whether scrollbars are shown, etc.
◆ getVisibleContentWidth()
|
noexcept |
Returns the space currently available for the row items, taking into account borders, scrollbars, etc.
◆ getVisibleRowWidth()
|
noexcept |
Returns the width of a row (which may be less than the width of this component if there's a scrollbar).
◆ hasAccessibleHeaderComponent()
|
private |
◆ isRowSelected()
| bool juce::ListBox::isRowSelected | ( | int | rowNumber | ) | const |
Checks whether a row is selected.
◆ keyPressed()
Called when a key is pressed.
When a key is pressed, the component that has the keyboard focus will have this method called. Remember that a component will only be given the focus if its setWantsKeyboardFocus() method has been used to enable this.
If your implementation returns true, the event will be consumed and not passed on to any other listeners. If it returns false, the key will be passed to any KeyListeners that have been registered with this component. As soon as one of these returns true, the process will stop, but if they all return false, the event will be passed upwards to this component's parent, and so on.
The default implementation of this method does nothing and returns false.
- See also
- keyStateChanged, getCurrentlyFocusedComponent, addKeyListener
Reimplemented from juce::Component.
◆ keyStateChanged()
|
overridevirtual |
Called when a key is pressed or released.
Whenever a key on the keyboard is pressed or released (including modifier keys like shift and ctrl), this method will be called on the component that currently has the keyboard focus. Remember that a component will only be given the focus if its setWantsKeyboardFocus() method has been used to enable this.
If your implementation returns true, the event will be consumed and not passed on to any other listeners. If it returns false, then any KeyListeners that have been registered with this component will have their keyStateChanged methods called. As soon as one of these returns true, the process will stop, but if they all return false, the event will be passed upwards to this component's parent, and so on.
The default implementation of this method does nothing and returns false.
To find out which keys are up or down at any time, see the KeyPress::isKeyCurrentlyDown() method.
- Parameters
-
isKeyDown true if a key has been pressed; false if it has been released
- See also
- keyPressed, KeyPress, getCurrentlyFocusedComponent, addKeyListener
Reimplemented from juce::Component.
◆ mouseUp()
|
overridevirtual |
Called when a mouse button is released.
A mouseUp callback is sent to the component in which a button was pressed even if the mouse is actually over a different component when the button is released.
The MouseEvent object passed in contains lots of methods for finding out which buttons were down just before they were released.
- Parameters
-
Event details about the position and status of the mouse event, including the source component in which it occurred
- See also
- mouseDown, mouseDrag, mouseDoubleClick, contains
Reimplemented from juce::Component.
◆ mouseWheelMove()
|
overridevirtual |
Called when the mouse-wheel is moved.
This callback is sent to the component that the mouse is over when the wheel is moved.
If not overridden, a component will forward this message to its parent, so that parent components can collect mouse-wheel messages that happen to child components which aren't interested in them. (Bear in mind that if you attach a component as a mouse-listener to other components, then those wheel moves will also end up calling this method and being passed up to the parents, which may not be what you intended to happen).
- Parameters
-
Event details about the mouse event wheel details about the mouse wheel movement
Reimplemented from juce::Component.
◆ paint()
Components can override this method to draw their content.
The paint() method gets called when a region of a component needs redrawing, either because the component's repaint() method has been called, or because something has happened on the screen that means a section of a window needs to be redrawn.
Any child components will draw themselves over whatever this method draws. If you need to paint over the top of your child components, you can also implement the paintOverChildren() method to do this.
If you want to cause a component to redraw itself, this is done asynchronously - calling the repaint() method marks a region of the component as "dirty", and the paint() method will automatically be called sometime later, by the message thread, to paint any bits that need refreshing. In JUCE (and almost all modern UI frameworks), you never redraw something synchronously.
You should never need to call this method directly - to take a snapshot of the component you could use createComponentSnapshot() or paintEntireComponent().
- Parameters
-
g the graphics context that must be used to do the drawing operations.
- See also
- repaint, paintOverChildren, Graphics
Reimplemented from juce::Component.
◆ paintOverChildren()
Components can override this method to draw over the top of their children.
For most drawing operations, it's better to use the normal paint() method, but if you need to overlay something on top of the children, this can be used.
- See also
- paint, Graphics
Reimplemented from juce::Component.
◆ parentHierarchyChanged()
|
overridevirtual |
Called to indicate that the component's parents have changed.
When a component is added or removed from its parent, this method will be called on all of its children (recursively - so all children of its children will also be called as well).
Subclasses can override this if they need to react to this in some way.
- See also
- getParentComponent, isShowing, ComponentListener::componentParentHierarchyChanged
Reimplemented from juce::Component.
◆ repaintRow()
Repaints one of the rows.
This does not invoke updateContent(), it just invokes a straightforward repaint for the area covered by this row.
◆ 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::Component.
Reimplemented in juce::TableListBox.
◆ scrollToEnsureRowIsOnscreen()
Scrolls if necessary to make sure that a particular row is visible.
◆ selectRangeOfRows()
| void juce::ListBox::selectRangeOfRows | ( | int | firstRow, |
| int | lastRow, | ||
| bool | dontScrollToShowThisRange = false ) |
Selects a set of rows.
This will add these rows to the current selection, so you might need to clear the current selection first with deselectAllRows()
- Parameters
-
firstRow the first row to select (inclusive) lastRow the last row to select (inclusive) dontScrollToShowThisRange if true, the list's position won't change; if false and the selected range is off-screen, it'll scroll to make sure that the range of rows is on-screen
◆ selectRow()
| void juce::ListBox::selectRow | ( | int | rowNumber, |
| bool | dontScrollToShowThisRow = false, | ||
| bool | deselectOthersFirst = true ) |
Selects a row.
If the row is already selected, this won't do anything.
- Parameters
-
rowNumber the row to select dontScrollToShowThisRow if true, the list's position won't change; if false and the selected row is off-screen, it'll scroll to make sure that row is on-screen deselectOthersFirst if true and there are multiple selections, these will first be deselected before this item is selected
- See also
- isRowSelected, selectRowsBasedOnModifierKeys, flipRowSelection, deselectRow, deselectAllRows, selectRangeOfRows
◆ selectRowInternal()
|
private |
◆ selectRowsBasedOnModifierKeys()
| void juce::ListBox::selectRowsBasedOnModifierKeys | ( | int | rowThatWasClickedOn, |
| ModifierKeys | modifiers, | ||
| bool | isMouseUpEvent ) |
Multiply-selects rows based on the modifier keys.
If no modifier keys are down, this will select the given row and deselect any others.
If the ctrl (or command on the Mac) key is down, it'll flip the state of the selected row.
If the shift key is down, it'll select up to the given row from the last row selected.
- See also
- selectRow
◆ setClickingTogglesRowSelection()
|
noexcept |
If enabled, this makes the listbox flip the selection status of each row that the user clicks, without affecting other selected rows.
(This only has an effect if multiple selection is also enabled). If not enabled, you can still get the same row-flipping behaviour by holding down CMD or CTRL when clicking.
◆ setHeaderComponent()
Sets a component that the list should use as a header.
This will position the given component at the top of the list, maintaining the height of the component passed-in, but rescaling it horizontally to match the width of the items in the listbox.
The component will be deleted when setHeaderComponent() is called with a different component, or when the listbox is deleted.
◆ setMinimumContentWidth()
Changes the width of the rows in the list.
This can be used to make the list's row components wider than the list itself - the width of the rows will be either the width of the list or this value, whichever is greater, and if the rows become wider than the list, a horizontal scrollbar will appear.
The default value for this is 0, which means that the rows will always be the same width as the list.
◆ setModel()
| void juce::ListBox::setModel | ( | ListBoxModel * | newModel | ) |
Changes the current data model to display.
The ListBoxModel instance must stay alive for as long as the ListBox holds a pointer to it. Be careful to destroy the ListBox before the ListBoxModel, or to call ListBox::setModel (nullptr) before destroying the ListBoxModel.
◆ setMouseMoveSelectsRows()
| void juce::ListBox::setMouseMoveSelectsRows | ( | bool | shouldSelect | ) |
Makes the list react to mouse moves by selecting the row that the mouse if over.
This function is here primarily for the ComboBox class to use, but might be useful for some other purpose too.
◆ setMultipleSelectionEnabled()
|
noexcept |
Turns on multiple-selection of rows.
By default this is disabled.
When your row component gets clicked you'll need to call the selectRowsBasedOnModifierKeys() method to tell the list that it's been clicked and to get it to do the appropriate selection based on whether the ctrl/shift keys are held down.
◆ setOutlineThickness()
Sets the thickness of a border that will be drawn around the box.
To set the colour of the outline, use
- See also
- outlineColourId
◆ setRowHeight()
Sets the height of each row in the list. The default height is 22 pixels.
- See also
- getRowHeight
◆ setRowSelectedOnMouseDown()
|
noexcept |
Sets whether a row should be selected when the mouse is pressed or released. By default this is true, but you may want to turn it off.
◆ setSelectedRows() [1/2]
◆ setSelectedRows() [2/2]
| void juce::ListBox::setSelectedRows | ( | const SparseSet< int > & | setOfRowsToBeSelected, |
| NotificationType | sendNotificationEventToModel = sendNotification ) |
Sets the rows that should be selected, based on an explicit set of ranges.
If sendNotificationEventToModel is true, the ListBoxModel::selectedRowsChanged() method will be called. If it's false, no notification will be sent to the model.
- See also
- getSelectedRows
◆ setVerticalPosition()
| void juce::ListBox::setVerticalPosition | ( | double | newProportion | ) |
Scrolls the list to a particular position.
The proportion is between 0 and 1.0, so 0 scrolls to the top of the list, 1.0 scrolls to the bottom.
If the total number of rows all fit onto the screen at once, then this method won't do anything.
- See also
- getVerticalPosition
◆ startDragAndDrop()
| void juce::ListBox::startDragAndDrop | ( | const MouseEvent & | e, |
| const SparseSet< int > & | rowsToDrag, | ||
| const var & | dragDescription, | ||
| bool | allowDraggingToOtherWindows ) |
◆ updateContent()
| void juce::ListBox::updateContent | ( | ) |
Causes the list to refresh its content.
Call this when the number of rows in the list changes, or if you want it to call refreshComponentForRow() on all the row components.
This must only be called from the main message thread.
◆ visibilityChanged()
|
overridevirtual |
Called when this component's visibility changes.
- See also
- setVisible, isVisible
Reimplemented from juce::Component.
Friends And Related Symbol Documentation
◆ ListViewport
|
friend |
◆ TableListBox
|
friend |
Member Data Documentation
◆ alwaysFlipSelection
|
private |
◆ hasDoneInitialUpdate
|
private |
◆ headerComponent
|
private |
◆ lastRowSelected
|
private |
◆ minimumRowWidth
|
private |
◆ model
|
private |
◆ mouseMoveSelector
|
private |
◆ multipleSelection
|
private |
◆ outlineThickness
|
private |
◆ rowHeight
|
private |
◆ selected
◆ selectOnMouseDown
|
private |
◆ totalItems
|
private |
◆ viewport
|
private |
◆ weakModelPtr
|
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_ListBox.h
- /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_gui_basics/widgets/juce_ListBox.cpp
Generated on for LMMS by
1.16.1